ceres-nav 0.0.1a2

Celestial Estimation for Research, Exploration, and Science

CERES

Celestial Estimation for Research, Exploration, and Science

CERES is an API for aiding in the ismulation of spacecraft dynamics, and the devleopment of new navigation and mapping techniques.

Releases are registed on PyPI, while development is occuring on the ceres GitHub page. Any bugs should be reported to the Issue Tracker. Documentation is located at docs.ceresnavigation.org

NOTE: Currently, CERES is only supported on Linux. Native Windows support is coming soon, though WSL2 (available on both Windows 10 and 11) is already supported.

Install

pip install ceres-nav

Once installed, ceres can be imported using: import ceres

Call for Contributions

To contribute to this project, it is highly recommended that you create a virtual environment with either mamba or conda.

1. Install mamba or conda:
   • To install mamba (RECOMENDED): mambaforge
   • To install conda: anaconda
2. Create the virtual environment:
   • source the base environment
   • create ceres_env environment with ceres dependencies: conda create -n ceres_env python=3 numpy
   • Install tools required for development: pip install sphinx pytest pytest-cov sphinx-rtd-theme setuptools wheel twine
   • Activate the virtual environment with conda activate ceres_env
3. Installing CERES into the environment:
   • Clone: git clone https://github.com/ceres-navigation/ceres
   • Install: cd ceres; pip install -e .
4. Running tests:
   • pytest --cov=ceres tests/

If you are new to contributing to open source, this guide helps explain why, what, and how to successfully get involved.

Contact

All questions should be directed to Chris Gnam: [e-mail]