Skip to content

ASTRODYN-CORE Documentation

ASTRODYN-CORE is builder-first astrodynamics tooling that keeps Orekit APIs first-class while adding typed configuration, state-file workflows, and mission/uncertainty helpers.

This docs site is the user-facing guide for learning and using the project.

Start here

If you are new to the project, follow this path:

  1. Install
  2. Orekit data setup
  3. First propagation
  4. Run examples

Choose a learning path

If you already know what you want to do, use one of these paths:

Documentation map

  • Getting Started: shortest path to a working propagation run
  • Tutorials: guided workflows based on the example scripts
  • How-To / Cookbook: focused recipes for specific tasks
  • Reference: API docs, troubleshooting, and advanced links

ASTRODYN-CORE exposes two practical usage tiers:

  • Facade-first (recommended): start with AstrodynClient
  • Advanced: use PropagatorFactory, ProviderRegistry, and typed specs directly

See README.md in the repo root for a broader project overview and current feature status.

What to expect from the docs

  • Tutorials are based on the runnable scripts in examples/
  • How-to pages are task-oriented recipes (shorter than tutorials)
  • API reference is generated from docstrings and improves as coverage increases

If a page feels incomplete, check the corresponding example script first and use that as the executable reference.