# Parameters and their Configuration Variables

These are the parameters available in CACE. Use their IDs to specify the parameters in the datasheet.

Configuration variables are used to configure the behavior of the parameters.

## KLayout


(step-klayout-antennacheck)=
### Antenna check (KLayout)
ID: `KLayout.AntennaCheck`

Run antenna check using KLayout to find antenna violations in the layout.

(klayout.antennacheck-configuration-variables)=
#### Configuration Variables

<div class="table-wrapper colwidths-auto docutils container">
<table class="docutils align-default">
<thead><tr>
<th class="head">Variable Name</th>
<th class="head">Type</th>
<th class="head">Description</th>
<th class="head">Default</th>

</tr></thead>
<tbody>

<tr>
<td>

`jobs`

</td>
<td>

int

</td>
<td>

Number of jobs (threads) to use in parallel.

</td>
<td>

`1`

</td>

</tr>
<tr>
<td>

`args`

</td>
<td>

List[str]?

</td>
<td>

Additional arguments.

</td>
<td>

`None`

</td>

</tr>
<tr>
<td>

`drc_script_path`

</td>
<td>

Path?

</td>
<td>

Optional path to a custom KLayout antenna script..

</td>
<td>

`None`

</td>

</tr></tbody></table></div>

(klayout.antennacheck-configuration-results)=
#### Results

<div class="table-wrapper colwidths-auto docutils container">
<table class="docutils align-default">
<thead><tr>
<th class="head">Variable Name</th>
<th class="head">Type</th>
<th class="head">Description</th>

</tr></thead>
<tbody>

<tr>
<td>

`antenna_violations`

</td>
<td>

Any

</td>
<td>

The number of antenna violations.

</td>

</tr></tbody></table></div>

<hr />


(step-klayout-drc)=
### Design Rule Check (KLayout)
ID: `KLayout.DRC`

Run DRC using KLayout.

(klayout.drc-configuration-variables)=
#### Configuration Variables

<div class="table-wrapper colwidths-auto docutils container">
<table class="docutils align-default">
<thead><tr>
<th class="head">Variable Name</th>
<th class="head">Type</th>
<th class="head">Description</th>
<th class="head">Default</th>

</tr></thead>
<tbody>

<tr>
<td>

`jobs`

</td>
<td>

(int｜<br />'max')

</td>
<td>

Number of jobs to run in parallel.

</td>
<td>

`1`

</td>

</tr>
<tr>
<td>

`args`

</td>
<td>

List[str]?

</td>
<td>

Additional arguments. For example `['-rd', 'variable=value']`.

</td>
<td>

`None`

</td>

</tr>
<tr>
<td>

`drc_script_path`

</td>
<td>

Path?

</td>
<td>

Path to a custom KLayout DRC script. If not specified, the PDK DRC deck is used.

</td>
<td>

`None`

</td>

</tr></tbody></table></div>

(klayout.drc-configuration-results)=
#### Results

<div class="table-wrapper colwidths-auto docutils container">
<table class="docutils align-default">
<thead><tr>
<th class="head">Variable Name</th>
<th class="head">Type</th>
<th class="head">Description</th>

</tr></thead>
<tbody>

<tr>
<td>

`drc_errors`

</td>
<td>

Any

</td>
<td>

The number of DRC errors.

</td>

</tr></tbody></table></div>

<hr />


(step-klayout-lvs)=
### Layout Versus Schematic (KLayout)
ID: `KLayout.LVS`

Run LVS using KLayout.

(klayout.lvs-configuration-variables)=
#### Configuration Variables

<div class="table-wrapper colwidths-auto docutils container">
<table class="docutils align-default">
<thead><tr>
<th class="head">Variable Name</th>
<th class="head">Type</th>
<th class="head">Description</th>
<th class="head">Default</th>

</tr></thead>
<tbody>

<tr>
<td>

`args`

</td>
<td>

List[str]?

</td>
<td>

Additional arguments. For example `['-rd', 'variable=value']`.

</td>
<td>

`None`

</td>

</tr>
<tr>
<td>

`script`

</td>
<td>

Path?

</td>
<td>

Custom LVS script relative to `scripts/`.

</td>
<td>

`None`

</td>

</tr></tbody></table></div>

(klayout.lvs-configuration-results)=
#### Results

<div class="table-wrapper colwidths-auto docutils container">
<table class="docutils align-default">
<thead><tr>
<th class="head">Variable Name</th>
<th class="head">Type</th>
<th class="head">Description</th>

</tr></thead>
<tbody>

<tr>
<td>

`lvs_errors`

</td>
<td>

Any

</td>
<td>

The number of LVS errors.

</td>

</tr></tbody></table></div>

<hr />

## Magic


(step-magic-antennacheck)=
### Antenna check (Magic)
ID: `Magic.AntennaCheck`

Run antenna check using magic to find antenna violations in the layout.

(magic.antennacheck-configuration-variables)=
#### Configuration Variables

<div class="table-wrapper colwidths-auto docutils container">
<table class="docutils align-default">
<thead><tr>
<th class="head">Variable Name</th>
<th class="head">Type</th>
<th class="head">Description</th>
<th class="head">Default</th>

</tr></thead>
<tbody>

<tr>
<td>

`args`

</td>
<td>

List[str]?

</td>
<td>

Additional arguments.

</td>
<td>

`None`

</td>

</tr>
<tr>
<td>

`gds_flatten`

</td>
<td>

bool

</td>
<td>

Flatten the GDS before running the check.

</td>
<td>

`False`

</td>

</tr></tbody></table></div>

(magic.antennacheck-configuration-results)=
#### Results

<div class="table-wrapper colwidths-auto docutils container">
<table class="docutils align-default">
<thead><tr>
<th class="head">Variable Name</th>
<th class="head">Type</th>
<th class="head">Description</th>

</tr></thead>
<tbody>

<tr>
<td>

`antenna_violations`

</td>
<td>

Any

</td>
<td>

The number of antenna violations.

</td>

</tr></tbody></table></div>

<hr />


(step-magic-drc)=
### Design Rule Check (Magic)
ID: `Magic.DRC`

Run DRC using magic.

(magic.drc-configuration-variables)=
#### Configuration Variables

<div class="table-wrapper colwidths-auto docutils container">
<table class="docutils align-default">
<thead><tr>
<th class="head">Variable Name</th>
<th class="head">Type</th>
<th class="head">Description</th>
<th class="head">Default</th>

</tr></thead>
<tbody>

<tr>
<td>

`args`

</td>
<td>

List[str]?

</td>
<td>

Additional arguments.

</td>
<td>

`None`

</td>

</tr>
<tr>
<td>

`gds_flatten`

</td>
<td>

bool

</td>
<td>

Flatten the GDS before running the check.

</td>
<td>

`False`

</td>

</tr></tbody></table></div>

(magic.drc-configuration-results)=
#### Results

<div class="table-wrapper colwidths-auto docutils container">
<table class="docutils align-default">
<thead><tr>
<th class="head">Variable Name</th>
<th class="head">Type</th>
<th class="head">Description</th>

</tr></thead>
<tbody>

<tr>
<td>

`drc_errors`

</td>
<td>

Any

</td>
<td>

The number of DRC errors.

</td>

</tr></tbody></table></div>

<hr />


(step-magic-geometry)=
### Get area, width and height (Magic)
ID: `Magic.Geometry`

Take measurements of the layout geometry using magic.

(magic.geometry-configuration-variables)=
#### Configuration Variables

<div class="table-wrapper colwidths-auto docutils container">
<table class="docutils align-default">
<thead><tr>
<th class="head">Variable Name</th>
<th class="head">Type</th>
<th class="head">Description</th>
<th class="head">Default</th>

</tr></thead>
<tbody>

<tr>
<td>

`args`

</td>
<td>

List[str]?

</td>
<td>

Additional arguments.

</td>
<td>

`None`

</td>

</tr></tbody></table></div>

(magic.geometry-configuration-results)=
#### Results

<div class="table-wrapper colwidths-auto docutils container">
<table class="docutils align-default">
<thead><tr>
<th class="head">Variable Name</th>
<th class="head">Type</th>
<th class="head">Description</th>
<th class="head">Units</th>
</tr></thead>
<tbody>

<tr>
<td>

`area`

</td>
<td>

Any

</td>
<td>

The area of the layout.

</td>

<td>

μm²

</td>

</tr>
<tr>
<td>

`width`

</td>
<td>

Any

</td>
<td>

The width of the layout.

</td>

<td>

μm

</td>

</tr>
<tr>
<td>

`height`

</td>
<td>

Any

</td>
<td>

The height of the layout.

</td>

<td>

μm

</td>

</tr></tbody></table></div>

<hr />

## Netgen


(step-netgen-lvs)=
### Layout Versus Schematic (Netgen)
ID: `Netgen.LVS`

Run LVS using netgen.

```{note}
The `netgen_lvs` tool always compares the `schematic` netlist with the `layout` extracted netlist, independent of the selected netlist source.
```

(netgen.lvs-configuration-variables)=
#### Configuration Variables

<div class="table-wrapper colwidths-auto docutils container">
<table class="docutils align-default">
<thead><tr>
<th class="head">Variable Name</th>
<th class="head">Type</th>
<th class="head">Description</th>
<th class="head">Default</th>

</tr></thead>
<tbody>

<tr>
<td>

`args`

</td>
<td>

List[str]?

</td>
<td>

Additional arguments.

</td>
<td>

`None`

</td>

</tr>
<tr>
<td>

`script`

</td>
<td>

Path?

</td>
<td>

Custom netgen LVS script located relative to `scripts/`.

</td>
<td>

`None`

</td>

</tr></tbody></table></div>

(netgen.lvs-configuration-results)=
#### Results

<div class="table-wrapper colwidths-auto docutils container">
<table class="docutils align-default">
<thead><tr>
<th class="head">Variable Name</th>
<th class="head">Type</th>
<th class="head">Description</th>

</tr></thead>
<tbody>

<tr>
<td>

`lvs_errors`

</td>
<td>

Any

</td>
<td>

The number of LVS errors.

</td>

</tr></tbody></table></div>

<hr />

## Ngspice


(step-ngspice-simulation)=
### Simulation (Ngspice)
ID: `Ngspice.Simulation`

Run simulations using ngspice.

Results: The results depend on the `variables` and, optionally, the `script_variables` configuration variables.

(ngspice.simulation-configuration-variables)=
#### Configuration Variables

<div class="table-wrapper colwidths-auto docutils container">
<table class="docutils align-default">
<thead><tr>
<th class="head">Variable Name</th>
<th class="head">Type</th>
<th class="head">Description</th>
<th class="head">Default</th>

</tr></thead>
<tbody>

<tr>
<td>

`jobs`

</td>
<td>

(int｜<br />'max')

</td>
<td>

Number of jobs to run in parallel. Make sure to set `num_threads` to `CACE{jobs}` in the template testbench.

</td>
<td>

`1`

</td>

</tr>
<tr>
<td>

`template`

</td>
<td>

Path

</td>
<td>

The template testbench under the `templates/` folder.

</td>
<td>

`None`

</td>

</tr>
<tr>
<td>

`collate`

</td>
<td>

str?

</td>
<td>

Merge runs with the same conditions but different iterations. Used to collate results for plotting Monte Carlo simulations.

</td>
<td>

`None`

</td>

</tr>
<tr>
<td>

`format`

</td>
<td>

'ascii'

</td>
<td>

Output format of the testbench simulation result file. Currently only `ascii` is supported.

</td>
<td>

`ascii`

</td>

</tr>
<tr>
<td>

`suffix`

</td>
<td>

str

</td>
<td>

Suffix of the testbench simulation result file.

</td>
<td>

`.data`

</td>

</tr>
<tr>
<td>

`variables`

</td>
<td>

List[str?]

</td>
<td>

The results inside the simulation result file. Use `null` to ignore a column.

</td>
<td>

`None`

</td>

</tr>
<tr>
<td>

`script`

</td>
<td>

Path?

</td>
<td>

Postprocessing using user-defined Python script relative to `scripts/`. It will be executed on the results of each simulation. Note: This is experimental and the API might still change.

</td>
<td>

`None`

</td>

</tr>
<tr>
<td>

`script_variables`

</td>
<td>

List[str?]?

</td>
<td>

Results generated by the user-defined Python script. These results are available in addition to the ones specified under `variables`.

</td>
<td>

`None`

</td>

</tr>
<tr>
<td>

`spiceinit_path`

</td>
<td>

Path?

</td>
<td>

Path to a spiceinit file that is copied to the simulation directory and renamed to `.spiceinit`. If not specified, the PDK spiceinit is used.

</td>
<td>

`None`

</td>

</tr></tbody></table></div>

<hr />

## Misc



If you're missing a tool or functionality, please open an issue [here](https://github.com/efabless/cace/issues).