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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file ssapy_toolkit-1.0.0.tar.gz.
File metadata
- Download URL: ssapy_toolkit-1.0.0.tar.gz
- Upload date:
- Size: 220.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.10.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
5a52603dcc721417ecde7f3c63a0158e2cef2701f151c8d1b0ff65346ea180e7
|
|
| MD5 |
6aa7f077d92bbbf6a0c9baac6593708d
|
|
| BLAKE2b-256 |
c61474b1f3ffad2fb6615905df1091f17503d85992b80473e1ffc740e45e3e03
|
File details
Details for the file ssapy_toolkit-1.0.0-py3-none-any.whl.
File metadata
- Download URL: ssapy_toolkit-1.0.0-py3-none-any.whl
- Upload date:
- Size: 290.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.10.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
7edb4a1281532a8b1dbbdc2150005bff27e39b4d7438fa6d721a3d35385fb231
|
|
| MD5 |
f23043089e1f7a36bdf6bd6edbe5b97b
|
|
| BLAKE2b-256 |
021f1650f0acf0cf8933d009375974ebd680be61b805d117d538e18f7b0c4ff3
|