-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathconfig.create.example.yaml
228 lines (221 loc) · 10.8 KB
/
config.create.example.yaml
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
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
# Setup
nanomaterial: TiO2 # Name of the nanomaterial. Not used in model.
output:
nc_file: ./data.nc # Where do you want the output NetCDF file to be stored?
constants_file: ./constants.nml # Where do you want the output constants file to be stored?
constants_file: ./data.example/thames_tio2_2015/constants.yaml # Where is the input constants file?
land_use_config: ./data.example/thames_tio2_2015/land_use.yaml # Where is the input land use config file?
root_dir: ./data.example/thames_tio2_2015/ # Root dir, can be used in path variables below as <root_dir>
iso3: GBR # iso3 code for country modelled
time:
n: 365 # Number of timesteps to run the model for
dt: 86400 # Length of each timestep in seconds
start_date: 2015-01-01 # Start date for the model run
# Meteorological and hydrological
flow_dir: # Flow direction is responsible for defining the grid system
type: raster # Type can be raster or csv (see docs)
path: <root_dir>flow_dir.tif # Path to file, <root_dir> variable can be used from above
crs: EPSG:27700 # Manually specify CRS if it is absent or ill-defined in file
dem: # Digital Elevation Model, which defines the height above sea level
type: raster # of each grid cell, in metres
units: dm
path: <root_dir>dem.grd
runoff: # Runoff, usually provided by a hydrological model
type: csv
path: <root_dir>runoff.csv
units: mm/day # What units is the file in? These will be converted automatically by Pint: https://pint.readthedocs.io/en/0.10.1/
quickflow: # Quickflow (sometimes called direct runoff, or overland flow) is the portion of runoff that travels overland,
type: csv # and is usually provided by a hydrological model
path: <root_dir>quickflow.csv
units: mm/day
precip: # Precipitation
type: raster
path: <root_dir>precip/rainfall_5km_2015-{t}.tif # If the variable is spatiotemporal, multiple raster files can be indexed by {t}, with one file per timestep
units: mm/day
t_min: 1 # What index should the multiple input files start at (default is 0)?
# Source and references can be provided and whilst these aren't used by the model, they will be added as attributes to the NetCDF file
source: Provided information about the source of the data here, and any data processing it has already been through (e.g. reprojection).
references: References to scientific papers.
# Soil
# Most soil properties can be obtained from the European Soil Data Center (ESDAC): https://esdac.jrc.ec.europa.eu/
soil_bulk_density:
type: raster
units: t/m**3
path: <root_dir>soil_bulk_density.tif
# Source example:
source: European Soil Data Centre topsoil physical properties resampled to OS National Grid (ESPG:27700) by bilinear interpolation. See https://esdac.jrc.ec.europa.eu/content/topsoil-physical-properties-europe-based-lucas-topsoil-data.
soil_water_content_field_capacity:
type: raster
path: <root_dir>soil_water_content_field_capacity.tif
soil_water_content_saturation:
type: raster
path: <root_dir>soil_water_content_saturation.tif
soil_hydraulic_conductivity:
type: raster
units: cm/day
path: <root_dir>soil_hydraulic_conductivity.tif
soil_texture_sand_content: # Sand content as a percentage. Sand + clay + silt must equal 100%
type: raster
path: <root_dir>soil_texture_sand_content.tif
soil_texture_clay_content:
type: raster
path: <root_dir>soil_texture_clay_content.tif
soil_texture_silt_content:
type: raster
path: <root_dir>soil_texture_silt_content.tif
soil_texture_coarse_frag_content:
type: raster
path: <root_dir>soil_texture_coarse_frag_content.tif
soil_usle_c_factor: # Universal Soil Loss Equation (USLE) cover management factor
type: raster
path: <root_dir>soil_usle_c_factor.tif
soil_usle_ls_factor: # USLE topography (slope length and steepness) factor
type: raster
path: <root_dir>soil_usle_ls_factor.tif
soil_usle_p_factor: # USLE support practices factor
type: raster
path: <root_dir>soil_usle_p_factor.tif
# Suspended sediment
bank_erosion_alpha:
type: raster
path: <root_dir>bank_erosion_alpha.tif
units: kg/m**5
bank_erosion_beta:
type: raster
path: <root_dir>bank_erosion_beta.tif
deposition_alpha:
type: raster
path: <root_dir>deposition_alpha.tif
deposition_beta:
type: raster
path: <root_dir>deposition_beta.tif
resuspension_alpha:
type: raster
path: <root_dir>resuspension_alpha.tif
resuspension_beta:
type: raster
path: <root_dir>resuspension_beta.tif
sediment_transport_a:
type: raster
path: <root_dir>sediment_transport_a.tif
sediment_transport_c:
type: raster
path: <root_dir>sediment_transport_c.tif
# Land use
land_use:
type: raster
path: <root_dir>land_use.tif
is_estuary: # Boolean raster indicating whether waterbodies within a cell are estuarine
type: raster
path: <root_dir>is_estuary.tif
# Emissions - areal
# Variables can be omitted and emissions for that variable will be set to zero (e.g. if a particular form is not relevant for the NM modelled)
emissions_areal_soil_pristine: # Areal emissions of pristine NM to soil
type: raster
path: <root_dir>emissions_areal_soil_pristine.tif
units: kg/m**2/year
emissions_areal_soil_matrixembedded: # Areal emissions of matrix-embedded NM to soil
type: raster
path: <root_dir>emissions_areal_soil_matrixembedded.tif
units: kg/m**2/year
emissions_areal_soil_transformed: # Areal emissions of transformed NM to soil
type: raster
path: <root_dir>emissions_areal_soil_transformed.tif
units: kg/m**2/year
#emissions_areal_soil_dissolved: # Areal emissions of dissolved NM to soil
# type: raster
# path: <root_dir>emissions_areal_soil_dissolved.tif
# units: kg/m**2/year
emissions_areal_water_pristine: # Areal emissions of pristine NM to water
type: raster
path: <root_dir>emissions_areal_water_pristine.tif
units: kg/m**2/year
emissions_areal_water_matrixembedded: # Areal emissions of matrix-embedded NM to water
type: raster
path: <root_dir>emissions_areal_water_matrixembedded.tif
units: kg/m**2/year
emissions_areal_water_transformed: # Areal emissions of transformed NM to water
type: raster
path: <root_dir>emissions_areal_water_transformed.tif
units: kg/m**2/year
#emissions_areal_water_dissolved: # Areal emissions of dissolved NM to water
# type: raster
# path: <root_dir>emissions_areal_water_dissolved.tif
# units: kg/m**2/year
# Emissions - point
emissions_point_water_pristine: # Point source emissions of pristine NM to water
type: shapefile # Point source emissions must be a shapefile
value_var: emission # Which variable in the shapefile gives the emission value?
path: <root_dir>emissions_point_water_pristine/point_sources_water_pristine_2015_osgb.shp # Path to .shp file. Sidecar files must be present too
source_type_col: profile # Which variable in the shapefile gives the profile of each point? See the docs
temporal_profile: # Temporal profile for these emissions
path: <root_dir>emissions_temporal-profile_2015.csv # Path to temporal profile CSV (see docs)
source_type_col: Emission_source_type # Which column gives the emission source type profile?
for_source_type: P2 # Which of these types does this temporal profile apply to?
factor_col: Factor # Which column gives the factor?
units: kg/year
emissions_point_water_matrixembedded: # Point source emissions of matrix-embedded NM to water
type: shapefile
value_var: emission
path: <root_dir>emissions_point_water_matrixembedded/point_sources_water_matrix-embedded_2015_osgb.shp
source_type_col: profile
temporal_profile:
path: <root_dir>emissions_temporal-profile_2015.csv
source_type_col: Emission_source_type
for_source_type: P2
factor_col: Factor
units: kg/year
emissions_point_water_transformed: # Point source emissions of transformed NM to water
type: shapefile
value_var: emission
path: <root_dir>emissions_point_water_transformed/point_sources_water_transformed_2015_osgb.shp
source_type_col: profile
temporal_profile:
path: <root_dir>emissions_temporal-profile_2015.csv
source_type_col: Emission_source_type
for_source_type: P2
factor_col: Factor
units: kg/year
#emissions_point_water_dissolved: # Point source emissions of dissolved NM to water
# type: shapefile
# value_var: emission
# path: <root_dir>point_sources_water_dissolved.shp
# source_type_col: profile
# temporal_profile:
# path: <root_dir>emissions_temporal-profile_2015.csv
# source_type_col: Emission_source_type
# for_source_type: P2
# factor_col: Factor
# units: kg/year
# Emissions - atmospheric
# Atmospheric deposition data can be provided as dry deposition (drydep) and wet deposition (wetdepo)
emissions_atmospheric_drydepo_pristine:
type: raster
path: <root_dir>emissions_atmospheric_drydepo_pristine/{t}.tif # {t} placeholder is used to iterate over files, with 1 file for each timestep
units: kg/m**2/s
t_min: 1
emissions_atmospheric_drydepo_matrixembedded:
type: raster
path: <root_dir>emissions_atmospheric_drydepo_matrix-embedded/{t}.tif
units: kg/m**2/s
t_min: 1
emissions_atmospheric_drydepo_transformed:
type: raster
path: <root_dir>emissions_atmospheric_drydepo_transformed/{t}.tif
units: kg/m**2/s
t_min: 1
emissions_atmospheric_wetdepo_pristine:
type: raster
path: <root_dir>emissions_atmospheric_wetdepo_pristine/{t}.tif
units: kg/m**2/s
t_min: 1
emissions_atmospheric_wetdepo_matrixembedded:
type: raster
path: <root_dir>emissions_atmospheric_wetdepo_matrix-embedded/{t}.tif
units: kg/m**2/s
t_min: 1
emissions_atmospheric_wetdepo_transformed:
type: raster
path: <root_dir>emissions_atmospheric_wetdepo_transformed/{t}.tif
units: kg/m**2/s
t_min: 1