rocket-engine 0.0.2b1__py3-none-any.whl

rocket_engine/interfaces/setup_catalogue.yaml

@@ -0,0 +1,243 @@
+# Provision catalogue (ENGINE-SETUP): the data the Vivado-style setup
+# menu renders. One entry per provisionable unit: what it provides,
+# how to detect it, and where the install recipe lives. Recipes cite
+# docs/provision-plan.md (PROV seed), scripts/install.sh modes
+# (B10/DEMO-PATH), or the owning ticket — never a bare "install X".
+# Load with rocket_engine.interfaces.setup.load_catalogue.
+# GTKWave is EXCLUDED from engine provisioning by the headless rule
+# (display-side, RocketIDE concern) — recorded, never installed.
+catalogue_version: 1
+entries:
+  - id: digital-bundle
+    kind: tool
+    label: Digital bundle (oss-cad-suite)
+    binaries: [iverilog, vvp, verilator, slang, yosys, ghdl, sby]
+    remedy: >-
+      Install the pinned oss-cad-suite bundle 20261025 (iverilog, vvp,
+      verilator, slang, yosys, ghdl, sby; run
+      scripts/provision_toolchain.sh --install); the scenario gate needs
+      dev-PATH with oss-cad-suite (see scenarios/README.md).
+    recipe: "scripts/provision_toolchain.sh: pinned tarball 20261025 + asserts (PROV phase 1)."
+  - id: librelane
+    kind: tool
+    label: LibreLane (RTL-to-GDS flow)
+    binaries: [librelane]
+    remedy: >-
+      Install the LibreLane 3.0.17 supported distribution (run
+      scripts/provision_toolchain.sh --install for the pinned AppImage
+      per the upstream install docs); inside a nix-shell env, `librelane
+      --version` must report 3.0.17.
+    recipe: "scripts/provision_toolchain.sh (PROV phase 1; upstream AppImage/Nix install docs)."
+  - id: opensta
+    kind: tool
+    label: OpenSTA (static timing)
+    binaries: [sta]
+    remedy: >-
+      Install the pinned OpenSTA build 857316f (run
+      scripts/provision_toolchain.sh --install for the CMake source
+      build per the upstream README); `sta` lands in
+      ~/tools/opensta-857316f/bin.
+    recipe: "scripts/provision_toolchain.sh (PROV phase 1; upstream OpenSTA README source build)."
+  - id: ngspice
+    kind: tool
+    label: ngspice (SPICE)
+    binaries: [ngspice]
+    remedy: >-
+      Provision ngspice (see docs/tickets/NGSPICE-LIVE.md).
+    recipe: "docs/provision-plan.md: apt pin or source build (B10)."
+  - id: netgen
+    kind: tool
+    label: Netgen (LVS)
+    binaries: [netgen]
+    banner: lvs
+    remedy: >-
+      Install opencircuitdesign netgen from source (see
+      docs/tickets/NGSPICE-LIVE.md); the `netgen` apt package is
+      the Schoeberl mesh-generator impostor, not the LVS tool.
+    recipe: "docs/tickets/NGSPICE-LIVE.md: opencircuitdesign source build (B10)."
+  - id: magic
+    kind: tool
+    label: Magic (DRC + extraction)
+    binaries: [magic]
+    remedy: >-
+      Install Magic from source per the rtimothyedwards docs (see
+      docs/provision-plan.md); ambient installs are kept and
+      version-asserted, never reinstalled.
+    recipe: "docs/provision-plan.md: source build with --prefix into the app-owned tools dir (B10)."
+  - id: klayout
+    kind: tool
+    label: KLayout (batch DRC)
+    binaries: [klayout]
+    remedy: >-
+      Install KLayout for batch DRC (see
+      docs/provision-plan.md); the engine uses `klayout -b`
+      batch only — GUI breakage never gates engine work.
+    recipe: "docs/provision-plan.md: ambient install kept and version-asserted (B10)."
+  - id: xyce
+    kind: tool
+    label: Xyce (parallel SPICE)
+    binaries: [Xyce]
+    remedy: >-
+      Install the pinned Xyce Release-7.10.0 build (Trilinos
+      trilinos-release-17-2-1 first; run
+      scripts/provision_toolchain.sh --install).
+    recipe: "scripts/provision_toolchain.sh (PROV phase 2; Xyce building guide recipe)."
+  - id: xschem
+    kind: tool
+    label: Xschem (schematic)
+    binaries: [xschem]
+    remedy: >-
+      Install Xschem from source at 7811010 (run
+      scripts/provision_toolchain.sh --install).
+    recipe: "scripts/provision_toolchain.sh (PROV phase 2; upstream xschem source build)."
+  - id: cace
+    kind: python
+    label: CACE (characterization)
+    python: [cace]
+    remedy: >-
+      Install cace==2.13.0 into the engine venv (run
+      scripts/provision_toolchain.sh --install; needs
+      xschem/magic/netgen/ngspice first).
+    recipe: "scripts/provision_toolchain.sh (PROV phase 2; pip into the engine venv)."
+  - id: bwrap
+    kind: tool
+    label: Bubblewrap (isolation)
+    binaries: [bwrap]
+    remedy: >-
+      B10 owns bwrap provenance (system vs bundled) and PATH
+      placement (see docs/probe-bwrap-isolation.md).
+    recipe: "docs/probe-bwrap-isolation.md (B10)."
+  - id: sax
+    kind: python
+    label: SAX (photonic sim)
+    python: [sax]
+    remedy: "sax not installed, uv sync (B10-owned tooling)"
+    recipe: "pyproject.toml [project] dependencies: plain `uv sync` installs everything (core library)."
+  - id: circulax
+    kind: python
+    label: Circulax (time-domain circuit sim)
+    python: [circulax]
+    remedy: "circulax not installed, uv sync (B10-owned tooling)"
+    recipe: "pyproject.toml [project] dependencies: plain `uv sync` installs everything (core library)."
+  - id: meow
+    kind: python
+    label: Meow (EME mode/field solver)
+    python: [meow]
+    remedy: "meow not installed, uv sync (B10-owned tooling)"
+    recipe: "pyproject.toml [project] dependencies: plain `uv sync` installs everything (core library)."
+  - id: gdsfactory
+    kind: python
+    label: gdsfactory (layout views)
+    python: [gdsfactory]
+    remedy: "gdsfactory not installed, uv sync (B10-owned tooling)"
+    recipe: "pyproject.toml [project] dependencies: plain `uv sync` installs everything (core library)."
+  - id: cvc
+    kind: tool
+    label: cvc (SMT solvers)
+    binaries: [cvc4, cvc5]
+    remedy: >-
+      Install the pinned oss-cad-suite bundle 20261025 (ships
+      the cvc4/cvc5 SMT solvers; run
+      scripts/provision_toolchain.sh --install).
+    recipe: "scripts/provision_toolchain.sh: pinned tarball 20261025 ships cvc4/cvc5 (PROV phase 1)."
+  - id: openroad
+    kind: tool
+    label: OpenROAD
+    binaries: [openroad]
+    remedy: >-
+      Install the LibreLane 3.0.17 supported distribution (run
+      scripts/provision_toolchain.sh --install); openroad ships
+      in its tool closure (see docs/provision-sources.md §3-§4).
+    recipe: "scripts/provision_toolchain.sh (PROV phase 1; LibreLane closure ships openroad)."
+  - id: pymeep
+    kind: python
+    label: pymeep (FDTD)
+    python: [meep]
+    remedy: >-
+      Provision pymeep==1.35.0 via the miniforge conda env (run
+      scripts/provision_toolchain.sh --install); it lives in
+      the conda env, not the engine venv, so verify with the
+      env python (see docs/provision-sources.md §10).
+    recipe: "scripts/provision_toolchain.sh (PROV-DEFERRED; conda-forge pymeep env)."
+  - id: openems
+    kind: tool
+    label: openEMS (EC-FDTD)
+    binaries: [openEMS]
+    remedy: >-
+      Install openEMS v0.37.0 + CSXCAD v0.7.0 from source (run
+      scripts/provision_toolchain.sh --install).
+    recipe: "scripts/provision_toolchain.sh (PROV-DEFERRED; docs.openEMS.de recipe)."
+  - id: elmer
+    kind: tool
+    label: Elmer (thermal/FEM)
+    binaries: [ElmerSolver]
+    remedy: >-
+      Install elmerfem-csc via the CSC PPA (needs sudo; run
+      scripts/provision_toolchain.sh --install).
+    recipe: "scripts/provision_toolchain.sh (PROV-DEFERRED; CSC PPA apt route)."
+  - id: devsim
+    kind: python
+    label: DEVSIM (TCAD)
+    python: [devsim]
+    remedy: >-
+      Install devsim==2.11.2 into the engine venv (run
+      scripts/provision_toolchain.sh --install).
+    recipe: "scripts/provision_toolchain.sh (PROV-DEFERRED; pip into the engine venv)."
+  - id: palace
+    kind: tool
+    label: Palace (full-wave FEM)
+    binaries: [palace]
+    provisionable: false
+    remedy: >-
+      Palace is unsourced: its install docs are not read yet
+      (docs/provision-sources.md §12). No row action.
+    recipe: "docs/provision-sources.md §12 (unsourced — no recipe yet)."
+  - id: pdk-sky130A
+    kind: pdk
+    label: PDK sky130A
+    pdk_id: sky130A
+    source_default: ~/.local/share/pdk/sky130A
+    decks:
+      - libs.tech/klayout/drc/sky130A.lydrc
+      - libs.tech/magic/sky130A.tech
+      - libs.tech/combined/sky130.lib.spice
+      - libs.tech/netgen/sky130A_setup.tcl
+    remedy: >-
+      Register the PDK into ROCKETEDA_HOME (run
+      scripts/install.sh --pdk-only with PDK_SOURCE set to the
+      sky130A tree).
+    recipe: "scripts/install.sh --pdk-only (PDK_SOURCE/PDK_ID/PDK_REVISION; see docs/demo-runbook.md)."
+  - id: pdk-ihp
+    kind: pdk
+    label: PDK ihp (IHP SG13G2 BiCMOS + RF)
+    pdk_id: ihp
+    source_default: ~/.local/share/pdk/ihp
+    decks:
+      - ihp/klayout/tech/drc/ihp-sg13g2.drc
+    remedy: >-
+      Provision ihp-gdsfactory 2.0.1 per docs/pdk/ihp/recipe.md
+      (pip pin + KLayout tech link + verify probe), then register
+      the tree via scripts/install.sh --pdk-only with PDK_ID=ihp.
+      The PDK deck needs KLayout newer than 0.30.7 (euclidean
+      metric; recipe §4).
+    recipe: "docs/pdk/ihp/recipe.md (PDK-IHP lane)."
+  - id: cloud-tidy3d
+    kind: cloud
+    label: Tidy3D web (cloud)
+    service: tidy3d web
+    remedy: >-
+      BYOC opt-in only (F12/I32): tidy3d web needs a
+      user-supplied key from the CLOUD-AUTH secure store (see
+      docs/tickets/CLOUD-AUTH.md); cloud never activates
+      without an explicit opt-in.
+    recipe: "CLOUD-AUTH (Backlog): OS keyring preferred, encrypted file fallback."
+  - id: cloud-gdsfactory-plus
+    kind: cloud
+    label: GDSFactory+ (cloud)
+    service: gdsfactory+
+    remedy: >-
+      BYOC opt-in only (F12/I32): gdsfactory+ needs a
+      user-supplied key from the CLOUD-AUTH secure store (see
+      docs/tickets/CLOUD-AUTH.md); cloud never activates
+      without an explicit opt-in.
+    recipe: "CLOUD-AUTH (Backlog): OS keyring preferred, encrypted file fallback."

rocket_engine/interfaces/setup_probes.py

@@ -0,0 +1,66 @@
+"""Shadow-proof Python-tool probes for the setup surface.
+
+`detect_python` answers "is this tool module genuinely installed"
+without false-readying on import shadows: a bare `find_spec` hit is
+not enough, because an empty namespace directory on `sys.path` (a
+stray dir, a partial uninstall, a foreign residue like the observed
+`/tmp/gdsfactory/`) yields a loader-less namespace spec that the old
+probe counted as installed and then stamped `found: True` when the
+version lookup missed. This probe requires both a real loader and
+installed distribution metadata before reporting found.
+"""
+
+import importlib.metadata
+import importlib.util
+
+
+def detect_python(names):
+    """Split module names into found versions and missing names.
+
+    A module counts as found only when it resolves to a spec with a
+    real loader (namespace shadows carry `loader=None`) and its
+    distribution metadata answers a version. Anything else — no
+    spec, a loader-less spec, an unresolvable spec, or no installed
+    distribution — reports missing, never a bare `True`.
+
+    The distribution is resolved through the top-level mapping,
+    not by assuming the names match: the `meow` module ships as
+    the `meow-sim` distribution, and only the mapping knows that.
+    Dotted names look up their top-level parent; when the mapping
+    is silent (a dist-info without top_level records), a direct
+    version lookup under the module name is the fallback, so the
+    rule stays loader-plus-version either way.
+
+    Args:
+        names: Importable module names to probe, in order.
+
+    Returns:
+        (found, missing) pair: found maps each installed module to
+            its distribution version, missing lists the rest in
+            probe order.
+    """
+    try:
+        provided = importlib.metadata.packages_distributions()
+    except Exception:
+        provided = {}
+    found, missing = {}, []
+    for name in names:
+        try:
+            spec = importlib.util.find_spec(name)
+        except (ImportError, ValueError):
+            spec = None
+        if spec is None or spec.loader is None:
+            missing.append(name)
+            continue
+        candidates = list(provided.get(name.partition(".")[0]) or [])
+        if name not in candidates:
+            candidates.append(name)
+        for candidate in candidates:
+            try:
+                found[name] = importlib.metadata.version(candidate)
+                break
+            except importlib.metadata.PackageNotFoundError:
+                continue
+        else:
+            missing.append(name)
+    return found, missing

rocket_engine/interfaces/vocabulary.py

@@ -0,0 +1,58 @@
+"""Operation vocabulary: the single source of truth for callable names.
+
+Transports gate inbound names against these sets; the composition root
+gates outbound routing against them. Neither side keeps its own copy.
+"""
+
+OPERATIONS = frozenset(
+    {
+        "generate_views", "run_hdl_test", "run_formal", "run_syntax",
+        "run_synth",
+        "run_connectivity", "run_drc", "run_lvs", "run_erc", "run_spice",
+        "run_optical", "run_digital_flow", "run_timing", "run_extraction",
+        "run_post_layout", "run_em", "run_thermal", "python_execute",
+        "run_view_sync", "run_cosim", "run_xschem", "run_antenna",
+        "python_open", "python_reset",
+        "run_job",
+        "resume_run", "discard_run", "resume_all_retryable", "cancel_job",
+        "create_project", "write_doc", "delete_doc", "apply_mutations",
+        "rewind", "place_cell", "write_settings",
+        "create_entity", "set_component", "attach_component",
+        "detach_component", "delete_entity",
+        "place_wire", "place_junction", "connect_endpoint", "move_wire",
+        "split_wire", "delete_wire", "delete_junction", "materialize_nets",
+        "apply_transaction",
+        "create_shape",
+        "create_sheet", "place_instance", "bind_block",
+        "create_symbol", "create_cell", "map_pins",
+        "ip_register", "ip_instantiate", "ip_promote",
+        "bind_layers", "annotate",
+        "create_testbench", "regenerate_testbench",
+    }
+)
+QUERIES = frozenset(
+    {
+        "api_search", "api_info", "api_help", "get_python_console",
+        "get_capabilities", "get_project_snapshot", "list_job_kinds",
+        "plan_checks", "get_design_completion",
+        "get_job_status", "get_check_results",
+        "get_events_since", "list_artifacts", "get_logs",
+        "get_findings",
+        "list_projects", "list_docs", "read_doc",
+        "get_component", "components_of", "entities_with",
+        "get_world_snapshot",
+        "list_cells", "serve_asset", "list_assets",
+        "read_settings", "get_resolved_config",
+        "get_layer_stackup", "get_layer_rows", "list_layer_presets",
+        "save_layer_preset", "delete_layer_preset", "apply_layer_preset",
+        "list_survivors",
+        "read_entity_revision",
+        "list_sheets", "get_sheet", "get_instance", "instances_on_sheet",
+        "list_symbols", "get_symbol", "get_cell",
+        "list_layers", "check_capability",
+        "ip_search", "ip_get",
+        "connection_graph", "net_occurrences", "xprobe", "resolve_pin",
+        "plot_export", "erc_check", "write_netlist", "update_netlist",
+        "list_testbenches", "describe_testbench",
+    }
+)

rocket_engine/interfaces/yaml_dump.py

@@ -0,0 +1,31 @@
+"""Fresh ruamel dumpers for YAML writes (RUAMEL-DUMPER).
+
+A failed ruamel ``YAML(typ="safe").dump`` poisons that dumper
+instance: every later dump through it emits empty text instead
+of raising. A long-lived dumper therefore collapses distinct
+writes onto one hollow identity after a single failure. Every
+YAML write on the Engine/ProjectService path dumps through a
+fresh instance per call, so a failure raises loudly and later
+writes are unaffected.
+"""
+
+import io
+
+from ruamel.yaml import YAML
+
+__all__ = ["dump_yaml_text"]
+
+
+def dump_yaml_text(data):
+    """Render one YAML text through a fresh dumper.
+
+    Args:
+        data: Mapping or list to serialize.
+
+    Returns:
+        YAML text for the payload, byte-identical to a direct
+        fresh ``YAML(typ="safe")`` dump and never empty.
+    """
+    buf = io.StringIO()
+    YAML(typ="safe").dump(data, buf)
+    return buf.getvalue()

rocket_engine/library/README.md

@@ -0,0 +1,22 @@
+# library — PDK and reusable-cell catalogs
+
+library/ supplies catalog lookups used by operations and capability checks. It currently contains PDK context/catalog logic and the APIG cell catalog; solver execution remains in adapters/ and project revisions remain in project/.
+
+## PDK catalog
+
+catalog.py resolves versioned PDK references, reports per-operation readiness, registers and verifies catalog entries, and provides cell instantiate/promote helpers. The file-backed PDK registry and asset resolver live in [interfaces/pdks.py](../interfaces/pdks.py); registration records a revision and content identity, and upstream files are treated as read-only inputs.
+
+## Cell catalog
+
+apig_catalog.py combines static providers with a GDSFactory provider, normalizes cell metadata, and supports list/get/placement methods. The engine currently exposes the list_cells query; the generated API marks place_cell unwired, and get_cell is not a public engine query yet. Check the [generated API](../../docs/engine-api.md) before depending on a caller-facing operation.
+
+## Readiness
+
+Catalog metadata is distinct from verification. get_capabilities reports whether a tool, PDK, or deck is ready on the current machine and includes a remedy for blocked items. Registering a PDK or cell does not imply a design has passed its checks.
+
+## Routing
+
+- PDK bytes, profiles, and setup probes → [interfaces](../interfaces/README.md) and [provision plan](../../docs/provision-plan.md).
+- Project component state and revisions → [project](../project/README.md).
+- Adapter execution → [adapters](../adapters/README.md).
+- Product PDK model → [PRD PDK abstraction](../../../PRD/tools-research/pdk-abstraction.md).

rocket_engine/library/__init__.py

@@ -0,0 +1,13 @@
+"""PDK registry, prepared-profile catalog, IP search/register/instantiate."""
+
+from .apig_catalog import ApigCatalog, gdsfactory_provider, static_provider
+from .catalog import Catalog
+from .errors import LibraryError
+
+__all__ = [
+    "ApigCatalog",
+    "Catalog",
+    "LibraryError",
+    "gdsfactory_provider",
+    "static_provider",
+]