Examples

Explore comprehensive examples demonstrating OptixLog integration with various simulation and experiment frameworks.

Meep Examples

FDTD photonic simulations with Meep — waveguides, resonators, gratings, and more

Coming Soon

COMSOL Examples

Finite element simulations with COMSOL Multiphysics

Lumerical Examples

Photonic design with Lumerical FDTD and MODE

Hardware Testing

Lab measurement and hardware characterization workflows

Example Structure

All examples follow a consistent pattern for OptixLog integration:

from optixlog import Optixlog

# Initialize client
client = Optixlog(api_key="your_api_key")
project = client.project(name="MyProject", create_if_not_exists=True)

# Create a run with configuration
run = project.run(
    name="simulation_run",
    config={"param1": value1, "param2": value2}
)

# Run your simulation...

# Log results
run.log(step=0, metric1=value, metric2=value)
run.log_matplotlib("plot_name", fig)

Getting Started

Install OptixLog — pip install optixlog
Set your API key — export OPTIX_API_KEY="your_key"
Choose an example — Pick from the categories above
Run and track — Execute the example and view results on optixlog.com

All Examples