gnatss.main module

gnatss.main.run_gnatss(config_yaml: str, distance_limit: float | None = None, residual_limit: float | None = None, residual_range_limit: float | None = None, outlier_threshold: float | None = None, from_cache: bool = False, return_raw: bool = False, remove_outliers: bool = False, extract_process_dataset: bool = True, extract_dist_center: bool = True, qc: bool = True, skip_parsed: bool = True, skip_posfilter: bool = False, skip_solver: bool = False) → tuple[Configuration, dict[str, any]]

The main function to run GNATSS from end-to-end.

Parameters:

config_yamlstr

Path to the configuration yaml file

distance_limitfloat | None, optional

Distance in meters from center beyond which points will be excluded from solution

Setting this argument will override the value set in the configuration.

residual_limitfloat | None, optional

Maximum residual in centimeters beyond which data points will be excluded from solution

Setting this argument will override the value set in the configuration.

residual_range_limitfloat | None, optional

Maximum residual range (maximum - minimum) in centimeters for a given epoch, beyond which data points will be excluded from solution

Setting this argument will override the value set in the configuration.

outlier_thresholdfloat | None, optional

Residual outliers threshold acceptable before throwing an error in percent

Setting this argument will override the value set in the configuration.

from_cachebool, optional

Flag to load the GNSS-A Level-2 Data from cache.

Setting this to ``True`` will load the data from the cache output directory set in the configuration

return_rawbool, optional

Flag to return raw processing data as part of the result dictionary, by default False

remove_outliersbool, optional

Flag to execute removing outliers from the GNSS-A Level-2 Data before running the solver process, by default False

extract_process_datasetbool, optional

Flag to extract the process dataset as a netCDF file, by default True

extract_dist_centerbool, optional

Flag to extract the distance from center as a CSV file, by default True

qcbool, optional

Flag to plot residuals from run and store in output folder, by default True

skip_parsedbool, optional

Flag to skip the parsed step, by default True

skip_posfilterbool, optional

Flag to skip the posfilter step, by default False

skip_solverbool, optional

Flag to skip the solver step, by default False

Returns:

configConfiguration

Configuration object containing all the configuration values

data_dictdict

Dictionary containing the results of the GNATSS run