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
API References
- 1. Schema
- 2. Schema API
- 2.1. Useful APIs
- 2.2. Project Classes
ProjectProject.add()Project.add_alias()Project.add_dep()Project.add_fileset()Project.allkeys()Project.check_filepaths()Project.check_manifest()Project.convert()Project.copy()Project.create_cmdline()Project.designProject.find_files()Project.find_result()Project.from_manifest()Project.get()Project.get_filesets()Project.get_flow()Project.get_library()Project.getdict()Project.getkeys()Project.hash_files()Project.history()Project.loggerProject.nameProject.optionProject.read_manifest()Project.remove()Project.run()Project.set()Project.set_design()Project.set_flow()Project.show()Project.snapshot()Project.summary()Project.unset()Project.valid()Project.write_depgraph()Project.write_manifest()
ASICASIC.add()ASIC.add_alias()ASIC.add_asiclib()ASIC.add_dep()ASIC.add_fileset()ASIC.allkeys()ASIC.check_filepaths()ASIC.check_manifest()ASIC.constraintASIC.convert()ASIC.copy()ASIC.create_cmdline()ASIC.designASIC.find_files()ASIC.find_result()ASIC.from_manifest()ASIC.get()ASIC.get_filesets()ASIC.get_flow()ASIC.get_library()ASIC.getdict()ASIC.getkeys()ASIC.hash_files()ASIC.history()ASIC.loggerASIC.nameASIC.optionASIC.read_manifest()ASIC.remove()ASIC.run()ASIC.set()ASIC.set_asic_delaymodel()ASIC.set_asic_routinglayers()ASIC.set_design()ASIC.set_flow()ASIC.set_mainlib()ASIC.set_pdk()ASIC.show()ASIC.snapshot()ASIC.summary()ASIC.unset()ASIC.valid()ASIC.write_depgraph()ASIC.write_manifest()
FPGAFPGA.add()FPGA.add_alias()FPGA.add_dep()FPGA.add_fileset()FPGA.allkeys()FPGA.check_filepaths()FPGA.check_manifest()FPGA.constraintFPGA.convert()FPGA.copy()FPGA.create_cmdline()FPGA.designFPGA.find_files()FPGA.find_result()FPGA.from_manifest()FPGA.get()FPGA.get_filesets()FPGA.get_flow()FPGA.get_library()FPGA.getdict()FPGA.getkeys()FPGA.hash_files()FPGA.history()FPGA.loggerFPGA.nameFPGA.optionFPGA.read_manifest()FPGA.remove()FPGA.run()FPGA.set()FPGA.set_design()FPGA.set_flow()FPGA.set_fpga()FPGA.show()FPGA.snapshot()FPGA.summary()FPGA.unset()FPGA.valid()FPGA.write_depgraph()FPGA.write_manifest()
LintLint.add()Lint.add_alias()Lint.add_dep()Lint.add_fileset()Lint.allkeys()Lint.check_filepaths()Lint.check_manifest()Lint.convert()Lint.copy()Lint.create_cmdline()Lint.designLint.find_files()Lint.find_result()Lint.from_manifest()Lint.get()Lint.get_filesets()Lint.get_flow()Lint.get_library()Lint.getdict()Lint.getkeys()Lint.hash_files()Lint.history()Lint.loggerLint.nameLint.optionLint.read_manifest()Lint.remove()Lint.run()Lint.set()Lint.set_design()Lint.set_flow()Lint.show()Lint.snapshot()Lint.summary()Lint.unset()Lint.valid()Lint.write_depgraph()Lint.write_manifest()
SimSim.add()Sim.add_alias()Sim.add_dep()Sim.add_fileset()Sim.allkeys()Sim.check_filepaths()Sim.check_manifest()Sim.convert()Sim.copy()Sim.create_cmdline()Sim.designSim.find_files()Sim.find_result()Sim.from_manifest()Sim.get()Sim.get_filesets()Sim.get_flow()Sim.get_library()Sim.getdict()Sim.getkeys()Sim.hash_files()Sim.history()Sim.loggerSim.nameSim.optionSim.read_manifest()Sim.remove()Sim.run()Sim.set()Sim.set_design()Sim.set_flow()Sim.show()Sim.snapshot()Sim.summary()Sim.unset()Sim.valid()Sim.write_depgraph()Sim.write_manifest()
- 2.3. User Classes
DesignDesign.active_dataroot()Design.active_fileset()Design.add()Design.add_define()Design.add_dep()Design.add_depfileset()Design.add_file()Design.add_idir()Design.add_lib()Design.add_libdir()Design.add_undefine()Design.allkeys()Design.check_filepaths()Design.copy()Design.copy_fileset()Design.find_files()Design.from_manifest()Design.get()Design.get_dataroot()Design.get_define()Design.get_dep()Design.get_depfileset()Design.get_file()Design.get_fileset()Design.get_idir()Design.get_lib()Design.get_libdir()Design.get_param()Design.get_topmodule()Design.get_undefine()Design.getdict()Design.getkeys()Design.has_dep()Design.has_file()Design.has_fileset()Design.has_idir()Design.has_libdir()Design.hash_files()Design.nameDesign.packageDesign.read_fileset()Design.read_manifest()Design.remove()Design.remove_dep()Design.set()Design.set_dataroot()Design.set_name()Design.set_param()Design.set_topmodule()Design.type()Design.unset()Design.valid()Design.write_depgraph()Design.write_fileset()Design.write_manifest()
PDKPDK.active_dataroot()PDK.active_fileset()PDK.add()PDK.add_aprtechfileset()PDK.add_define()PDK.add_dep()PDK.add_depfileset()PDK.add_devmodelfileset()PDK.add_displayfileset()PDK.add_file()PDK.add_idir()PDK.add_layermapfileset()PDK.add_lib()PDK.add_libdir()PDK.add_pexmodelfileset()PDK.add_runsetfileset()PDK.add_undefine()PDK.add_waiverfileset()PDK.allkeys()PDK.calc_dpw()PDK.calc_yield()PDK.check_filepaths()PDK.copy()PDK.copy_fileset()PDK.define_tool_parameter()PDK.find_files()PDK.from_manifest()PDK.get()PDK.get_dataroot()PDK.get_define()PDK.get_dep()PDK.get_depfileset()PDK.get_file()PDK.get_fileset()PDK.get_idir()PDK.get_lib()PDK.get_libdir()PDK.get_param()PDK.get_topmodule()PDK.get_undefine()PDK.getdict()PDK.getkeys()PDK.has_dep()PDK.has_file()PDK.has_fileset()PDK.has_idir()PDK.has_libdir()PDK.hash_files()PDK.namePDK.packagePDK.read_fileset()PDK.read_manifest()PDK.remove()PDK.remove_dep()PDK.set()PDK.set_aprroutinglayers()PDK.set_dataroot()PDK.set_defectdensity()PDK.set_edgemargin()PDK.set_foundry()PDK.set_name()PDK.set_node()PDK.set_param()PDK.set_scribewidth()PDK.set_stackup()PDK.set_topmodule()PDK.set_unitcost()PDK.set_wafersize()PDK.type()PDK.unset()PDK.valid()PDK.write_depgraph()PDK.write_fileset()PDK.write_manifest()
FlowgraphFlowgraph.add()Flowgraph.allkeys()Flowgraph.copy()Flowgraph.edge()Flowgraph.from_manifest()Flowgraph.get()Flowgraph.get_all_tasks()Flowgraph.get_entry_nodes()Flowgraph.get_execution_order()Flowgraph.get_exit_nodes()Flowgraph.get_graph_node()Flowgraph.get_node_outputs()Flowgraph.get_nodes()Flowgraph.get_task_module()Flowgraph.getdict()Flowgraph.getkeys()Flowgraph.graph()Flowgraph.insert_node()Flowgraph.make_docs()Flowgraph.nameFlowgraph.node()Flowgraph.read_manifest()Flowgraph.remove()Flowgraph.remove_node()Flowgraph.set()Flowgraph.set_name()Flowgraph.type()Flowgraph.unset()Flowgraph.valid()Flowgraph.validate()Flowgraph.write_flowgraph()Flowgraph.write_manifest()
ChecklistChecklist.add()Checklist.allkeys()Checklist.check()Checklist.copy()Checklist.from_manifest()Checklist.get()Checklist.get_criteria()Checklist.getdict()Checklist.getkeys()Checklist.make_criteria()Checklist.nameChecklist.read_manifest()Checklist.remove()Checklist.set()Checklist.set_name()Checklist.type()Checklist.unset()Checklist.valid()Checklist.write_manifest()
TaskTask.active_dataroot()Task.add()Task.add_commandline_option()Task.add_input_file()Task.add_licenseserver()Task.add_output_file()Task.add_parameter()Task.add_postscript()Task.add_prescript()Task.add_regex()Task.add_required_key()Task.add_sbom()Task.add_version()Task.add_vswitch()Task.add_warningoff()Task.allkeys()Task.check_exe_version()Task.check_filepaths()Task.compute_input_file_node_name()Task.copy()Task.design_nameTask.design_topmoduleTask.find_files()Task.find_task()Task.from_manifest()Task.generate_replay_script()Task.get()Task.get_commandline_options()Task.get_dataroot()Task.get_exe()Task.get_exe_version()Task.get_files_from_input_nodes()Task.get_fileset_file_keys()Task.get_logpath()Task.get_output_files()Task.get_runtime_arguments()Task.get_runtime_environmental_variables()Task.get_tcl_variables()Task.get_threads()Task.getdict()Task.getkeys()Task.has_breakpoint()Task.has_postscript()Task.has_prescript()Task.hash_files()Task.indexTask.loggerTask.make_docs()Task.nameTask.nodeTask.nodeworkdirTask.normalize_version()Task.parse_version()Task.post_process()Task.pre_process()Task.read_manifest()Task.record_metric()Task.remove()Task.run()Task.run_task()Task.runtime()Task.runtime_options()Task.select_input_nodes()Task.set()Task.set_dataroot()Task.set_environmentalvariable()Task.set_exe()Task.set_logdestination()Task.set_name()Task.set_path()Task.set_refdir()Task.set_script()Task.set_threads()Task.setup()Task.setup_work_directory()Task.stepTask.task()Task.tool()Task.type()Task.unset()Task.valid()Task.write_manifest()Task.write_task_manifest()
FPGADeviceFPGADevice.active_dataroot()FPGADevice.active_fileset()FPGADevice.add()FPGADevice.add_define()FPGADevice.add_dep()FPGADevice.add_depfileset()FPGADevice.add_file()FPGADevice.add_idir()FPGADevice.add_lib()FPGADevice.add_libdir()FPGADevice.add_undefine()FPGADevice.allkeys()FPGADevice.check_filepaths()FPGADevice.copy()FPGADevice.copy_fileset()FPGADevice.define_tool_parameter()FPGADevice.find_files()FPGADevice.from_manifest()FPGADevice.get()FPGADevice.get_dataroot()FPGADevice.get_define()FPGADevice.get_dep()FPGADevice.get_depfileset()FPGADevice.get_file()FPGADevice.get_fileset()FPGADevice.get_idir()FPGADevice.get_lib()FPGADevice.get_libdir()FPGADevice.get_param()FPGADevice.get_topmodule()FPGADevice.get_undefine()FPGADevice.getdict()FPGADevice.getkeys()FPGADevice.has_dep()FPGADevice.has_file()FPGADevice.has_fileset()FPGADevice.has_idir()FPGADevice.has_libdir()FPGADevice.hash_files()FPGADevice.nameFPGADevice.packageFPGADevice.read_fileset()FPGADevice.read_manifest()FPGADevice.remove()FPGADevice.remove_dep()FPGADevice.set()FPGADevice.set_dataroot()FPGADevice.set_lutsize()FPGADevice.set_name()FPGADevice.set_param()FPGADevice.set_partname()FPGADevice.set_topmodule()FPGADevice.type()FPGADevice.unset()FPGADevice.valid()FPGADevice.write_depgraph()FPGADevice.write_fileset()FPGADevice.write_manifest()
StdCellLibraryStdCellLibrary.active_dataroot()StdCellLibrary.active_fileset()StdCellLibrary.add()StdCellLibrary.add_asic_aprfileset()StdCellLibrary.add_asic_celllist()StdCellLibrary.add_asic_libcornerfileset()StdCellLibrary.add_asic_pdk()StdCellLibrary.add_asic_pexcornerfileset()StdCellLibrary.add_asic_site()StdCellLibrary.add_asic_stackup()StdCellLibrary.add_define()StdCellLibrary.add_dep()StdCellLibrary.add_depfileset()StdCellLibrary.add_file()StdCellLibrary.add_idir()StdCellLibrary.add_lib()StdCellLibrary.add_libdir()StdCellLibrary.add_undefine()StdCellLibrary.allkeys()StdCellLibrary.check_filepaths()StdCellLibrary.copy()StdCellLibrary.copy_fileset()StdCellLibrary.define_tool_parameter()StdCellLibrary.find_files()StdCellLibrary.from_manifest()StdCellLibrary.get()StdCellLibrary.get_dataroot()StdCellLibrary.get_define()StdCellLibrary.get_dep()StdCellLibrary.get_depfileset()StdCellLibrary.get_file()StdCellLibrary.get_fileset()StdCellLibrary.get_idir()StdCellLibrary.get_lib()StdCellLibrary.get_libdir()StdCellLibrary.get_param()StdCellLibrary.get_topmodule()StdCellLibrary.get_undefine()StdCellLibrary.getdict()StdCellLibrary.getkeys()StdCellLibrary.has_dep()StdCellLibrary.has_file()StdCellLibrary.has_fileset()StdCellLibrary.has_idir()StdCellLibrary.has_libdir()StdCellLibrary.hash_files()StdCellLibrary.nameStdCellLibrary.packageStdCellLibrary.read_fileset()StdCellLibrary.read_manifest()StdCellLibrary.remove()StdCellLibrary.remove_dep()StdCellLibrary.set()StdCellLibrary.set_dataroot()StdCellLibrary.set_name()StdCellLibrary.set_param()StdCellLibrary.set_topmodule()StdCellLibrary.type()StdCellLibrary.unset()StdCellLibrary.valid()StdCellLibrary.write_depgraph()StdCellLibrary.write_fileset()StdCellLibrary.write_manifest()
- 2.4. ASIC Constraint Classes
ASICConstraintASICConstraint.add()ASICConstraint.allkeys()ASICConstraint.areaASICConstraint.componentASICConstraint.copy()ASICConstraint.from_manifest()ASICConstraint.get()ASICConstraint.getdict()ASICConstraint.getkeys()ASICConstraint.pinASICConstraint.read_manifest()ASICConstraint.remove()ASICConstraint.set()ASICConstraint.timingASICConstraint.unset()ASICConstraint.valid()ASICConstraint.write_manifest()
ASICTimingConstraintSchemaASICTimingConstraintSchema.add()ASICTimingConstraintSchema.add_mode()ASICTimingConstraintSchema.add_scenario()ASICTimingConstraintSchema.allkeys()ASICTimingConstraintSchema.copy()ASICTimingConstraintSchema.copy_mode()ASICTimingConstraintSchema.copy_scenario()ASICTimingConstraintSchema.from_manifest()ASICTimingConstraintSchema.get()ASICTimingConstraintSchema.get_mode()ASICTimingConstraintSchema.get_scenario()ASICTimingConstraintSchema.getdict()ASICTimingConstraintSchema.getkeys()ASICTimingConstraintSchema.make_mode()ASICTimingConstraintSchema.make_scenario()ASICTimingConstraintSchema.read_manifest()ASICTimingConstraintSchema.remove()ASICTimingConstraintSchema.remove_mode()ASICTimingConstraintSchema.remove_scenario()ASICTimingConstraintSchema.set()ASICTimingConstraintSchema.unset()ASICTimingConstraintSchema.valid()ASICTimingConstraintSchema.write_manifest()
ASICTimingScenarioSchemaASICTimingScenarioSchema.add()ASICTimingScenarioSchema.add_check()ASICTimingScenarioSchema.add_libcorner()ASICTimingScenarioSchema.add_sdcfileset()ASICTimingScenarioSchema.allkeys()ASICTimingScenarioSchema.copy()ASICTimingScenarioSchema.from_manifest()ASICTimingScenarioSchema.get()ASICTimingScenarioSchema.get_check()ASICTimingScenarioSchema.get_libcorner()ASICTimingScenarioSchema.get_mode()ASICTimingScenarioSchema.get_opcond()ASICTimingScenarioSchema.get_pexcorner()ASICTimingScenarioSchema.get_pin_voltage()ASICTimingScenarioSchema.get_sdcfileset()ASICTimingScenarioSchema.get_temperature()ASICTimingScenarioSchema.getdict()ASICTimingScenarioSchema.getkeys()ASICTimingScenarioSchema.nameASICTimingScenarioSchema.read_manifest()ASICTimingScenarioSchema.remove()ASICTimingScenarioSchema.remove_pin_voltage()ASICTimingScenarioSchema.set()ASICTimingScenarioSchema.set_mode()ASICTimingScenarioSchema.set_name()ASICTimingScenarioSchema.set_opcond()ASICTimingScenarioSchema.set_pexcorner()ASICTimingScenarioSchema.set_pin_voltage()ASICTimingScenarioSchema.set_temperature()ASICTimingScenarioSchema.type()ASICTimingScenarioSchema.unset()ASICTimingScenarioSchema.valid()ASICTimingScenarioSchema.write_manifest()
ASICAreaConstraintASICAreaConstraint.add()ASICAreaConstraint.allkeys()ASICAreaConstraint.calc_diearea()ASICAreaConstraint.copy()ASICAreaConstraint.from_manifest()ASICAreaConstraint.get()ASICAreaConstraint.get_aspectratio()ASICAreaConstraint.get_corearea()ASICAreaConstraint.get_coremargin()ASICAreaConstraint.get_density()ASICAreaConstraint.get_diearea()ASICAreaConstraint.getdict()ASICAreaConstraint.getkeys()ASICAreaConstraint.read_manifest()ASICAreaConstraint.remove()ASICAreaConstraint.set()ASICAreaConstraint.set_aspectratio()ASICAreaConstraint.set_corearea()ASICAreaConstraint.set_corearea_rectangle()ASICAreaConstraint.set_coremargin()ASICAreaConstraint.set_density()ASICAreaConstraint.set_diearea()ASICAreaConstraint.set_diearea_rectangle()ASICAreaConstraint.unset()ASICAreaConstraint.valid()ASICAreaConstraint.write_manifest()
ASICPinConstraintsASICPinConstraints.add()ASICPinConstraints.add_pinconstraint()ASICPinConstraints.allkeys()ASICPinConstraints.copy()ASICPinConstraints.copy_pinconstraint()ASICPinConstraints.from_manifest()ASICPinConstraints.get()ASICPinConstraints.get_pinconstraint()ASICPinConstraints.getdict()ASICPinConstraints.getkeys()ASICPinConstraints.make_pinconstraint()ASICPinConstraints.read_manifest()ASICPinConstraints.remove()ASICPinConstraints.remove_pinconstraint()ASICPinConstraints.set()ASICPinConstraints.unset()ASICPinConstraints.valid()ASICPinConstraints.write_manifest()
ASICPinConstraintASICPinConstraint.add()ASICPinConstraint.allkeys()ASICPinConstraint.copy()ASICPinConstraint.from_manifest()ASICPinConstraint.get()ASICPinConstraint.get_layer()ASICPinConstraint.get_length()ASICPinConstraint.get_order()ASICPinConstraint.get_placement()ASICPinConstraint.get_shape()ASICPinConstraint.get_side()ASICPinConstraint.get_width()ASICPinConstraint.getdict()ASICPinConstraint.getkeys()ASICPinConstraint.nameASICPinConstraint.read_manifest()ASICPinConstraint.remove()ASICPinConstraint.set()ASICPinConstraint.set_layer()ASICPinConstraint.set_length()ASICPinConstraint.set_name()ASICPinConstraint.set_order()ASICPinConstraint.set_placement()ASICPinConstraint.set_shape()ASICPinConstraint.set_side()ASICPinConstraint.set_width()ASICPinConstraint.type()ASICPinConstraint.unset()ASICPinConstraint.valid()ASICPinConstraint.write_manifest()
ASICComponentConstraintsASICComponentConstraints.add()ASICComponentConstraints.add_component()ASICComponentConstraints.allkeys()ASICComponentConstraints.copy()ASICComponentConstraints.copy_component()ASICComponentConstraints.from_manifest()ASICComponentConstraints.get()ASICComponentConstraints.get_component()ASICComponentConstraints.getdict()ASICComponentConstraints.getkeys()ASICComponentConstraints.make_component()ASICComponentConstraints.read_manifest()ASICComponentConstraints.remove()ASICComponentConstraints.remove_component()ASICComponentConstraints.set()ASICComponentConstraints.unset()ASICComponentConstraints.valid()ASICComponentConstraints.write_manifest()
ASICComponentConstraintASICComponentConstraint.add()ASICComponentConstraint.allkeys()ASICComponentConstraint.copy()ASICComponentConstraint.from_manifest()ASICComponentConstraint.get()ASICComponentConstraint.get_halo()ASICComponentConstraint.get_partname()ASICComponentConstraint.get_placement()ASICComponentConstraint.get_rotation()ASICComponentConstraint.getdict()ASICComponentConstraint.getkeys()ASICComponentConstraint.nameASICComponentConstraint.read_manifest()ASICComponentConstraint.remove()ASICComponentConstraint.set()ASICComponentConstraint.set_halo()ASICComponentConstraint.set_name()ASICComponentConstraint.set_partname()ASICComponentConstraint.set_placement()ASICComponentConstraint.set_rotation()ASICComponentConstraint.type()ASICComponentConstraint.unset()ASICComponentConstraint.valid()ASICComponentConstraint.write_manifest()
- 2.5. FPGA Constraint Classes
FPGAConstraintFPGAConstraint.add()FPGAConstraint.allkeys()FPGAConstraint.componentFPGAConstraint.copy()FPGAConstraint.from_manifest()FPGAConstraint.get()FPGAConstraint.getdict()FPGAConstraint.getkeys()FPGAConstraint.pinFPGAConstraint.read_manifest()FPGAConstraint.remove()FPGAConstraint.set()FPGAConstraint.timingFPGAConstraint.unset()FPGAConstraint.valid()FPGAConstraint.write_manifest()
FPGATimingConstraintSchemaFPGATimingConstraintSchema.add()FPGATimingConstraintSchema.add_mode()FPGATimingConstraintSchema.add_scenario()FPGATimingConstraintSchema.allkeys()FPGATimingConstraintSchema.copy()FPGATimingConstraintSchema.copy_mode()FPGATimingConstraintSchema.copy_scenario()FPGATimingConstraintSchema.from_manifest()FPGATimingConstraintSchema.get()FPGATimingConstraintSchema.get_mode()FPGATimingConstraintSchema.get_scenario()FPGATimingConstraintSchema.getdict()FPGATimingConstraintSchema.getkeys()FPGATimingConstraintSchema.make_mode()FPGATimingConstraintSchema.make_scenario()FPGATimingConstraintSchema.read_manifest()FPGATimingConstraintSchema.remove()FPGATimingConstraintSchema.remove_mode()FPGATimingConstraintSchema.remove_scenario()FPGATimingConstraintSchema.set()FPGATimingConstraintSchema.unset()FPGATimingConstraintSchema.valid()FPGATimingConstraintSchema.write_manifest()
FPGATimingScenarioSchemaFPGATimingScenarioSchema.add()FPGATimingScenarioSchema.allkeys()FPGATimingScenarioSchema.copy()FPGATimingScenarioSchema.from_manifest()FPGATimingScenarioSchema.get()FPGATimingScenarioSchema.get_mode()FPGATimingScenarioSchema.getdict()FPGATimingScenarioSchema.getkeys()FPGATimingScenarioSchema.nameFPGATimingScenarioSchema.read_manifest()FPGATimingScenarioSchema.remove()FPGATimingScenarioSchema.set()FPGATimingScenarioSchema.set_mode()FPGATimingScenarioSchema.set_name()FPGATimingScenarioSchema.type()FPGATimingScenarioSchema.unset()FPGATimingScenarioSchema.valid()FPGATimingScenarioSchema.write_manifest()
FPGAComponentConstraintsFPGAComponentConstraints.add()FPGAComponentConstraints.allkeys()FPGAComponentConstraints.copy()FPGAComponentConstraints.from_manifest()FPGAComponentConstraints.get()FPGAComponentConstraints.getdict()FPGAComponentConstraints.getkeys()FPGAComponentConstraints.read_manifest()FPGAComponentConstraints.remove()FPGAComponentConstraints.set()FPGAComponentConstraints.unset()FPGAComponentConstraints.valid()FPGAComponentConstraints.write_manifest()
FPGAPinConstraintsFPGAPinConstraints.add()FPGAPinConstraints.allkeys()FPGAPinConstraints.copy()FPGAPinConstraints.from_manifest()FPGAPinConstraints.get()FPGAPinConstraints.getdict()FPGAPinConstraints.getkeys()FPGAPinConstraints.read_manifest()FPGAPinConstraints.remove()FPGAPinConstraints.set()FPGAPinConstraints.unset()FPGAPinConstraints.valid()FPGAPinConstraints.write_manifest()
- 2.6. Core Schema Classes
BaseSchemaBaseSchema._from_dict()BaseSchema._parent()BaseSchema.add()BaseSchema.allkeys()BaseSchema.copy()BaseSchema.from_manifest()BaseSchema.get()BaseSchema.getdict()BaseSchema.getkeys()BaseSchema.read_manifest()BaseSchema.remove()BaseSchema.set()BaseSchema.unset()BaseSchema.valid()BaseSchema.write_manifest()
EditableSchemaSafeSchemaJournalNamedSchemaNamedSchema.add()NamedSchema.allkeys()NamedSchema.copy()NamedSchema.from_manifest()NamedSchema.get()NamedSchema.getdict()NamedSchema.getkeys()NamedSchema.nameNamedSchema.read_manifest()NamedSchema.remove()NamedSchema.set()NamedSchema.set_name()NamedSchema.type()NamedSchema.unset()NamedSchema.valid()NamedSchema.write_manifest()
ParameterParameter.add()Parameter.add_commandline_arguments()Parameter.copy()Parameter.defaultParameter.from_dict()Parameter.get()Parameter.getdict()Parameter.gettcl()Parameter.getvalues()Parameter.has_value()Parameter.is_directoryParameter.is_empty()Parameter.is_fileParameter.is_list()Parameter.is_pathParameter.is_set()Parameter.parse_commandline_arguments()Parameter.reset()Parameter.set()Parameter.unset()
NodeListValueNodeSetValueNodeValuePathNodeValuePathNodeValue.add()PathNodeValue.copy()PathNodeValue.fieldsPathNodeValue.from_dict()PathNodeValue.generate_hashed_path()PathNodeValue.get()PathNodeValue.get_hashed_filename()PathNodeValue.getdict()PathNodeValue.gettcl()PathNodeValue.has_valuePathNodeValue.hash()PathNodeValue.hash_directory()PathNodeValue.hash_file()PathNodeValue.resolve_path()PathNodeValue.set()PathNodeValue.sign()PathNodeValue.typePathNodeValue.verify_signature()
DirectoryNodeValueDirectoryNodeValue.add()DirectoryNodeValue.copy()DirectoryNodeValue.fieldsDirectoryNodeValue.from_dict()DirectoryNodeValue.generate_hashed_path()DirectoryNodeValue.get()DirectoryNodeValue.get_hashed_filename()DirectoryNodeValue.getdict()DirectoryNodeValue.gettcl()DirectoryNodeValue.has_valueDirectoryNodeValue.hash()DirectoryNodeValue.hash_directory()DirectoryNodeValue.hash_file()DirectoryNodeValue.resolve_path()DirectoryNodeValue.set()DirectoryNodeValue.sign()DirectoryNodeValue.typeDirectoryNodeValue.verify_signature()
FileNodeValueFileNodeValue.add()FileNodeValue.copy()FileNodeValue.fieldsFileNodeValue.from_dict()FileNodeValue.generate_hashed_path()FileNodeValue.get()FileNodeValue.get_hashed_filename()FileNodeValue.getdict()FileNodeValue.gettcl()FileNodeValue.has_valueFileNodeValue.hash()FileNodeValue.hash_directory()FileNodeValue.hash_file()FileNodeValue.resolve_path()FileNodeValue.set()FileNodeValue.sign()FileNodeValue.typeFileNodeValue.verify_signature()
NodeTypeNodeEnumTypeScopePerNodeDocsSchema
- 2.7. Supporting Classes
DependencySchemaDependencySchema.add()DependencySchema.add_dep()DependencySchema.allkeys()DependencySchema.check_filepaths()DependencySchema.copy()DependencySchema.from_manifest()DependencySchema.get()DependencySchema.get_dep()DependencySchema.getdict()DependencySchema.getkeys()DependencySchema.has_dep()DependencySchema.read_manifest()DependencySchema.remove()DependencySchema.remove_dep()DependencySchema.set()DependencySchema.unset()DependencySchema.valid()DependencySchema.write_depgraph()DependencySchema.write_manifest()
OptionSchemaOptionSchema.add_alias()OptionSchema.add_fileset()OptionSchema.add_from()OptionSchema.add_prune()OptionSchema.add_to()OptionSchema.get_alias()OptionSchema.get_autoissue()OptionSchema.get_breakpoint()OptionSchema.get_builddir()OptionSchema.get_cachedir()OptionSchema.get_clean()OptionSchema.get_continue()OptionSchema.get_credentials()OptionSchema.get_design()OptionSchema.get_env()OptionSchema.get_fileset()OptionSchema.get_flow()OptionSchema.get_from()OptionSchema.get_hash()OptionSchema.get_jobincr()OptionSchema.get_jobname()OptionSchema.get_nice()OptionSchema.get_nodashboard()OptionSchema.get_nodisplay()OptionSchema.get_novercheck()OptionSchema.get_optmode()OptionSchema.get_prune()OptionSchema.get_quiet()OptionSchema.get_remote()OptionSchema.get_timeout()OptionSchema.get_to()OptionSchema.get_track()OptionSchema.schedulerOptionSchema.set()OptionSchema.set_autoissue()OptionSchema.set_breakpoint()OptionSchema.set_builddir()OptionSchema.set_cachedir()OptionSchema.set_clean()OptionSchema.set_continue()OptionSchema.set_credentials()OptionSchema.set_design()OptionSchema.set_env()OptionSchema.set_flow()OptionSchema.set_hash()OptionSchema.set_jobincr()OptionSchema.set_jobname()OptionSchema.set_nice()OptionSchema.set_nodashboard()OptionSchema.set_nodisplay()OptionSchema.set_novercheck()OptionSchema.set_optmode()OptionSchema.set_quiet()OptionSchema.set_remote()OptionSchema.set_timeout()OptionSchema.set_track()OptionSchema.write_defaults()
SchedulerSchemaSchedulerSchema.add_msgcontact()SchedulerSchema.add_msgevent()SchedulerSchema.add_options()SchedulerSchema.get_cores()SchedulerSchema.get_defer()SchedulerSchema.get_maxnodes()SchedulerSchema.get_maxthreads()SchedulerSchema.get_memory()SchedulerSchema.get_msgcontact()SchedulerSchema.get_msgevent()SchedulerSchema.get_name()SchedulerSchema.get_options()SchedulerSchema.get_queue()SchedulerSchema.set_cores()SchedulerSchema.set_defer()SchedulerSchema.set_maxnodes()SchedulerSchema.set_maxthreads()SchedulerSchema.set_memory()SchedulerSchema.set_name()SchedulerSchema.set_queue()
CommandLineSchemaPathSchemaBasePathSchemaBase.add()PathSchemaBase.allkeys()PathSchemaBase.check_filepaths()PathSchemaBase.copy()PathSchemaBase.find_files()PathSchemaBase.from_manifest()PathSchemaBase.get()PathSchemaBase.getdict()PathSchemaBase.getkeys()PathSchemaBase.hash_files()PathSchemaBase.read_manifest()PathSchemaBase.remove()PathSchemaBase.set()PathSchemaBase.unset()PathSchemaBase.valid()PathSchemaBase.write_manifest()
PathSchemaPathSchema.active_dataroot()PathSchema.add()PathSchema.allkeys()PathSchema.check_filepaths()PathSchema.copy()PathSchema.find_files()PathSchema.from_manifest()PathSchema.get()PathSchema.get_dataroot()PathSchema.getdict()PathSchema.getkeys()PathSchema.hash_files()PathSchema.read_manifest()PathSchema.remove()PathSchema.set()PathSchema.set_dataroot()PathSchema.unset()PathSchema.valid()PathSchema.write_manifest()
FileSetSchemaFileSetSchema.add()FileSetSchema.add_define()FileSetSchema.add_depfileset()FileSetSchema.add_file()FileSetSchema.add_idir()FileSetSchema.add_lib()FileSetSchema.add_libdir()FileSetSchema.add_undefine()FileSetSchema.allkeys()FileSetSchema.check_filepaths()FileSetSchema.copy()FileSetSchema.find_files()FileSetSchema.from_manifest()FileSetSchema.get()FileSetSchema.get_define()FileSetSchema.get_depfileset()FileSetSchema.get_file()FileSetSchema.get_idir()FileSetSchema.get_lib()FileSetSchema.get_libdir()FileSetSchema.get_param()FileSetSchema.get_topmodule()FileSetSchema.get_undefine()FileSetSchema.getdict()FileSetSchema.getkeys()FileSetSchema.has_file()FileSetSchema.has_idir()FileSetSchema.has_libdir()FileSetSchema.hash_files()FileSetSchema.nameFileSetSchema.read_manifest()FileSetSchema.remove()FileSetSchema.set()FileSetSchema.set_name()FileSetSchema.set_param()FileSetSchema.set_topmodule()FileSetSchema.type()FileSetSchema.unset()FileSetSchema.valid()FileSetSchema.write_manifest()
FlowgraphNodeSchemaFlowgraphNodeSchema.add_args()FlowgraphNodeSchema.add_goal()FlowgraphNodeSchema.add_weight()FlowgraphNodeSchema.get_args()FlowgraphNodeSchema.get_goal()FlowgraphNodeSchema.get_input()FlowgraphNodeSchema.get_task()FlowgraphNodeSchema.get_taskmodule()FlowgraphNodeSchema.get_tool()FlowgraphNodeSchema.get_weight()FlowgraphNodeSchema.has_input()
RuntimeFlowgraphTaskErrorTaskTimeoutTaskExecutableNotFoundPackageSchemaPackageSchema.add_author()PackageSchema.add_doc()PackageSchema.add_license()PackageSchema.add_licensefile()PackageSchema.get_author()PackageSchema.get_description()PackageSchema.get_doc()PackageSchema.get_license()PackageSchema.get_licensefile()PackageSchema.get_vendor()PackageSchema.get_version()PackageSchema.set_description()PackageSchema.set_vendor()PackageSchema.set_version()
CriteriaCriteria.add_criteria()Criteria.add_rationale()Criteria.add_report()Criteria.add_task()Criteria.add_waiver()Criteria.get_criteria()Criteria.get_dataformat()Criteria.get_description()Criteria.get_ok()Criteria.get_rationale()Criteria.get_report()Criteria.get_requirement()Criteria.get_task()Criteria.get_waiver()Criteria.set_dataformat()Criteria.set_description()Criteria.set_ok()Criteria.set_requirement()
ToolLibrarySchemaRecordSchemaRecordSchema.clear()RecordSchema.get_cloud_information()RecordSchema.get_earliest_time()RecordSchema.get_ip_information()RecordSchema.get_latest_time()RecordSchema.get_machine_information()RecordSchema.get_recorded_time()RecordSchema.get_user_information()RecordSchema.record_python_packages()RecordSchema.record_time()RecordSchema.record_tool()RecordSchema.record_userinformation()RecordSchema.record_version()
MetricSchemaSchematicSchematic.add()Schematic.add_component()Schematic.add_net()Schematic.add_part()Schematic.add_pin()Schematic.all_components()Schematic.all_nets()Schematic.all_pins()Schematic.allkeys()Schematic.connect()Schematic.copy()Schematic.from_manifest()Schematic.get()Schematic.get_netrange()Schematic.get_partname()Schematic.get_partpins()Schematic.get_pindir()Schematic.get_pinrange()Schematic.getdict()Schematic.getkeys()Schematic.read_manifest()Schematic.read_verilog()Schematic.remove()Schematic.set()Schematic.unset()Schematic.valid()Schematic.write_manifest()Schematic.write_verilog()
- 2.8. Inheritance
- 3. CLI apps
- 4. Server API
- 5. Leflib API
Appendix
- 1. Design Glossary
- 2. Slurm setup
- 3. Licenses
- 4. Revision History and Change Log
- 4.1. SiliconCompiler 0.37.11 (2026-05-20)
- 4.2. SiliconCompiler 0.37.10 (2026-05-11)
- 4.3. SiliconCompiler 0.37.9 (2026-05-08)
- 4.4. SiliconCompiler 0.37.8 (2026-05-04)
- 4.5. SiliconCompiler 0.37.7 (2026-04-21)
- 4.6. SiliconCompiler 0.37.6 (2026-04-15)
- 4.7. SiliconCompiler 0.37.5 (2026-04-08)
- 4.8. SiliconCompiler 0.37.4 (2026-03-25)
- 4.9. SiliconCompiler 0.37.3 (2026-03-22)
- 4.10. SiliconCompiler 0.37.2 (2026-03-09)
- 4.11. SiliconCompiler 0.37.1 (2026-02-26)
- 4.12. SiliconCompiler 0.37.0 (2026-02-24)
- 4.13. SiliconCompiler 0.36.5 (2026-02-02)
- 4.14. SiliconCompiler 0.36.4 (2026-01-31)
- 4.15. SiliconCompiler 0.36.3 (2026-01-21)
- 4.16. SiliconCompiler 0.36.2 (2026-01-16)
- 4.17. SiliconCompiler 0.36.1 (2026-01-10)
- 4.18. SiliconCompiler 0.36.0 (2026-01-06)
- 4.19. SiliconCompiler 0.35.4 (2025-12-08)
- 4.20. SiliconCompiler 0.35.3 (2025-11-10)
- 4.21. SiliconCompiler 0.35.2 (2025-10-28)
- 4.22. SiliconCompiler 0.35.1 (2025-10-17)
- 4.23. SiliconCompiler 0.35.0 (2025-10-08)
- 4.24. SiliconCompiler 0.34.3 (2025-08-11)
- 4.25. SiliconCompiler 0.34.2 (2025-07-21)
- 4.26. SiliconCompiler 0.34.1 (2025-07-07)
- 4.27. SiliconCompiler 0.34.0 (2025-06-16)
- 4.28. SiliconCompiler 0.33.2 (2025-06-03)
- 4.29. SiliconCompiler 0.33.1 (2025-05-23)
- 4.30. SiliconCompiler 0.33.0 (2025-05-19)
- 4.31. SiliconCompiler 0.32.3 (2025-04-11)
- 4.32. SiliconCompiler 0.32.2 (2025-03-31)
- 4.33. SiliconCompiler 0.32.1 (2025-03-13)
- 4.34. SiliconCompiler 0.32.0 (2025-03-11)
- 4.35. SiliconCompiler 0.31.1 (2025-03-06)
- 4.36. SiliconCompiler 0.31.0 (2025-03-03)
- 4.37. SiliconCompiler 0.30.0 (2025-02-18)
- 4.38. SiliconCompiler 0.29.4 (2025-02-06)
- 4.39. SiliconCompiler 0.29.3 (2025-01-28)
- 4.40. SiliconCompiler 0.29.2 (2025-01-16)
- 4.41. SiliconCompiler 0.29.1 (2025-01-09)
- 4.42. SiliconCompiler 0.29.0 (2024-12-12)
- 4.43. SiliconCompiler 0.28.9 (2024-11-27)
- 4.44. SiliconCompiler 0.28.8 (2024-11-20)
- 4.45. SiliconCompiler 0.28.7 (2024-11-12)
- 4.46. SiliconCompiler 0.28.6 (2024-11-12)
- 4.47. SiliconCompiler 0.28.5 (2024-11-06)
- 4.48. SiliconCompiler 0.28.4 (2024-10-28)
- 4.49. SiliconCompiler 0.28.3 (2024-10-14)
- 4.50. SiliconCompiler 0.28.2 (2024-10-02)
- 4.51. SiliconCompiler 0.28.1 (2024-09-20)
- 4.52. SiliconCompiler 0.28.0 (2024-09-18)
- 4.53. SiliconCompiler 0.27.1 (2024-08-28)
- 4.54. SiliconCompiler 0.27.0 (2024-08-28)
- 4.55. SiliconCompiler 0.26.5 (2024-08-26)
- 4.56. SiliconCompiler 0.26.4 (2024-08-22)
- 4.57. SiliconCompiler 0.26.3 (2024-08-20)
- 4.58. SiliconCompiler 0.26.2 (2024-08-15)
- 4.59. SiliconCompiler 0.26.1 (2024-08-02)
- 4.60. SiliconCompiler 0.26.0 (2024-07-30)
- 4.61. SiliconCompiler 0.25.0 (2024-07-26)
- 4.62. SiliconCompiler 0.24.1 (2024-07-11)
- 4.63. SiliconCompiler 0.24.0 (2024-07-09)
- 4.64. SiliconCompiler 0.23.4 (2024-07-02)
- 4.65. SiliconCompiler 0.23.3 (2024-06-25)
- 4.66. SiliconCompiler 0.23.2 (2024-06-20)
- 4.67. SiliconCompiler 0.23.1 (2024-06-18)
- 4.68. SiliconCompiler 0.23.0 (2024-06-13)
- 4.69. SiliconCompiler 0.22.0 (2024-05-23)
- 4.70. SiliconCompiler 0.21.13 (2024-05-15)
- 4.71. SiliconCompiler 0.21.12 (2024-05-13)
- 4.72. SiliconCompiler 0.21.11 (2024-04-26)
- 4.73. SiliconCompiler 0.21.10 (2024-04-22)
- 4.74. SiliconCompiler 0.21.9 (2024-04-12)
- 4.75. SiliconCompiler 0.21.8 (2024-04-11)
- 4.76. SiliconCompiler 0.21.7 (2024-04-02)
- 4.77. SiliconCompiler 0.21.6 (2024-03-28)
- 4.78. SiliconCompiler 0.21.5 (2024-03-21)
- 4.79. SiliconCompiler 0.21.4 (2024-03-15)
- 4.80. SiliconCompiler 0.21.3 (2024-03-13)
- 4.81. SiliconCompiler 0.21.2 (2024-03-08)
- 4.82. SiliconCompiler 0.21.1 (2024-03-07)
- 4.83. SiliconCompiler 0.21.0 (2024-03-07)
- 4.84. SiliconCompiler 0.20.3 (2024-03-06)
- 4.85. SiliconCompiler 0.20.2 (2024-02-20)
- 4.86. SiliconCompiler 0.20.1 (2024-02-12)
- 4.87. SiliconCompiler 0.20.0 (2024-02-01)
- 4.88. SiliconCompiler 0.19.1 (2024-01-24)
- 4.89. SiliconCompiler 0.19.0 (2024-01-05)
- 4.90. SiliconCompiler 0.18.2 (2023-12-18)
- 4.91. SiliconCompiler 0.18.1 (2023-12-13)
- 4.92. SiliconCompiler 0.18.0 (2023-12-04)
- 4.93. SiliconCompiler 0.17.0 (2023-11-16)
- 4.94. SiliconCompiler 0.16.3 (2023-11-02)
- 4.95. SiliconCompiler 0.16.2 (2023-10-13)
- 4.96. SiliconCompiler 0.16.1 (2023-10-11)
- 4.97. SiliconCompiler 0.16.0 (2023-10-09)
- 4.98. SiliconCompiler 0.15.4 (2023-09-25)
- 4.99. SiliconCompiler 0.15.3 (2023-09-21)
- 4.100. SiliconCompiler 0.15.2 (2023-09-18)
- 4.101. SiliconCompiler 0.15.1 (2023-09-08)
- 4.102. SiliconCompiler 0.15.0 (2023-08-31)
- 4.103. SiliconCompiler 0.14.0 (2023-08-21)
- 4.104. SiliconCompiler 0.13.2 (2023-08-10)
- 4.105. SiliconCompiler 0.13.1 (2023-07-21)
- 4.106. SiliconCompiler 0.13.0 (2023-07-07)
- 4.107. SiliconCompiler 0.12.3 (2023-06-23)
- 4.108. SiliconCompiler 0.12.2 (2023-06-14)
- 4.109. SiliconCompiler 0.12.1 (2023-06-07)
- 4.110. SiliconCompiler 0.12.0 (2023-05-24)
- 4.111. SiliconCompiler 0.11.2 (2023-05-15)
- 4.112. SiliconCompiler 0.11.1 (2023-05-03)
- 4.113. SiliconCompiler 0.11.0 (2023-04-17)
- 4.114. SiliconCompiler 0.10.2 (2023-04-04)
- 4.115. SiliconCompiler 0.10.1 (2023-03-11)
- 4.116. SiliconCompiler 0.10.0 (2023-03-08)
- 4.117. SiliconCompiler 0.9.6 (2022-10-03)
- 4.118. SiliconCompiler 0.9.5 (2022-09-12)
- 4.119. SiliconCompiler 0.9.4 (2022-08-25)
- 4.120. SiliconCompiler 0.9.3 (2022-08-01)
- 4.121. SiliconCompiler 0.9.2 (2022-07-08)
- 4.122. SiliconCompiler 0.9.1 (2022-06-21)
- 4.123. SiliconCompiler 0.9.0 (2022-05-19)
- 4.124. SiliconCompiler 0.7.0 (2022-03-02)
- 4.125. SiliconCompiler 0.6.0 (2022-02-11)
- 4.126. SiliconCompiler 0.4.1 (2022-01-06)
- 4.127. SiliconCompiler 0.4.0 (2022-01-05)
- 4.128. SiliconCompiler 0.3.1 (2021-12-21)
- 4.129. SiliconCompiler 0.3.0 (2021-12-21)
- 4.130. SiliconCompiler 0.1.1 (2021-12-08)
- 4.131. SiliconCompiler 0.1.0 (2021-12-03)
- 5. Dashboard