SiliconCompiler

https://docs.siliconcompiler.com/en/latest/
Admin
SiliconCompiler is an open source, modular build system that automates translation from hardware...
Tokens:449,874
Snippets:5,075
Trust Score:6.3
Update:5 months ago
Show doc for...
Tokens:
Raw
### Set Package Quickstart Document (API)

Source: https://docs.siliconcompiler.com/en/latest/reference_manual/schema.html

Adds a quickstart file to the package documentation. This file provides a brief guide to get started with the package.

```python
schema.set('doc', 'quickstart', 'quickstart.pdf')
```

--------------------------------

### Package Quickstart Document

Source: https://docs.siliconcompiler.com/en/latest/reference_manual/schema.html

Adds a quickstart document to the package. Quickstart guides help users get started quickly.

```APIDOC
## Package Quickstart Document

### Description
Adds a quickstart document to the package.

### API Example
`schema.set('doc', 'quickstart', 'quickstart.pdf')`
```

--------------------------------

### Set Package Quickstart Document

Source: https://docs.siliconcompiler.com/en/latest/reference_manual/schema.html

Use this to add a quickstart document to the package. Provide the file path.

```cli
-package_doc_quickstart quickstart.pdf
```

```python
schema.set('doc', 'quickstart', 'quickstart.pdf')
```

--------------------------------

### Install FPGA Tools

Source: https://docs.siliconcompiler.com/en/latest/user_guide/installation.html

Install the recommended set of tools for an FPGA design flow using the sc-install script.

```bash
sc-install -group fpga

```

--------------------------------

### Show install script with sc-install

Source: https://docs.siliconcompiler.com/en/latest/reference_manual/apps.html

Use the -show option to display the generated installation script for a tool without actually executing the installation. This is helpful for debugging or understanding the installation process.

```bash
sc-install -show openroad
```

--------------------------------

### Package Quickstart Document

Source: https://docs.siliconcompiler.com/en/latest/reference_manual/schema.html

Adds a quickstart document to the package's documentation list.

```APIDOC
## quickstart#

### Description
Package list of quickstart documents.

### Type
[file]

### Scope
global

### Example (API)
```python
schema.set('doc', 'quickstart', 'quickstart.pdf')
```
```

--------------------------------

### Install ASIC Tools

Source: https://docs.siliconcompiler.com/en/latest/user_guide/installation.html

Install the recommended set of tools for an ASIC design flow using the sc-install script.

```bash
sc-install -group asic

```

--------------------------------

### Private Server Configuration Example

Source: https://docs.siliconcompiler.com/en/latest/development_guide/remote_processing.html

Example of interactive prompts for configuring a private, authenticated remote server. The configuration is saved to `$HOME/.sc/credentials.json`.

```bash
Remote server address: [https://your-secure-server.com](https://your-secure-server.com)
Remote username: your-username
Remote password: your-key
Remote configuration saved to: /home/user/.sc/credentials.json

```

--------------------------------

### Set Up Python Virtual Environment and Install SiliconCompiler (Linux/macOS)

Source: https://docs.siliconcompiler.com/en/latest/user_guide/docker.html

Create and activate a Python virtual environment, then install SiliconCompiler. This is for Linux and macOS systems.

```bash
# Create and activate a Python virtual environment
python3 -m venv .venv
source .venv/bin/activate

# Install SiliconCompiler
pip install siliconcompiler

```

--------------------------------

### Add Package Quickstart Document

Source: https://docs.siliconcompiler.com/en/latest/reference_manual/schema.html

Adds a quickstart document to the package.

```APIDOC
## Add Package Quickstart Document

### Description
Adds a quickstart document to the package.

### Method
API

### Endpoint
schema.set('doc', 'quickstart', '<file>')
```

--------------------------------

### Starting Step

Source: https://docs.siliconcompiler.com/en/latest/reference_manual/schema.html

Defines an inclusive list of steps from which to start execution. Defaults to all entry steps in the flow graph.

```APIDOC
## from

### Description
Inclusive list of steps to start execution from. The default is to start at all entry steps in the flow graph.

### Option Type
[str]

### Scope
job

### CLI Switch
- `-from <str>`

### Example (CLI)
- `-from 'import'`

### Example (API)
`option.set('from', 'import')`
```

--------------------------------

### Install a group of tools with sc-install

Source: https://docs.siliconcompiler.com/en/latest/reference_manual/apps.html

Install a predefined group of tools by using the -group option followed by the group name. This simplifies installing sets of tools for specific workflows like 'asic' or 'fpga'.

```bash
sc-install -group asic
```

--------------------------------

### Set Up Python Virtual Environment and Install SiliconCompiler (Windows)

Source: https://docs.siliconcompiler.com/en/latest/user_guide/docker.html

Create and activate a Python virtual environment, then install SiliconCompiler. This is for Windows PowerShell.

```powershell
# Create and activate a Python virtual environment
python3 -m venv .venv
.venv\Scripts\activate

# Install SiliconCompiler
pip install siliconcompiler

```

--------------------------------

### Public Server Configuration Example

Source: https://docs.siliconcompiler.com/en/latest/development_guide/remote_processing.html

Example of interactive prompts for configuring a public, unauthenticated remote server. Leave username and password blank.

```bash
Remote server address: [https://server.siliconcompiler.com](https://server.siliconcompiler.com)
Remote username: 
Remote password: 
Remote configuration saved to: /home/user/.sc/credentials.json

```

--------------------------------

### Set Setup Skew Metric (CLI)

Source: https://docs.siliconcompiler.com/en/latest/reference_manual/schema.html

Use the CLI to set the setup clock skew for a specific step and index.

```bash
-metric_setupskew 'place 0 0.01'
```

--------------------------------

### Install Slurm Documentation Package

Source: https://docs.siliconcompiler.com/en/latest/reference_manual/appendix/slurmsetup.html

Installs the Slurm documentation package, which includes the web-based configurator tool.

```bash
apt-get install slurm-wlm-doc
```

--------------------------------

### Set Start Step Option

Source: https://docs.siliconcompiler.com/en/latest/reference_manual/schema.html

Specifies an inclusive list of steps from which to start execution. Defaults to all entry steps in the flow graph.

```bash
-from 'import'
```

```python
option.set('from', 'import')
```

--------------------------------

### Install a single tool with sc-install

Source: https://docs.siliconcompiler.com/en/latest/reference_manual/apps.html

Use the sc-install command to install a specific tool. This is the most basic way to add supported tools to your environment.

```bash
sc-install openroad
```

--------------------------------

### Install multiple tools with sc-install

Source: https://docs.siliconcompiler.com/en/latest/reference_manual/apps.html

Install several tools simultaneously by listing them after the sc-install command. This is useful for setting up a project with multiple dependencies.

```bash
sc-install openroad yosys klayout
```

--------------------------------

### Set Setup Paths Metric

Source: https://docs.siliconcompiler.com/en/latest/reference_manual/schema.html

Sets the total number of timing paths violating setup constraints.

```APIDOC
## Set Setup Paths Metric

### Description
Sets the total number of timing paths violating setup constraints on a per step and index basis.

### Method
`fpga.set('metric', 'setuppaths', value, step='step_name', index=index_value)`

### Parameters
- **metric** (string) - Must be 'setuppaths'.
- **value** (int) - The number of setup paths violating constraints.
- **step** (string) - The design step (e.g., 'place').
- **index** (int) - The index for the step.

### Request Example
```python
fpga.set('metric', 'setuppaths', 10, step='place', index=0)
```
```

--------------------------------

### Install SiliconCompiler from PyPI

Source: https://docs.siliconcompiler.com/en/latest/user_guide/installation.html

Installs the latest stable version of SiliconCompiler from PyPI using pip within an activated virtual environment.

```bash
(venv) pip install --upgrade siliconcompiler    # install SiliconCompiler in venv
(venv) pip show siliconcompiler                 # will display SiliconCompiler package information

```

--------------------------------

### Set Setup Paths Metric (CLI)

Source: https://docs.siliconcompiler.com/en/latest/reference_manual/schema.html

Use the CLI to set the total number of timing paths violating setup constraints for a specific step and index.

```bash
-metric_setuppaths 'place 0 10'
```

--------------------------------

### Set Setup TNS Metric (CLI)

Source: https://docs.siliconcompiler.com/en/latest/reference_manual/schema.html

Use the CLI to set the total negative setup slack (TNS) for a specific step and index.

```bash
-metric_setuptns 'place 0 0.01'
```

--------------------------------

### Set Setup Slack Metric (CLI)

Source: https://docs.siliconcompiler.com/en/latest/reference_manual/schema.html

Use the CLI to set the worst setup slack (positive or negative) for a specific step and index.

```bash
-metric_setupslack 'place 0 0.01'
```

--------------------------------

### Set Setup Paths Metric (API)

Source: https://docs.siliconcompiler.com/en/latest/reference_manual/schema.html

Use the Python API to set the total number of timing paths violating setup constraints for a specific step and index.

```python
asic.set('metric', 'setuppaths', 10, step='place', index=0)
```

--------------------------------

### Set Setup Skew Metric (API)

Source: https://docs.siliconcompiler.com/en/latest/reference_manual/schema.html

Use the Python API to set the setup clock skew for a specific step and index.

```python
asic.set('metric', 'setupskew', 0.01, step='place', index=0)
```

--------------------------------

### Set Setup WNS Metric (CLI)

Source: https://docs.siliconcompiler.com/en/latest/reference_manual/schema.html

Use the CLI to set the worst negative setup slack (positive values truncated to zero) for a specific step and index.

```bash
-metric_setupwns 'place 0 0.01'
```

--------------------------------

### Set Start Time Record (CLI)

Source: https://docs.siliconcompiler.com/en/latest/reference_manual/schema.html

Use this CLI switch to record the start time for a specific step and index. Time is recorded in UTC format.

```bash
-record_starttime 'dfm 0 "2021-09-06 12:20:20.000000"'
```

--------------------------------

### Set Setup Slack Metric (API)

Source: https://docs.siliconcompiler.com/en/latest/reference_manual/schema.html

Use the Python API to set the worst setup slack (positive or negative) for a specific step and index.

```python
asic.set('metric', 'setupslack', 0.01, step='place', index=0)
```

--------------------------------

### Set Setup WNS Metric (API)

Source: https://docs.siliconcompiler.com/en/latest/reference_manual/schema.html

Use the Python API to set the worst negative setup slack (positive values truncated to zero) for a specific step and index.

```python
asic.set('metric', 'setupwns', 0.01, step='place', index=0)
```

--------------------------------

### Install Slurm Daemons and Client

Source: https://docs.siliconcompiler.com/en/latest/reference_manual/appendix/slurmsetup.html

Install the core Slurm scheduling daemons (slurmctld and slurmd) and the slurm-client package using the system's package manager. This command is for Ubuntu.

```bash
apt-get install slurmctld slurmd slurm-client

```

--------------------------------

### Start a Fresh Run in Python

Source: https://docs.siliconcompiler.com/en/latest/user_guide/faq.html

Ensure a clean build by removing previous outputs before starting a new run. This is useful for avoiding issues caused by stale artifacts.

```python
project.option.set_clean(True)

```

--------------------------------

### Set Starting Step for Execution

Source: https://docs.siliconcompiler.com/en/latest/reference_manual/schema.html

Specifies an inclusive list of steps to begin execution from. If not set, execution starts from all entry steps in the flow graph. Can be set via API or CLI.

```python
option.set('from', 'import')
```

```bash
-from 'import'
```

--------------------------------

### Configure Tool Executable and Version

Source: https://docs.siliconcompiler.com/en/latest/development_guide/tools.html

In the setup() method, specify the tool's executable path and how to check its version using add_vswitch() and add_version().

```python
def setup(self):
    # Get the tool and task name for the current step.
    tool = self.tool
    task = self.task

    # 1. Point to the executable.
    self.set_exe('my_tool_binary')

    # 2. Define how to check the version.
    #    'vswitch' is the command-line flag to print the version.
    #    'version' is a list of known-good version specifiers.
    self.add_vswitch('--version')
    self.add_version('>=2.1')

```

--------------------------------

### Migen HDL Example for SiliconCompiler

Source: https://docs.siliconcompiler.com/en/latest/user_guide/tutorials/hw_frontends.html

This example demonstrates how to use Migen HDL with SiliconCompiler to describe hardware circuits. Ensure Migen is installed (`pip install migen`).

```python
#!/usr/bin/env python3

import os.path

# Import the necessary components from the Migen library for hardware design.
# Migen allows you to describe hardware circuits using Python.
from migen import Module, Signal, Cat, Replicate
from migen.fhdl.verilog import convert

# Import the core classes from the siliconcompiler library.
from siliconcompiler import Design
from siliconcompiler import ASIC
# Import a pre-defined target for the FreePDK45 process.
from siliconcompiler.targets import freepdk45_demo


# --- Migen Hardware Description ---
```

--------------------------------

### Install Munge for Communication

Source: https://docs.siliconcompiler.com/en/latest/reference_manual/appendix/slurmsetup.html

Install the munge package, which is used for encrypting communications between Slurm daemons. It is often installed as a dependency but can be installed separately if needed.

```bash
apt-get install munge

```

--------------------------------

### Set Tutorial Document

Source: https://docs.siliconcompiler.com/en/latest/reference_manual/schema.html

Use this to set the tutorial document for a package. Accepts a file path.

```cli
-package_doc_tutorial tutorial.pdf
```

```python
schema.set('doc', 'tutorial', 'tutorial.pdf')
```

--------------------------------

### Install Python Dependencies on Ubuntu

Source: https://docs.siliconcompiler.com/en/latest/user_guide/installation.html

Installs Python 3, pip, and venv on Ubuntu systems. Activates a virtual environment for subsequent installations.

```bash
python3 --version                                      # check for Python 3
sudo apt update                                        # update package information
sudo apt install python3-dev python3-pip python3-venv  # install dependencies
python3 -m venv  ./venv                                # create a virtual env
source ./venv/bin/activate                             # active virtual env (bash/zsh)

```

--------------------------------

### Install tools to a custom prefix with sc-install

Source: https://docs.siliconcompiler.com/en/latest/reference_manual/apps.html

Specify a custom installation directory using the -prefix option. This allows you to manage tool installations outside of the default location.

```bash
sc-install -prefix /usr/local yosys
```

--------------------------------

### Add Package User Guide

Source: https://docs.siliconcompiler.com/en/latest/reference_manual/schema.html

Adds a user guide document to the package.

```APIDOC
## Add Package User Guide

### Description
Adds a user guide document to the package.

### Method
API

### Endpoint
schema.set('doc', 'userguide', '<file>')
```

--------------------------------

### Task.setup

Source: https://docs.siliconcompiler.com/en/latest/development_guide/tools.html

A hook for setting up the task before execution.

```APIDOC
## Task.setup

### Description
A hook for setting up the task before execution.

### Method
N/A (Hook)

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A
```

--------------------------------

### from Option

Source: https://docs.siliconcompiler.com/en/latest/reference_manual/schema.html

Defines an inclusive list of steps to start execution from. Defaults to all entry steps in the flow graph.

```APIDOC
## from Option

### Description
Inclusive list of steps to start execution from. The default is to start at all entry steps in the flow graph.

### Type
[str]

### Scope
job

### API Example
`option.set('from', 'import')`
```

--------------------------------

### Verify SiliconCompiler Installation (PyPI)

Source: https://docs.siliconcompiler.com/en/latest/user_guide/installation.html

Confirms the SiliconCompiler installation by importing the package and printing its version number.

```python
(venv) python3 -c "import siliconcompiler;print(siliconcompiler.__version__)"

```

--------------------------------

### Set Userguide Document

Source: https://docs.siliconcompiler.com/en/latest/reference_manual/schema.html

Use this to set the userguide document for a package. Accepts a file path.

```cli
-package_doc_userguide userguide.pdf
```

```python
schema.set('doc', 'userguide', 'userguide.pdf')
```

--------------------------------

### Task.setup_work_directory

Source: https://docs.siliconcompiler.com/en/latest/development_guide/tools.html

Creates the runtime directories needed to execute a task.

```APIDOC
## Task.setup_work_directory

### Description
Creates the runtime directories needed to execute a task.

### Method
N/A (Method)

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A
```

--------------------------------

### Set Setup Skew Metric

Source: https://docs.siliconcompiler.com/en/latest/reference_manual/schema.html

Sets the setup clock skew on a per step and index basis.

```APIDOC
## Set Setup Skew Metric

### Description
Sets the setup clock skew on a per step and index basis.

### Method
`fpga.set('metric', 'setupskew', value, step='step_name', index=index_value)`

### Parameters
- **metric** (string) - Must be 'setupskew'.
- **value** (float) - The setup clock skew value in ns.
- **step** (string) - The design step (e.g., 'place').
- **index** (int) - The index for the step.

### Request Example
```python
fpga.set('metric', 'setupskew', 0.01, step='place', index=0)
```
```

--------------------------------

### Set setupslack metric via API

Source: https://docs.siliconcompiler.com/en/latest/reference_manual/schema.html

Use the API to track the worst setup slack on a per step and index basis. Requires specifying the metric name, value, step, and index.

```python
fpga.set('metric', 'setupslack', 0.01, step='place', index=0)
```

--------------------------------

### Set setupskew metric via API

Source: https://docs.siliconcompiler.com/en/latest/reference_manual/schema.html

Use the API to track the setup clock skew on a per step and index basis. Requires specifying the metric name, value, step, and index.

```python
fpga.set('metric', 'setupskew', 0.01, step='place', index=0)
```

--------------------------------

### Set setupwns metric via API

Source: https://docs.siliconcompiler.com/en/latest/reference_manual/schema.html

Use the API to track the worst negative setup slack on a per step and index basis. Requires specifying the metric name, value, step, and index.

```python
fpga.set('metric', 'setupwns', 0.01, step='place', index=0)
```

--------------------------------

### MacroPlacementTask.set_openroad_latetimingderate

Source: https://docs.siliconcompiler.com/en/latest/reference_manual/predef_modules/tools.html

Sets the timing derating factor to use for setup corners. This value influences the setup time analysis.

```APIDOC
## MacroPlacementTask.set_openroad_latetimingderate

### Description
Sets the timing derating factor to use for setup corners.

### Parameters
#### Path Parameters
- **derate** (float) - Required - The derating factor.
- **step** (str) - Optional - The specific step to apply this configuration to.
- **index** (str) - Optional - The specific index to apply this configuration to.
```

--------------------------------

### Set Setup TNS Metric

Source: https://docs.siliconcompiler.com/en/latest/reference_manual/schema.html

Sets the total negative setup slack (TNS) on a per step and index basis.

```APIDOC
## Set Setup TNS Metric

### Description
Sets the total negative setup slack (TNS) on a per step and index basis.

### Method
`fpga.set('metric', 'setuptns', value, step='step_name', index=index_value)`

### Parameters
- **metric** (string) - Must be 'setuptns'.
- **value** (float) - The total negative setup slack value in ns.
- **step** (string) - The design step (e.g., 'place').
- **index** (int) - The index for the step.

### Request Example
```python
fpga.set('metric', 'setuptns', 0.01, step='place', index=0)
```
```

--------------------------------

### Add Tutorial Document (API)

Source: https://docs.siliconcompiler.com/en/latest/reference_manual/schema.html

Use this to add a tutorial document to the package. The value is a file path.

```python
schema.set('doc', 'tutorial', 'tutorial.pdf')
```

--------------------------------

### Set Setup Slack Metric

Source: https://docs.siliconcompiler.com/en/latest/reference_manual/schema.html

Sets the worst setup slack (positive or negative) on a per step and index basis.

```APIDOC
## Set Setup Slack Metric

### Description
Sets the worst setup slack (positive or negative) on a per step and index basis.

### Method
`fpga.set('metric', 'setupslack', value, step='step_name', index=index_value)`

### Parameters
- **metric** (string) - Must be 'setupslack'.
- **value** (float) - The worst setup slack value in ns.
- **step** (string) - The design step (e.g., 'place').
- **index** (int) - The index for the step.

### Request Example
```python
fpga.set('metric', 'setupslack', 0.01, step='place', index=0)
```
```

--------------------------------

### ShowTask.set_openroad_latetimingderate

Source: https://docs.siliconcompiler.com/en/latest/reference_manual/predef_modules/tools.html

Sets the timing derating factor to use for setup timing corners. This parameter influences the calculated setup times.

```APIDOC
## ShowTask.set_openroad_latetimingderate

### Description
Sets the timing derating factor to use for setup corners.

### Method
ShowTask.set_openroad_latetimingderate

### Parameters
#### Path Parameters
- **derate** (float) - Required - The derating factor.
- **step** (str | None) - Optional - The specific step to apply this configuration to.
- **index** (str | None) - Optional - The specific index to apply this configuration to.
```

--------------------------------

### RepairTimingTask.set_openroad_skipsetuprepair

Source: https://docs.siliconcompiler.com/en/latest/reference_manual/predef_modules/tools.html

Enables or disables skipping setup timing repair. This method controls the skipping of setup timing violation repairs.

```APIDOC
## RepairTimingTask.set_openroad_skipsetuprepair

### Description
Enables or disables skipping setup timing repair.

### Parameters
- **skip** (bool) - Required - True to skip repair, False to perform it.
- **step** (str | None) - Optional - The specific step to apply this configuration to.
- **index** (str | None) - Optional - The specific index to apply this configuration to.
```

--------------------------------

### from option

Source: https://docs.siliconcompiler.com/en/latest/reference_manual/schema.html

Defines an inclusive list of steps to start execution from. By default, execution begins at all entry steps in the flow graph.

```APIDOC
## from

### Description
Inclusive list of steps to start execution from. The default is to start at all entry steps in the flow graph.

### Option
starting step

### Type
[str]

### Scope
job

### Default Value
[]

### CLI Switch
-from <str>

### Example (CLI)
-from 'import'

### Example (API)
option.set('from', 'import')
```

--------------------------------

### Install Python Dependencies on macOS

Source: https://docs.siliconcompiler.com/en/latest/user_guide/installation.html

Installs Homebrew, Python 3, and sets up a virtual environment on macOS. Ensures Python is in the PATH.

```bash
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
export PATH="/usr/local/opt/python/libexec/bin:$PATH"
brew update
brew install python
python3 --version                                      # check for Python 3
python3 -m venv  ./venv                                # create a virtual env
source ./venv/bin/activate                             # active virtual env

```

--------------------------------

### Add User Guide Document (API)

Source: https://docs.siliconcompiler.com/en/latest/reference_manual/schema.html

Use this to add a userguide document to the package. The value is a file path.

```python
schema.set('doc', 'userguide', 'userguide.pdf')
```

--------------------------------

### Combine sc-install options

Source: https://docs.siliconcompiler.com/en/latest/reference_manual/apps.html

Combine multiple options like -prefix and -jobs to customize both the installation location and the build parallelism for tools.

```bash
sc-install -prefix /opt/tools -jobs 8 openroad yosys
```

--------------------------------

### Show Design with sc-show

Source: https://docs.siliconcompiler.com/en/latest/user_guide/quickstart.html

Use the sc-show command-line tool to view IC layout files (DEF, GDSII) after a design has been completed. Ensure Klayout is installed.

```bash
(venv) sc-show -design heartbeat
```

--------------------------------

### RepairTimingTask.set_openroad_rszsetupslackmargin

Source: https://docs.siliconcompiler.com/en/latest/reference_manual/predef_modules/tools.html

Sets the margin for setup timing repair. This allows adjustment of the slack margin to influence setup time repair decisions.

```APIDOC
## RepairTimingTask.set_openroad_rszsetupslackmargin

### Description
Sets the margin for setup timing repair.

### Parameters
- **margin** (float) - Required - The margin in ns.
- **step** (str | None) - Optional - The specific step to apply this configuration to.
- **index** (str | None) - Optional - The specific index to apply this configuration to.
```

--------------------------------

### PinPlacementTask.set_openroad_latetimingderate

Source: https://docs.siliconcompiler.com/en/latest/reference_manual/predef_modules/tools.html

Sets the timing derating factor for setup corners. This method applies a derating factor to timing analysis for setup corners.

```APIDOC
## PinPlacementTask.set_openroad_latetimingderate

### Description
Sets the timing derating factor to use for setup corners.

### Parameters
- **derate** (float) - Required - The derating factor.
- **step** (str, optional) - The specific step to apply this configuration to.
- **index** (str, optional) - The specific index to apply this configuration to.
```

--------------------------------

### DetailedPlacementTask.set_openroad_latetimingderate

Source: https://docs.siliconcompiler.com/en/latest/reference_manual/predef_modules/tools.html

Sets the timing derating factor for setup corners. This parameter affects how timing analysis considers variations in setup conditions.

```APIDOC
## DetailedPlacementTask.set_openroad_latetimingderate

### Description
Sets the timing derating factor to use for setup corners.

### Method
`set_openroad_latetimingderate`

### Parameters
#### Parameters
- **derate** (float) - Required - The derating factor.
- **step** (str, optional) - The specific step to apply this configuration to.
- **index** (str, optional) - The specific index to apply this configuration to.
```

--------------------------------

### Set Start Time Record

Source: https://docs.siliconcompiler.com/en/latest/reference_manual/schema.html

Record the start time for a specific step and index. The time is recorded in UTC with microsecond precision.

```cli
-record_starttime 'dfm 0 "2021-09-06 12:20:20.000000"'
```

```python
schema.set('record', 'starttime', '"2021-09-06 12:20:20.000000"', step='dfm', index=0)
```

--------------------------------

### Set From Step

Source: https://docs.siliconcompiler.com/en/latest/reference_manual/schema.html

Specifies an inclusive list of steps to start execution from. Defaults to all entry steps.

```APIDOC
## set

### Description
Inclusive list of steps to start execution from. The default is to start at all entry steps in the flow graph.

### Method
`option.set(variable_name, value)`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```python
option.set('from', 'import')
```

### Response
#### Success Response (200)
None

#### Response Example
None
```

--------------------------------

### View smake general help

Source: https://docs.siliconcompiler.com/en/latest/reference_manual/apps.html

Display the general help message for the smake utility, outlining its usage and available options.

```bash
smake --help
```

--------------------------------

### Configure Remote Server Interactively

Source: https://docs.siliconcompiler.com/en/latest/development_guide/remote_processing.html

Run this command to interactively set up your remote server credentials. Follow the prompts to enter server address, username, and password/API key.

```bash
sc-remote -configure

```

--------------------------------

### Clone and Install SiliconCompiler

Source: https://docs.siliconcompiler.com/en/latest/development_guide/contribution.html

Clone the official SiliconCompiler repository and install it in editable mode to enable local changes to be reflected immediately during testing.

```bash
# Clone the repository
git clone https://github.com/siliconcompiler/siliconcompiler.git
cd siliconcompiler

# Install in editable mode
pip install -e .
```
Tokens:
Raw