Skip to content

Use the Ophiolite CLI

The pilot CLI keeps service addresses, project IDs and private credential files out of the ordinary scientific workflow. It uses the same public authorization and publication contracts as the existing Python examples; it does not host computation.

In your project, open Connect → Use Python, select a permitted input and save its curve/output configuration. Download the input configuration and the Python kit. Unzip the kit and put configuration.json in that directory. The configuration contains no secrets. With Python 3.12 or later for the bundled examples, open a terminal there:

Terminal window
python3 -m venv .venv
source .venv/bin/activate
python -m pip install .
python -m pip install -r requirements.txt
ophiolite login --write
ophiolite status

The browser asks you to approve your own account and project. No database connection string, pooler, port choice or copied access token is needed. A separate private credential cache is used for each service/project. For two identities in one project, use separate operating-system profiles or pass a separate --credentials path to each command. --configuration selects another downloaded configuration.

For Append new derived curves, adapt the kit’s example and parameter file:

Terminal window
ophiolite prepare --script alice.py --parameters alice-parameters.json --work run
ophiolite run --work run
# Inspect run/curves.json and scientific outputs.
ophiolite publish --work run
  • prepare resolves the permitted exact input and records a run. It does not run code.
  • run executes your selected script locally using your Python environment and OS permissions. Review code first; this is not a sandbox. No remote execution is promised.
  • publish validates and commits the output as a separate managed asset. Sharing remains a separate action in Workspace.

The supplied Alice/Bob scripts are NLOG-specific examples. Choose appropriate units, curves, intervals and parameters for your task. CLI configuration does not certify a calculation. Existing depth, channels and missing samples are preserved under the supported derived-curve contract.

For Edit existing curve values, the bounded offset example is:

Terminal window
ophiolite correct --start 100 --stop 103 --offset 2 --output correction --publish

This command both computes and publishes; --publish is required explicitly. Those numbers are synthetic examples, not recommended parameters for real logs.

After an interrupted prepare or publish, repeat the same command with the same run directory. Changed code/parameters require a new directory. Do not alter frozen checkpoints or receipts. Reauthorize with ophiolite login --write when access expires. ophiolite logout revokes the application grant and removes its local credentials. Workspace sign-in and application authorization are separate sessions.

Version 0.1 is a pilot package downloaded from Ophiolite, not a published package-index name, broad SDK or managed execution service. Existing standalone helpers remain compatible. Use ophiolite --help and command-specific --help for options.