References#
The following sections provides details on the functions, modules and objects included in SiliconCompiler. To learn how to use SiliconCompiler, see the User Guide.
- 1. Schema
- 1.1. Keywords
- 1.2. Parameter Fields
- 1.3. Per-node Parameter Fields
- 1.4. Parameters
- 1.4.1. arg
- 1.4.2. asic
- 1.4.3. checklist
- 1.4.4. constraint
- 1.4.5. datasheet
- 1.4.5.1. abstraction
- 1.4.5.2. analog
- 1.4.5.3. description
- 1.4.5.4. doc
- 1.4.5.5. features
- 1.4.5.6. fmax
- 1.4.5.7. fpga
- 1.4.5.8. grade
- 1.4.5.9. io
- 1.4.5.10. iobw
- 1.4.5.11. iocount
- 1.4.5.12. limit
- 1.4.5.13. manufacturer
- 1.4.5.14. memory
- 1.4.5.15. ops
- 1.4.5.16. package
- 1.4.5.17. partnumber
- 1.4.5.18. peakpower
- 1.4.5.19. pin
- 1.4.5.20. proc
- 1.4.5.21. qual
- 1.4.5.22. ram
- 1.4.5.23. series
- 1.4.5.24. status
- 1.4.5.25. thermal
- 1.4.5.26. trl
- 1.4.5.27. type
- 1.4.6. design
- 1.4.7. flowgraph
- 1.4.8. fpga
- 1.4.9. input
- 1.4.10. metric
- 1.4.10.1. averagepower
- 1.4.10.2. brams
- 1.4.10.3. buffers
- 1.4.10.4. cellarea
- 1.4.10.5. cells
- 1.4.10.6. coverage
- 1.4.10.7. dozepower
- 1.4.10.8. drvs
- 1.4.10.9. dsps
- 1.4.10.10. errors
- 1.4.10.11. exetime
- 1.4.10.12. fmax
- 1.4.10.13. holdpaths
- 1.4.10.14. holdslack
- 1.4.10.15. holdtns
- 1.4.10.16. holdwns
- 1.4.10.17. idlepower
- 1.4.10.18. irdrop
- 1.4.10.19. leakagepower
- 1.4.10.20. luts
- 1.4.10.21. macros
- 1.4.10.22. memory
- 1.4.10.23. nets
- 1.4.10.24. overflow
- 1.4.10.25. peakpower
- 1.4.10.26. pins
- 1.4.10.27. registers
- 1.4.10.28. security
- 1.4.10.29. setuppaths
- 1.4.10.30. setupslack
- 1.4.10.31. setuptns
- 1.4.10.32. setupwns
- 1.4.10.33. sleeppower
- 1.4.10.34. tasktime
- 1.4.10.35. totalarea
- 1.4.10.36. totaltime
- 1.4.10.37. transistors
- 1.4.10.38. unconstrained
- 1.4.10.39. utilization
- 1.4.10.40. vias
- 1.4.10.41. warnings
- 1.4.10.42. wirelength
- 1.4.11. option
- 1.4.11.1. autoinstall
- 1.4.11.2. breakpoint
- 1.4.11.3. builddir
- 1.4.11.4. cache
- 1.4.11.5. cfg
- 1.4.11.6. clean
- 1.4.11.7. cmdfile
- 1.4.11.8. continue
- 1.4.11.9. copyall
- 1.4.11.10. credentials
- 1.4.11.11. define
- 1.4.11.12. dir
- 1.4.11.13. entrypoint
- 1.4.11.14. env
- 1.4.11.15. file
- 1.4.11.16. flow
- 1.4.11.17. flowcontinue
- 1.4.11.18. from
- 1.4.11.19. frontend
- 1.4.11.20. hash
- 1.4.11.21. idir
- 1.4.11.22. jobincr
- 1.4.11.23. jobinput
- 1.4.11.24. jobname
- 1.4.11.25. libext
- 1.4.11.26. loglevel
- 1.4.11.27. metricoff
- 1.4.11.28. mode
- 1.4.11.29. nice
- 1.4.11.30. nodisplay
- 1.4.11.31. novercheck
- 1.4.11.32. optmode
- 1.4.11.33. param
- 1.4.11.34. pdk
- 1.4.11.35. prune
- 1.4.11.36. quiet
- 1.4.11.37. relax
- 1.4.11.38. remote
- 1.4.11.39. resume
- 1.4.11.40. scheduler
- 1.4.11.41. show
- 1.4.11.42. showtool
- 1.4.11.43. skipall
- 1.4.11.44. skipcheck
- 1.4.11.45. stackup
- 1.4.11.46. strict
- 1.4.11.47. target
- 1.4.11.48. timeout
- 1.4.11.49. to
- 1.4.11.50. trace
- 1.4.11.51. track
- 1.4.11.52. uselambda
- 1.4.11.53. var
- 1.4.11.54. vlib
- 1.4.11.55. ydir
- 1.4.12. output
- 1.4.13. package
- 1.4.14. pdk
- 1.4.14.1. aprtech
- 1.4.14.2. d0
- 1.4.14.3. density
- 1.4.14.4. devmodel
- 1.4.14.5. directory
- 1.4.14.6. display
- 1.4.14.7. doc
- 1.4.14.8. drc
- 1.4.14.9. edgemargin
- 1.4.14.10. erc
- 1.4.14.11. file
- 1.4.14.12. fill
- 1.4.14.13. foundry
- 1.4.14.14. hscribe
- 1.4.14.15. lambda
- 1.4.14.16. layermap
- 1.4.14.17. lvs
- 1.4.14.18. maxlayer
- 1.4.14.19. minlayer
- 1.4.14.20. node
- 1.4.14.21. panelsize
- 1.4.14.22. pexmodel
- 1.4.14.23. stackup
- 1.4.14.24. thickness
- 1.4.14.25. unitcost
- 1.4.14.26. var
- 1.4.14.27. version
- 1.4.14.28. vscribe
- 1.4.14.29. wafersize
- 1.4.15. record
- 1.4.15.1. arch
- 1.4.15.2. distro
- 1.4.15.3. endtime
- 1.4.15.4. ipaddr
- 1.4.15.5. kernelversion
- 1.4.15.6. macaddr
- 1.4.15.7. machine
- 1.4.15.8. osversion
- 1.4.15.9. platform
- 1.4.15.10. publickey
- 1.4.15.11. region
- 1.4.15.12. remoteid
- 1.4.15.13. scversion
- 1.4.15.14. starttime
- 1.4.15.15. toolargs
- 1.4.15.16. toolpath
- 1.4.15.17. toolversion
- 1.4.15.18. userid
- 1.4.16. schemaversion
- 1.4.17. tool
- 1.4.18. unit
- 1.5. Nested Schemas
- 2. Core API
Checklist
Chip
Chip.add()
Chip.allkeys()
Chip.archive()
Chip.audit_manifest()
Chip.calc_area()
Chip.calc_dpw()
Chip.calc_yield()
Chip.check_checklist()
Chip.check_filepaths()
Chip.check_logfile()
Chip.check_manifest()
Chip.clock()
Chip.create_cmdline()
Chip.design
Chip.edge()
Chip.error()
Chip.find_files()
Chip.find_result()
Chip.get()
Chip.getdict()
Chip.getkeys()
Chip.graph()
Chip.grep()
Chip.hash_files()
Chip.help()
Chip.input()
Chip.load_target()
Chip.node()
Chip.nodes_to_execute()
Chip.output()
Chip.pipe()
Chip.read_manifest()
Chip.register_package_source()
Chip.run()
Chip.set()
Chip.show()
Chip.summary()
Chip.top()
Chip.unset()
Chip.use()
Chip.valid()
Chip.write_flowgraph()
Chip.write_manifest()
FPGA
Flow
Library
PDK
Schema
SiliconCompilerError
Checklist
FPGA
Flow
Library
PDK
PackageChip
add_frontend_requires()
add_require_input()
get_frontend_options()
get_input_files()
get_libraries()
- 3. CLI apps
- 4. Server API
- 5. Leflib API
- 1. Design Glossary
- 2. Slurm setup
- 3. Licenses
- 4. Revision History and Change Log
- 4.1. SiliconCompiler 0.21.9 (2024-04-12)
- 4.2. SiliconCompiler 0.21.8 (2024-04-11)
- 4.3. SiliconCompiler 0.21.7 (2024-04-02)
- 4.4. SiliconCompiler 0.21.6 (2024-03-28)
- 4.5. SiliconCompiler 0.21.5 (2024-03-21)
- 4.6. SiliconCompiler 0.21.4 (2024-03-15)
- 4.7. SiliconCompiler 0.21.3 (2024-03-13)
- 4.8. SiliconCompiler 0.21.2 (2024-03-08)
- 4.9. SiliconCompiler 0.21.1 (2024-03-07)
- 4.10. SiliconCompiler 0.21.0 (2024-03-07)
- 4.11. SiliconCompiler 0.20.3 (2024-03-06)
- 4.12. SiliconCompiler 0.20.2 (2024-02-20)
- 4.13. SiliconCompiler 0.20.1 (2024-02-12)
- 4.14. SiliconCompiler 0.20.0 (2024-02-01)
- 4.15. SiliconCompiler 0.19.1 (2024-01-24)
- 4.16. SiliconCompiler 0.19.0 (2024-01-05)
- 4.17. SiliconCompiler 0.18.2 (2023-12-18)
- 4.18. SiliconCompiler 0.18.1 (2023-12-13)
- 4.19. SiliconCompiler 0.18.0 (2023-12-04)
- 4.20. SiliconCompiler 0.17.0 (2023-11-16)
- 4.21. SiliconCompiler 0.16.3 (2023-11-02)
- 4.22. SiliconCompiler 0.16.2 (2023-10-13)
- 4.23. SiliconCompiler 0.16.1 (2023-10-11)
- 4.24. SiliconCompiler 0.16.0 (2023-10-09)
- 4.25. SiliconCompiler 0.15.4 (2023-09-25)
- 4.26. SiliconCompiler 0.15.3 (2023-09-21)
- 4.27. SiliconCompiler 0.15.2 (2023-09-18)
- 4.28. SiliconCompiler 0.15.1 (2023-09-08)
- 4.29. SiliconCompiler 0.15.0 (2023-08-31)
- 4.30. SiliconCompiler 0.14.0 (2023-08-21)
- 4.31. SiliconCompiler 0.13.2 (2023-08-10)
- 4.32. SiliconCompiler 0.13.1 (2023-07-21)
- 4.33. SiliconCompiler 0.13.0 (2023-07-07)
- 4.34. SiliconCompiler 0.12.3 (2023-06-23)
- 4.35. SiliconCompiler 0.12.2 (2023-06-14)
- 4.36. SiliconCompiler 0.12.1 (2023-06-07)
- 4.37. SiliconCompiler 0.12.0 (2023-05-24)
- 4.38. SiliconCompiler 0.11.2 (2023-05-15)
- 4.39. SiliconCompiler 0.11.1 (2023-05-03)
- 4.40. SiliconCompiler 0.11.0 (2023-04-17)
- 4.41. SiliconCompiler 0.10.2 (2023-04-04)
- 4.42. SiliconCompiler 0.10.1 (2023-03-11)
- 4.43. SiliconCompiler 0.10.0 (2023-03-08)
- 4.44. SiliconCompiler 0.9.6 (2022-10-03)
- 4.45. SiliconCompiler 0.9.5 (2022-09-12)
- 4.46. SiliconCompiler 0.9.4 (2022-08-25)
- 4.47. SiliconCompiler 0.9.3 (2022-08-01)
- 4.48. SiliconCompiler 0.9.2 (2022-07-08)
- 4.49. SiliconCompiler 0.9.1 (2022-06-21)
- 4.50. SiliconCompiler 0.9.0 (2022-05-19)
- 4.51. SiliconCompiler 0.7.0 (2022-03-02)
- 4.52. SiliconCompiler 0.6.0 (2022-02-11)
- 4.53. SiliconCompiler 0.4.1 (2022-01-06)
- 4.54. SiliconCompiler 0.4.0 (2022-01-05)
- 4.55. SiliconCompiler 0.3.1 (2021-12-21)
- 4.56. SiliconCompiler 0.3.0 (2021-12-21)
- 4.57. SiliconCompiler 0.1.1 (2021-12-08)
- 4.58. SiliconCompiler 0.1.0 (2021-12-03)
- 5. Dashboard