stable
User Guide
1. Introduction
1.1. Motivation
1.2. Our Approach
1.3. Authors
2. Installation
2.1. Python
2.1.1. Ubuntu (>=18.04)
2.1.2. RHEL (>=RHEL 7)
2.1.3. macOS (>=10.15)
2.1.4. Windows (>= Windows 10)
2.2. SiliconCompiler
2.2.1. Offline Install (Linux only)
2.3. Cloud Access
2.4. Layout Viewer
2.5. External Tools
3. Quickstart guide
3.1. Design
3.2. Setup
3.3. Compilation
3.4. View layout
4. Glossary
5. Data model
6. Programming model
6.1. Object Creation
6.2. Setup
6.3. Run
6.4. Inspection
7. Execution model
8. Remote processing
9. Package Management
10. Tools
10.1. setup(chip)
10.2. parse_version(stdout)
10.3. normalize_version(version)
10.4. pre_process(chip)
10.5. post_process(chip)
10.6. runtime_options(chip)
10.7. make_docs()
10.8. TCL interface
11. PDKs
11.1. setup(chip)
11.2. make_docs()
12. Flows
12.1. setup(chip)
12.2. make_docs()
13. Targets
14. Metrics
15. Records
16. Libraries
16.1. Library Modules
17. Packages
18. FAQ
18.1. How do I…
19. Licenses
19.1. Software License
19.2. Documentation License
19.3. Dependency Licenses
Tutorials
1. Floorplanning
1.1. Floorplanning methodology
1.2. Getting Started
1.3. Minimal chip configuration
1.4. Chip dimensions
1.5. Specifying die area
1.6. Placing RAM
1.7. Placing Pins
1.8. PDN
1.9. Top-level padring
1.10. Building ZeroSoC
2. Contributing targets
3. Parallel Programming
4. Slurm setup
4.1. Initial Slurm Configuration
4.1.1. User and Group Configuration
4.1.2. Slurm Daemon Installation
4.1.3. Slurm Configuration Files
4.1.3.1. cgroup.conf
4.1.3.2. cgroup_allowed_devices.conf
4.1.3.3. slurm.conf
4.1.4. Slurm Startup
4.1.5. Running SiliconCompiler on a Cluster
4.1.6. Troubleshooting
5. Python-based frontends
6. Chisel frontend
7. C HLS frontend
8. Bluespec frontend
Reference Manual
1. Schema
1.1. Keywords
1.2. Parameter Fields
1.3. Parameters
1.3.1. arg
1.3.1.1. flow
1.3.1.2. index
1.3.1.3. pdk
1.3.1.4. step
1.3.2. asic
1.3.2.1. aspectratio
1.3.2.2. cells
1.3.2.3. corearea
1.3.2.4. coremargin
1.3.2.5. delaymodel
1.3.2.6. density
1.3.2.7. diearea
1.3.2.8. dir
1.3.2.9. file
1.3.2.10. footprint
1.3.2.11. hpinlayer
1.3.2.12. libarch
1.3.2.13. logiclib
1.3.2.14. macrolib
1.3.2.15. maxcap
1.3.2.16. maxfanout
1.3.2.17. maxlayer
1.3.2.18. maxlength
1.3.2.19. maxslew
1.3.2.20. minlayer
1.3.2.21. ndr
1.3.2.22. pdk
1.3.2.23. pgmetal
1.3.2.24. rclayer
1.3.2.25. stackup
1.3.2.26. var
1.3.2.27. vpinlayer
1.3.3. checklist
1.3.3.1. criteria
1.3.3.2. dataformat
1.3.3.3. description
1.3.3.4. ok
1.3.3.5. rationale
1.3.3.6. report
1.3.3.7. requirement
1.3.3.8. task
1.3.3.9. waiver
1.3.4. constraint
1.3.4.1. check
1.3.4.2. file
1.3.4.3. libcorner
1.3.4.4. mode
1.3.4.5. opcond
1.3.4.6. pexcorner
1.3.4.7. temperature
1.3.4.8. voltage
1.3.5. datasheet
1.3.5.1. feature
1.3.5.2. limits
1.3.5.3. pin
1.3.6. design
1.3.7. flowgraph
1.3.7.1. args
1.3.7.2. goal
1.3.7.3. input
1.3.7.4. select
1.3.7.5. status
1.3.7.6. timeout
1.3.7.7. tool
1.3.7.8. valid
1.3.7.9. weight
1.3.8. fpga
1.3.8.1. arch
1.3.8.2. board
1.3.8.3. flash
1.3.8.4. partname
1.3.8.5. program
1.3.8.6. vendor
1.3.9. input
1.3.10. metric
1.3.10.1. averagepower
1.3.10.2. brams
1.3.10.3. buffers
1.3.10.4. cellarea
1.3.10.5. cells
1.3.10.6. coverage
1.3.10.7. dozepower
1.3.10.8. drvs
1.3.10.9. dsps
1.3.10.10. errors
1.3.10.11. exetime
1.3.10.12. holdpaths
1.3.10.13. holdslack
1.3.10.14. holdtns
1.3.10.15. holdwns
1.3.10.16. idlepower
1.3.10.17. irdrop
1.3.10.18. leakagepower
1.3.10.19. luts
1.3.10.20. macros
1.3.10.21. memory
1.3.10.22. nets
1.3.10.23. overflow
1.3.10.24. peakpower
1.3.10.25. pins
1.3.10.26. registers
1.3.10.27. security
1.3.10.28. setuppaths
1.3.10.29. setupslack
1.3.10.30. setuptns
1.3.10.31. setupwns
1.3.10.32. sleeppower
1.3.10.33. tasktime
1.3.10.34. totalarea
1.3.10.35. totaltime
1.3.10.36. transistors
1.3.10.37. unconstrained
1.3.10.38. utilization
1.3.10.39. vias
1.3.10.40. warnings
1.3.10.41. wirelength
1.3.11. model
1.3.11.1. formal
1.3.11.2. functional
1.3.11.3. io
1.3.11.4. layout
1.3.11.5. power
1.3.11.6. rtl
1.3.11.7. thermal
1.3.11.8. timing
1.3.12. option
1.3.12.1. autoinstall
1.3.12.2. bkpt
1.3.12.3. builddir
1.3.12.4. cfg
1.3.12.5. clean
1.3.12.6. cmdfile
1.3.12.7. copyall
1.3.12.8. credentials
1.3.12.9. define
1.3.12.10. entrypoint
1.3.12.11. env
1.3.12.12. flow
1.3.12.13. frontend
1.3.12.14. hash
1.3.12.15. idir
1.3.12.16. indexlist
1.3.12.17. jobincr
1.3.12.18. jobinput
1.3.12.19. jobname
1.3.12.20. jobscheduler
1.3.12.21. libext
1.3.12.22. loglevel
1.3.12.23. metricoff
1.3.12.24. mode
1.3.12.25. msgcontact
1.3.12.26. msgevent
1.3.12.27. nodisplay
1.3.12.28. novercheck
1.3.12.29. optmode
1.3.12.30. param
1.3.12.31. pdk
1.3.12.32. quiet
1.3.12.33. registry
1.3.12.34. relax
1.3.12.35. remote
1.3.12.36. resume
1.3.12.37. scpath
1.3.12.38. show
1.3.12.39. showtool
1.3.12.40. skipall
1.3.12.41. skipcheck
1.3.12.42. skipstep
1.3.12.43. steplist
1.3.12.44. target
1.3.12.45. trace
1.3.12.46. track
1.3.12.47. vlib
1.3.12.48. ydir
1.3.13. output
1.3.14. package
1.3.14.1. author
1.3.14.2. dependency
1.3.14.3. depgraph
1.3.14.4. description
1.3.14.5. doc
1.3.14.6. homepage
1.3.14.7. keyword
1.3.14.8. license
1.3.14.9. licensefile
1.3.14.10. location
1.3.14.11. name
1.3.14.12. organization
1.3.14.13. publickey
1.3.14.14. repo
1.3.14.15. target
1.3.14.16. version
1.3.15. pdk
1.3.15.1. aprtech
1.3.15.2. d0
1.3.15.3. density
1.3.15.4. devmodel
1.3.15.5. directory
1.3.15.6. display
1.3.15.7. doc
1.3.15.8. drc
1.3.15.9. edgemargin
1.3.15.10. erc
1.3.15.11. file
1.3.15.12. fill
1.3.15.13. foundry
1.3.15.14. grid
1.3.15.15. hscribe
1.3.15.16. layermap
1.3.15.17. lvs
1.3.15.18. node
1.3.15.19. panelsize
1.3.15.20. pexmodel
1.3.15.21. stackup
1.3.15.22. thickness
1.3.15.23. unitcost
1.3.15.24. var
1.3.15.25. version
1.3.15.26. vscribe
1.3.15.27. wafersize
1.3.16. record
1.3.16.1. arch
1.3.16.2. distro
1.3.16.3. endtime
1.3.16.4. ipaddr
1.3.16.5. kernelversion
1.3.16.6. macaddr
1.3.16.7. machine
1.3.16.8. osversion
1.3.16.9. platform
1.3.16.10. publickey
1.3.16.11. region
1.3.16.12. scversion
1.3.16.13. starttime
1.3.16.14. toolargs
1.3.16.15. toolpath
1.3.16.16. toolversion
1.3.16.17. userid
1.3.17. schemaversion
1.3.18. tool
1.3.18.1. continue
1.3.18.2. env
1.3.18.3. exe
1.3.18.4. format
1.3.18.5. input
1.3.18.6. keep
1.3.18.7. licenseserver
1.3.18.8. option
1.3.18.9. output
1.3.18.10. path
1.3.18.11. refdir
1.3.18.12. regex
1.3.18.13. report
1.3.18.14. require
1.3.18.15. script
1.3.18.16. stderr
1.3.18.17. stdout
1.3.18.18. threads
1.3.18.19. var
1.3.18.20. vendor
1.3.18.21. version
1.3.18.22. vswitch
1.3.18.23. warningoff
1.3.19. unit
1.3.19.1. capacitance
1.3.19.2. current
1.3.19.3. energy
1.3.19.4. inductance
1.3.19.5. length
1.3.19.6. mass
1.3.19.7. power
1.3.19.8. resistance
1.3.19.9. time
1.3.19.10. voltage
1.4. Nested keypaths
1.4.1. history
1.4.2. library
2. Core API
3. Sup API
4. Server API
4.1. remote_run
4.2. check_user
4.3. delete_job
4.4. get_results/{job_hash}.tar.gz
4.5. check_progress
5. Floorplan API
6. Leflib API
7. CLI apps
7.1. sc-env
7.2. sc-ping
7.3. sc-run
7.4. sc-show
7.5. sup
8. Flows directory
8.1. asicflow
8.1.1. Configuration
8.1.1.1. asicflow
8.1.1.2. showtool
8.2. asictopflow
8.2.1. Configuration
8.2.1.1. asictopflow
8.2.1.2. showtool
8.3. dvflow
8.3.1. Configuration
8.3.1.1. dvflow
8.4. fpgaflow
8.4.1. Configuration
8.4.1.1. fpgaflow
8.5. lintflow
8.5.1. Configuration
8.5.1.1. lintflow
8.6. signoffflow
8.6.1. Configuration
8.6.1.1. signoffflow
8.6.1.2. showtool
9. Tools directory
9.1. bambu
9.2. bluespec
9.3. chisel
9.4. ghdl
9.5. icarus
9.6. icepack
9.7. klayout
9.8. magic
9.9. netgen
9.10. nextpnr
9.11. openfpga
9.12. openfpgaloader
9.13. openroad
9.14. surelog
9.15. sv2v
9.16. template
9.17. verilator
9.17.1. Steps supported
9.18. vivado
9.19. vpr
9.20. xyce
9.21. yosys
10. PDK directory
10.1. asap7
10.1.1. Configuration
10.1.1.1. pdk, asap7
10.2. freepdk45
10.2.1. Configuration
10.2.1.1. pdk, freepdk45
10.3. skywater130
10.3.1. Configuration
10.3.1.1. pdk, skywater130
11. Libraries directory
11.1. asap7sc7p5t
11.1.1. asap7sc7p5t_rvt
11.1.1.1. asic
11.1.1.2. model, timing, nldm
11.1.1.3. model, layout, lef
11.1.1.4. model, layout, gds
11.1.2. asap7sc7p5t_lvt
11.1.2.1. asic
11.1.2.2. model, timing, nldm
11.1.2.3. model, layout, lef
11.1.2.4. model, layout, gds
11.1.3. asap7sc7p5t_slvt
11.1.3.1. asic
11.1.3.2. model, timing, nldm
11.1.3.3. model, layout, lef
11.1.3.4. model, layout, gds
11.2. nangate45
11.2.1. nangate45
11.2.1.1. asic
11.2.1.2. model, timing, nldm
11.2.1.3. model, layout, lef
11.2.1.4. model, layout, gds
11.3. sky130hd
11.3.1. sky130hd
11.3.1.1. asic
11.3.1.2. model, timing, nldm
11.3.1.3. model, layout, lef
11.3.1.4. model, layout, gds
11.4. sky130io
11.4.1. sky130io
11.4.1.1. asic
11.4.1.2. model, timing, nldm
11.4.1.3. model, layout, lef
11.4.1.4. model, layout, gds
12. Targets directory
12.1. asap7_demo
12.1.1. Flows
12.1.2. PDK
12.1.3. Libraries
12.1.4. Configuration
12.2. fpgaflow_demo
12.2.1. Flows
12.2.2. Configuration
12.3. freepdk45_demo
12.3.1. Flows
12.3.2. PDK
12.3.3. Libraries
12.3.4. Configuration
12.4. skywater130_demo
12.4.1. Flows
12.4.2. PDK
12.4.3. Libraries
12.4.4. Configuration
Resources
1. Design Glossary
1.1. Architecture
1.2. Design
1.3. Manufacturing
1.4. Packaging
1.5. Test
SiliconCompiler
»
Index
Edit on GitHub
Index
A
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
J
|
K
|
L
|
M
|
N
|
P
|
R
|
S
|
T
|
U
|
V
|
W
A
add() (siliconcompiler.core.Chip method)
add_net() (siliconcompiler.floorplan.Floorplan method)
add_via() (siliconcompiler.floorplan.Floorplan method)
archive() (siliconcompiler.core.Chip method)
audit_manifest() (siliconcompiler.core.Chip method)
author
available_cells (siliconcompiler.floorplan.Floorplan attribute)
C
calc_area() (siliconcompiler.core.Chip method)
calc_dpw() (siliconcompiler.core.Chip method)
calc_yield() (siliconcompiler.core.Chip method)
check() (siliconcompiler.package.Sup method)
check_checklist() (siliconcompiler.core.Chip method)
check_filepaths() (siliconcompiler.core.Chip method)
check_logfile() (siliconcompiler.core.Chip method)
check_manifest() (siliconcompiler.core.Chip method)
chip
Chip (class in siliconcompiler.core)
clear() (siliconcompiler.package.Sup method)
clock() (siliconcompiler.core.Chip method)
create_cmdline() (siliconcompiler.core.Chip method)
create_diearea() (siliconcompiler.floorplan.Floorplan method)
D
date
default
,
[1]
defvalue
design (siliconcompiler.core.Chip property)
dictionary
diearea (siliconcompiler.floorplan.Floorplan attribute)
E
edge
edge() (siliconcompiler.core.Chip method)
example
F
filehash
fill_io_region() (siliconcompiler.floorplan.Floorplan method)
find_files() (siliconcompiler.core.Chip method)
find_function() (siliconcompiler.core.Chip method)
find_result() (siliconcompiler.core.Chip method)
Floorplan (class in siliconcompiler.floorplan)
flowgraph
G
generate_rows() (siliconcompiler.floorplan.Floorplan method)
generate_tracks() (siliconcompiler.floorplan.Floorplan method)
get() (siliconcompiler.core.Chip method)
get_layers() (siliconcompiler.floorplan.Floorplan method)
getdict() (siliconcompiler.core.Chip method)
getkeys() (siliconcompiler.core.Chip method)
graph() (siliconcompiler.core.Chip method)
grep() (siliconcompiler.core.Chip method)
H
hash_files() (siliconcompiler.core.Chip method)
hashalgo
help
help() (siliconcompiler.core.Chip method)
I
import_library() (siliconcompiler.core.Chip method)
index
info() (siliconcompiler.package.Sup method)
insert_vias() (siliconcompiler.floorplan.Floorplan method)
install() (siliconcompiler.package.Sup method)
J
job
join() (siliconcompiler.core.Chip method)
K
keypath
keys
keywords
L
layers (siliconcompiler.floorplan.Floorplan attribute)
list
list_metrics() (siliconcompiler.core.Chip method)
list_steps() (siliconcompiler.core.Chip method)
load_checklist() (siliconcompiler.core.Chip method)
load_flow() (siliconcompiler.core.Chip method)
load_lib() (siliconcompiler.core.Chip method)
load_pdk() (siliconcompiler.core.Chip method)
load_target() (siliconcompiler.core.Chip method)
lock
M
manifest
maximum() (siliconcompiler.core.Chip method)
merge_manifest() (siliconcompiler.core.Chip method)
minimum() (siliconcompiler.core.Chip method)
module
siliconcompiler.core
siliconcompiler.floorplan
siliconcompiler.leflib
siliconcompiler.package
mux() (siliconcompiler.core.Chip method)
N
node
node() (siliconcompiler.core.Chip method)
nop() (siliconcompiler.core.Chip method)
P
parameter
parse() (in module siliconcompiler.leflib)
pipe() (siliconcompiler.core.Chip method)
place_blockage() (siliconcompiler.floorplan.Floorplan method)
place_macros() (siliconcompiler.floorplan.Floorplan method)
place_obstruction() (siliconcompiler.floorplan.Floorplan method)
place_pins() (siliconcompiler.floorplan.Floorplan method)
place_ring() (siliconcompiler.floorplan.Floorplan method)
place_vias() (siliconcompiler.floorplan.Floorplan method)
place_wires() (siliconcompiler.floorplan.Floorplan method)
program
publish() (siliconcompiler.package.Sup method)
R
read_file() (siliconcompiler.core.Chip method)
read_lef() (siliconcompiler.core.Chip method)
read_manifest() (siliconcompiler.core.Chip method)
record_history() (siliconcompiler.core.Chip method)
render_tuple() (in module siliconcompiler.floorplan)
require
run() (siliconcompiler.core.Chip method)
S
schema
search() (siliconcompiler.package.Sup method)
set() (siliconcompiler.core.Chip method)
shorthelp
show() (siliconcompiler.core.Chip method)
signature
siliconcompiler.core
module
siliconcompiler.floorplan
module
siliconcompiler.leflib
module
siliconcompiler.package
module
SiliconCompilerError
snap() (siliconcompiler.floorplan.Floorplan method)
snap_to_x_track() (siliconcompiler.floorplan.Floorplan method)
snap_to_y_track() (siliconcompiler.floorplan.Floorplan method)
stdcell_height (siliconcompiler.floorplan.Floorplan attribute)
stdcell_width (siliconcompiler.floorplan.Floorplan attribute)
step
summary() (siliconcompiler.core.Chip method)
Sup (class in siliconcompiler.package)
switch
T
task
tool
type
U
uninstall() (siliconcompiler.package.Sup method)
update() (siliconcompiler.core.Chip method)
V
valid() (siliconcompiler.core.Chip method)
verify() (siliconcompiler.core.Chip method)
W
write_def() (siliconcompiler.floorplan.Floorplan method)
write_depgraph() (siliconcompiler.core.Chip method)
write_flowgraph() (siliconcompiler.core.Chip method)
write_lef() (siliconcompiler.floorplan.Floorplan method)
write_manifest() (siliconcompiler.core.Chip method)
Read the Docs
v: stable
Versions
latest
stable
noah-examples-cleanup
Downloads
pdf
On Read the Docs
Project Home
Builds