Planetary coverage documentation#

Package name change

The moon-coverage was renamed planetary-coverage to illustrate that this tool can be used with all SPICE based space missions (see gallery of examples). You recommend that you update your code to use this new denomination.

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 latest version of the planetary-coverage available on Python Package Index (PyPI) is 1.0.0. You can install it with pip, either in a Jupyter environnement or locally:

In your Jupyter environment, go to File > New > Notebook to create a new notebook and in the first cell, type:

%pip install --upgrade planetary-coverage

Execute the cell with ⇧ Shift + ↵ Enter and you should get the latest version of the planetary-coverage.

You can double check which version was installed by running the following command:

%load_ext planetary_coverage

Caution

If you want to use the planetary-coverage directly in your terminal or in your REPL, you can install it locally at the user level. We recommend to encapsulate it in a virtual environment to avoid any conflict with your default python environment.

For example, you can use either python native virtual environment (venv):

python -m venv venv
. venv/bin/activate

or a conda environment:

conda create -n planetary-coverage python=3.10
conda activate planetary-coverage

Then install the package:

python -m pip install planetary-coverage

If you need to install the very latest development version from the source, you 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, clone the source from the repository:

git clone https://juigitlab.esac.esa.int/python/planetary-coverage.git
cd planetary-coverage

and install the package with its development dependencies:

poetry install

All the dependencies will be installed in an isolated virtual environment and will not affect you default python environment. Now you can either prefix your commands with:

poetry run <my-cmd>

or activate directly the virtual environment:

poetry shell

Note

If you have access to a working Jupyter environnement, ie. a locally installed JupyterLab Desktop or a remote JupyterHub like ESA DataLabs, we recommend to use the first method of installation.

Hint

If you need to perform pointing simulations for the ESA-JUICE mission. You will need to install an optional dependency (esa-ptr). More details can be found here.

Changes and updates#

The planetary-coverage adheres to semantic versioning, ie. the version number will have the following pattern:

MAJOR.MINOR.PATCH

Since this package is under active development, new releases are available on irregular basis. All the changes are reported in the changelog. If you need to upgrade to a newer version, you only need to re-run one of the installation command above to get the latest version.

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.0.0), planetary-coverage.org, swh:1:rel:3900e871fe34fdeead5a4d8d6b3aa86a063e82df

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:

this documentation (the search bar on the left is there for you)
the gallery of examples
the example notebooks repository

If you did not find a solution there, don’t hesitate to:

open an issue, if you have an account on the JUICE Gitlab
send us an email at contact@planetary-coverage.org

The planetary-coverage is distributed under a open-source BSD-3 clauses license. Bug reports and contributions are encouraged and always welcome.