Package: juice-geopipeline
🪐 geopipelineJUICE 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).🛠️️ PrerequisitesA computer based on a 64-bit Unix operating system: Linux or MacPython 3.8 (or higher)⎆ Python InstallationInstall geopipeline with:pipinstall[--upgrade]juice-geopipelineYou can install geopipeline locally from the repository:gitclonehttps://juigitlab.esac.esa.int/core-system/uplink/geopipelinecdgeopipeline
pipinstall.Using the LibraryAfter installing the library can be used with the Python Shell or with its CLI.Python ShellA 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 InterfaceThe 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-hJUICE SOC ConfigurationThe Configuration below is only required by certain routines used internally by the JUICE SOC.Setup Environmental VariablesTo 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~/.envTheCONF_REPOvariable, that points to your localJUICE SOC configuration repository (conf)is mandatory.🧪 Python TestsTo run the tests, first make sure thesrcpath is inPYTHONPATH. E.g.:cdtests/geopipelineexportPYTHONPATH=../../Then run:python3-munittest-v📄 DocumentationGenerate DocumentationInstall the documentation generation:pip3 install sphinx
pip3 install sphinx sphinx_rtd_themeTo 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 popularbashshell; your own prompt may appear differently and may vary depending on operating system, shell choice, and so forth.Restructured Text FormatThis documentation is generated with Restructured Text Format (RST).For full documentation visitRST|Sphinx|Sublime|GitHubFor a cheatsheet visitRST-cheatsheet