Skip to content

gdsfactoryplus

GDSFactory+ Python SDK.

Modules:

Name Description
autodesign

Autodesign campaign client.

check

Verification helpers.

cli

The gfp command line, restoring the GDSFactory+ 1.x CLI on the 2.x SDK.

compile

Compile a .gsch file into GDS or .py schematic factory modules.

component_picker

Interactive active-PDK component selection for simulation notebooks.

convert

Convert .gsch schematics into a kfactory DSchematic.

core

Compatibility exports for GDSFactory+ core functionality.

credentials

Credential selection for SDK calls to GDSFactory+ services.

diff

GDSFactory+ structural layout diff using kdb.LayoutDiff.

dschematic_to_gds

Stage 2: kf.DSchematic to GDS file.

emit

Emit kfactory-idiomatic .py source files from kf.DSchematic objects.

errors

Structured SDK errors carrying a machine-readable kind.

export

GDS export helpers.

factory_metadata

Factory-model registration and resolution helpers.

generate_svg

Generate SVG from cell.

kfactory_compat

Compatibility operations for kfactory 2.x and 3.x schematics.

logging

Structured logging that feeds into the worker log pipeline.

model_authoring

Runtime inspection helpers for SAX model authoring.

nyancir_to_dschematic

Stage 1: .gsch file to in-memory kf.DSchematic.

pdk

Project-aware PDK access for standalone scripts.

placement

DoRoutes-powered component placement for the Livewire editor.

routing

PDK-agnostic routing APIs.

runtime

Runtime setup for compiled-schematic factory modules.

sax_ports

The shared external marker policy for SAX.

schematic_netlist

Read Mosaic schematics and convert their connectivity for SDK consumers.

sim

Simulation helpers.

xs_default

PDK default cross-section inference (§xs-route-default).

Functions:

Name Description
circulax_model_for

Register the decorated callable as a Circulax model for target.

get_component

Instantiate the chosen cell, retaining settings only for the default.

get_pdk

Activate and return the PDK configured by the nearest project.

sax_model_for

Register the decorated callable as a SAX model for target.

spice_model_for

Register declarative SPICE model metadata for a factory.

symbol_for

Assign packaged SVG artwork as the schematic symbol of target.

circulax_model_for

circulax_model_for(
    target: str,
    *,
    params: Mapping[str, str] | None = None,
    port_order: Sequence[str] | None = None,
    position: ModelPosition = "prepend",
) -> Callable[[ModelCallable], ModelCallable]

Register the decorated callable as a Circulax model for target.

@tags factory model authoring

get_component

get_component(picker: str | Any, default: str, **default_settings: Any) -> Component

Instantiate the chosen cell, retaining settings only for the default.

get_pdk

get_pdk() -> Pdk

Activate and return the PDK configured by the nearest project.

@tags python sdk package

sax_model_for

sax_model_for(
    target: str,
    *,
    params: Mapping[str, str] | None = None,
    port_order: Sequence[str] | None = None,
    position: ModelPosition = "prepend",
) -> Callable[[ModelCallable], ModelCallable]

Register the decorated callable as a SAX model for target.

@tags factory model authoring

spice_model_for

spice_model_for(
    target: str,
    *,
    name: str,
    spice_type: str,
    port_order: Sequence[str],
    params: Mapping[str, str] | None = None,
    position: ModelPosition = "prepend",
    implementation: str | None = None,
    library: str | None = None,
    sections: Sequence[str] | None = None,
    code: str | None = None,
) -> None

Register declarative SPICE model metadata for a factory.

@tags factory model authoring

symbol_for

symbol_for(target: str, resource: str) -> None

Assign packaged SVG artwork as the schematic symbol of target.

The latest registration for a target wins and replaces the PDK's packaged or generated artwork; all other factory metadata is untouched.

@tags mosaic symbol maker