llnl-ssapy 1.0.0__tar.gz

llnl_ssapy-1.0.0/CMakeLists.txt

@@ -0,0 +1,61 @@
+# Minimum required CMake version
+cmake_minimum_required(VERSION 3.15)
+
+# Set policies for compatibility
+cmake_policy(SET CMP0048 NEW)  # Project version policy
+cmake_policy(SET CMP0063 NEW)  # Visibility preset policy
+
+# Project settings
+project(ssapy VERSION 1.0 LANGUAGES CXX)
+
+# Compiler settings
+set(CMAKE_CXX_STANDARD 17)                # Use C++17 standard
+set(CMAKE_CXX_STANDARD_REQUIRED ON)       # Require C++17
+set(CMAKE_CXX_EXTENSIONS OFF)             # Disable compiler-specific extensions
+set(CMAKE_CXX_VISIBILITY_PRESET hidden)   # Hide symbols by default
+set(CMAKE_POSITION_INDEPENDENT_CODE ON)   # Enable position-independent code (PIC)
+
+# macOS-specific settings
+set(CMAKE_MACOSX_RPATH 1)
+
+# Output directories
+if(NOT CMAKE_LIBRARY_OUTPUT_DIRECTORY)
+    set(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/lib)  # Set default output directory for libraries
+endif()
+
+# Find Python
+find_package(Python3 REQUIRED COMPONENTS Interpreter Development.Module)
+set(PYTHON_MODULE_INSTALL_DIR "${Python3_SITEARCH}/ssapy")
+
+# Include pybind11 using FetchContent
+include(FetchContent)
+FetchContent_Declare(
+    pybind11
+    GIT_REPOSITORY https://github.com/pybind/pybind11.git
+    GIT_TAG        v2.11.1
+)
+FetchContent_MakeAvailable(pybind11)
+
+# Include directories
+include_directories(${CMAKE_CURRENT_SOURCE_DIR}/include)
+
+# Define the Python module target (_ssapy)
+pybind11_add_module(_ssapy pysrc/ssapy.cpp)
+
+# Ensure the Python module is installed in the correct location
+set(CMAKE_POSITION_INDEPENDENT_CODE True)
+install(TARGETS _ssapy
+    LIBRARY DESTINATION ssapy # Install the compiled module in Python's site-packages
+)
+
+# Define a static library target (ssapy)
+add_library(ssapy STATIC src/ssapy.cpp)
+
+# Link the static library to the Python module
+target_link_libraries(_ssapy PUBLIC ssapy)
+
+# Add the header file explicitly to the static library target
+target_sources(ssapy PRIVATE include/ssapy.h)
+
+# Ensure the header file is included in the Python module target
+target_include_directories(_ssapy PRIVATE ${CMAKE_CURRENT_SOURCE_DIR}/include)

llnl_ssapy-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018, Lawrence Livermore National Security, LLC
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

llnl_ssapy-1.0.0/MANIFEST.in

@@ -0,0 +1,16 @@
+include README.rst
+include LICENSE
+include pyproject.toml
+include CMakeLists.txt
+
+include include/*.h
+include pysrc/*.cpp
+include src/*.cpp
+
+recursive-include pybind11/include/ *
+include pybind11/CMakeLists.txt
+include pybind11/LICENSE
+recursive-include pybind11/tools *
+recursive-include ssapy *.so
+
+recursive-exclude ssapy/data *

llnl_ssapy-1.0.0/NOTICE

@@ -0,0 +1,7 @@
+This work was produced under the auspices of the U.S. Department of Energy by Lawrence Livermore National Laboratory under Contract DE-AC52-07NA27344.
+
+This work was prepared as an account of work sponsored by an agency of the United States Government. Neither the United States Government nor Lawrence Livermore National Security, LLC, nor any of their employees makes any warranty, expressed or implied, or assumes any legal liability or responsibility for the accuracy, completeness, or usefulness of any information, apparatus, product, or process disclosed, or represents that its use would not infringe privately owned rights.
+
+Reference herein to any specific commercial product, process, or service by trade name, trademark, manufacturer, or otherwise does not necessarily constitute or imply its endorsement, recommendation, or favoring by the United States Government or Lawrence Livermore National Security, LLC.
+
+The views and opinions of authors expressed herein do not necessarily state or reflect those of the United States Government or Lawrence Livermore National Security, LLC, and shall not be used for advertising or product endorsement purposes.

llnl_ssapy-1.0.0/PKG-INFO

@@ -0,0 +1,207 @@
+Metadata-Version: 2.1
+Name: llnl-ssapy
+Version: 1.0.0
+Summary: A fast, flexible, high-fidelity orbital modeling and analysis tool for orbits spanning from low-Earth orbit into the cislunar regime.
+Author-email: LLNL SSAPy Software Team <yeagerastro@gmail.com>
+License: MIT License
+        
+        Copyright (c) 2018, Lawrence Livermore National Security, LLC
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Project-URL: Homepage, https://github.com/LLNL/SSAPy
+Project-URL: Issues, https://github.com/LLNL/SSAPy/issues
+Project-URL: Documentation, https://software.llnl.gov/SSAPy/
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.8
+Description-Content-Type: text/x-rst
+License-File: LICENSE
+License-File: NOTICE
+Requires-Dist: numpy
+Requires-Dist: scipy
+Requires-Dist: astropy
+Requires-Dist: pyerfa
+Requires-Dist: emcee
+Requires-Dist: lmfit
+Requires-Dist: sgp4
+Requires-Dist: matplotlib
+Requires-Dist: pandas
+Requires-Dist: h5py
+Requires-Dist: pypdf2
+Requires-Dist: imageio
+Requires-Dist: ipython
+Requires-Dist: ipyvolume
+Requires-Dist: ipython_genutils
+Requires-Dist: jplephem
+Requires-Dist: tqdm
+Requires-Dist: myst-parser
+Requires-Dist: graphviz
+
+SSAPy - Space Situational Awareness for Python
+==============================================
+
+|ci_badge|  |docs_badge| |codecov_badge| |joss_badge|
+
+.. |ci_badge| image:: https://github.com/LLNL/SSAPy/actions/workflows/ci.yml/badge.svg
+    :target: https://github.com/LLNL/SSAPy/actions/workflows/ci.yml
+
+.. |docs_badge| image:: https://github.com/LLNL/SSAPy/actions/workflows/pages/pages-build-deployment/badge.svg
+    :target: https://LLNL.github.io/SSAPy
+
+.. |codecov_badge| image:: https://codecov.io/gh/LLNL/SSAPy/branch/main/graph/badge.svg
+    :target: https://codecov.io/gh/LLNL/SSAPy
+
+.. |joss_badge| image:: https://joss.theoj.org/papers/a629353cbdd8d64a861bb807e12c5d06/status.svg
+   :target: https://joss.theoj.org/papers/a629353cbdd8d64a861bb807e12c5d06
+
+`SSAPy <https://github.com/LLNL/SSAPy>`_ is a fast, flexible, high-fidelity orbital modeling and analysis tool for orbits spanning from low-Earth orbit into the cislunar regime, and includes the following:
+
+- Ability to define satellite parameters (area, mass, radiation and drag coefficients, etc.)
+- Support for multiple data types (e.g., read in orbit from TLE file, define a set of Keplerian, Equinoctial, or Kozai Mean Keplerian elements, etc.)
+- Define a fully customizable analytic force propagation model including the following:
+    - Earth gravity models (WGS84, EGM84, EGM96, EGM2008)
+    - Lunar gravity model (point source & harmonic)
+    - Radiation pressure (Earth & solar)
+    - Forces for all planets out to Neptune
+    - Atmospheric drag models
+    - Maneuvering (takes a user defined burn profile)
+- Various community used integrators: SGP4, Runge-Kutta (4, 8, and 7/8), SciPy, Keplerian, Taylor Series
+- User definable timesteps with the ability to return various parameters for any orbit and at any desired timestep (e.g., magnitude, state vector, TLE, Keplerian elements, periapsis, apoapsis, specific angular momentum, and many more.)
+- Ground and space-based observer models
+- Location and time of various lighting conditions of interest
+- Multiple-hypothesis tracking (MHT) UCT linker
+- Vectorized computations (use of array broadcasting for fast computation, easily parallelizable and deployable on HPC machines)
+- Short arc probabilistic orbit determination methods
+- Conjunction probability estimation
+- Built-in uncertainty quantification
+- Support for Monte Carlo runs and data fusion
+- Support for multiple coordinate frames and coordinate frame conversions (GCRF, IERS, GCRS Cartesian, TEME Cartesian, ra/dec, NTW, zenith/azimuth, apparent positions, orthoginal tangent plane, and many more.)
+- Various plotting capabilities (ground tracks, 3D orbit plotting, cislunar trajectory visualization, etc.)
+- User definable timesteps and orbit information retrieval times, in which the user can query parameters of interest for that orbit and time.
+
+Installation
+------------
+
+For installation details, see the `Installing SSAPy <https://LLNL.github.io/SSAPy/installation.html>`_ section of the documentation.
+
+Strict dependencies
+-------------------
+
+- `Python <http://docs.python-guide.org/en/latest/starting/installation/>`_ (3.8+)
+
+The following are installed automatically when you install SSAPy:
+
+- `numpy <https://scipy.org/install.html>`_;
+- `scipy <https://scipy.org/scipylib/index.html>`_ for many statistical functions;
+- `astropy <https://www.astropy.org/>`_ for astronomy related functions;
+- `pyerfa <https://pypi.org/project/pyerfa/>`_ a Python wrapper for the ERFA library;
+- `emcee <https://pypi.org/project/emcee/>`_ an affine-invariant ensemble sampler for Markov chain Monte Carlo;
+- `lmfit <https://pypi.org/project/lmfit/>`_ a package for non-linear least-squares minimization and curve fitting;
+- `sgp4 <https://pypi.org/project/sgp4/>`_ contains functions to compute the positions of satellites in Earth orbit;
+- `matplotlib <https://matplotlib.org/>`_ as a plotting backend;
+- and other utility packages, as enumerated in `setup.py`.
+
+Documentation
+-------------
+
+All documentation is hosted at `https://LLNL.github.io/SSAPy/ <https://LLNL.github.io/SSAPy/>`_.
+
+The API documentation may also be seen by doing:
+
+.. code-block:: bash
+
+    python3
+    >>> import ssapy
+    >>> help(ssapy)
+
+Contributing
+------------
+
+Contributing to SSAPy is relatively easy. Just send us a `pull request <https://help.github.com/articles/using-pull-requests/>`_. When you send your request, make `main` the destination branch on the `SSAPy repository <https://github.com/LLNL/SSAPy>`_.
+
+Your PR must pass SSAPy's unit tests and documentation tests, and must be `PEP 8 <https://www.python.org/dev/peps/pep-0008/>`_ compliant. We enforce these guidelines with our CI process. To run these tests locally, and for helpful tips on git, see our `Contribution Guide <https://ssapy.reathedocs.io/en/latest/contribution_guide.html>`_.
+
+SSAPy's `main` branch has the latest contributions. Pull requests should target `main`, and users who want the latest package versions, features, etc. can use `main`.
+
+Releases
+--------
+
+For multi-user site deployments or other use cases that need very stable software installations, we recommend using SSAPy's `stable releases <https://github.com/LLNL/SSAPy/releases>`_.
+
+Each SSAPy release series also has a corresponding branch, e.g. `releases/v0.14` has `0.14.x` versions of SSAPy, and `releases/v0.13` has `0.13.x` versions. We backport important bug fixes to these branches but we do not advance the package versions or make other changes that would change the way SSAPy concretizes dependencies within a release branch. So, you can base your SSAPy deployment on a release branch and `git pull` to get fixes, without the package churn that comes with `main`.
+
+The latest release is always available with the `releases/latest` tag.
+
+See the `docs on releases <https://ssapy.reathedocs.io/en/latest/contribution_guide.html#releases>`_ for more details.
+
+Code of Conduct
+---------------
+
+Please note that SSAPy has a `Code of Conduct <https://github.com/LLNL/SSAPy/blob/main/CODE_OF_CONDUCT.md>`_. By participating in the SSAPy community, you agree to abide by its rules.
+
+Authors
+-------
+
+SSAPy was developed with support from Lawrence Livermore National Laboratory's (LLNL) Laboratory Directed Research and Development (LDRD) Program under projects
+`19-SI-004 <https://ldrd-annual.llnl.gov/archives/ldrd-annual-2021/project-highlights/high-performance-computing-simulation-and-data-science/madstare-modeling-and-analysis-data-starved-or-ambiguous-environments>`_ and
+`22-ERD-054 <https://ldrd-annual.llnl.gov/ldrd-annual-2023/project-highlights/space-security/data-demand-capable-space-domain-awareness-architecture>`_, by the following individuals (in alphabetical order):
+
+- `Robert Armstrong <https://orcid.org/0000-0002-6911-1038>`_ (`LLNL <https://www.llnl.gov/>`_)
+- `Nathan Golovich <https://orcid.org/0000-0003-2632-572X>`_ (`LLNL <https://www.llnl.gov/>`_)
+- `Julia Ebert <https://orcid.org/0000-0002-1975-772X>`_ (formerly `LLNL <https://www.llnl.gov/>`_, now at Fleet Robotics)
+- `Noah Lifset <https://orcid.org/0000-0003-3397-7021>`_ (formerly `LLNL <https://www.llnl.gov/>`_, now PhD student at `UT Austin <https://www.utexas.edu>`_)
+- `Dan Merl <https://orcid.org/0000-0003-4196-5354>`_ (`LLNL <https://www.llnl.gov/>`_) - Developer
+- `Joshua Meyers <https://orcid.org/0000-0002-2308-4230>`_ (formerly `LLNL <https://www.llnl.gov/>`_, now at `KIPAC <https://kipac.stanford.edu/>`_) - Former Lead Developer
+- `Caleb Miller <https://orcid.org/0000-0001-6249-0031>`_ (`LLNL <https://www.llnl.gov/>`_)
+- `Alexx Perloff <https://orcid.org/0000-0001-5230-0396>`_ (`LLNL <https://www.llnl.gov/>`_)
+- `Kerianne Pruett <https://orcid.org/0000-0002-2911-8657>`_ (formerly `LLNL <https://www.llnl.gov/>`_)
+- `Edward Schlafly <https://orcid.org/0000-0002-3569-7421>`_ (formerly `LLNL <https://www.llnl.gov/>`_, now `STScI <https://www.stsci.edu/>`_) - Former Lead Developer
+- `Michael Schneider <https://orcid.org/0000-0002-8505-7094>`_ (`LLNL <https://www.llnl.gov/>`_) - Creator, Former Lead Developer
+- `Travis Yeager <https://orcid.org/0000-0002-2582-0190>`_ (`LLNL <https://www.llnl.gov/>`_) - Current Lead Developer
+
+Many thanks go to SSAPy's other `contributors <https://github.com/llnl/ssapy/graphs/contributors>`_.
+
+
+Citing SSAPy
+^^^^^^^^^^^^
+
+On GitHub, you can copy this citation in APA or BibTeX format via the "Cite this repository" button.
+If you prefer MLA or Chicago style citations, see the comments in `CITATION.cff <https://github.com/LLNL/SSAPy/blob/main/CITATION.cff>`_.
+
+You may also cite the following publications (click `here <https://github.com/LLNL/SSAPy/blob/main/docs/source/citations.bib>`_ for list of BibTeX citations):
+
+ - Yeager, T., Pruett, K., & Schneider, M. (2022). *Unaided Dynamical Orbit Stability in the Cislunar Regime.* [Poster presentation]. Cislunar Security Conference, USA.
+ - Yeager, T., Pruett, K., & Schneider, M. (2023). *Long-term N-body Stability in Cislunar Space.* [Poster presentation]. Advanced Maui Optical and Space Surveillance (AMOS) Technologies Conference, USA.
+ - Yeager, T., Pruett, K., & Schneider, M. (2023, September). Long-term N-body Stability in Cislunar Space. In S. Ryan (Ed.), *Proceedings of the Advanced Maui Optical and Space Surveillance (AMOS) Technologies Conference* (p. 208). Retrieved from `https://amostech.com/TechnicalPapers/2023/Poster/Yeager.pdf <https://amostech.com/TechnicalPapers/2023/Poster/Yeager.pdf>`_
+
+License
+-------
+
+SSAPy is distributed under the terms of the MIT license. All new contributions must be made under the MIT license.
+
+See `Link to license <https://github.com/LLNL/SSAPy/blob/main/LICENSE>`_ and `NOTICE <https://github.com/LLNL/SSAPy/blob/main/NOTICE>`_ for details.
+
+SPDX-License-Identifier: MIT
+
+LLNL-CODE-862420
+
+Documentation Inspiration
+-------------------------
+The structure and organization of this repository's documentation were inspired by the excellent design and layout of the `Coffea <https://coffea-hep.readthedocs.io/en/latest/index.html>`_ project. 

llnl_ssapy-1.0.0/README.rst

@@ -0,0 +1,151 @@
+SSAPy - Space Situational Awareness for Python
+==============================================
+
+|ci_badge|  |docs_badge| |codecov_badge| |joss_badge|
+
+.. |ci_badge| image:: https://github.com/LLNL/SSAPy/actions/workflows/ci.yml/badge.svg
+    :target: https://github.com/LLNL/SSAPy/actions/workflows/ci.yml
+
+.. |docs_badge| image:: https://github.com/LLNL/SSAPy/actions/workflows/pages/pages-build-deployment/badge.svg
+    :target: https://LLNL.github.io/SSAPy
+
+.. |codecov_badge| image:: https://codecov.io/gh/LLNL/SSAPy/branch/main/graph/badge.svg
+    :target: https://codecov.io/gh/LLNL/SSAPy
+
+.. |joss_badge| image:: https://joss.theoj.org/papers/a629353cbdd8d64a861bb807e12c5d06/status.svg
+   :target: https://joss.theoj.org/papers/a629353cbdd8d64a861bb807e12c5d06
+
+`SSAPy <https://github.com/LLNL/SSAPy>`_ is a fast, flexible, high-fidelity orbital modeling and analysis tool for orbits spanning from low-Earth orbit into the cislunar regime, and includes the following:
+
+- Ability to define satellite parameters (area, mass, radiation and drag coefficients, etc.)
+- Support for multiple data types (e.g., read in orbit from TLE file, define a set of Keplerian, Equinoctial, or Kozai Mean Keplerian elements, etc.)
+- Define a fully customizable analytic force propagation model including the following:
+    - Earth gravity models (WGS84, EGM84, EGM96, EGM2008)
+    - Lunar gravity model (point source & harmonic)
+    - Radiation pressure (Earth & solar)
+    - Forces for all planets out to Neptune
+    - Atmospheric drag models
+    - Maneuvering (takes a user defined burn profile)
+- Various community used integrators: SGP4, Runge-Kutta (4, 8, and 7/8), SciPy, Keplerian, Taylor Series
+- User definable timesteps with the ability to return various parameters for any orbit and at any desired timestep (e.g., magnitude, state vector, TLE, Keplerian elements, periapsis, apoapsis, specific angular momentum, and many more.)
+- Ground and space-based observer models
+- Location and time of various lighting conditions of interest
+- Multiple-hypothesis tracking (MHT) UCT linker
+- Vectorized computations (use of array broadcasting for fast computation, easily parallelizable and deployable on HPC machines)
+- Short arc probabilistic orbit determination methods
+- Conjunction probability estimation
+- Built-in uncertainty quantification
+- Support for Monte Carlo runs and data fusion
+- Support for multiple coordinate frames and coordinate frame conversions (GCRF, IERS, GCRS Cartesian, TEME Cartesian, ra/dec, NTW, zenith/azimuth, apparent positions, orthoginal tangent plane, and many more.)
+- Various plotting capabilities (ground tracks, 3D orbit plotting, cislunar trajectory visualization, etc.)
+- User definable timesteps and orbit information retrieval times, in which the user can query parameters of interest for that orbit and time.
+
+Installation
+------------
+
+For installation details, see the `Installing SSAPy <https://LLNL.github.io/SSAPy/installation.html>`_ section of the documentation.
+
+Strict dependencies
+-------------------
+
+- `Python <http://docs.python-guide.org/en/latest/starting/installation/>`_ (3.8+)
+
+The following are installed automatically when you install SSAPy:
+
+- `numpy <https://scipy.org/install.html>`_;
+- `scipy <https://scipy.org/scipylib/index.html>`_ for many statistical functions;
+- `astropy <https://www.astropy.org/>`_ for astronomy related functions;
+- `pyerfa <https://pypi.org/project/pyerfa/>`_ a Python wrapper for the ERFA library;
+- `emcee <https://pypi.org/project/emcee/>`_ an affine-invariant ensemble sampler for Markov chain Monte Carlo;
+- `lmfit <https://pypi.org/project/lmfit/>`_ a package for non-linear least-squares minimization and curve fitting;
+- `sgp4 <https://pypi.org/project/sgp4/>`_ contains functions to compute the positions of satellites in Earth orbit;
+- `matplotlib <https://matplotlib.org/>`_ as a plotting backend;
+- and other utility packages, as enumerated in `setup.py`.
+
+Documentation
+-------------
+
+All documentation is hosted at `https://LLNL.github.io/SSAPy/ <https://LLNL.github.io/SSAPy/>`_.
+
+The API documentation may also be seen by doing:
+
+.. code-block:: bash
+
+    python3
+    >>> import ssapy
+    >>> help(ssapy)
+
+Contributing
+------------
+
+Contributing to SSAPy is relatively easy. Just send us a `pull request <https://help.github.com/articles/using-pull-requests/>`_. When you send your request, make `main` the destination branch on the `SSAPy repository <https://github.com/LLNL/SSAPy>`_.
+
+Your PR must pass SSAPy's unit tests and documentation tests, and must be `PEP 8 <https://www.python.org/dev/peps/pep-0008/>`_ compliant. We enforce these guidelines with our CI process. To run these tests locally, and for helpful tips on git, see our `Contribution Guide <https://ssapy.reathedocs.io/en/latest/contribution_guide.html>`_.
+
+SSAPy's `main` branch has the latest contributions. Pull requests should target `main`, and users who want the latest package versions, features, etc. can use `main`.
+
+Releases
+--------
+
+For multi-user site deployments or other use cases that need very stable software installations, we recommend using SSAPy's `stable releases <https://github.com/LLNL/SSAPy/releases>`_.
+
+Each SSAPy release series also has a corresponding branch, e.g. `releases/v0.14` has `0.14.x` versions of SSAPy, and `releases/v0.13` has `0.13.x` versions. We backport important bug fixes to these branches but we do not advance the package versions or make other changes that would change the way SSAPy concretizes dependencies within a release branch. So, you can base your SSAPy deployment on a release branch and `git pull` to get fixes, without the package churn that comes with `main`.
+
+The latest release is always available with the `releases/latest` tag.
+
+See the `docs on releases <https://ssapy.reathedocs.io/en/latest/contribution_guide.html#releases>`_ for more details.
+
+Code of Conduct
+---------------
+
+Please note that SSAPy has a `Code of Conduct <https://github.com/LLNL/SSAPy/blob/main/CODE_OF_CONDUCT.md>`_. By participating in the SSAPy community, you agree to abide by its rules.
+
+Authors
+-------
+
+SSAPy was developed with support from Lawrence Livermore National Laboratory's (LLNL) Laboratory Directed Research and Development (LDRD) Program under projects
+`19-SI-004 <https://ldrd-annual.llnl.gov/archives/ldrd-annual-2021/project-highlights/high-performance-computing-simulation-and-data-science/madstare-modeling-and-analysis-data-starved-or-ambiguous-environments>`_ and
+`22-ERD-054 <https://ldrd-annual.llnl.gov/ldrd-annual-2023/project-highlights/space-security/data-demand-capable-space-domain-awareness-architecture>`_, by the following individuals (in alphabetical order):
+
+- `Robert Armstrong <https://orcid.org/0000-0002-6911-1038>`_ (`LLNL <https://www.llnl.gov/>`_)
+- `Nathan Golovich <https://orcid.org/0000-0003-2632-572X>`_ (`LLNL <https://www.llnl.gov/>`_)
+- `Julia Ebert <https://orcid.org/0000-0002-1975-772X>`_ (formerly `LLNL <https://www.llnl.gov/>`_, now at Fleet Robotics)
+- `Noah Lifset <https://orcid.org/0000-0003-3397-7021>`_ (formerly `LLNL <https://www.llnl.gov/>`_, now PhD student at `UT Austin <https://www.utexas.edu>`_)
+- `Dan Merl <https://orcid.org/0000-0003-4196-5354>`_ (`LLNL <https://www.llnl.gov/>`_) - Developer
+- `Joshua Meyers <https://orcid.org/0000-0002-2308-4230>`_ (formerly `LLNL <https://www.llnl.gov/>`_, now at `KIPAC <https://kipac.stanford.edu/>`_) - Former Lead Developer
+- `Caleb Miller <https://orcid.org/0000-0001-6249-0031>`_ (`LLNL <https://www.llnl.gov/>`_)
+- `Alexx Perloff <https://orcid.org/0000-0001-5230-0396>`_ (`LLNL <https://www.llnl.gov/>`_)
+- `Kerianne Pruett <https://orcid.org/0000-0002-2911-8657>`_ (formerly `LLNL <https://www.llnl.gov/>`_)
+- `Edward Schlafly <https://orcid.org/0000-0002-3569-7421>`_ (formerly `LLNL <https://www.llnl.gov/>`_, now `STScI <https://www.stsci.edu/>`_) - Former Lead Developer
+- `Michael Schneider <https://orcid.org/0000-0002-8505-7094>`_ (`LLNL <https://www.llnl.gov/>`_) - Creator, Former Lead Developer
+- `Travis Yeager <https://orcid.org/0000-0002-2582-0190>`_ (`LLNL <https://www.llnl.gov/>`_) - Current Lead Developer
+
+Many thanks go to SSAPy's other `contributors <https://github.com/llnl/ssapy/graphs/contributors>`_.
+
+
+Citing SSAPy
+^^^^^^^^^^^^
+
+On GitHub, you can copy this citation in APA or BibTeX format via the "Cite this repository" button.
+If you prefer MLA or Chicago style citations, see the comments in `CITATION.cff <https://github.com/LLNL/SSAPy/blob/main/CITATION.cff>`_.
+
+You may also cite the following publications (click `here <https://github.com/LLNL/SSAPy/blob/main/docs/source/citations.bib>`_ for list of BibTeX citations):
+
+ - Yeager, T., Pruett, K., & Schneider, M. (2022). *Unaided Dynamical Orbit Stability in the Cislunar Regime.* [Poster presentation]. Cislunar Security Conference, USA.
+ - Yeager, T., Pruett, K., & Schneider, M. (2023). *Long-term N-body Stability in Cislunar Space.* [Poster presentation]. Advanced Maui Optical and Space Surveillance (AMOS) Technologies Conference, USA.
+ - Yeager, T., Pruett, K., & Schneider, M. (2023, September). Long-term N-body Stability in Cislunar Space. In S. Ryan (Ed.), *Proceedings of the Advanced Maui Optical and Space Surveillance (AMOS) Technologies Conference* (p. 208). Retrieved from `https://amostech.com/TechnicalPapers/2023/Poster/Yeager.pdf <https://amostech.com/TechnicalPapers/2023/Poster/Yeager.pdf>`_
+
+License
+-------
+
+SSAPy is distributed under the terms of the MIT license. All new contributions must be made under the MIT license.
+
+See `Link to license <https://github.com/LLNL/SSAPy/blob/main/LICENSE>`_ and `NOTICE <https://github.com/LLNL/SSAPy/blob/main/NOTICE>`_ for details.
+
+SPDX-License-Identifier: MIT
+
+LLNL-CODE-862420
+
+Documentation Inspiration
+-------------------------
+The structure and organization of this repository's documentation were inspired by the excellent design and layout of the `Coffea <https://coffea-hep.readthedocs.io/en/latest/index.html>`_ project.