Metadata-Version: 2.4
Name: ssapy-toolkit
Version: 1.0.1
Summary: SSAPy Toolkit: extensions for orbital mechanics, plotting, and data IO
Author-email: "Travis R. Yeager" <yeagerastro@gmail.com>
License: BSD 3-Clause License
        
        Copyright (c) 2026, Lawrence Livermore National Laboratory
        
        Redistribution and use in source and binary forms, with or without
        modification, are permitted provided that the following conditions are met:
        
        1. Redistributions of source code must retain the above copyright notice, this
           list of conditions and the following disclaimer.
        
        2. Redistributions in binary form must reproduce the above copyright notice,
           this list of conditions and the following disclaimer in the documentation
           and/or other materials provided with the distribution.
        
        3. Neither the name of the copyright holder nor the names of its
           contributors may be used to endorse or promote products derived from
           this software without specific prior written permission.
        
        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
        
Project-URL: Homepage, https://github.com/llnl/SSAPy-Toolkit
Project-URL: Repository, https://github.com/llnl/SSAPy-Toolkit
Project-URL: Issues, https://github.com/llnl/SSAPy-Toolkit/issues
Project-URL: Documentation, https://ssapy-toolkit.readthedocs.io/
Keywords: orbital-mechanics,astrodynamics,visualization,utilities
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Operating System :: OS Independent
Classifier: Topic :: Scientific/Engineering :: Astronomy
Classifier: Topic :: Scientific/Engineering :: Visualization
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: astropy
Requires-Dist: astroquery
Requires-Dist: corner
Requires-Dist: emcee
Requires-Dist: gitpython
Requires-Dist: h5py
Requires-Dist: imageio
Requires-Dist: imageio-ffmpeg
Requires-Dist: ipykernel
Requires-Dist: ipympl
Requires-Dist: ipython
Requires-Dist: ipytree
Requires-Dist: ipyvolume
Requires-Dist: jplephem
Requires-Dist: llnl-ssapy
Requires-Dist: lmfit
Requires-Dist: matplotlib
Requires-Dist: mpmath
Requires-Dist: nexusformat
Requires-Dist: npy-append-array
Requires-Dist: numpy
Requires-Dist: opencv-python
Requires-Dist: pandas
Requires-Dist: pillow
Requires-Dist: psutil
Requires-Dist: pyerfa
Requires-Dist: PyPDF2
Requires-Dist: rebound
Requires-Dist: regex
Requires-Dist: requests
Requires-Dist: scikit-learn
Requires-Dist: seaborn
Requires-Dist: selenium
Requires-Dist: sympy
Requires-Dist: tqdm
Requires-Dist: spacetrack
Requires-Dist: vg
Provides-Extra: dev
Requires-Dist: pytest; extra == "dev"
Requires-Dist: pytest-mpi; extra == "dev"
Requires-Dist: sphinx; extra == "dev"
Requires-Dist: sphinx-rtd-theme; extra == "dev"
Requires-Dist: myst-parser<4.0.0; extra == "dev"
Requires-Dist: ruff; extra == "dev"
Requires-Dist: build; extra == "dev"
Requires-Dist: twine; extra == "dev"
Dynamic: license-file

# 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.

```bash
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:

```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:

```bash
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):

```bash
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.
