es_sfgtools.pride_tools.pride_cli_config module

class es_sfgtools.pride_tools.pride_cli_config.Constellations(value)

Bases: str, Enum

BDS = 'C'

BDS_THREE = '3'

BDS_TWO = '2'

GLAILEO = 'E'

GLONASS = 'R'

GPS = 'G'

QZSS = 'J'

classmethod print_options()

class es_sfgtools.pride_tools.pride_cli_config.PrideCLIConfig(*, sample_frequency: float = 1, system: str = 'GREC23J', frequency: list = ['G12', 'R12', 'E15', 'C26', 'J12'], loose_edit: bool = True, cutoff_elevation: int = 7, interval: float | None = None, high_ion: bool | None = None, tides: str = 'SOP', local_pdp3_path: str | None = None, override: bool = False, override_products_download: bool = False, pride_configfile_path: Path | None = None)

Bases: BaseModel

PrideCLIConfig is a configuration class for setting up and generating commands to run the pdp3 GNSS processing tool. .. attribute:: system

The GNSS system(s) to use. Default is “GREC23J” which is “GPS/GLONASS/Galileo/BDS/BDS-2/BDS-3/QZSS”.

type:

str

frequency

The GNSS frequencies to use. Default is [“G12”, “R12”, “E15”, “C26”, “J12”]. Refer to Table 5-4 in PRIDE-PPP-AR v.3.0 manual for more options.

Type:

list

loose_edit

Disable strict editing mode, which should be used when high dynamic data quality is poor. Default is True.

Type:

bool

cutoff_elevation

The elevation cutoff angle in degrees (0-60 degrees). Default is 7.

Type:

int

interval

Processing interval, values range from 0.02s to 30s. If this item is not specified and the configuration file is specified, the processing interval in the configuration file will be read, otherwise, the sampling rate of the observation file is used by default.

Type:

float

high_ion

Use 2nd ionospheric delay model with CODE’s GIM product. When this option is not entered, no higher-order ionospheric correction is performed. Default is False.

Type:

bool

tides

Enter one or more of “S” “O” “P”, e.g SO for solid, ocean, and polar tides. Default is “SOP”, which uses all tides.

Type:

str

local_pdp3_path

The path to the local pdp3 binary. Default is None.

Type:

str

generate_pdp_command(site

str, local_file_path: str) -> List[str]: Generate the command to run pdp3 with the given parameters.

site (str): The site identifier for the GNSS data. local_file_path (str): The local file path to the GNSS data.

Returns:

The command to run pdp3 with the specified configuration.

Return type:

List[str]

cutoff_elevation: int

frequency: list

generate_pdp_command(site: str, local_file_path: str) → List[str]

Generate the command to run pdp3 with the given parameters

high_ion: bool | None

interval: float | None

local_pdp3_path: str | None

loose_edit: bool

model_computed_fields = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields = {'cutoff_elevation': FieldInfo(annotation=int, required=False, default=7), 'frequency': FieldInfo(annotation=list, required=False, default=['G12', 'R12', 'E15', 'C26', 'J12']), 'high_ion': FieldInfo(annotation=Union[bool, NoneType], required=False, default=None), 'interval': FieldInfo(annotation=Union[float, NoneType], required=False, default=None), 'local_pdp3_path': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, title='Local Path to pdp3 Binary', description='Path to the local pdp3 binary. If not provided, the system PATH will be used.'), 'loose_edit': FieldInfo(annotation=bool, required=False, default=True), 'override': FieldInfo(annotation=bool, required=False, default=False), 'override_products_download': FieldInfo(annotation=bool, required=False, default=False, title='Flag to Override Existing Products Download'), 'pride_configfile_path': FieldInfo(annotation=Union[Path, NoneType], required=False, default=None, title='Path to Pride Config File', description='Path to the Pride config file. If not provided, the default config will be used.'), 'sample_frequency': FieldInfo(annotation=float, required=False, default=1), 'system': FieldInfo(annotation=str, required=False, default='GREC23J'), 'tides': FieldInfo(annotation=str, required=False, default='SOP')}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

override: bool

override_products_download: bool

pride_configfile_path: Path | None

sample_frequency: float

system: str

tides: str

class es_sfgtools.pride_tools.pride_cli_config.Tides(value)

Bases: str, Enum

OCEAN = 'O'

POLAR = 'P'

SOLID = 'S'

classmethod print_options()