Update documentation

docs/source/reference_manual/template_format.md

@@ -22,7 +22,11 @@ that is substituted by CACE. The syntax follows three essential rules:
 
 - `CACE{simpath}`
 
-	> The name of the path to simulation files.
+	> The path to the simulation directory.
+
+- `CACE{root}`
+
+    > The root path of the project.
 
 - `CACE{DUT_path}`
 
@@ -36,6 +40,10 @@ that is substituted by CACE. The syntax follows three essential rules:
 
 	> The current netlist source such as: schematic, layout, pex or rcx.
 
+- `CACE{jobs}`
+
+	> The number of jobs (threads) allocated for this simulation run. Should be used to set `num_threads`.
+
 - `CACE{PDK_ROOT}`
 
 	> The path to the directory containing the PDK

docs/source/reference_manual/tools.md

@@ -9,12 +9,14 @@ Perform spice simulation using ngspice.
 Arguments:
 
 - `template`: `<string>` The template schematic under the `templates/` folder for simulation.
-- `collate`: `<string>` Used to collate results for Monte Carlo simulations.
-- `format`: `<'ascii'>` The file format of the ngspice result. Currently only `ascii` is supported.
-- `suffix`: `<string>` File extension of the result file. For example: `.data`.
+- `jobs` (optional): `<int|'max'>` The number of jobs (threads) that CACE allocates for a single simulation run. Make sure to set `num_threads` to `CACE{jobs}` in the template testbench. If not specified, the default is 1.
+- `collate` (optional): `<string>` Used to collate results for Monte Carlo simulations.
+- `format` (optional): `<'ascii'>` The file format of the ngspice result. Currently only `ascii` is supported.
+- `suffix` (optional): `<string>` File extension of the result file. For example: `.data`.
 - `variables`: `<List[string|null]>` A list of results inside the result file. Use `null` to ignore a column.
 - `script` (optional): `<string>` Name of a Python script in the script folder. It will be executed on the results of each simulation.
-- `script_variables` (optional): `<List[string|null]>` A list of results generated by the specified Python script. These results are available in addition to the ones specified under `variables`. TODO
+- `script_variables` (optional): `<List[string|null]>` A list of results generated by the specified Python script. These results are available in addition to the ones specified under `variables`.
+- `spiceinit_path` (optional): `<string>` Path to a spiceinit file that is copied to the simulation directory and renamed to `.spiceinit`. If not specified, the PDK spiceinit is used.
 
 Results: The results depend on the `variables` and optionally the `script_variables` arguments.
 
@@ -24,8 +26,8 @@ Perform DRC (Design Rule Check) with magic.
 
 Arguments:
 
-- `args`: `<list[string]>` Additional args that are passed to magic.
-- `gds_flatten`: `<true/false>` Flatten the GDSII layout prior to running DRC.
+- `args` (optional): `<list[string]>` Additional args that are passed to magic.
+- `gds_flatten` (optional): `<true/false>` Flatten the GDSII layout prior to running DRC. If not specified, the default is false.
 
 Results:
 
@@ -37,7 +39,7 @@ Perform area measurements with magic.
 
 Arguments:
 
-- `args`: `<list[string]>` Additional args that are passed to magic.
+- `args` (optional): `<list[string]>` Additional args that are passed to magic.
 
 Results:
 
@@ -51,7 +53,7 @@ Perform the magic antenna check to find antenna violations in the layout.
 
 Arguments:
 
-- `args`: `<list[string]>` Additional args that are passed to magic.
+- `args` (optional): `<list[string]>` Additional args that are passed to magic.
 
 Results:
 
@@ -63,7 +65,8 @@ Perform DRC (Design Rule Check) with KLayout.
 
 Arguments:
 
-- `args`: `<list[string]>` Additional args that are passed to KLayout. For example `['-rd', 'feol=true']`.
+- `jobs` (optional): `<int|'max'>` The number of jobs (threads) that CACE allocates for running DRC. If not specified, the default is 1.
+- `args` (optional): `<list[string]>` Additional args that are passed to KLayout. For example `['-rd', 'feol=true']`.
 
 Results:
 
@@ -79,8 +82,8 @@ Perform LVS (Layout VS Schematic) with netgen.
 
 Arguments:
 
-- `args`: `<list[string]>` Additional args that are passed to netgen.
-- `script`: `<string>` A custom LVS script under `scripts/`.
+- `args` (optional): `<list[string]>` Additional args that are passed to netgen.
+- `script` (optional): `<string>` A custom LVS script under `scripts/`.
 
 Results: