Moon Coverage toolbox
Project description
ESA Moon Coverage Toolbox
The moon-coverage python package is a toolbox to perform surface coverage analysis based on orbital trajectory configuration. 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 Laboratory of Planetology and Geosciences (CNRS-UMR 6112) at Nantes University (France), under ESA-JUICE 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%pip
in a notebook cell and ▶️Run
it:
%pip install --upgrade moon-coverage
- or, if you are using a
terminal environment
, you can do:
pip install --upgrade moon-coverage
Note: If you plan to use this package with JUICE and you want to enable PTR simulation with AGM. You can add a
juice
extra parameter in thepip
install command:pip install moon-coverage[juice]
✏️ How to cite this package
If you use this package for your analyses, please consider using the following citation:
Seignovert, Benoît, Gabriel Tobie, Rozenn Robidel, Claire Vallat, Inès Belgacem, and Nicolas Altobelli. Python Moon-Coverage Toolbox, LPG - Nantes Université, 2022. Version: 0.12.0, moon-coverage.univ-nantes.fr, hal-03648491, swh:1:rel:9c89f93a167637432c71cfc7f84263576edc4d1b
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:
- 📚 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 moon-coverage@univ-nantes.fr
🎨 Contribution and 🐛 fix bugs
Contributions are always welcome and appreciated.
An account on the JUICE Giltab is required.
You also need to install the latest version of Poetry (≥1.2
), for example on Linux/macOS, 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>/moon-coverage
cd moon-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 🙌 👏 💪.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for moon_coverage-0.12.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0f2897aa60c6918cb259c679f72f898709b97cb60609e78b1a80b78ab5d75512 |
|
MD5 | 7718c5adc49b51f5f7be404bbc607d0d |
|
BLAKE2b-256 | aabeb823087574a3fee98903422148040c3c90d4236614ee0b8a955f91f0c56b |