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.
📦 Installation
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 ▶️Runit:
%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 thepipinstall command:pip install planetary-coverage[juice]
The package is also available on conda-forge
and you can install it with conda:
conda install -c conda-forge planetary-coverage
✏️ How to cite this package
If you use this package for your analyses, please consider using the following citation:
Seignovert et al. 2025, Planetary coverage (1.2.1), doi:10.60487/zjfq-h2c6
or can use either:
⚡️ Issues and 💬 feedback
If you have any issue with this package, we highly recommend to take a look at:
- 📚 our extended documentation online.
- 📓 the collection of notebook examples.
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 contact@planetary-coverage.org
🎨 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 (2.x), 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 --all-groups
-
✍️ Make your edits and 🚧 write the tests.
-
🚦 Check that the linter and formatter are happy 😱 🤔 😃 :
poetry run ruff format --diff
poetry run ruff check
- 🛠 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 🙌 👏 💪.
👽 Maintainer section
-
To add a new contributor, you need to edit the following files:
CITATION.cffcodemeta.jsonplanetary-coverage.bib
-
To release a new version:
DOI='abcd-efgh' bump-my-version bump [patch|minor|major]
Metadata
Release files for planetary-coverage 1.2.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| planetary_coverage-1.2.1.tar.gz | 4.7 MB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| planetary_coverage-1.2.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 9.4 MB
Release files / planetary_coverage-1.2.1.tar.gz
| Download URL | planetary_coverage-1.2.1.tar.gz |
|---|---|
| Size | 4.7 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
a065ca55831fc7be477404b69e00ca97f64f6d9fe6420588aa1ca96a65291dd3
|
|
BLAKE2b-256 checksum How to use checksums |
ecafb693d4f8c8c36672b79d8f2d30dfcce4da62560e8d3f882c8fb5e3f402da
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.2.1 CPython/3.11.14 Linux/6.1.0-38-amd64
|
Release files / planetary_coverage-1.2.1-py3-none-any.whl
| Download URL | planetary_coverage-1.2.1-py3-none-any.whl |
|---|---|
| Size | 4.7 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
14b2aa37d1e95d638f2480c1dac5247f7c61f82dc5e2efb26de72234fc682996
|
|
BLAKE2b-256 checksum How to use checksums |
a9d2e8f3c4322bf834be30be4b7ff9ff27665ee05e14c8dded06aad9de487506
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.2.1 CPython/3.11.14 Linux/6.1.0-38-amd64
|