Skip to content

Latest commit

 

History

History
77 lines (55 loc) · 6.29 KB

DEMO.md

File metadata and controls

77 lines (55 loc) · 6.29 KB

Steps:

0. Start Docker daemon:

Needed for Structure facets (MinIO scratch + Plant / KubeRay), not Docker Kubo T&D peers (retired).

1. Content store + Node lifecycle: see NodeLifeCycle.md (optional Kubo: IPFS.md)

Live Orders use Node CAS-over-HTTP. Host Kubo is optional operator tooling. Node start soft-probes ContentStore and does not hard-require Kubo. See NodeLifeCycle.md.

2. Create the environment and install dependencies in Terminal C:
# CATs working directory
cd cats
uv sync --extra ops

uv sync creates/updates .venv from the locked dependencies (uv.lock); --extra ops adds Marimo, Ray, and pandas for the mesh workflow. uv run (below) uses this environment automatically — no manual activation needed.

3. Deploy CAT Node in Terminal A:

Follow NodeLifeCycle.md (or Get Started!).

make node-start              # soft-probes ContentStore; Kubo not required for CAS-only
# optional: make node-up     # content-store-ensure && node-start (brings Kubo tooling up too)
make node-stop               # Flask only — host Kubo left running if you started it
4. Establish Data (CAT) Mesh in Terminal B: Demo

Execute CATs on a single-node Mesh via Marimo — the REPLaC (REPL as Code) Workflow UI of Function [FaaS], used to compose Process [Composed Function] (transport callables plus a Higher-Order Transfer Function / hotF, integrated_subproc) for InfraFunction [Actuator] to dispatch onto Plant [SaaS]. Function sources are packaged as data/input/function/process/ and data/input/function/infrafunction/ (import the package public surfaces). Compose Orders with named imports of the Process public surface only (ingress, egress, integration_cache, process_*, … — see process.__all__); never from data.input.function.process import *. Stock surfaces are Order-bound as named-bind JSON leaves (contentId + optional source_uri / module / qualname); non-stock REPL callables still pickle. Across runs, linkProcess mutates Function lineage, linkStructure mutates Structure lineage, and linkOrder mutates Function and/or Structure in one lineage step (all chain prior Invoice data equality via data_uri / ni:). Each link* accepts a prior HTTP cat_response or content_id= / data_uri= / bom_uri= / hl= resolved through the Node-local BOM registry (GET /ldp/registry/…; see BomRegistry.md). Legacy bom_cid= / data_cid= are rejected. Recreate Orders after Function module-path or bind-shape changes.

What you should see after CAT0 catSubmit: HTTP envelope with content_id, bom_ldp_uri, optional hl / bom_solid_uri; signed bom carrying invoice_uri / log_uri / node_did + Data Integrity proof. Order URI is on the Invoice (invoice.order_uri), not on the HTTP envelope. flatten_bom (CAT1 in the demos) returns {invoice, log} with uri slots kept and fetched JSON under each parent’s flat (max_depth=4 by default) — it does not mutate the envelope. CAT1 uses linkProcess (Function lineage) — not a second independent create_order_request.

Marimo’s working directory is notebooks/. from cats import … does not import Order Function sources (cats/ must not import data). The registry-first demo’s cat0_create_order cell inserts CATS_HOME on sys.path before named Process imports. For cats_demo.py (or any cell that imports data without that insert), run with the repo on PYTHONPATH:

# primary registry-first lineage (linkProcess via content_id= / bom_ldp_uri=):
uv run marimo edit notebooks/cats_lineage_demo.py
# mesh establish / cells that import data without the CATS_HOME insert:
PYTHONPATH=. uv run marimo edit notebooks/cats_demo.py
# out-of-loop SPDX / CDX / DCAT projections (catalog-first; does not remint):
uv run marimo edit notebooks/cats_bom_projections_demo.py

After CAT0 catSubmit, cats_lineage_demo.py runs the same library helpers as the unit suites: registry index parity, handoff projection completeness, claims reachability, then control-plane handoff coherence, then content equivalence (assert_*_content_equiv before flatten), then stageLineage directory-manifest hops (assert_directory_manifest_equiv / assert_stage_lineage_payload_equiv) — not “all HTTP content ∈ registry.”

Not in this notebook (cats_lineage_demo.py): this walk is demo-proved on one Structure (KubeRay + MinIO + CAS), not interop-proved (same Function CID graph on ≥2 Structure adapter sets) — see INTEROP.md.

  • BOM projections (SPDX 3 / CycloneDX / DCAT 3) — living §6u walk cats_bom_projections_demo.py; catalog-first project_bom. P3 cells read Invoice runtime_sbom_uri after a one-shot CATS_SBOM=1 remint. This lineage notebook stays flag-off.
  • linkStructure (Structure mutation) — Order op to swap Plant while carrying Function; required for INTEROP 2f / P2. This notebook exercises linkProcess only.
  • mesh-federated registry — link* here uses the Node-local index (BomRegistry.md, linked from INTEROP); federation is a remaining discovery gap, not a second Plant.
  • dataframe transform checks (tests/test_provenance.py) — live integration on this same demo stack (TEST.md); not a second Structure. CAT1 does run the record helpers (handoff / content-equiv / stageLineage / as-executed) on its envelope after lineage asserts.

Cells re-run reactively as dependencies change; work through the notebook top to bottom. See BomRegistry.md for the Python registry guide.

5. (Optional) Envelope-held walk: old_cats_demo.py

Earlier demo that holds cat_response in-notebook (not registry-first). Needs the repo on PYTHONPATH:

PYTHONPATH=. uv run marimo edit notebooks/old_cats_demo.py