Command Line Interface

This Spinifex command-line interface can make an H5Parm with ionospheric data (TEC or RM), using the metadata from a measurement set.

usage: spinifex [-h] {get_rm_h5parm_from_ms,get_tec_h5parm_from_ms} ...

Positional Arguments

command

Possible choices: get_rm_h5parm_from_ms, get_tec_h5parm_from_ms

Sub-commands

get_rm_h5parm_from_ms

Calculate RM values using spinifex, write to h5parm

spinifex get_rm_h5parm_from_ms [-h]
                               [--iono-model-name {ionex,ionex_iri,tomion}]
                               [--solset-name SOLSET_NAME]
                               [--soltab-name SOLTAB_NAME]
                               [--timestep TIMESTEP] [-o H5PARM] [-a]
                               ms

Positional Arguments

ms

Measurement set for which the RM values should be calculated.

Named Arguments

--iono-model-name

Possible choices: ionex, ionex_iri, tomion

iono mode name

Default: 'ionex'

--solset-name

Solset name. Default: create a new one based on first existing sol###

--soltab-name

Soltab name. Default: rotationmeasure

--timestep

Timestep in seconds for which independent model calculations are done. Default: use time resolution of the measurement set

-o, --h5parm

h5parm to which the results of the RotationMeasure is added.

Default: rotationmeasure.h5

-a, --add-to-existing-solset

Add to existing solset if it exists

Default: False

get_tec_h5parm_from_ms

Calculate tec values using spinifex, write to h5parm

spinifex get_tec_h5parm_from_ms [-h]
                                [--iono-model-name {ionex,ionex_iri,tomion}]
                                [--solset-name SOLSET_NAME]
                                [--soltab-name SOLTAB_NAME]
                                [--timestep TIMESTEP] [-o H5PARM] [-a]
                                ms

Positional Arguments

ms

Measurement set for which the tec values should be calculated.

Named Arguments

--iono-model-name

Possible choices: ionex, ionex_iri, tomion

iono mode name

Default: 'ionex'

--solset-name

Solset name. Default: create a new one based on first existing sol###

--soltab-name

Soltab name. Default: tec###

--timestep

Timestep in seconds for which independent model calculations are done. Default: use time resolution of the measurement set

-o, --h5parm

h5parm to which the results of the tec is added.

Default: tec.h5

-a, --add-to-existing-solset

Add to existing solset if it exists

Default: False