Skip to main content

Moon Coverage toolbox

Project description

ESA Moon Coverage Toolbox

CI/CD Coverage Documentation Status

Version License PyPI Python

Docs DataLab


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 Geodynamics (CNRS-UMR 6112) at the University of Nantes (France), under ESA-JUICE founding support.

LPG / ESA logos

Installation

The package is available on pypi and can be install directly with pip:

pip install moon-coverage

If you already installed moon-coverage and you want to upgrade it to the latest version, you need to add a --upgrade flag in the pip command above.

Documentation

The module documentation can be found on ReadTheDocs. You can look into the notebooks/ folder for additional examples.

Local development and testing

Setup:

git clone https://juigitlab.esac.esa.int/datalab/moon-coverage
cd moon-coverage

pip install -e .
pip install -r tests/requirements.txt -r docs/requirements.txt

Linter:

flake8 moon_coverage/ tests/ setup.py docs/conf.py
pylint --rcfile=setup.cfg moon_coverage/ tests/*/*.py setup.py

Unit tests (with pytest):

pytest --cov moon_coverage tests/

Build the docs (with sphinx):

sphinx-build docs docs/_build --color -W -bhtml

Deploy on a JupyterLab Docker instance

A Dockerfile configuration setup is provided in the docker/ folder.

cd docker/

To build the Docker image:

docker-compose build

Start the JupyterLab instance:

docker-compose run --service-ports jupyter-lab

Then click on the link in the console: http://127.0.0.1:8000/lab?token=xxxxxxxxx

You can check that the instance is correctly configured:

docker-compose run jupyter-lab-tests

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

moon-coverage-0.6.3.tar.gz (1.1 MB view hashes)

Uploaded Source

Built Distribution

moon_coverage-0.6.3-py3-none-any.whl (1.1 MB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page