3. Sup API
- class siliconcompiler.package.Sup(design, registry=None)
SiliconCompiler Unified Package (SUP) class.
Main object used to interact with the SiliconCompiler Package Management System API.
- check(filename)
Check that manifest before publishing.
- Parameters
filename (filepath) – Path to a manifest file to be loaded
- clear()
Removes all locally installed packages.
- info(name)
Display package information.
- Parameters
name (str) – Package to display in format <design>-(<semver>)?
- install(name, nodeps=False)
Install registry package in local cache.
- Parameters
name (str) – Package to install in format <design>-(<semver>)?
registry (str) – List of registries tos search
nodeps (bool) – Don’t descend dependency tree if True
- publish(filename, registry=None, history=True, metrics=True, imports=True, exports=True)
Publish chip manifest to registry.
- Parameters
filename (filepath) – Path to a manifest file to be loaded
registry (str) – File system directory or IP address of registry
history (bool) – Include job history in package
metrics (bool) – Include metrics in package
imports (bool) – Include import files (sources) in package
exports (bool) – Include export files (outputs) in package
- search(name=None)
Search for a package in registry.
- Parameters
name (str) – Package to searc in format <design>-(<semver>)?
- uninstall(name)
Uninstall local package.
If no version is specified, all versions of the design are removed.
- Parameters
name (str) – Package to remove in format <design>-(<semver>)?