OSVE Datapacks
OSVE dataPacks are intended to export generated data during the simulation to an output formatted file, or by providing this data via callbacks to the OSVE caller program.
For the moment only CSV formatted files are supported as output formatted files. But you could use the CALLBACK datapacks to easily implement your own custom writer.
This is how a list of 4 dataPacks looks like in the session file:
...
"outputFiles": {
...
"dataPacks": [
{
"filePath": "dataPack1.csv",
"precision": 9,
"fields": [
{
"type": "time",
"format": "utc",
"label": "date"
},
{
"type": "MAPPS",
"overlayId": "ATT_QUAT_VALUE",
"label": "qs"
},
{
"type": "MAPPS",
"overlayId": "ATT_QUAT_AXIS1",
"label": "q1"
},
{
"type": "MAPPS",
"overlayId": "ATT_QUAT_AXIS2",
"label": "q2"
},
{
"type": "MAPPS",
"overlayId": "ATT_QUAT_AXIS3",
"label": "q3"
}
]
},
{
"filePath": "dataPack2.csv",
"timeStep": 60,
"precision": 3,
"type": "CSV",
"fields": [
{
"type": "time",
"format": "utc"
},
{
"type": "MAPPS",
"overlayId": "EPS_BATTERY_DOD"
},
{
"type": "MAPPS",
"overlayId": "EPS_SA_POWER",
"label": "SolarArrayWatts"
"precision": 5
},
{
"type": "MAPPS",
"overlayId": "EPS_SA_AVAIL_POWER"
},
{
"type": "MAPPS",
"overlayId": "EPS_SA_ANGLE"
},
{
"type": "MAPPS",
"overlayId": "EPS_SA_FLUX"
},
{
"type": "MAPPS",
"overlayId": "FLUX_PANEL_NORM",
"vector": [0.5, 0.5, 0.0]
},
{
"type": "MAPPS",
"overlayId": "AGM_PROFILE",
"agmEventIndex": 0,
"agmEventMode": "STATE"
},
{
"type": "MAPPS",
"overlayId": "AGM_PROFILE",
"agmEventIndex": 0,
"agmEventMode": "VALUE"
}
]
},
{
"filePath": "callbacksDatapack1",
"type": "CALLBACK",
"fields": [
{
"type": "time",
"format": "utc"
},
{
"type": "MAPPS",
"overlayId": "EPS_SA_POWER"
},
{
"type": "MAPPS",
"overlayId": "STATE_PARAM",
"parameter1": "SSMM",
"parameter2": "STATE_TIME"
},
{
"type": "MAPPS",
"overlayId": "DS_MEMORY",
"parameter1": "SSMM",
"parameter2": "SSMM_INSITU"
},
{
"type": "MAPPS",
"overlayId": "DS_ACCUM",
"parameter1": "SSMM",
"parameter2": "SSMM_INSITU"
},
{
"type": "MAPPS",
"overlayId": "EXP_DR_UP",
"parameter1": "KAB_LINK"
},
{
"type": "MAPPS",
"overlayId": "EXP_DR_DOWN",
"parameter1": "KAB_LINK"
},
{
"type": "MAPPS",
"overlayId": "EXP_MEMORY",
"parameter1": "SSMM"
},
{
"type": "MAPPS",
"overlayId": "EXP_ACCUM",
"parameter1": "SSMM"
},
{
"type": "MAPPS",
"overlayId": "EXP_POWER",
"parameter1": "GEOPHYSICS"
}
]
},
{
"filePath": "callbacksDatapack2",
"type": "CALLBACK",
"fields": [
{
"type": "time",
"format": "utc"
},
{
"type": "MAPPS",
"overlayId": "ATT_QUAT_VALUE"
},
{
"type": "MAPPS",
"overlayId": "ATT_QUAT_AXIS1"
},
{
"type": "MAPPS",
"overlayId": "ATT_QUAT_AXIS2"
},
{
"type": "MAPPS",
"overlayId": "ATT_QUAT_AXIS3"
}
]
}
]
},
...
So in this case we are going to generate two CSV data packs with the first column as the time in UTC format. The datapack 1 will then have the S/C quaternion elements and the datapack 2 will have some Power Model parameters between others.
Therefore for each data pack, the user must indicate the filename and fields and optionally the time resolution and data precision of the datapack.
Precision range goes from 0 to 12.
Datapack fields
Datapack consists of a list of numerical series or profiles. Each numerical series in a datapack is called datapack field.
Each datapack field definition shall provide an overlayId and a type, supported types are:
Each field have a type, supported types are:
time: Specifies to OSVE that this field is of type time. You could also specify the time format with the
formatfield keyword, at the time being onlyutcis supported.MAPPS: Specifies to OSVE that this field represents a AGM/EPS Overlay, so required
overlayIdfield keyword must match one of the supported AGM/EPS Overlays. Note all MAPPS Overlays haven’t been implemented. See more details at the 36_osve_datapacks:AGM and EPS Overlays Supported by OSVE section.OSVE: Specifies to OSVE that this field represents an OSVE Overlay, so required
overlayIdfield keyword must match one of the supported OSVE Overlays. See more details at the 36_osve_datapacks:OSVE Overlays Supported section.
Optional datapack field attributes
Additionally, a label can be specified in order to set the column name to show in the CSV header,
and a specific field precision could be set by using the precision attribute.
Note
In case the label attribute is not specified the default column name will be have the following syntax:
{OVERLAY_ID_MNEMONIC}[_{PARAMETER1}[_{PARAMETER2}]]
Finally, there are specific overlays that requires dedicated attributes to be present in the field definition, such us:
vector: Array of three numbers specifying the vector coordinates in case of a vector specification is required by the selected overlay ID. Example of syntax: “vector”: [0.5, 0.5, 0.0]
agmEventIndex: Integer specifying the AGM Event Index as found the AGM Event file starting by 0, only required when using ‘AGM_PROFILE’ overlay ID.
agmEventMode: String specifying the AGM Event value to report. Type ‘VALUE’ for reporting the event value being checked against the event threshold, or type ‘STATE’ to report the event state. Only required when using ‘AGM_PROFILE’ overlay ID.
parameter1: String with the value of the parameter1. Only required by overlays IDs that requires parameter1 specification.
parameter2: String with the value of the parameter2. Only required by overlays IDs that requires parameter2 specification.
CSV Datapacks
The CSV datapacks are intended to export generated data during the simulation to an output CSV formatted file.
In the example above, the CSV datapacks have the first column as the time in UTC format. The datapack 1 will then have the SC quaternion elements and the datapack 2 will have some power model properties.
So for each dataPack, the user shall indicate at least the filename and fields, but also could specify that the type is “CSV” to keep it clear and optionally the time resolution and data precision of the datapack.
CALLBACK Datapacks
The CALLBACK datapacks are intended to notify and provide to the OSVE caller program the steps, the data, and events risen during the simulation.
More details of the OSVE CALLBACK datapacks is provided in CALLBACK Datapacks
AGM and EPS Overlays Supported by OSVE
Spacecraft Attitude overlays
- SUN_PANEL_PX, SUN_PANEL_MX, SUN_PANEL_PY, SUN_PANEL_MY, SUN_PANEL_PZ, SUN_PANEL_MZ
These overlays provide the elevation angle of the Sun above the spacecraft panel facing towards the (+X, -X, +Y, -Y, +Z, -Z) direction [deg].
- SUN_PANEL_NORM
This overlay is the same as (SUN_PANEL_…) but the panel normal is specified by a vector in the SC Frame by specifying an overlay vector.
- SUN_ANGLE_PX, SUN_ANGLE_MX, SUN_ANGLE_PY, SUN_ANGLE_MY, SUN_ANGLE_PZ, SUN_ANGLE_MZ
These overlays provide the angle of the spacecraft to Sun vector with the spacecraft panel normal vector of the panel facing towards the (+X, -X, +Y, -Y, +Z, -Z) direction [deg].
- SUN_ANGLE_AXIS
This overlay is the same as (SUN_ANGLE_…) but the axis is specified by a vector in the SC Frame by specifying an overlay vector.
- FLUX_PANEL_PX, FLUX_PANEL_MX, FLUX_PANEL_PY, FLUX_PANEL_MY, FLUX_PANEL_PZ, FLUX_PANEL_MZ
These overlays provide the solar flux on the spacecraft panel facing towards the (+X, -X, +Y, -Y, +Z, -Z) direction. The solar flux takes into account the relative distance of the spacecraft from the Sun, the solar incidence angle on the panel, but does not account for when the spacecraft is in eclipse [W/m2].
- FLUX_PANEL_NORM
This overlay is the same as (FLUX_PANEL_…) but the panel normal is specified by a vector in the SC Frame by specifying an overlay vector.
- TOTAL_BODY_RATE
This overlay provides the total spacecraft body rate [deg/sec].
- BODY_RATE_X, BODY_RATE_Y, BODY_RATE_Z
These overlays provide the spacecraft body rate around the (X, Y, Z)-axis [deg/sec].
- TOTAL_BODY_ACC
This overlay provides the total spacecraft body acceleration [deg/sec2].
- BODY_ACC_X, BODY_ACC_Y, BODY_ACC_Z
These overlays provide the spacecraft body acceleration around the (X, Y, Z)-axis [deg/sec2].
- ATT_QUAT_AXIS1, ATT_QUAT_AXIS2, ATT_QUAT_AXIS3, ATT_QUAT_VALUE
These overlays provide the component of the quaternion representing the spacecraft attitude in the EME reference frame.
Warning
SUN_PANEL_P/Mn, SUN_ANGLE_P/Mn, and FLUX_PANEL_P/Mn provide different results in MAPPS and in OSVE. This is due to the fact that environmental information in OSVE, such as object positions and geometrical computations are coming from SPICE while in MAPPS are produced by the simulator, so both implementations are independent.
Please note that About Sun angle overlays, these shall be investigated, environmental information in OSVE, such as object positions and geometrical computations are coming from SPICE while in MAPPS are produced by the simulator, so both implementations are independent.
HGA (High Gain Antenna) overlays
These overlays will only be computed when the AGM HGA has been activated, see AGM section. Please note that these overlays are not relevant for JUICE.
- HGA_ELEV
This overlay provides the HGA Elevation [deg].
- HGA_AZ
This overlay provides the HGA Azimuth [deg].
- HGA_ELEV_RATE:
This overlay provides the HGA Elevation Rate [deg/sec].
- HGA_AZ_RATE:
This overlay provides the HGA Azimuth Rate [deg/sec].
- HGA_ELEV_ACCEL:
This overlay provides the HGA Elevation Acceleration [deg/sec2].
- HGA_AZ_ACCEL:
This overlay provides the HGA Azimuth Acceleration [deg/sec2].
MGA (Medium Gain Antenna) overlays
These overlays will only be computed when the AGM MGA has been activated, see AGM section.
Note
In AGM all these overlays support to specify a given pointing case for MGA using the overlay paramValue1, but for OSVE at the time being only the COMBINED CASE is provided, so no specific parameters are required.
Supported pointing cases by AGM:
0: COMBINED CASE: AGM tries to find the optimal pointing case in each time step (Default value).
1: CASE -Y: AGM tries to point to Earth using the boom rotation that is aligned with the -Y SC Axis. So for pointing to +X SC Axis the Boom Rotation is 0 and the Dish Orientation is 0. Currently disabled in OSVE.
2: CASE Y: AGM tries to point to Earth using the boom rotation that is aligned with the Y SC Axis. So for pointing to +X SC Axis the Boom Rotation is 180 and the Dish Orientation is 180. Currently disabled in OSVE.
- MGA_ELEV
This overlay provides the MGA Elevation [deg].
- MGA_AZ
This overlay provides the MGA Azimuth [deg].
- MGA_ELEV_RATE
This overlay provides the MGA Elevation Rate [deg/sec].
- MGA_AZ_RATE
This overlay provides the MGA Azimuth Rate [deg/sec].
- MGA_ELEV_ACCEL
This overlay provides the MGA Elevation Acceleration [deg/sec2].
- MGA_AZ_ACCEL
This overlay provides the MGAAzimuth Acceleration [deg/sec2].
- MGA_ANGLE
This overlay provides the angle between the Earth direction vector in SC frame versus the antenna look at vector in SC Frame [deg].
- MGA_BOOM_ROT
This overlay provides the boom rotation angle of the MGA. This is the angle between boom and the MGA X axis (That for JUICE is the SC -Y Axis). This value goes from 180 to -180 degrees [deg].
- MGA_DISH_ORI
This overlay provides the dish orientation angle of the MGA. This is the angle between dish pointing vector and the MGA Y axis (That for JUICE is the SC X Axis). This value goes from 0 to 360 degrees [deg].
Reaction Wheels(RW) overlays
These overlays will only be computed when the AGM WMM has been activated, see AGM section.
In order to AGM to compute the Excursion values the user shall specify the AGM AC_RWEXCURSIONMIN and AC_RWEXCURSIONMAX configuration parameters while taking in account that MAX values shall be greater that MIN values, otherwise excursion computation is disabled.
Reaction Wheels
- WHEEL_1_TORQUE, WHEEL_2_TORQUE, WHEEL_3_TORQUE, WHEEL_4_TORQUE
These overlays provide the AGM legacy torque of reaction wheel (1, 2, 3, 4).The equivalent WMM_WHL_(N)_TORQUE shall be used [Nm].
- WMM_WHL_1_TORQUE, WMM_WHL_2_TORQUE, WMM_WHL_3_TORQUE, WMM_WHL_4_TORQUE
These overlays provide the torque of reaction wheel (1, 2, 3, 4). These overlays are equivalent to WMM_WHL_(N)_TORQUE [Nm].
- WHEEL_1_EXCURS, WHEEL_2_EXCURS, WHEEL_3_EXCURS, WHEEL_4_EXCURS
These overlays provide the excursion of reaction wheel (1, 2, 3, 4) [Nms].
Warning
WHEEL_n_TORQUE and WMM_WHL_n_TORQUE provide only absolute values whereas in MAPPS negative values are also provided.
Wheel Momentum Management
- WMM_GGT_X, WMM_GGT_Y, WMM_GGT_Z
These overlays provide the (X, Y, Z) component of the gravity gradient torque due to the target body [Nm].
- WMM_BODYRATES_X, WMM_BODYRATES_Y, WMM_BODYRATES_Z
These overlays provide the (X, Y, Z) component of the spacecraft body rates [rad/s].
- WMM_ASS_MOM_X, WMM_ASS_MOM_Y, WMM_ASS_MOM_Z
These overlays provide the (X, Y, Z) component of the reaction wheel assembly momentum [Nms].
- WMM_WHL_1_ACC_MOM, WMM_WHL_2_ACC_MOM, WMM_WHL_3_ACC_MOM, WMM_WHL_4_ACC_MOM:
These overlays provide the momentum of reaction wheel (1, 2, 3, 4) [Nms].
- WMM_WHL_1_TORQUE, WMM_WHL_2_TORQUE, WMM_WHL_3_TORQUE, WMM_WHL_4_TORQUE
These overlays provide the torque of reaction wheel (1, 2, 3, 4). These overlays are equivalent to WHEEL_(N)_TORQUE [Nm].
Power Model Overlays
These overlays will only be computed when the EPS simulation power model and AGM Solar Arrays have been activated,
see AGM section and parameter Power_algorithm in the power models section.
- AGM_SA_FIX_ROT_ANG
This overlay provides the Solar Array Fix Rotation Angle calculated in AGM [deg].
- AGM_SA_ROT_ANG
This overlay provides the Solar Array Rotation Angle calculated in AGM [deg].
- EPS_BATTERY_DOD
This overlay provides the Depth-of-Discharge (DoD), which is a measure for the batteries discharge given as a percentage. In case of 0, the batteries are fully charged. In case of 100, the batteries are fully discharged [%].
- EPS_SA_POWER
This overlay provides the Solar Array generated power, which is the total solar array power (available SA power) taking in account the solar array efficiency and without the auxiliary losses (Solar array and harness power loss). This value goes from 0 Watts to SA_MAXPOWER parameter value in EPS config file [Watts].
- EPS_SA_AVAIL_POWER
This overlay provides the Solar Array available power, which is the total solar array power without any losses. This value goes from 0 Watts to SA_MAXPOWER parameter value in EPS config file [Watts].
- EPS_SA_ANGLE
This overlay provides the Solar Array to Sun angle [deg].
- EPS_SA_FLUX
This overlay provides the solar flux at Solar Array [W/m2].
- EPS_SA_AREA
This overlay provides the Solar Array Area. It is defined as the multiplication of the SA_CELL_AREA parameter by the PM_SA_CELL_COUNT resource value, both defined in the in EPS config file [m2].
AGM Events Overlays
- AGM_PROFILE
This overlay provides the value used for the computation or the event state of a given AGM Event defined using the datapack field attribute ‘agmEventIndex’. The agmEventIndex is an integer specifying the AGM Event Index as found the AGM Event file starting by 0. The datapack field attribute ‘agmEventMode” is an optional string specifying the AGM Event property to report in the datapack. Type ‘VALUE’ for reporting the event value being checked against the event threshold, or type ‘STATE’ to report the event state.
EPS Totals
- TOTAL_POWER
This overlay provides the total experiment power as computed by the EPS software. This overlay has no additional parameters.
- TOTAL_DR_UP
This overlay provides the total upload data rate as computed by the EPS software. This overlay has no additional parameters.
- TOTAL_DR_DOWN
This overlay provides the total download data rate as computed by the EPS software. It the sum of the experiment memory usages while not taking in account any datastore or SSMM. So in the case of JUICE there is no experiment with local memory defined, therefore it reports 0. This overlay has no additional parameters.
- TOTAL_MEMORY
This overlay provides the total of the currently used memory as computed by the EPS software. It provides the sum of the experiment memory usages while not taking in account any datastore or SSMM. So in the case of JUICE there is noexperiment with local memory defined therefore it reports 0. This overlay has no additional parameters.
- TOTAL_ACCUM
This overlay provides the total of the accumulated memory (which is the total of the downloaded memory) as computed by the EPS software. This overlay has no additional parameters.
EPS Experiment Values
- EXP_POWER
This overlay provides the experiment or experiment’s module power in Watts as computed by the EPS software. The experiment shall be defined using parameter1, which shall be a valid experiment label as defined in the EDF. The optional module shall be defined using parameter2, which shall be a valid experiment’s module label as defined in the EDF. In case just requiring the experiment power do not specify parameter2.
- EXP_DR_UP
This overlay provides the experiment upload data rate in bits/s as computed by the EPS software. The experiment shall be defined using parameter1, which shall be a valid experiment label as defined in the EDF. Only the experiments that store data into the SSMM can be requested.
Example:
{ "type": "MAPPS", "overlayId": "EXP_DR_UP", "parameter1": "IN_SITU" }
- EXP_DR_DOWN
This overlay provides the experiment download data rate in bits/s as computed by the EPS software. The experiment shall be defined using parameter1, which shall be a valid experiment label as defined in the EDF. No modelled experiment in JUICE will report EXP_DR_DOWN data, because there is no experiment (that are not downlink devices) that will obtain data from SSMM.
- EXP_MEMORY
This overlay provides the currently used experiment memory in bits as computed by the EPS software. The experiment shall be defined using parameter1, which shall be a valid experiment label as defined in the EDF. Currently the only experiment with local memory is the SSMM.
Example:
{ "type": "MAPPS", "overlayId": "EXP_MEMORY", "parameter1": "SSMM" }
- EXP_ACCUM
This overlay provides the accumulated experiment memory (which is the downloaded memory) in bits as computed by the EPS software.
- EXP_DATAFLOW
This overlay provides the datarate in bits/s generated by an experiment dataflow. The experiment shall be defined using parameter1, which shall be a valid experiment label as defined in the EDF. The dataflow name shall be defined using parameter2, which shall be a valid data flow as defined in the EDF.
Similarly to HK_DATA_VOLUME, the experiment and dataflow shall be specified in the field attributes. For the moment no dataflow is defined in JUICE modelling.
Example:
{ "type": "MAPPS", "overlayId": "EXP_DATAFLOW", "parameter1": "KAB_LINK", "parameter2": "DATAFLOW_KAB" }, { "type": "MAPPS", "overlayId": "EXP_DATAFLOW", "parameter1": "XB_LINK", "parameter2": "DATAFLOW_XB" }
EPS House-Keeping Data Volume
- HK_DATA_VOLUME
This summary item will display the current house-keeping data volume as accumulated in a downlink device. Note that the house-keeping data volume will only have a non-trivial (non-zero) value for a downlink device that has the EDF keyword
HK_data_volumeset to a non-zero value. The downlink device experiment shall be defined using parameter1.Example:
{ "type": "MAPPS", "overlayId": "HK_DATA_VOLUME", "parameter1": "KAB_LINK" }
EPS Data stores
- DS_MEMORY
This overlay provides the currently used memory for an experiment data store in a mass memory device, as computed by the EPS software. The mass memory device shall be defined using parameter1, which shall be a valid mass memory experiment label as defined in the EDF. The datastore shall be defined using parameter2, which shall be a valid datastore label as defined in the EDF.
- DS_ACCUM
This overlay provides the accumulated memory (which is the downloaded memory) for an experiment data store in a mass memory device, as computed by the EPS software. The mass memory device shall be defined using parameter1, which shall be a valid mass memory experiment label as defined in the EDF. The datastore shall be defined using parameter2, which shall be a valid datastore label as defined in the EDF.
EPS State Parameter
- STATE_PARAM
This overlay provides the value of a state parameter. The experiment shall be defined using parameter1. The state parameter name shall be defined using parameter2. The state parameter value (either raw or engineering) will be converted into a floating point value. In case the value can not be converted (e.g. for a status text value), then the overlay value will be set to zero.
Example:
{ "type": "MAPPS", "overlayId": "STATE_PARAM", "parameter1": "JUICE", "parameter2": "POWER" }
EPS Data buses
- TOTAL_DB_RATE
This overlay provides the total bus rate of all available data buses, as defined in the EDF.
- DATA_BUS_RATE
This overlay provides the bus rate of the given data bus, as defined using parameter1.
Example:
{ "type": "MAPPS", "overlayId": "DATA_BUS_RATE", "parameter1": "JUICE_DATABUS" }
Considering that there is a Data_bus defined in an EDF:
Nr_of_data_buses: 1 Data_bus: JUICE_DATABUS
OSVE Overlays Supported
Attitude Checks Overlays
- AGM_ATT_VALID
This overlay provides if the AGM attitude values are valid at a given time. The value reported will be 1 if the spacecraft attitude is valid, or 0 otherwise.
- AGM_BLOCK_TYPE
This overlay provides the block type at a given time. The block type could be UNDEFINED, POINTING or SLEW.
- AGM_POINTING_MODE
This overlay provides the internal AGM Pointing Mode being applied at a given time. The string value format could specify specific mission pointing modes between “()”.
- AGM_COMPOSITE_IDX
This overlay provides the index of the internal AGM Block Index in case a composite block (RASTER, SCAN, ..) is being applied at a given time or 0 otherwise.
- AGM_IN_ERROR
This overlay provides if at least one AGM Constraint is being violated at a given time. The value reported will be 1 in case any constraint is violated, or 0 otherwise.
- AGM_IN_SETTLING
This overlay provides if the spacecraft is in settling time at a given time. The value reported will be 1 in case in settling time, or 0 otherwise.
Wheel Momentum Management Overlays
- AGM_WMM_MOM_IN_ERROR
This overlay provides if a given wheel momentum is in error at a given time. The value reported will be 1 in case in error, or 0 otherwise. The wheel number shall be defined using parameter1, which shall be an integer value in range 0..3.
- AGM_WMM_ASS_MOM_IN_ERROR
This overlay provides if assembly momentum is in error at a given time. The value reported will be 1 in case in error, or 0 otherwise.
- AGM_WMM_TORQUE_IN_ERROR
This overlay provides if a given wheel torque is in error at a given time. The value reported will be 1 in case in error, or 0 otherwise. The wheel number shall be defined using parameter1, which shall be an integer value in range 0..3.
- AGM_WMM_TARGET_BODY
This overlay provides a string with the AGM Object Name of the AGM Target Body at a given time.
- AGM_WMM_HILL_RADIUS
This overlay provides a double value representing the Hill Sphere Radius in kilometers of the AGM Target Body at a given time.
Medium Gain Antenna Overlays
- AGM_MGA_LOOK_AT
This overlay provides a string representing the MGA Boresight vector in the spacecraft reference frame at a given time. This string has the following format: [X;Y;Z]
- AGM_MGA_IS_STOWED
This overlay provides if the MGA is in stowed position. The value reported will be 1 in case of being stowed, or 0 otherwise.