Skip to main content

SSAPy Toolkit: extensions for orbital mechanics, plotting, and data IO

Project description

SSAPy Toolkit

SSAPy Toolkit (Python package: ssapy_toolkit) is a collection of extensions for the SSAPy ecosystem, providing tools for orbital mechanics, plotting, and data IO to support research and engineering workflows.

SSAPy itself is a fast, flexible, high-fidelity orbital modeling and analysis tool for orbits spanning from low-Earth orbit into the cislunar regime. It supports rich satellite definitions, multiple element types and coordinate frames, configurable force models (Earth and lunar gravity, radiation pressure, drag, planetary perturbations, maneuvers), a variety of integrators, Monte Carlo and UQ workflows, and extensive ground/space observer and plotting capabilities. See the SSAPy repository for full details:

https://github.com/llnl/SSAPy/tree/main


Features

  • Utility functions for orbital mechanics and astrodynamics
  • Coordinate transforms and time conversions
  • Data IO helpers for HDF5, CSV, JSON, and more
  • Plotting helpers for orbits, ground tracks, and dashboards

Installation

SSAPy Toolkit is a standard Python package.

python -m venv .venv
source .venv/bin/activate  # On Windows: .venv\Scripts\activate
pip install --upgrade pip
pip install -e .[dev]

This installs the package in editable mode along with development dependencies (testing, linting, docs tools, etc.).


Usage

Once installed, you can import the package in Python:

import ssapy_toolkit as st

from ssapy_toolkit.orbital_mechanics import keplerian
from ssapy_toolkit.plots import orbit_plot

More detailed examples can be found in the demos/ directory.


Development

To run the test suite:

pytest demos

or to build a visualization document of the full test suite:

ssapy-demo-gallery

Code formatting and linting are handled via ruff (see pyproject.toml for configuration).


Documentation

Project documentation is built with Sphinx and hosted on Read the Docs. Once configured, you will be able to find the latest documentation at:

https://ssapy-toolkit.readthedocs.io

To build the docs locally (after installing dev dependencies):

cd docs
make html

The built HTML files will be in docs/_build/html/.


License

This project is licensed under the BSD 3-Clause License. See the LICENSE file for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ssapy_toolkit-1.0.3.tar.gz (227.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ssapy_toolkit-1.0.3-py3-none-any.whl (299.6 kB view details)

Uploaded Python 3

File details

Details for the file ssapy_toolkit-1.0.3.tar.gz.

File metadata

  • Download URL: ssapy_toolkit-1.0.3.tar.gz
  • Upload date:
  • Size: 227.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for ssapy_toolkit-1.0.3.tar.gz
Algorithm Hash digest
SHA256 f5673fb6703495e47760b908648651c7de9cd7a93f8cc0a7d7803d73ea3efe5b
MD5 d4907a06ba617a10ed1e8b848de40c98
BLAKE2b-256 e775be027536a2982c26a8c1ef8cdec6eea9667fafd757d8a13bdd49b2591cb2

See more details on using hashes here.

Provenance

The following attestation bundles were made for ssapy_toolkit-1.0.3.tar.gz:

Publisher: publish.yml on llnl/SSAPy-Toolkit

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file ssapy_toolkit-1.0.3-py3-none-any.whl.

File metadata

  • Download URL: ssapy_toolkit-1.0.3-py3-none-any.whl
  • Upload date:
  • Size: 299.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for ssapy_toolkit-1.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 d2ff318be2b4f9d69cb74697f8fb06c764cf77795fa67832d4a333ed74e9ee98
MD5 8dcd808103bef018838ac2a5bf019763
BLAKE2b-256 f04126b0434a46ce1b433e6a4c4529e49cf62fe6c7a221c6ec7421c9262300c8

See more details on using hashes here.

Provenance

The following attestation bundles were made for ssapy_toolkit-1.0.3-py3-none-any.whl:

Publisher: publish.yml on llnl/SSAPy-Toolkit

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page