#################
OSVE Session File
#################

Introduction
============

The OSVE Session File is a text file in JSON format intended to specify to OSVE
the settings or parameters to use during initialisation, simulation and
reporting steps.

The JSON file is structured with the following objects:

- `sessionConfiguration` Main session object containing the specified OSVE settings.
  - `source` Defines the source or the origin of the data used for this OSVE execution.
  - `simulationConfiguration` Defines the simulation settings for the OSVE execution. 
  - `attitudeSimulationConfiguration` Defines the attitude simulation settings used by AGM during the OSVE execution. 
    If not specified, OSVE will run the simulation without using AGM.
    - `kernelsList` Defines SPICE kernels settings for being used by AGM during the OSVE execution. 
  - `instrumentSimulationConfiguration` Defines the instrument simulation settings for being used by EPS during 
    the OSVE execution. In not specified, OSVE will run the simulation without EPS.
  - `inputFiles` Defines the input files for the OSVE execution.
    - `modellingConfiguration` Defines the Experiment modelling files for being used by EPS.
  - `outputFiles` Defines the output files that OSVE will generate after the execution.
  - `logging` Defines the logging parameters of OSVE.


Session File Template
=====================

A template of the Session file with a description of each parameter is available hereunder. In the JSON file keywords are mandatory unless specified as `[OPTIONAL]`.
Some keywords are labeled as `[NOT_USED]`, this just remarks that this keyword is not used by 
OSVE itself but can be used for traceability purposes.

.. literalinclude:: ../../session-file.json
   :language: json

Examples of Session files are provided in the test directories. 
E.g.: Minor Moons test scenario: ``validation/osve/osve-if/pt-if-test-0001-minor-moons/session_file.json``.