projectESL/config.yml at main · Timh37/projectESL · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
general:
    n_samples: 10000                                                            # number of monte carlo samples to use
    run_name: 'ar6_1f_ssp585_gesla3_tgs_custom'
    output_dir: '/Users/timhermans/Documents/GitHub/projectESL/output/TGs' # existing directory to save the output in
    output_quantiles: .05,.17,.5,.83,.95                                        # which quantiles of sample distributions to save [between 0-1]
    use_central_esl_estimates_only: 0                                           # whether to ignore uncertainty in ESL statistics if provided (z_hist output quantiles will be identical)

input:
    esl_data: 'gesla3'                                                          # options: ['gesla2','gesla3','gtsm_dmax'] (raw data); ['vousdoukas2018','kirezci2020','hermans2023'] (GPD parameters);['coast-rp'] (return curves)
    match_dist_limit: 10                                                        # maximum distance ESL datapoints may have from input locations to be matched [km]
    paths:                                                                      # [string] paths to input files (only need to set those that you want to use)
        gesla2: '/Volumes/Naamloos/PhD_Data/GESLA2/private_14032017_public_110292018'
        gesla3: '/Volumes/Naamloos/PhD_Data/GESLA3'
        gtsm_dmax: '/Volumes/Naamloos/PhD_Data/GTSM_HighResMIP/era5/total/dmax'#'_from_hourly'

        vousdoukas2018: '/Users/timhermans/Documents/Data/Vousdoukas18/Historical_ERA-INTERIM_wl.nc'
        kirezci2020: '/Users/timhermans/Documents/Github/projectESL/input/kirezci2020_gpd.csv'
        hermans2023: '/Volumes/Naamloos/PhD_Data/GESLA3/GPD_fits/gesla3_gpd_daily_max_potATS_Solari.nc'

        coast-rp: '/Volumes/Naamloos/PhD_Data/COAST_RP/COAST_RP_full_dataset'

        diva: '/Users/timhermans/Documents/Data/DIVA/cls_historical_protection_levels.gpkg'
        flopros: '/Users/timhermans/Documents/Data/FLOPROS/Tiggeloven/'
        custom: '/Users/timhermans/Documents/GitHub/projectESL/input/flopros_estimates_at_coastrp_locations.nc'

        input_locations: '../input/full_sample_total_wf_1f_ssp585_at_coastal_GESLA3.zarr'  #dataset containing lon/lat coordinates for'locations' dimension, with optional ['sea_level_change'] variable with dims ['locations','years','samples']
        #input_locations: '/Volumes/Naamloos/PhD_Data/AR6_projections/ar6-gridded-samples-total/full_sample_total_wf_1f_ssp245_at_COAST_RP_coastal_locations.zarr'

preprocessing:                                                                # set preprocessing options for timeseries analysis (used if input_type is raw data):
    min_yrs: 30                                                                 # [int/float] minimum tide gauge length
    resample_freq: 'D_max'                                                      # ['H_mean', 'D_mean','D_max']
    deseasonalize: 1                                                            # [0,1] whether to deseasonalize raw data prior to estimating ESL distribution
    detrend: 1                                                                  # [0,1] whether to detrend raw data prior to estimating ESL distribution
    subtract_amean: 0                                                           # [0,1] whether to subtract annual means of raw data prior to estimating ESL distribution
    ref_to_msl: 0                                                               # [0,1] whether to reference observations to mean sea level during defined period
    msl_period: 1980,2014                                                       # reference period to compute MSL for, if referencing observations to MSL (TG data must cover at least half of this period)
    declus_method: 'rolling_max'                                                # ['iterative_descending','rolling_max'] how to decluster the extremes
    declus_window: 3                                                            # [int] declustering window length to use
    extremes_threshold: 99                                                      # [0<float<100] threshold above which to define events at resamlpe_freq frequency extreme
    store_esls: 0                                                               # whether to store peaks over threshold used to fit ESL distribution to csv files (1 file per site)

projecting:                                                                  # set projection options
    below_threshold: 'Sweet22'                                               # ['mhhw','Sweet22',None] if/how to treat return frequencies/heights below extremes threshold. Default: None. No effect if using direct return curve input (e.g., COAST-RP).
    refFreqs: 'custom'                                                       # ['diva,'flopros', or constant] reference frequency to use for amplifications
    target_years: 2050,2100                                                  # [comma-separated series of ints, e.g., 2050,2100] years to project AFs for (must be contained in SLR projections); leave empty for no output
    target_AFs: 20                                                            # [comma-separated series of ints/floats, e.g., 10,100] AFs to project timing for; leave empty for no output
    target_freqs:                                                            # [comma-separated series of ints/floats, e.g., 0.1,1] target future frequencies to project timing for; leave empty for no output