Operations Simulation & Validation Engine (OSVE)
Introduction
OSVE is Python package that incorporates a C/C++ library to assist the
development and implementation of the science operations by the JUICE Science
Operations Center (SOC).
Its main functionality is to simulate and validate the S/C pointing timeline, instrument timeline and to perform operational constraint checks and assessment of Power and Data Volume resources.
AGM & EPS Libraries
OSVE's core includes the Experiment Planning System (EPS) and the Attitude
Generator Module (AGM) C/C++ software applications developed by TEC (ESTEC)
and PSS (ESAC) that have been used to implement the science planning and conduct
in-flight science operations for ESA's Venus Express, Mars Express, Rosetta,
Solar Orbiter, and BepiColombo missions.
Documentation
A detailed documentation is available with a thorough description of OSVE, the API documentation is also included and is automatically generated from the content of the docs directory and from the docstrings of the public signatures of the source code.
Additional documentation is available at the JUICE SOC Toolkit Help.
Building the Documentation
pip install sphinx
pip install sphinx sphinx_rtd_theme
cd docs
sphinx-build -b html source build
Installation
OSVE is available from the Python Package Index repository. Install it by running the following command:
pip install osve
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 contents can be done as follows:
from osve import osve
sim = osve.osve()
version = sim.get_app_version()
print(version)
Command line Interface
The package has a CLI entry point:
usage: osve [-h] -r ROOTPATH -s SESSIONFILE
JUICE Operations Simulation & Validation Engine (OSVE) command line interface
optional arguments:
-h, --help show this help message and exit
-r ROOTPATH, --RootPath ROOTPATH
Top level path of the scenario file_path to be used to resolve the relative paths
-s SESSIONFILE, --SessionFile SESSIONFILE
Location and name of the session file containing all the scenarios files
JUICE SOC Tools using OSVE
There are a number of JUICE SOC tools that make usage of OSVE. The most remarkable public ones are listed hereunder:
PTWrapperActs as a wrapper to simplify the usage of OSVE to simulate a Pointing Timeline and generate the Attitude as a SPICE CK to assist the Pointing Timeline Harmonisation of the Detailed Scenario process.juice-phsExploits and uses the OSVE capabilities to assist the Instrument Timeline Harmonisation of the Detailed Scenario process.
OSVE Session File
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:
sessionConfigurationMain session object containing the specified OSVE settings.sourceDefines the source or the origin of the data used for this OSVE execution.simulationConfigurationDefines the simulation settings for the OSVE execution.attitudeSimulationConfigurationDefines the attitude simulation settings used by AGM during the OSVE execution. If not specified, OSVE will run the simulation without using AGM.kernelsListDefines SPICE kernels settings for being used by AGM during the OSVE execution.
instrumentSimulationConfigurationDefines the instrument simulation settings for being used by EPS during the OSVE execution. In not specified, OSVE will run the simulation without EPS.inputFilesDefines the input files for the OSVE execution.modellingConfigurationDefines the Experiment modelling files for being used by EPS.
outputFilesDefines the output files that OSVE will generate after the execution.loggingDefines the logging parameters of OSVE.
A template of the Session file with a description of each parameter is available at
session-file. 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.
An example of a session file with all the available OSVE overlays is available at session-file-example. More examples of Session files are provided in the test directories. E.g.: Minor Moons test scenario.
OSVE C++/C Library
The C++/C library for which the current Python package works as a wrapper
for can also be directly used and linked with other applications. If this path is chosen it is recommended to inspect the source code of the Python Package to understand how to use it.
Running EPS Regression tests
There are two kind of regression tests in MAPPS / EPS, the first on are the legacy ones, in order to run them execute these commands: Note: Depending on your building setup you would need to replace all occurrences of by in the mapps-jui/EPS/EPSNG/build/build.xml file.
cd mapps-jui/EPS/EPSNG/build ant clean ant ant runEPSTests
In order to run the EPS Python regression tests, do the following:
cd mapps-jui/EPS/EPSNG/build ./buildTests.sh cd ../../../.. cp mapps-jui/EPS/EPSNG/delivery/* mappsjui_tests/EPSShell/bin cd mappsjui_tests/EPSShell ./runTests.sh
Metadata
Release files for osve 2.9.0
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 |
|---|---|---|---|---|
| osve-2.9.0-py3-none-any.whl | Python 3 | none | any | Details for osve-2.9.0-py3-none-any.whl |
Release files / osve-2.9.0-py3-none-any.whl
| Download URL | osve-2.9.0-py3-none-any.whl |
|---|---|
| Size | 33.3 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
e13a68f6468744b6046ba7bd7538d4902831c2a535ca278806a84c0c4ffb2774
|
|
BLAKE2b-256 checksum How to use checksums |
96062164d7afa9952c1751e700049654ef55670360222d1ec1795ed67aeab9e0
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.11.4
|
Security for osve 2.9.0
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.