Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

CWARHM procedure for CAMELS-spat dataset #174

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,10 @@ core.*
# rtd
rtd/build

rtd/source/*.md
rtd/source/*.md

# Ignore macOS system files
.DS_Store

# Ignore environment configuration files
.env
152 changes: 0 additions & 152 deletions 0_control_files/control_Africa.txt

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -6,23 +6,27 @@


# Modeling domain settings
root_path | /project/gwf/gwf_cmt/wknoben/CWARHM_data # Root folder where data will be stored.
domain_name | BowAtBanff # Used as part of the root folder name for the prepared data.
root_path | /path/to/output/folder # Root folder where data will be stored.
domain_name | CAN_05BB001 # Used as part of the root folder name for the prepared data, must be the same name as in CAMELS-spat database


# database settings - CAMELS-spat folder
camels_spath | /path/to/camels-spat/dataset/ # Path de the CAMELS-spat dataset, must be "/path/to/camels-spat/dataset/[name]".


# Shapefile settings - SUMMA catchment file
catchment_shp_path | default # If 'default', uses 'root_path/domain_[name]/shapefiles/catchment'.
catchment_shp_name | bow_distributed_elevation_zone.shp # Name of the catchment shapefile. Requires extension '.shp'.
catchment_shp_name | CAN_05BB001_distributed_basin.shp # Name of the catchment shapefile. Requires extension '.shp'.
catchment_shp_gruid | GRU_ID # Name of the GRU ID column (can be any numeric value, HRU's within a single GRU have the same GRU ID).
catchment_shp_hruid | HRU_ID # Name of the HRU ID column (consecutive from 1 to total number of HRUs, must be unique).
catchment_shp_hruid | HRU_ID # Name of the HRU ID column (consecutive from 1 to total number of HRUs, must be unique). Note: With CAMELS-spat there is only 1 HRU per GRU.
catchment_shp_area | HRU_area # Name of the catchment area column. Area must be in units [m^2]
catchment_shp_lat | center_lat # Name of the latitude column. Should be a value representative for the HRU. Typically the centroid.
catchment_shp_lon | center_lon # Name of the longitude column. Should be a value representative for the HRU. Typically the centroid.


# Shapefile settings - mizuRoute river network file
river_network_shp_path | default # If 'default', uses 'root_path/domain_[name]/shapefiles/river_network'.
river_network_shp_name | bow_river_network_from_merit_hydro.shp # Name of the river network shapefile. Requires extension '.shp'.
river_network_shp_name | CAN_05BB001_distributed_river.shp # Name of the river network shapefile. Requires extension '.shp'.
river_network_shp_segid | COMID # Name of the segment ID column.
river_network_shp_downsegid | NextDownID # Name of the downstream segment ID column.
river_network_shp_slope | slope # Name of the slope column. Slope must be in in units [length/length].
Expand All @@ -31,16 +35,12 @@ river_network_shp_length | length # Name

# Shapefile settings - mizuRoute catchment file
river_basin_shp_path | default # If 'default', uses 'root_path/domain_[name]/shapefiles/river_basins'.
river_basin_shp_name | bow_distributed.shp # Name of the routing subbasins shapefile needed for remapping. Requires extension '.shp'.
river_basin_shp_name | CAN_05BB001_distributed_basin.shp # Name of the routing subbasins shapefile needed for remapping. Requires extension '.shp'.
river_basin_shp_rm_hruid | COMID # Name of the routing basin ID column.
river_basin_shp_area | area # Name of the catchment area column. Area must be in units [m^2]
river_basin_shp_hru_to_seg | hru_to_seg # Name of the column that shows which river segment each HRU connects to.


# Shapefile settings - SUMMA-to-mizuRoute
river_basin_needs_remap | no # 'no' if routing basins map 1:1 onto model GRUs. 'yes' if river segments span multiple GRUs or if multiple segments are inside a single GRU.


# Install settings
github_summa | https://github.com/CH-Earth/summa # Replace this with the path to your own fork if you forked the repo.
github_mizuroute | https://github.com/ncar/mizuroute # Replace this with the path to your own fork if you forked the repo.
Expand All @@ -51,49 +51,24 @@ exe_name_mizuroute | mizuroute.exe # Name


# Forcing settings
forcing_raw_time | 2008,2013 # Years to download: Jan-[from],Dec-[to].
forcing_raw_space | 51.74/-116.55/50.95/-115.52 # Bounding box of the shapefile: lat_max/lon_min/lat_min/lon_max. Will be converted to ERA5 download coordinates in script. Order and use of '/' to separate values is mandatory.
forcing_raw_time | 2000,2020 # Years to download: Jan-[from],Dec-[to].
forcing_data_name | ERA5 # ERA5 or EM-Earth.
forcing_time_step_size | 3600 # Size of the forcing time step in [s]. Must be constant.
forcing_measurement_height | 3 # Reference height for forcing measurements [m].
forcing_shape_path | default # If 'default', uses 'root_path/domain_[name]/shapefiles/forcing'.
forcing_shape_name | era5_grid.shp # Name of the forcing shapefile. Requires extension '.shp'.
forcing_shape_lat_name | lat # Name of the latitude field that contains the latitude of ERA5 data points.
forcing_shape_lon_name | lon # Name of the longitude field that contains the latitude of ERA5 data points.
forcing_geo_path | default # If 'default', uses 'root_path/domain_[name]/forcing/0_geopotential'.
forcing_raw_path | default # If 'default', uses 'root_path/domain_[name]/forcing/1_raw_data'.
forcing_merged_path | default # If 'default', uses 'root_path/domain_[name]/forcing/2_merged_data'.
forcing_easymore_path | default # If 'default', uses 'root_path/domain_[name]/forcing/3_temp_easymore'.
forcing_basin_avg_path | default # If 'default', uses 'root_path/domain_[name]/forcing/3_basin_averaged_data'.
forcing_summa_path | default # If 'default', uses 'root_path/domain_[name]/forcing/4_SUMMA_input'.


# Parameter settings - DEM
parameter_dem_main_url | http://hydro.iis.u-tokyo.ac.jp/~yamadai/MERIT_Hydro/distribute/v1.0.1/ # Primary download URL for MERIT Hydro adjusted elevation data. Needs to be appended with filenames.
parameter_dem_file_template | elv_{}{}.tar # Template for download file names.
parameter_dem_raw_path | default # If 'default', uses 'root_path/domain_[name]/parameters/dem/1_MERIT_hydro_raw_data'.
parameter_dem_unpack_path | default # If 'default', uses 'root_path/domain_[name]/parameters/dem/2_MERIT_hydro_unpacked_data'.
parameter_dem_vrt1_path | default # If 'default', uses 'root_path/domain_[name]/parameters/dem/3_vrt'.
parameter_dem_vrt2_path | default # If 'default', uses 'root_path/domain_[name]/parameters/dem/4_domain_vrt'.
parameter_dem_tif_path | default # If 'default', uses 'root_path/domain_[name]/parameters/dem/5_elevation'.
parameter_dem_tif_name | elevation.tif # Name of the final DEM for the domain. Must be in .tif format.


# Parameter settings - soil
parameter_soil_hydro_ID | 1361509511e44adfba814f6950c6e742 # ID of the Hydroshare resource to download.
parameter_soil_raw_path | default # If 'default', uses 'root_path/domain_[name]/parameters/soilclass/1_soil_classes_global'.
parameter_soil_domain_path | default # If 'default', uses 'root_path/domain_[name]/parameters/soilclass/2_soil_classes_domain'.
parameter_soil_tif_name | soil_classes.tif # Name of the final soil class overview for the domain. Must be in .tif format.


# Parameter settings - land
parameter_land_list_path | default # If 'default', uses 'summaWorkflow_public/3b_parameters/MODIS_MCD12Q1_V6/1_download/'. Location of file with data download links.
parameter_land_list_name | daac_mcd12q1_data_links.txt # Name of file that contains list of MODIS download urls.
parameter_land_raw_path | default # If 'default', uses 'root_path/domain_[name]/parameters/landclass/1_MODIS_raw_data'.
parameter_land_vrt1_path | default # If 'default', uses 'root_path/domain_[name]/parameters/landclass/2_vrt_native_crs'. Virtual dataset composed of .hdf files.
parameter_land_vrt2_path | default # If 'default', uses 'root_path/domain_[name]/parameters/landclass/3_vrt_epsg_4326'. Virtual dataset projected in EPSG:4326.
parameter_land_vrt3_path | default # If 'default', uses 'root_path/domain_[name]/parameters/landclass/4_domain_vrt_epsg_4326'. Virtual dataset cropped to model domain.
parameter_land_vrt4_path | default # If 'default', uses 'root_path/domain_[name]/parameters/landclass/5_multiband_domain_vrt_epsg_4326'. Multiband cropped virtual dataset.
parameter_land_tif_path | default # If 'default', uses 'root_path/domain_[name]/parameters/landclass/6_tif_multiband'.
parameter_land_mode_path | default # If 'default', uses 'root_path/domain_[name]/parameters/landclass/7_mode_land_class'.
parameter_land_tif_name | land_classes.tif # Name of the final landclass overview for the domain. Must be in .tif format.

Expand All @@ -105,9 +80,6 @@ intersect_soil_path | default # If '
intersect_soil_name | catchment_with_soilgrids.shp # Name of the shapefile with intersection between catchment and SOILGRIDS-derived USDA soil classes, stored in columns 'USDA_{1,...n}'
intersect_land_path | default # If 'default', uses 'root_path/domain_[name]/shapefiles/catchment_intersection/with_modis'.
intersect_land_name | catchment_with_modis.shp # Name of the shapefile with intersection between catchment and MODIS-derived IGBP land classes, stored in columns 'IGBP_{1,...n}'
intersect_forcing_path | default # If 'default', uses 'root_path/domain_[name]/shapefiles/catchment_intersection/with_forcing'.
intersect_routing_path | default # If 'default', uses 'root_path/domain_[name]/shapefiles/catchment_intersection/with_routing'.
intersect_routing_name | catchment_with_routing_basins.shp # Name of the shapefile with intersection between hydrologic model catchments and routing model catchments.


# Experiment settings - general
Expand Down Expand Up @@ -142,10 +114,10 @@ settings_mizu_control_file | mizuroute.control # Name
settings_mizu_routing_var | averageRoutedRunoff # Name of SUMMA output variable to use for routing.
settings_mizu_routing_units | m/s # Units of the variable to be routed.
settings_mizu_routing_dt | 3600 # Size of the routing time step [s].
settings_mizu_output_freq | annual # Frequency with which mizuRoute generates new output files. Must be one of 'single', 'day', 'month', 'annual'.
settings_mizu_output_vars | 0 # Routing output. '0' for both KWT and IRF; '1' IRF only; '2' KWT only.
settings_mizu_output_freq | yearly # Frequency with which mizuRoute generates new output files. Must be one of 'single', 'daily', 'monthly', 'yearly'.
settings_mizu_output_vars | 2 # Option for routing schemes. 0: Sum; 1: IRF; 2: KWT; 3: KW: 4: MC; 5: DW. Saves no data if not specified
settings_mizu_within_basin | 0 # '0' (no) or '1' (IRF routing). Flag to enable within-basin routing by mizuRoute. Should be set to 0 if SUMMA is run with "subRouting" decision "timeDlay".
settings_mizu_make_outlet | 71028585 # Segment ID or IDs that should be set as network outlet. Specify multiple IDs separated by commas: X,Y,Z. Specify no IDs as: n/a. Note that this can also be done in the network shapefile.
settings_mizu_make_outlet | default # Segment ID or IDs that should be set as network outlet. Specify multiple IDs separated by commas: X,Y,Z. Specify no IDs as: n/a. Note that this can also be done in the network shapefile. If default, The HRU with the largest upstream surface is selected.


# Postprocessing settings
Expand Down
Loading