GFINDER CLI#

Note

The same documentation can be accessed via the GFINDER CLI, for example:

gfinder --help
gfinder search --help

gfinder#

MAJIS Operations Simulator CLI.

gfinder [OPTIONS] COMMAND [ARGS]...

Options

--version#: Show the version and exit.

compute#

Compute observation geometry.

This command takes as input an Opportunity Definition File (ODF) file, containing the geometry condition(s) and geometry parameters corresponding to a user-defined observation opportunity.

Computation time window can be provided as timing inputs (using start-time, stop-time, event-id options), or or as an ‘opportunity’ resulting from a previous search.

It produces a set of output geometry event (GeoEvt) files in JSON format, depending of the number of input time intervals or opportunities, bundled in an ‘opportunity’ directory. It also produce companion GeoJSON files. The identifier of an opportunity is automatically assigned. Geometry events are either: a sequence of observations, or an observation:

Sequence GeoEvt files contain the times and geometry of a sequence of observations, and the times and geometry of each individual observation opportunity.
Observation GeoEvt files contains the times and geometry of an observation opportunity, and the times and geometry of each individual instant measurement.

The geometry of an observation is always derived from the geometry of all individual instant measurement (model hypothesis). Timing information, such as the number of time steps, can be provided as an option.

Examples:

$ gfinder compute –odf-file=data/odf/highres_ganymede_mapping.json –event-id=GCO1 $ gfinder compute –odf-file=data/odf/jupiter_disk.json –event-id=JFB1

gfinder compute [OPTIONS]

Options

--odf-file <odf_file>#: Input Opportunity Definition File.

--opportunity-id <opportunity_id>#: Identifier of the opportunity to compute geometry data for.

--event-id <event_id>#: ID of the mission event to be used as input time window (based on Mission Fvents file).

--start-time <start_time>#: Start time of the input time window (UTC).

--stop-time <stop_time>#: Stop time of the input time window (UTC).

--n-steps <n_steps>#: Number of computation steps (or repetitions) (default: 100).

--time-step <time_step>#: Computation time step, in seconds (or repetition time)

--mission-scenario-id <mission_scenario_id>#: Mission scenario ID (default: CREMA50)

--target <target>#: Target name ODF overwrite.

--binning <binning>#: Detector binning: 1 (default), 2 or 4.

--ptr-file <ptr_file>#: Input PTR file, converted into CK file and loaded to SPICE kernel pool.

--ck-file <ck_file>#: Input CK file loaded to SPICE kernel pool.

--sim-sc-att, --no-sim-sc-att#: Simulate SC attitude based on input ODF pointing definition (default: False).

--sc-slew-angles <sc_slew_angles>#: Overwrites ODF SC_Slew_Angles parameters (run geometry command to know allowed parameters).

--sim-scanner, --no-sim-scanner#: Simulate MAJIS scanner pointing based on input ODF pointing definition (default: False).

--majis-scan-angle <majis_scan_angle>#: Overwrites ODF MAJIS_Scan_Angle parameters (run geometry command to know allowed parameters).

--overwrite, --no-overwrite#: Overwrite existing opportunity data files.

--suffix <suffix>#: Add suffix string to the computed opportunity ID.

config#

Get information about configuration.

gfinder config [OPTIONS]

definition#

Get information about an observation opportunity definition (ODF file).

gfinder definition [OPTIONS] ODF_FILE

Options

--target <target>#: Overwrites ODF target parameters.

--binning <binning>#: Detector binning: 1 (default), 2 or 4

--sc-slew-angles <sc_slew_angles>#: Overwrites ODF SC_Slew_Angles parameters (run geometry command to know allowed parameters).

--majis-scan-angle <majis_scan_angle>#: Overwrites ODF MAJIS_Scan_Angle parameters (run geometry command to know allowed parameters).

--to-json, --no-to-json#: Output JSON

Arguments

ODF_FILE#: Required argument

definitions#

List available observation opportunity definitions (ODF files), grouped by observation type.

gfinder definitions [OPTIONS]

Options

--obs-type <obs_type>#: Filter by observation type

--target <target>#: Filter by target name

event#

Get information about a mission event for a given event identifier or synonym.

A mission event ID within MOS is defined as a unique string identifier allowing to retrieve an event defined in events files. Identifier is formed as follows:

|     MISSION_EVENT_ID: '<event_file_key>:<key1>[:<key2>]' (full) or '<synonym>'

where:

<event_file_key> is the key of event file as defined in the Mission Scenario Index file, for example:

‘phase’, ‘timeline’, ‘orbit’, ‘dl’ and ‘custom’.

<key1> is the name of the event (eg: ‘GCO500’ or ‘PERIJOVE_12PJ’), or the name of the events list (eg:

‘FLYBY_EUROPA’ or ‘DL_’).

<key2> is the optional name of the event, when exists (eg: ‘7E1’ for ‘FLYBY_EUROPA’ events list), or the

occurence number of the event in the events list (eg: ‘66’ for ‘IO_TRANSIT’ events list).

For example:

$ gfinder event phase:GCO500
$ gfinder event timeline:FLYBY_GANYMEDE:1G1
$ gfinder event orbit:54
$ gfinder event custom:TOUR

When only <event_file_key> is provided (no <key1> and <key2>), it is assumed to be a synonym and its corresponding event ID is derived. Examples of synonyms, which can be used (not sensitive to the case):

$ gfinder event TOUR    # ‘custom:TOUR’
$ gfinder event GCO500  # ‘phase:GCO500’
$ gfinder event 7E1     # ‘timeline:FLYBY_EUROPA:7E1’
$ gfinder event PJ12    # ‘timeline:PERIJOVE_12PJ’
$ gfinder event AP12    # ‘timeline:APOJOVE_12AP’
$ gfinder event orb54   # ‘orbit:54’
$ gfinder event dl666   # ‘dl:DL_:666’

gfinder event [OPTIONS] MISSION_EVENT_ID

Options

--mission-scenario-id <mission_scenario_id>#: Mission scenario ID (default: CREMA50)

Arguments

MISSION_EVENT_ID#: Required argument

events#

List mission events for a given mission scenario.

Examples:

gfinder events –event-file-key=phase –mission-scenario-id=CREMA5_1_150lb

gfinder events –filter=’flyby’

gfinder events [OPTIONS]

Options

--event-file-key <event_file_key>#: Filter by event file key (eg: “phase”, “orbit”)

--filter <filter>#: Filter name using complex regular expression.

--before <before>#: Filter before a given UTC time.

--after <after>#: Filter after a given UTC time.

--mission-scenario-id <mission_scenario_id>#: Mission scenario ID (default: CREMA50)

export#

Export opportunity data to external data format (EventCSV, QuaternionCSV, GeoJSON, CK, PTR, ITL).

Exported files are located in subdirectories of the opportunity directory. Each subdirectory corresponds to the exported format (eg: EventCSV files on eventcsv/ subdirectory).

Export to Event CSV:

Jupiter ring low-phase observations opportunity windows, and a specific simulated observation geometry data in CSV format.

$ gfinder export crema50_jup_majis_mainring_lowphase_20310119_20341219 –format=EventCSV

$ gfinder export crema50_jup_majis_mainring_lowphase_20331127_20331127 –format=EventCSV

Export to PTR:

$ gfinder export crema50_jup_majis_mainring_lowphase_20331127_20331127 –format=PTR

$ gfinder export crema50_jup_majis_mainring_lowphase_20331127_20331127 –format=PTR –agm-validation

gfinder export [OPTIONS] OPPORTUNITY_ID

Options

--format <format>#: Output format: [‘EventCSV’, ‘GeoJSON’, ‘QuaternionCSV’, ‘CK’, ‘PTR’, ‘ITL’].

--overwrite, --no-overwrite#: Overwrite existing exported files.

--measurements, --no-measurements#: [EventCSV] Export measurements data for all observations. By default, only the first observation measurements are exported.

--agm-validation, --no-agm-validation#: [PTR] Validate exported PTR file(s) using AGM.

Arguments

OPPORTUNITY_ID#: Required argument

geometries#

List available geometry classes.

gfinder geometries [OPTIONS]

Options

-name, --name-filter <name_filter>#: Filter by any string contained in the Geometry class name.

-class, --class-filter <class_filter>#: Filter by Geometry parent class (eg: Scalar, Direction)

--searchable, --no-searchable#: Show source code for computing Geometry.

geometry#

Get information about a given geometry class.

gfinder geometry [OPTIONS] CLASS_NAME

Options

--source-code, --no-source-code#: Show source code for computing Geometry.

Arguments

CLASS_NAME#: Required argument

opportunities#

List available opportunities (for a given mission scenario, phase/segment and/or target: not implemented).

gfinder opportunities [OPTIONS]

Options

--mission-scenario-id <mission_scenario_id>#: Mission scenario ID (default: CREMA50)

--filter <filter>#: Filter by any string contained in opportunity ID.

opportunity#

Get information about an opportunity.

gfinder opportunity [OPTIONS] OPPORTUNITY_ID

Options

--depth <depth>#: Depth of data (1:sequence, 2:observation, 3:measurement)

Arguments

OPPORTUNITY_ID#: Required argument

ptr-pointings#

Show PTR pointing types.

gfinder ptr-pointings [OPTIONS]

ptrgen#

(beta) Generate a PTR file based on a pre-defined “PTR Pointing Type”, and given a set of required pointing parameters.

Use –params to show “pointing parameters” for a given PTR pointing type.

Examples:

$ gfinder ptrgen juice_jupiter_ring –params
$ gfinder ptrgen juice_jupiter_ring –fixed_offset_x_angle=12.6
$ gfinder ptrgen juice_jupiter_ring –fixed_offset_x_angle=12.6 –agm-validation

scenario#

Get information about a mission scenario.

gfinder scenario [OPTIONS] MISSION_SCENARIO_ID

Arguments

MISSION_SCENARIO_ID#: Required argument

scenarios#

List available mission scenarios.

gfinder scenarios [OPTIONS]

Options

--mission-scenario-id <mission_scenario_id>#: Mission scenario ID (default: CREMA50)

search#

Search observation opportunities.

This command takes as input an Opportunity Definition File (ODF) file, containing the geometry condition(s) and geometry parameters corresponding to a user-defined observation opportunity.

Search time window can be provided as timing inputs (using start_time, stop_time, event_name options), or as an ‘opportunity’ resulting from a previous search.

It produces a set of output geometry event (GeoEvent) files in JSON format bundled in an ‘opportunity’ directory. It also produces companion GeoJSON files when applicable. The identifier of an opportunity is automatically assigned.

gfinder search [OPTIONS] ODF_FILE

Options

--opportunity-id <opportunity_id>#: Identifier of an opportunity to used as input time window input (cascading search).

--start-time <start_time>#: Start time of the input time window (UTC), or relative start time string if –event-id is used.

--stop-time <stop_time>#: Stop time of the input time window (UTC), or relative stop time string if –event-id is used.

--event-id <event_id>#: Identifier of the mission event (phase/segment) to be used as input time window (based on Mission Event file).

--n-steps <n_steps>#: Number of time steps used to derive time step (default: 100).

--time-step <time_step>#: Time step, in seconds, to be used to bracket roots (default: 1.0 sec.).

--mission-scenario-id <mission_scenario_id>#: Mission scenario ID (default: CREMA50)

--target <target>#: Target name ODF overwrite.

--compute, --no-compute#: Run observation geometry data computation for all opportunity windows.

--overwrite, --no-overwrite#: Overwrite existing opportunity data files.

--suffix <suffix>#: Add suffix string to the searched opportunity ID.

Arguments

ODF_FILE#: Required argument

GFINDER CLI

Contents

GFINDER CLI#

gfinder#

compute#

config#

definition#

definitions#

event#

events#

export#

geometries#

geometry#

opportunities#

opportunity#

ptr-pointings#

ptrgen#

scenario#

scenarios#

search#