🪐 geopipeline
JUICE Science Operations Center Geometry Pipeline.
geopipeline is a suite of routines and processes provides: geometrical calculations, science models, science opportunity analysis, high-level operational resources calculations, and ESA validation for external development.
geopipeline is based on heritage from Mars Express and CASSINI (CIRS) routines developed by Nicolas Altobelli (ESAC/ESA).
🛠️️ Prerequisites
- A computer based on a 64-bit Unix operating system: Linux or Mac
- Python 3.8 (or higher)
⎆ Python Installation
Install geopipeline with:
pip install [--upgrade] juice-geopipeline
You can install geopipeline locally from the repository:
git clone https://juigitlab.esac.esa.int/core-system/uplink/geopipeline
cd geopipeline
pip install .
Using the Library
After installing the library can be used with the Python Shell or with its CLI.
Python Shell
A basic test of the library to search for Earth Occultations is provided.
from geopipeline import geometry_finder as gf
from planetary_coverage import TourConfig
logging.basicConfig(level=logging.INFO, format='%(message)s')
tour = TourConfig(
mk='juice_crema_5_0b23_1',
spacecraft='JUICE',
target='JUPITER',
download_kernels=True,
load_kernels=True
)
event = tour.get_event('All mission phases')
utc_start = str(event.start)
utc_end = str(event.stop)
occdict = gf.jovian_system_occultations(utc_start, utc_end, target='EARTH', system=['RINGS'], step=600, verbose=True)
Command Line Interface
The package has several CLI entry points, classified in General entry points and JUICE SOC internal entry points.
General Entry Points:
geopipeline-jovian-system-occultations: Finds occultations for a given object (star, Earth, etc.) by the Jovian System.
JUICE SOC internal:
geopipeline-jupiter-tour-flip-zaxis-windows: Augments the Mission Events file with Tour S/C +Z axis flips.
The API signature can be obtained using the following with any of the entry points:
geopipeline-jovian-system-occultations -h
JUICE SOC Configuration
The Configuration below is only required by certain routines used internally by the JUICE SOC.
Setup Environmental Variables
To setup the required environmental variables. Copy the environmental variables' setup file to your home directory and edit the paths with your favorite editor. For example:
cp <path_to_repo>/env.txt ~/.env
vi ~/.env
The CONF_REPO variable, that points to your local JUICE SOC configuration repository (conf) is mandatory.
🧪 Python Tests
To run the tests, first make sure the src path is in PYTHONPATH. E.g.:
cd tests/geopipeline
export PYTHONPATH=../../
Then run:
python3 -m unittest -v
📄 Documentation
Generate Documentation
Install the documentation generation:
pip3 install sphinx
pip3 install sphinx sphinx_rtd_theme
To build the HTML documentation run from the repository root directory:
sphinx-apidoc -o docs src/geopipeline
cd geopipeline/docs
sphinx-build -b html source build
👉 Note: The above commands demonstrate typical usage with a command-line prompt, such as that provided by the popular bash shell; your own prompt may appear differently and may vary depending on operating system, shell choice, and so forth.
Restructured Text Format
This documentation is generated with Restructured Text Format (RST).
- For full documentation visit RST|Sphinx|Sublime|GitHub
- For a cheatsheet visit RST-cheatsheet
Metadata
Release files for juice-geopipeline 0.6.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| juice_geopipeline-0.6.1-py3-none-any.whl | Python 3 | none | any | Details for juice_geopipeline-0.6.1-py3-none-any.whl |
Release files / juice_geopipeline-0.6.1-py3-none-any.whl
| Download URL | juice_geopipeline-0.6.1-py3-none-any.whl |
|---|---|
| Size | 27.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
34fea45b8b9db6b5add8132a937cbf9a88ed9a49892f7692d6cbf9fe2472d1b2
|
|
BLAKE2b-256 checksum How to use checksums |
2a9dcb374edc11ba1aefdd0541f3bd0fff718a8814625e43a4012a6690cb124c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.1 CPython/3.10.11
|
Security for juice-geopipeline 0.6.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.