Run Examples¶

The project ships executable examples and cookbook scripts. Treat them as the source of truth for runnable workflows while the tutorials/docs expand.

Two kinds of examples in the docs ecosystem¶

Docs-embedded examples (self-contained): copy-paste snippets in tutorial/how-to pages for pip users
Repo examples (examples/): fuller scripts for repo users and contributors

Recommended usage:

If you installed with pip, start with docs-embedded examples first
If you cloned the repo, use the examples/ scripts as executable references

The goal is for docs pages to remain useful even when the examples/ folder is not available in your installation.

Core entry-point examples¶

Run from the repo root:

conda run -n astrodyn-core-env python examples/quickstart.py --mode all
conda run -n astrodyn-core-env python examples/scenario_missions.py --mode all
conda run -n astrodyn-core-env python examples/uncertainty.py
conda run -n astrodyn-core-env python examples/geqoe_propagator.py --mode all

Cookbook examples¶

conda run -n astrodyn-core-env python examples/cookbook/multi_fidelity_comparison.py
conda run -n astrodyn-core-env python examples/cookbook/force_model_sweep.py
conda run -n astrodyn-core-env python examples/cookbook/ephemeris_from_oem.py

Generated outputs¶

Many examples write outputs to:

examples/generated/

Typical outputs include:

plots (.png)
state series (.yaml, .h5)
enriched scenario/state files

Choosing an example¶

New user: examples/quickstart.py
State-file / mission workflows: examples/scenario_missions.py
Covariance/STM: examples/uncertainty.py
GEqOE: examples/geqoe_propagator.py

See examples/README.md for mode breakdowns and script-specific notes.

Documentation growth path (what to expect)¶

New docs pages are being written with a consistent pattern:

Self-contained example (works for package users)
Extended repo example (links to examples/...)
API/reference links (for deeper exploration)

This keeps the docs useful for both package users and repo contributors.