The JUICE Pre-Operational Repository

The JUICE Pre-Operations Repository JUICE_PREOPS contains all the input files, configuration files, and data files required to run the JUICE SOC Planning Harmonisation System (PHS) in order to conduct different simulations and analyses for the science (payload) operations of the JUICE mission.

PHS consists of OSVE (Operations Simulations and Validation Engine), the Pointing Tool (and PTWrapper), and a number of Python Packages. OSVE is the main tool and it makes use of the AGM (Attitude Generator Module) and EPS (Experiment Planning System) libraries. MAPPS is currently considered an operatioinal backup system.

JUICE_PREOPS constitutes the main interface between the SOC and the Instrument Teams [PISOC-ICD]. All the files used during the Detailed Scenario process are exchanged via this Git repository.

The repository is available from the ESA GitLab.

This repository contains the branches dedicated to the different detailed scenario exercises. More information on the scenario name construction for the corresponding branch of the repository is provided below.

The README file of the repository contains a list of all the available scenarios.

Scenario Name

As an example, the PJ12 scenario reference for the Detailed planning exercise is: S007_PJ12. This corresponds to the branch in use in the JUICE_PREOPS repository (made the default branch for the duration of the planning exercise). The nomenclature for the scenario reference is:

<scenario_number>_<scenario_short>

where

scenario_number: is the number of the science scenario as per SOC’s reference.
scenario_short: is the short name of the scenario - e.g. for Perijove 12, it is PJ12.

In addition the scenario id that will be used in the different files exchanged will be S007_01. The scenario id uses the scenario_number and then an index that accounts for the number of different scenario directories - typically only one is necessary.

The JUICE_PREOPS branch is named after the scenario reference i.e.``S007_PJ12``. Instrument team branches add the instrument name suffix e.g. S007_PJ12_JANUS. The name of the scenario directory inside the repository is constructed from the scenario id, short name, and the start and end dates of the scenario, as follows:

<scenario_id>_<scenario_short>_<start_date>_<end_date>

where

start_date: is the date of the start of the scenario, and the simulation.
end_date: is the date of the end of the scenario, and the simulation.

For PJ12, the scenario runs from 2023-09-22 to 2023-09-26. The JUICE_PREOPS scenario directory will be PLANNING/SCENARIOS/S007_01_PJ12_320922_320926. All planning activities will be conducted in this directory and subdirectories.

Scenario Directory Structure

The Scenario directory has a given structure that is the result of gathering both the experience from previous missions in operations and the specific requirements of JUICE. The directory contains different types of files that serve different purposes:

Configuration files: The configuration files required by AGM, EPS, and OSVE (and MAPPS) are present in the CONFIG directory. Internally to the SOC, the source of these files is the Configuration repository conf. From this directory, only the OSVE Configuration file is accessed directly by the user when running the OSVE simulation.
Environment files: The Environment files are input files to OSVE that define the “environment” of the scenario. The EVENTS/GEOMETRY subdirectory include geometrical events generated with the geopipeline package. The OPS subdirectory includes operational files that include input related to the power and data models. In particular, we have a file that provides the solar cell counts, one for the efficiency of the solar cells and another one for the bit rates of the S/C. The SEGMENTATION subdirectory includes the opportunities from the latest Segmentation as well as Data Volume envelopes for each instrument type based on the DV pie for the Tour. These serve as resource envelopes during the Instrument Timeline Harmonisation process. The trajectory files required by MAPPS were also included in this directory. These files can be also considered as configuration files. Internally to the SOC, the source of these files is the Configuration repository conf.
Modelling files: The Modelling files are the Experiment Definition Files (EDFs) and are used as an input to EPS. These files contain all the relevant modelling information of the instruments, including sequence and command definitions as exported from the MIB, constraint modelling, etc. These files can be also considered as configuration files. Internally to the SOC the origin of these files is the Configuration repository conf.
Observation Definition files: The Observation definition files used by OSVE to run the simulation have a specific directory in the structure. These observation definitions are initially generated from the SOC Observation Database. Each instrument has its own directory with two subdirectories: GLOBAL and SCENARIO. The GLOBAL subdirectory contains all the observation definitions available to the instrument, whereas the SCENARIO one has the ones that are linked to the WG segments present in the scenario. These files are considered planning files and can be delivered by the SOC or PIs throughout the entire Detailed Scenario Process. Note that any changes to the ODFs during the Detailed Scenario Process (including instanciation of specific observations) will happen directly in the SCENARIO directory but will need to be reflected in the Observation Database after the end of the exercise.
Pointing files: This directory hosts all the Pointing Request Files (PTR) and the resulting SPICE C-Kernels (CK) This is the directory where the instrument teams deliver their pointing requests as well. These files are considered planning files and can be delivered by the SOC or PIs during the Pointing Timeline Harmonisation process. Each instrument has a subdirectory for their deliveries but only the latest SOC PTR in the main directory contains all the merged requests.
Timeline files: This directory hosts all the planning files related to instrument operations to provide instrument modes, module states, data generation, and power consumption information. Different types of files are hosted in this directory such as the event fies, Observation Plan files (OPL), Observation Timeline files (OTL), Instrument Timeline files (ITL), and Payload Operations Requests Files (POR). Each instrument has a subdirectory which is also the location where the files are delivered by the PI teams.
output directory: This is a directory required by OSVE where its output is dumped. Only the latest output files are kept in this directory by the SOC. These files are not version controlled.

To summarize the directory contains a number of:

Configuration Files: AGM, EPS, OSVE configuration files, Environmental files for data and power models, and EDF files.
Planning Files: Observation Definitions, PTRs, Timeline input files (OPL, OTL, ITL, POR, EVF, etc.)

A particularity of JUICE with respect to other missions is that the entire file structure, including the configuration, is under the scenario directory (rather than a higher-level directory).

An example of a detailed scenario file structure is provided hereunder:

S007_01_PJ12_320922_320926/
|-- aareadme.rst
|-- EVT_TOP_LEVEL_S007_01_1.evf
|-- ITL_TOP_LEVEL_S007_01_V1.itl
|-- CONFIG/
│   |-- AGM/
│   │   |-- CFG_AGM_DEF_BLOCK_JUPITER_S007_01.xml
│   │   |-- CFG_AGM_FIXED_DEFS_MLB_S007_01.xml
│   │   |-- CFG_AGM_PREDEF_BLOCKS_MLB_S007_01.xml
│   │   `-- CFG_AGM_S007_01.xml
│   |-- EPS/
│   │   |-- CFG_EPS_S007_01.cfg
│   │   |-- EVD_EPS_S007_01.def
│   │   |-- planning_mtp_mapping.def
│   │   |-- planning_period_def.xml
│   │   `-- units.def
│   |-- OSVE/
|   |   `-- CFG_OSVE_S007_01.json
│   `-- MAPPS/
│       `-- CFG_MAPPS_S007_01.ini
|-- ENVIRONMENT/
│   |-- EVENTS/
│   │   `-- GEOMETRY/
│   │       |-- EVT_S008_01_DOWNLINK.evf
|   |       | ...
│   |-- OPS/
│   │   |-- BRF_GEN_0_0_4_300101_330531_V01.asc
│   │   |-- RES_C51150LB231_SA_CELLS_EFFICIENCY_310119_350927.csv
│   │   `-- RES_SA_CELLS_COUNT_300101_330531_V01.asc
|   `-- SEGMENTATION/
|       |-- TMS_DATA_ACC_3GM_S007_01.csv
|      ...
|       `-- TMS_DATA_VOLUME_REMOTE_SENSING_S007_01.csv
|-- MODELLING/
│   |-- EDF_JUICE.edf
│   |-- JUICE/
│   │   |-- EDF_JUI_SPC.edf
│   │   |-- EDF_JUI_SPC_COMS.edf
│   │   |-- EDF_JUI_SPC_CONST.edf
│   │   |-- EDF_JUI_SPC_LINK_KAB.edf
│   │   |-- EDF_JUI_SPC_LINK_XB.edf
│   │   |-- EDF_JUI_SPC_MODEL.edf
│   │   |-- EDF_JUI_SPC_NAVCAM.edf
│   │   |-- EDF_JUI_SPC_RADEM.edf
│   │   `-- EDF_JUI_SPC_SSMM.edf
│   |-- MAJIS/
│   │   |-- EDF_JUI_MAJIS.edf
│   │   |-- EDF_JUI_MAJIS_CONST.edf
│   │   |-- EDF_JUI_MAJIS_MODEL.edf
│   │   `-- EDF_JUI_MAJIS_MODES.edf
|  ...
│   `-- UVS/
│       |-- EDF_JUI_UVS.edf
│       |-- EDF_JUI_UVS_CONST.edf
│       |-- EDF_JUI_UVS_MODEL.edf
│       `-- EDF_JUI_UVS_MODES.edf
|-- DEFINITIONS/
│   |-- DFS_TOP_LEVEL_S007_01.def
│   `-- OBSERVATIONS/
│       |-- 3GM/
│       │   |-- GLOBAL/
│       │   `-- SCENARIO/
│       |-- GAL/
│       │   |-- GLOBAL/
│       │   `-- SCENARIO/
|      ...
│       `-- UVS/
│           |-- GLOBAL/
│           `-- SCENARIO/
|-- OUTPUT/
|-- POINTING/
    |-- PTR_SOC_S007_01_SXXPYY.ptx
|   `-- JANUS/
|       `-- PTR_JAN_S007_01_S02P01.ptx
|  ...
|   `-- SWI/
|       `-- PTR_SWI_S007_01_S02P01.ptx
|-- TIMELINE/
|   |-- ITL_JUICE_PLATFORM_POWER_S007_01_V1.itl
|   |-- ITL_TOP_LEVEL_INSTRUMENTS_S007_01_V1.itl
|   |-- 3GM/
|   │   `-- ITL_3GM_S007_01_SXXPYY.itl
|  ...
|   `-- SWI/
|       `-- ITL_SWI_S007_01_SXXPYY.itl

OSVE configuration particularities

The OSVE configuration is the only configuration item that is accessed directly by the user when running the scenario simulation with OSVE. Therefore, this configuration file (or session file) points to the top level input files used during the simulation.

Inspection of the OSVE file is recommended. The full OSVE documentation is available here.

In particular the inputFiles section points to the top level Observation Definition File, the PTR file loaded for the OSVE/AGM simulation and to the top level ITL and EVF files used for the OSVE/EPS simulation.

The EVF and ITL top-level files are not included in the Timelines directory but rather at the top-level scenario directory. This is due to the fact that these top-level files should not be modified by the user but rather the ones in the TIMELINE directory should.

Timeline directory particularities

The TIMELINE directory has some particularities that need to be taken into account. It contains:

Top-level ITL for the instruments: this ITL points to the latest version of the individual instrument ITLs. These latest version are always copied in the static ones with SXXPXX.
ITL for JUICE S/C Communications: contains the ground station links of the detailed scenario.
ITL for JUICE S/C Platform Power: contains the power profile of the JUICE S/C platform for the detailed scenario.
SOC Observation Plans: contains a number of Observation plans provided by the SOC.
SOC event file: the file that contains the events defined by the SOC for the detailed scenario.