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.

Building Blocks

• 1. Targets
• 2. Flows
• 3. Tools
• 4. PDKs
• 5. Libraries
• 6. Checklists

API References

• 1. Schema
  • 1.1. Keywords
  • 1.2. Parameter Fields
  • 1.3. Per-node Parameter Fields
  • 1.4. Parameters
    • 1.4.1. arg
      • 1.4.1.1. index
      • 1.4.1.2. step
    • 1.4.2. asic
      • 1.4.2.1. cells
      • 1.4.2.2. delaymodel
      • 1.4.2.3. libarch
      • 1.4.2.4. logiclib
      • 1.4.2.5. macrolib
      • 1.4.2.6. site
    • 1.4.3. checklist
      • 1.4.3.1. criteria
      • 1.4.3.2. dataformat
      • 1.4.3.3. description
      • 1.4.3.4. ok
      • 1.4.3.5. rationale
      • 1.4.3.6. report
      • 1.4.3.7. requirement
      • 1.4.3.8. task
      • 1.4.3.9. waiver
    • 1.4.4. constraint
      • 1.4.4.1. aspectratio
      • 1.4.4.2. component
      • 1.4.4.3. corearea
      • 1.4.4.4. coremargin
      • 1.4.4.5. density
      • 1.4.4.6. net
      • 1.4.4.7. outline
      • 1.4.4.8. pin
      • 1.4.4.9. timing
    • 1.4.5. datasheet
      • 1.4.5.1. analog
      • 1.4.5.2. description
      • 1.4.5.3. doc
      • 1.4.5.4. features
      • 1.4.5.5. fmax
      • 1.4.5.6. fpga
      • 1.4.5.7. grade
      • 1.4.5.8. io
      • 1.4.5.9. iobw
      • 1.4.5.10. iocount
      • 1.4.5.11. limit
      • 1.4.5.12. manufacturer
      • 1.4.5.13. memory
      • 1.4.5.14. ops
      • 1.4.5.15. package
      • 1.4.5.16. peakpower
      • 1.4.5.17. pin
      • 1.4.5.18. proc
      • 1.4.5.19. qual
      • 1.4.5.20. ram
      • 1.4.5.21. series
      • 1.4.5.22. status
      • 1.4.5.23. thermal
      • 1.4.5.24. trl
      • 1.4.5.25. type
    • 1.4.6. design
    • 1.4.7. flowgraph
      • 1.4.7.1. args
      • 1.4.7.2. goal
      • 1.4.7.3. input
      • 1.4.7.4. select
      • 1.4.7.5. status
      • 1.4.7.6. task
      • 1.4.7.7. taskmodule
      • 1.4.7.8. tool
      • 1.4.7.9. weight
    • 1.4.8. fpga
      • 1.4.8.1. file
      • 1.4.8.2. lutsize
      • 1.4.8.3. partname
      • 1.4.8.4. var
      • 1.4.8.5. vendor
    • 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. drcs
      • 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. holdskew
      • 1.4.10.15. holdslack
      • 1.4.10.16. holdtns
      • 1.4.10.17. holdwns
      • 1.4.10.18. inverters
      • 1.4.10.19. irdrop
      • 1.4.10.20. leakagepower
      • 1.4.10.21. logicdepth
      • 1.4.10.22. luts
      • 1.4.10.23. macros
      • 1.4.10.24. memory
      • 1.4.10.25. nets
      • 1.4.10.26. overflow
      • 1.4.10.27. peakpower
      • 1.4.10.28. pins
      • 1.4.10.29. registers
      • 1.4.10.30. security
      • 1.4.10.31. setuppaths
      • 1.4.10.32. setupskew
      • 1.4.10.33. setupslack
      • 1.4.10.34. setuptns
      • 1.4.10.35. setupwns
      • 1.4.10.36. tasktime
      • 1.4.10.37. totalarea
      • 1.4.10.38. totaltime
      • 1.4.10.39. transistors
      • 1.4.10.40. unconstrained
      • 1.4.10.41. utilization
      • 1.4.10.42. vias
      • 1.4.10.43. warnings
      • 1.4.10.44. wirelength
    • 1.4.11. option
      • 1.4.11.1. breakpoint
      • 1.4.11.2. builddir
      • 1.4.11.3. cachedir
      • 1.4.11.4. cfg
      • 1.4.11.5. clean
      • 1.4.11.6. continue
      • 1.4.11.7. copyall
      • 1.4.11.8. credentials
      • 1.4.11.9. define
      • 1.4.11.10. dir
      • 1.4.11.11. entrypoint
      • 1.4.11.12. env
      • 1.4.11.13. file
      • 1.4.11.14. flow
      • 1.4.11.15. from
      • 1.4.11.16. frontend
      • 1.4.11.17. hash
      • 1.4.11.18. idir
      • 1.4.11.19. jobincr
      • 1.4.11.20. jobname
      • 1.4.11.21. libext
      • 1.4.11.22. loglevel
      • 1.4.11.23. mode
      • 1.4.11.24. nice
      • 1.4.11.25. nodisplay
      • 1.4.11.26. novercheck
      • 1.4.11.27. optmode
      • 1.4.11.28. param
      • 1.4.11.29. pdk
      • 1.4.11.30. prune
      • 1.4.11.31. quiet
      • 1.4.11.32. remote
      • 1.4.11.33. scheduler
      • 1.4.11.34. stackup
      • 1.4.11.35. strict
      • 1.4.11.36. target
      • 1.4.11.37. timeout
      • 1.4.11.38. to
      • 1.4.11.39. track
      • 1.4.11.40. var
      • 1.4.11.41. vlib
      • 1.4.11.42. ydir
    • 1.4.12. output
    • 1.4.13. package
      • 1.4.13.1. author
      • 1.4.13.2. description
      • 1.4.13.3. doc
      • 1.4.13.4. keyword
      • 1.4.13.5. license
      • 1.4.13.6. licensefile
      • 1.4.13.7. organization
      • 1.4.13.8. source
      • 1.4.13.9. version
    • 1.4.14. pdk
      • 1.4.14.1. aprtech
      • 1.4.14.2. d0
      • 1.4.14.3. devmodel
      • 1.4.14.4. dir
      • 1.4.14.5. display
      • 1.4.14.6. doc
      • 1.4.14.7. drc
      • 1.4.14.8. edgemargin
      • 1.4.14.9. erc
      • 1.4.14.10. file
      • 1.4.14.11. fill
      • 1.4.14.12. foundry
      • 1.4.14.13. layermap
      • 1.4.14.14. lvs
      • 1.4.14.15. maxlayer
      • 1.4.14.16. minlayer
      • 1.4.14.17. node
      • 1.4.14.18. panelsize
      • 1.4.14.19. pexmodel
      • 1.4.14.20. scribe
      • 1.4.14.21. stackup
      • 1.4.14.22. unitcost
      • 1.4.14.23. var
      • 1.4.14.24. version
      • 1.4.14.25. 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.17.1. exe
      • 1.4.17.2. format
      • 1.4.17.3. licenseserver
      • 1.4.17.4. path
      • 1.4.17.5. sbom
      • 1.4.17.6. task
      • 1.4.17.7. vendor
      • 1.4.17.8. version
      • 1.4.17.9. vswitch
  • 1.5. Nested Schemas
    • 1.5.1. history
    • 1.5.2. library
    • 1.5.3. Journaling
• 2. Core API
  • Checklist
  • Chip
    • Chip.add()
    • Chip.allkeys()
    • Chip.archive()
    • Chip.check_checklist()
    • Chip.check_filepaths()
    • Chip.check_manifest()
    • Chip.clock()
    • Chip.collect()
    • Chip.create_cmdline()
    • Chip.design
    • Chip.edge()
    • Chip.error()
    • Chip.find_files()
    • Chip.find_result()
    • Chip.get()
    • Chip.getdict()
    • Chip.getkeys()
    • Chip.getworkdir()
    • Chip.graph()
    • Chip.hash_files()
    • Chip.help()
    • Chip.input()
    • Chip.load_target()
    • Chip.node()
    • Chip.output()
    • Chip.read_manifest()
    • Chip.register_showtool()
    • Chip.register_source()
    • Chip.remove()
    • Chip.remove_node()
    • 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
    • Schema.add()
    • Schema.allkeys()
    • Schema.change_type()
    • Schema.copy()
    • Schema.create_cmdline()
    • Schema.get()
    • Schema.get_default()
    • Schema.getdict()
    • Schema.getkeys()
    • Schema.history()
    • Schema.is_empty()
    • Schema.merge_manifest()
    • Schema.prune()
    • Schema.read_journal()
    • Schema.read_manifest()
    • Schema.record_history()
    • Schema.remove()
    • Schema.set()
    • Schema.set_default()
    • Schema.unset()
    • Schema.valid()
    • Schema.write_tcl()
  • SiliconCompilerError
  • Checklist
  • FPGA
  • Flow
  • Library
  • PDK
  • PackageChip
    • PackageChip.add()
    • PackageChip.set()
  • add_frontend_requires()
  • add_require_input()
  • get_frontend_options()
  • get_input_files()
  • get_libraries()
  • get_tool_task()
  • record_metric()
  • find_sc_file()
  • format_fileset_type_table()
  • get_default_iomap()
  • get_file_ext()
  • get_plugins()
  • grep()
  • terminate_process()
  • calc_area()
  • calc_dpw()
  • calc_yield()
• 3. CLI apps
  • 3.1. sc
  • 3.2. sc-dashboard
  • 3.3. sc-issue
  • 3.4. sc-remote
  • 3.5. sc-server
  • 3.6. sc-show
• 4. Server API
  • 4.1. delete_job
    • 4.1.1. Request
    • 4.1.2. Response
  • 4.2. cancel_job
    • 4.2.1. Request
    • 4.2.2. Response
  • 4.3. check_server
    • 4.3.1. Request
    • 4.3.2. Response
  • 4.4. get_results/{job_hash}.tar.gz
    • 4.4.1. Request
    • 4.4.2. Response
  • 4.5. remote_run
    • 4.5.1. Request
    • 4.5.2. Response
  • 4.6. check_progress
    • 4.6.1. Request
    • 4.6.2. Response
• 5. Leflib API
  • parse()

Appendix

• 1. Design Glossary
  • 1.1. Architecture
  • 1.2. Design
  • 1.3. Manufacturing
  • 1.4. Packaging
  • 1.5. Test
• 2. Slurm setup
  • 2.1. Initial Slurm Configuration
    • 2.1.1. User and Group Configuration
    • 2.1.2. Slurm Daemon Installation
    • 2.1.3. Slurm Configuration Files
    • 2.1.4. Slurm Startup
    • 2.1.5. Running SiliconCompiler on a Cluster
• 3. Licenses
  • 3.1. Software License
  • 3.2. Documentation License
  • 3.3. Dependency Licenses
• 4. Revision History and Change Log
  • 4.1. SiliconCompiler 0.24.0 (2024-07-09)
  • 4.2. SiliconCompiler 0.23.4 (2024-07-02)
  • 4.3. SiliconCompiler 0.23.3 (2024-06-25)
  • 4.4. SiliconCompiler 0.23.2 (2024-06-20)
  • 4.5. SiliconCompiler 0.23.1 (2024-06-18)
  • 4.6. SiliconCompiler 0.23.0 (2024-06-13)
  • 4.7. SiliconCompiler 0.22.0 (2024-05-23)
  • 4.8. SiliconCompiler 0.21.13 (2024-05-15)
  • 4.9. SiliconCompiler 0.21.12 (2024-05-13)
  • 4.10. SiliconCompiler 0.21.11 (2024-04-26)
  • 4.11. SiliconCompiler 0.21.10 (2024-04-22)
  • 4.12. SiliconCompiler 0.21.9 (2024-04-12)
  • 4.13. SiliconCompiler 0.21.8 (2024-04-11)
  • 4.14. SiliconCompiler 0.21.7 (2024-04-02)
  • 4.15. SiliconCompiler 0.21.6 (2024-03-28)
  • 4.16. SiliconCompiler 0.21.5 (2024-03-21)
  • 4.17. SiliconCompiler 0.21.4 (2024-03-15)
  • 4.18. SiliconCompiler 0.21.3 (2024-03-13)
  • 4.19. SiliconCompiler 0.21.2 (2024-03-08)
  • 4.20. SiliconCompiler 0.21.1 (2024-03-07)
  • 4.21. SiliconCompiler 0.21.0 (2024-03-07)
  • 4.22. SiliconCompiler 0.20.3 (2024-03-06)
  • 4.23. SiliconCompiler 0.20.2 (2024-02-20)
  • 4.24. SiliconCompiler 0.20.1 (2024-02-12)
  • 4.25. SiliconCompiler 0.20.0 (2024-02-01)
  • 4.26. SiliconCompiler 0.19.1 (2024-01-24)
  • 4.27. SiliconCompiler 0.19.0 (2024-01-05)
  • 4.28. SiliconCompiler 0.18.2 (2023-12-18)
  • 4.29. SiliconCompiler 0.18.1 (2023-12-13)
  • 4.30. SiliconCompiler 0.18.0 (2023-12-04)
  • 4.31. SiliconCompiler 0.17.0 (2023-11-16)
  • 4.32. SiliconCompiler 0.16.3 (2023-11-02)
  • 4.33. SiliconCompiler 0.16.2 (2023-10-13)
  • 4.34. SiliconCompiler 0.16.1 (2023-10-11)
  • 4.35. SiliconCompiler 0.16.0 (2023-10-09)
  • 4.36. SiliconCompiler 0.15.4 (2023-09-25)
  • 4.37. SiliconCompiler 0.15.3 (2023-09-21)
  • 4.38. SiliconCompiler 0.15.2 (2023-09-18)
  • 4.39. SiliconCompiler 0.15.1 (2023-09-08)
  • 4.40. SiliconCompiler 0.15.0 (2023-08-31)
  • 4.41. SiliconCompiler 0.14.0 (2023-08-21)
  • 4.42. SiliconCompiler 0.13.2 (2023-08-10)
  • 4.43. SiliconCompiler 0.13.1 (2023-07-21)
  • 4.44. SiliconCompiler 0.13.0 (2023-07-07)
  • 4.45. SiliconCompiler 0.12.3 (2023-06-23)
  • 4.46. SiliconCompiler 0.12.2 (2023-06-14)
  • 4.47. SiliconCompiler 0.12.1 (2023-06-07)
  • 4.48. SiliconCompiler 0.12.0 (2023-05-24)
  • 4.49. SiliconCompiler 0.11.2 (2023-05-15)
  • 4.50. SiliconCompiler 0.11.1 (2023-05-03)
  • 4.51. SiliconCompiler 0.11.0 (2023-04-17)
  • 4.52. SiliconCompiler 0.10.2 (2023-04-04)
  • 4.53. SiliconCompiler 0.10.1 (2023-03-11)
  • 4.54. SiliconCompiler 0.10.0 (2023-03-08)
  • 4.55. SiliconCompiler 0.9.6 (2022-10-03)
  • 4.56. SiliconCompiler 0.9.5 (2022-09-12)
  • 4.57. SiliconCompiler 0.9.4 (2022-08-25)
  • 4.58. SiliconCompiler 0.9.3 (2022-08-01)
  • 4.59. SiliconCompiler 0.9.2 (2022-07-08)
  • 4.60. SiliconCompiler 0.9.1 (2022-06-21)
  • 4.61. SiliconCompiler 0.9.0 (2022-05-19)
  • 4.62. SiliconCompiler 0.7.0 (2022-03-02)
  • 4.63. SiliconCompiler 0.6.0 (2022-02-11)
  • 4.64. SiliconCompiler 0.4.1 (2022-01-06)
  • 4.65. SiliconCompiler 0.4.0 (2022-01-05)
  • 4.66. SiliconCompiler 0.3.1 (2021-12-21)
  • 4.67. SiliconCompiler 0.3.0 (2021-12-21)
  • 4.68. SiliconCompiler 0.1.1 (2021-12-08)
  • 4.69. SiliconCompiler 0.1.0 (2021-12-03)
• 5. Dashboard
  • 5.1. Header
  • 5.2. Metrics Tab
    • 5.2.1. Metrics Section
    • 5.2.2. Flowgraph Section
    • 5.2.3. Node Information Section
  • 5.3. File Viewer Tab
  • 5.4. Manifest Tab
  • 5.5. Display Preview Tab
  • 5.6. Graphs Tab