Installation

Base Installation

Use pip for user/runtime installs:

pip install adam_core

Optional Installation Profiles

Use extras when your analysis requires additional capabilities.

Pip Extras

# plotting and visualization helpers used in impact analysis
pip install "adam_core[plots]"

# OEM export/import helpers
pip install "adam_core[oem]"

Propagator Backends

Propagation and ephemeris generation depend on a compatible propagator implementation. A common setup is adam-assist:

pip install adam-assist

Development with PDM

For contributor/development tasks, use PDM in a cloned repository checkout:

# install runtime + test + docs dependency groups
pdm install -G test -G docs

# run documentation builds
pdm run docs
pdm run docs-check

Read the Docs and Self-Hosting

  • Canonical hosted docs target: Read the Docs.

  • Local/self-hosted build command from a development environment:

pdm run docs

For strict CI-style checks:

pdm run docs-check