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.1.tar.gz (220.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.1-py3-none-any.whl (290.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ssapy_toolkit-1.0.1.tar.gz
  • Upload date:
  • Size: 220.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.1.tar.gz
Algorithm Hash digest
SHA256 6c691282bf1dc19716c5ed099f23451555767572c334d585048213030bdc6b05
MD5 9b9ca089cf773b370ab7f631bff2ec17
BLAKE2b-256 4fed254cdbd4a72de70b597c77482e545fd23a47e768940f822e02c0b796e307

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: ssapy_toolkit-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 290.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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 e321669e7c264f99ab4ef7820b16c6ab80e633459c632a5553e997be10ff14a1
MD5 76409d8f342e7673d3cfd938a2de8882
BLAKE2b-256 f0942c49d2c08cea39d6282590b0a41b63d6fdecda7f006671a14a297a0f8159

See more details on using hashes here.

Provenance

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