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

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.2.tar.gz (227.4 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.2-py3-none-any.whl (299.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ssapy_toolkit-1.0.2.tar.gz
  • Upload date:
  • Size: 227.4 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.2.tar.gz
Algorithm Hash digest
SHA256 f8067eae3292a99e4e30c060ae5dbffdeeab429e98d0b9e875e852fc2e6edcf9
MD5 4afa47925eb2b0f995df3272ede00c4f
BLAKE2b-256 0209e08f801ab68ebe3c8c1ad39188b1598c4320df0795cec984d05303ffd027

See more details on using hashes here.

Provenance

The following attestation bundles were made for ssapy_toolkit-1.0.2.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.2-py3-none-any.whl.

File metadata

  • Download URL: ssapy_toolkit-1.0.2-py3-none-any.whl
  • Upload date:
  • Size: 299.1 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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 b9b165a8de5fc472b2752e8c9d8820e641a5a6265aaceb5528467d845e38776f
MD5 74bd20e6ce19d4f63766d1690eff2a76
BLAKE2b-256 606c9e28964b026f27870e94b41822cbef9b675d46565d465b23cd138d023606

See more details on using hashes here.

Provenance

The following attestation bundles were made for ssapy_toolkit-1.0.2-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