Parameter file¶

The RRINGG program relies on a wide range of configuration parameters to operate effectively. These parameters, defined in the parameter file, control various aspects of the program’s functionality, including file organization, data retrieval, analysis methods, and performance optimization.

Each parameter is carefully designed to adapt the program to different use cases. Below is a detailed description of these parameters, grouped by their functional roles:

Software Directories¶

software_directory

This parameter defines the root directory of the software. It is used as the base path for other directories such as work, output, and cache directories.

software_directory =  Path(__file__).resolve().parent.parent.parent

work_directory

Specifies the directory where the program will perform its computations.

work_directory = software_directory

output_directory

Directory for storing output files such as results, logs, or generated datasets.

output_directory = f"{software_directory}/output"

Data Sources¶

These parameters define the sources of GNSS data, including metadata, time series, and velocity.

source

The source of GNSS data, either from the European Plate Observing System (EPOS) or the Nevada Geodetic Laboratory (NGL).

source = EPOS

EPOS URLs
- url_metadata_epos
  
  Base URL for retrieving metadata about EPOS GNSS stations within a specified bounding box.
```
url_metadata_epos="https://gnssproducts.epos.ubi.pt/glass/stations/v2/station/bbox"
```
- url_time_series_epos
  
  Base URL for downloading EPOS GNSS station time series data.
```
url_time_series_epos="https://gnssproducts.epos.ubi.pt/glass/products/timeseries"
```
- url_velocities_epos
  
  Base URL for downloading GNSS station velocity data from EPOS.
```
url_velocities_epos="https://gnssproducts.epos.ubi.pt/GlassFramework/webresources/products"
```
NGL URLs
- url_metadata_ngl
  
  Base URL for retrieving GNSS station metadata from the NGL database.
```
url_metadata_ngl="http://geodesy.unr.edu/velocities"
```
- url_time_series_ngl
  
  Base URL for downloading GNSS time series data from the NGL database.
  - If reference_frame is IGS14:
    url_time_series_ngl="http://geodesy.unr.edu/gps_timeseries/tenv3"
  - If reference_frame is IGS20:
    url_time_series_ngl="https://geodesy.unr.edu/gps_timeseries/IGS20/tenv3"

Data Parameters¶

These parameters configure how GNSS data is retrieved and processed.

time_series_coordsy

Specifies the coordinate system used for time series data.
```
time_series_coordsy = enu
```
Options:
- xyz: Cartesian coordinates
- enu: East-North-Up (ENU) local coordinates
time_series_format

Format of the downloaded time series data.
```
time_series_format = json
```
Options:
- xml
- json
- pbo
time_series_sampling

Frequency of the sampled time series data.
```
time_series_format = daily
```
Options:
- daily: Daily samples
- weekly: Weekly samples
velocity_format

Format of velocity data for GNSS stations.
```
velocity_format = json
```
Options:
- midas
- xml
- json
- hector
- pbo
plate

Code representing the tectonic plate of interest.
```
plate = EURA
```
Options:
- EURA: Eurasian plate
- NUBI: Nubian plate
- NOAM: North American plate
- POSI: Positional plate
- ABSO: Absolute plate motion frames
reference_frame

The geodetic reference frame to use for GNSS station data.
```
reference_frame = IGS14
```

Earthquake Parameters¶

Parameters related to seismic data retrieval.

min_magnitude

Minimum earthquake magnitude to include in the seismicity catalogue.
```
min_magnitude = 5.5
```
seismicity_catalogue_source

Source of the seismicity catalogue. Supported values: emsc, usgs.
```
seismicity_catalogue_source = emsc
```

seismicity_catalogue_URL

URL for downloading the seismicity catalogue, automatically set according to the selected source.

Example for EMSC:

seismicity_catalogue_URL = https://www.seismicportal.eu/fdsnws/event/1/query?limit=1355495&format=text&minmag=5.5

Example for USGS:

seismicity_catalogue_URL = https://earthquake.usgs.gov/fdsnws/event/1/query?format=csv&starttime=2001-01-01&minmagnitude=5.5&orderby=time-asc&limit=20000

replace_seismicity_catalogue

Force replacement of the local seismicity catalogue file if it already exists.
```
replace_seismicity_catalogue = False
```

Linear Fit Parameters¶

These parameters are used for fitting linear models to GNSS data.

fitting

The method for fitting data.
```
fitting = least_squares
```
Options:
- least_squares
- ransac
weight_factor

Scaling factor for weights in the fitting process.
```
weight_factor = 0.9
```
tolerance

Tolerance for parameter variations during the fitting process.
```
tolerance = 1e-4
```
max_iter

Maximum number of iterations allowed in the fitting process.
```
max_iter = 100
```
cv_folds

Number of folds for cross-validation during the fitting process.
```
cv_folds = 3
```
weighted_fit

Whether to apply weights during fitting.
```
weighted_fit = True
```
Options:
- True
- False

Cache Management¶

Manages the caching of data to improve performance.

cache_directory

Directory for storing cached data.

cache_directory = f"{software_directory}/cache"

cache_size

Maximum size of the cache in bytes.
```
cache_size = 5e8
```

Bounding Box Parameters¶

Define how the bounding box for analysis is calculated.

limit

Specifies the method for defining the bounding box.
```
limit = "bb"
```
Options:
- bb : Vertical bounding box
- fbb: Based on the orientation of the screen footprint
scale_bbox

Scale factor for expanding the bounding box area.
```
scale_bbox = "1.2"
```

Regular Grid Parameters¶

These parameters define the grid’s resolution, placement, and spacing between its axes. Proper grid configuration is crucial for accurate data representation.

x_offset

Offset along the X-axis for the grid.

Adjusts the grid’s starting position in the horizontal direction. A value of 0 places the grid at the origin, while non-zero values shift it to the right or left.
```
x_offset = 0
```
y_offset

Offset along the Y-axis for the grid.

Determines the grid’s starting position in the vertical direction. Similar to x_offset, a value of 0 aligns the grid with the origin, and non-zero values shift it upward or downward.
```
y_offset = 0
```
step

Distance between consecutive grid lines along both axes.

Controls the grid’s resolution. Larger values create a coarse grid with widely spaced lines, while smaller values result in a finer grid with closely spaced lines
```
step = 12e4
```

GNSS Station Selection Parameters¶

min_nbr_days

Minimum number of days for which a station’s time series must have data.
```
min_nbr_days = 365
```
Purpose: Ensures that only stations with sufficient data are included in the analysis, enhancing reliability.
priority

Activates or deactivates the prioritization of stations processed by a specific center.
```
priority = True
```
Purpose: Gives preference to data from certain processing centers.
`priority_centre`

Specifies the processing center to prioritize.
```
priority_centre = SGO-EPND
```
Options:
- INGV
- ROB-EUREF
- UGA-CNRS
- SGO-EPND

GNSS Station Distribution Parameters¶

th_vcoef

Threshold for the coefficient of variation in station distribution.
```
th_vcoef = 0.6
```
Purpose: Measures the variability in station spacing to ensure an even distribution.
`th_per`

Threshold percentage for evaluating station distribution.
```
th_per = 4
```
Purpose: Identifies areas with sparse station coverage to improve representation.
th_psta

Threshold for the percentage of stations influencing overall results.
```
th_psta = 30
```
Purpose: Ensures significant contributions from the selected stations in the analysis.
th_ratio

Threshold for the percentage of total surface area covered by the stations with the largest surface areas.
```
th_ratio = 4
```
Purpose: Evaluates station coverage relative to the region of interest.

Spatial Resolution and Grid Parameters¶

window_size

Number of pixels averaged to obtain the value at a given position.
```
window_size = 5
```
x_resolution

Resolution of the raster along the X-axis.
```
x_resolution = 0.001111112
```
y_resolution

Resolution of the raster along the Y-axis.
```
y_resolution = 0.001111112
```

Station Logfiles¶

url_logfiles_catalog

URL for retrieving GNSS station logfiles (metadata catalogue).

url_logfiles_catalog = https://gnss-metadata.eu/v1/sitelog/metadata-list?downloadFormat=log&validMetadata=1&network=&country=&stationId=

threshold_days

Minimum number of valid days in a GNSS time series for the station to be considered.
```
threshold_days = 183
```
replace_logfile

Force replacement of existing station logfiles if they are already present.
```
replace_logfile = False
```

GNSS Time Series Windowing¶

days_window

Sliding window size (in days) applied along GNSS time series to detect gaps (absence of data).
```
days_window = 30
```

Offsets¶

url_offsets

URL for downloading GNSS offsets (EPOS).

url_offsets = https://gnssproducts.epos.ubi.pt/download-offsets

DOI¶

doi

Digital Object Identifier (DOI) of the latest published version of rringg.
```
doi = "10.5281/zenodo.14800884"
```