10-Minute Quickstart
Audience: first-time builders
Status: Preview
This quickstart is designed around the public surfaces that exist today. It proves the local runtime, interface split, project/package persistence, and core nouns without pretending every asset family is equally mature yet.
0. Run the install doctor
Section titled “0. Run the install doctor”ophiolite doctorThe doctor output is JSON so it can be used in support tickets and CI. In the preview build, a missing license certificate is a warning rather than a blocker.
1. Create a project
Section titled “1. Create a project”from ophiolite_sdk import Project
project = Project.create("demo-project")summary = project.summary()print(summary.root)print(summary.well_count)print(len(project.wells()))2. Inspect an implemented source-file slice
Section titled “2. Inspect an implemented source-file slice”cargo run --quiet --manifest-path Cargo.toml -p ophiolite-cli -- inspect-file .\examples\sample.lasThe current fastest source-file example uses LAS because that importer is mature. It is an implemented slice of the platform, not the definition of Ophiolite.
3. Materialize a standalone package
Section titled “3. Materialize a standalone package”cargo run --quiet --manifest-path Cargo.toml -p ophiolite-cli -- import .\examples\sample.las .\demo-log.laspkg4. Inspect the package
Section titled “4. Inspect the package”cargo run --quiet --manifest-path Cargo.toml -p ophiolite-cli -- summary .\demo-log.laspkgcargo run --quiet --manifest-path Cargo.toml -p ophiolite-cli -- list-curves .\demo-log.laspkg5. Inspect project wells from Python
Section titled “5. Inspect project wells from Python”from ophiolite_sdk import Project
project = Project.open("demo-project")print(project.summary().well_count)print(len(project.wells()))6. Run the evaluator proof workflow
Section titled “6. Run the evaluator proof workflow”The current backend-first evaluator path is the TraceBoost AGC procedure bundle. For the full evaluator path, see Evaluator Proof Workflow.
It resolves a typed seismic amplitude attribute from a generated tiny tbvol fixture, plans a linear procedure, executes seismic:trace_local.amplitude_scalar -> seismic:trace_local.agc_rms, and writes evidence files.
cargo xtask evaluator-proofInspect target\evaluator\post_stack_agc\report.md for the readable report, or report.json for durable run evidence. The bundle proves typed attribute resolution, procedure planning, AGC execution, assertions, artifact digests, source fingerprints, timings, and report rendering. It does not yet prove SEG-Y import, materialized product outputs, interpretation correctness, or production-scale performance.
For the current product proof output path, run:
cargo xtask product-proofThat writes target\product\post_stack_agc\ with the same AGC procedure evidence and a materialized artifacts\derived_agc.tbvol\ output.
The checked-in reference artifacts are in the TraceBoost AGC procedure bundle. The milestone status and accepted gaps are tracked in Evaluator Workflow MVP Status, with operator-family direction in the Operator Family Roadmap.
The checked-in product proof snapshot is in the TraceBoost AGC product bundle. Product status is tracked in Product Workflow MVP Status.
To inspect that product proof through the desktop app, continue to TraceBoost Bundle Viewer.
What you proved
Section titled “What you proved”- the Rust runtime is installed
- Python can create and query a local project
- Python speaks in project and well-domain nouns first
- the CLI can inspect and package source data
- TraceBoost can execute the current procedure workflow proof over a
tbvolfixture - source-specific examples can sit under the broader project, asset, operator, provenance, and persistence story
What comes next
Section titled “What comes next”If you want a builder workflow, continue to Build Workflows. If you want extensibility, go straight to Operators.