es_sfgtools.workflows.pipelines.config module
- class es_sfgtools.workflows.pipelines.config.DFOP00Config(*, override: bool = False)
Bases:
BaseModel- model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}
A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
- model_config: ClassVar[ConfigDict] = {}
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'override': FieldInfo(annotation=bool, required=False, default=False, title='Flag to Override Existing Data')}
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
- class es_sfgtools.workflows.pipelines.config.NovatelConfig(*, override: bool = False, n_processes: int = None)
Bases:
BaseModel- model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}
A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
- model_config: ClassVar[ConfigDict] = {}
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'n_processes': FieldInfo(annotation=int, required=False, default_factory=method, title='Number of Processes to Use'), 'override': FieldInfo(annotation=bool, required=False, default=False, title='Flag to Override Existing Data')}
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
- n_processes: int
- override: bool
- class es_sfgtools.workflows.pipelines.config.PositionUpdateConfig(*, override: bool = False, lengthscale: Annotated[float, Ge(ge=0.1), Le(le=1)] = 0.1, plot: bool = False)
Bases:
BaseModel- lengthscale: float
- model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}
A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
- model_config: ClassVar[ConfigDict] = {}
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'lengthscale': FieldInfo(annotation=float, required=False, default=0.1, title='Length Scale for Interpolation in seconds', metadata=[Ge(ge=0.1), Le(le=1)]), 'override': FieldInfo(annotation=bool, required=False, default=False, title='Flag to Override Existing Data'), 'plot': FieldInfo(annotation=bool, required=False, default=False)}
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
- plot: bool
- class es_sfgtools.workflows.pipelines.config.PrepSiteData(*, network: str, station: str, campaign: str, inter_dir: Path, pride_dir: Path, gnss_obs_data_dest: str | Path, kin_position_data_dest: str | Path, shot_data_dest: str | Path)
Bases:
BaseModel- campaign: str
- gnss_obs_data_dest: str | Path
- inter_dir: Path
- kin_position_data_dest: str | Path
- model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}
A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
- model_config: ClassVar[ConfigDict] = {'arbitrary_types_allowed': True}
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'campaign': FieldInfo(annotation=str, required=True, title='Campaign Name'), 'gnss_obs_data_dest': FieldInfo(annotation=Union[str, Path], required=True, title='GNSS Obs Data Destination'), 'inter_dir': FieldInfo(annotation=Path, required=True, title='Intermediate Directory'), 'kin_position_data_dest': FieldInfo(annotation=Union[str, Path], required=True, title='Kin Position Data Destination'), 'network': FieldInfo(annotation=str, required=True, title='Network Name'), 'pride_dir': FieldInfo(annotation=Path, required=True, title='Pride Directory'), 'shot_data_dest': FieldInfo(annotation=Union[str, Path], required=True, title='Shot Data Destination'), 'station': FieldInfo(annotation=str, required=True, title='Station Name')}
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
- network: str
- pride_dir: Path
- shot_data_dest: str | Path
- station: str
- class es_sfgtools.workflows.pipelines.config.RinexConfig(*, override: bool = False, n_processes: int = None, settings_path: Path | None = '', time_interval: int | None = 1, processing_year: Annotated[int | None, Le(le=2100)] = -1, use_secondary: bool = False)
Bases:
BaseModel- model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}
A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
- model_config: ClassVar[ConfigDict] = {'arbitrary_types_allowed': True}
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'n_processes': FieldInfo(annotation=int, required=False, default_factory=method, title='Number of Processes to Use'), 'override': FieldInfo(annotation=bool, required=False, default=False, title='Flag to Override Existing Data'), 'processing_year': FieldInfo(annotation=Union[int, NoneType], required=False, default=-1, description='Processing year to query tiledb', metadata=[Le(le=2100)]), 'settings_path': FieldInfo(annotation=Union[Path, NoneType], required=False, default='', title='Settings Path'), 'time_interval': FieldInfo(annotation=Union[int, NoneType], required=False, default=1, title='Tile to Rinex Time Interval [h]'), 'use_secondary': FieldInfo(annotation=bool, required=False, default=False, title='Use Secondary GNSS observation Data', description='If True, uses the secondary GNSS observation data for processing.')}
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
- n_processes: int
- override: bool
- processing_year: int | None
- settings_path: Path | None
- time_interval: int | None
- use_secondary: bool
- class es_sfgtools.workflows.pipelines.config.SV3PipelineConfig(*, pride_config: PrideCLIConfig = PrideCLIConfig(sample_frequency=1, system='GREC23J', frequency=['G12', 'R12', 'E15', 'C26', 'J12'], loose_edit=True, cutoff_elevation=7, interval=None, high_ion=None, tides='SOP', local_pdp3_path=None, override=False, override_products_download=False, pride_configfile_path=None), novatel_config: NovatelConfig = NovatelConfig(override=False, n_processes=2), rinex_config: RinexConfig = RinexConfig(override=False, n_processes=2, settings_path='', time_interval=1, processing_year=-1, use_secondary=False), dfop00_config: DFOP00Config = DFOP00Config(override=False), position_update_config: PositionUpdateConfig = PositionUpdateConfig(override=False, lengthscale=0.1, plot=False))
Bases:
BaseModel- dfop00_config: DFOP00Config
- classmethod load_yaml(filepath: Path)
- model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}
A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
- model_config: ClassVar[ConfigDict] = {'arbitrary_types_allowed': True, 'title': 'SV3 Pipeline Configuration'}
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'dfop00_config': FieldInfo(annotation=DFOP00Config, required=False, default=DFOP00Config(override=False)), 'novatel_config': FieldInfo(annotation=NovatelConfig, required=False, default=NovatelConfig(override=False, n_processes=2)), 'position_update_config': FieldInfo(annotation=PositionUpdateConfig, required=False, default=PositionUpdateConfig(override=False, lengthscale=0.1, plot=False)), 'pride_config': FieldInfo(annotation=PrideCLIConfig, required=False, default=PrideCLIConfig(sample_frequency=1, system='GREC23J', frequency=['G12', 'R12', 'E15', 'C26', 'J12'], loose_edit=True, cutoff_elevation=7, interval=None, high_ion=None, tides='SOP', local_pdp3_path=None, override=False, override_products_download=False, pride_configfile_path=None)), 'rinex_config': FieldInfo(annotation=RinexConfig, required=False, default=RinexConfig(override=False, n_processes=2, settings_path='', time_interval=1, processing_year=-1, use_secondary=False))}
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
- novatel_config: NovatelConfig
- position_update_config: PositionUpdateConfig
- pride_config: PrideCLIConfig
- rinex_config: RinexConfig
- to_yaml(filepath: Path)
- update(update_dict: dict) SV3PipelineConfig