Getting Started

The fastest path from zero to your first ingest — install, authenticate, generate bindings, and write a node into the graph.

This section takes you from a fresh environment to a running OptixLog ingest. The path has four steps: install the package, authenticate with your API key, initialize your project config, and generate typed bindings.

Fastest path

If you just want to see everything work right now using a local fixture (no server required):

pip install optixlog

optixlog login    --fixture tests/fixtures/schema.sample.json --api-key sk-opt-test --base-url http://x
optixlog init     --fixture tests/fixtures/schema.sample.json --all --output optixlog_gen.py
optixlog generate --fixture tests/fixtures/schema.sample.json

Then use the generated client:

from optixlog_gen import OptixClient, Projects, SimulationNode

client = OptixClient()
client.project(Projects.GRATING_COUPLER_LAB).ingest(
    data=SimulationNode(config={}, solver="fdtd"),
    prompt="Simulated a grating coupler.",
)