Planetary coverage package
Planetary coverage package
The planetary-coverage package is a toolbox to perform surface coverage analysis based on orbital trajectory calculations. Its main intent is to provide an easy way to compute observation opportunities of specific region of interest above the Galilean satellites for the ESA-Juice mission but could be extended in the future to other space mission.
It is actively developed by the Observatoire des Sciences de l'Univers Nantes Atlantique (OSUNA, CNRS-UAR 3281) and the Laboratory of Planetology and Geosciences (LPG, CNRS-UMR 6112) at Nantes University (France), under ESA-Juice and CNES founding support.
The package is available on PyPI and can be installed very easily:
- If you are in a
Jupyter environnement, you can use the magic command
%pipin a notebook cell and ▶️
%pip install planetary-coverage
- or, if you are using a
terminal environment, you can do:
pip install planetary-coverage
Note: If you plan to use this package with Juice and you want to enable PTR simulation with AGM. You can add a
juiceextra parameter in the
pip install planetary-coverage[juice]
The package is also available on conda-forge
and you can install it with
conda config --add channels conda-forge conda config --set channel_priority strict conda install planetary-coverage
✏️ How to cite this package
If you use this package for your analyses, please consider using the following citation:
Seignovert et al. 2023, Planetary coverage package (1.1.0), planetary-coverage.org, swh:1:rel:8416d4a23e2d695ce68c35f22aace9281c25dbaa
or can use this 📙 BibTeX file.
⚡️ Issues and 💬 feedback
If you have any issue with this package, we highly recommend to take a look at:
If you did not find a solution there, feel free to:
- 📝 open an issue (if you have an account on the Juice Gitlab).
- ✉️ send us an email at email@example.com
🎨 Contribution and 🐛 fix bugs
Contributions are always welcome and appreciated.
An account on the Juice Giltab is required.
You also need to install the recent version of Poetry (
≥1.2), for example on Linux/macOS/Windows (WSL), you can run this command:
curl -sSL https://install.python-poetry.org | python3 -
Then you are good to go!
🐑 Clone and 📦 install the repository locally:
git clone https://juigitlab.esac.esa.int/<YOUR_USERNAME>/planetary-coverage cd planetary-coverage poetry install --extras juice
✍️ Make your edits and 🚧 write the tests.
🚦 Double-check that the linters are happy 😱 🤔 😃 :
poetry run flake8 src/ tests/ docs/conf.py poetry run pylint src/ tests/
- 🛠 Check that your tests succeed 👍 and you have a coverage of 100% ✨ :
poetry run pytest
- 📖 Complete and ⚙️ build the documentation (if needed):
cd docs/ poetry run make docs
- 📤 Push your changes to your forked branch and 🚀 open a new merge request explaining what you changed 🙌 👏 💪.
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Hashes for planetary_coverage-1.1.0-py3-none-any.whl