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.

Sign up for GitHub

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

initial refactoring of main from ngen #578

Draft
wants to merge 8 commits into
base: master
Choose a base branch
from
Draft

initial refactoring of main from ngen #578

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
0537801
initial refactoring of main only incorporating changes made on ngen b…
Aug 19, 2022
cb1092d
added function _handle_output_v02 from ngen branch to __main__.py
Aug 19, 2022
ae2dd8c
some updates to main for use with NHDNetwork class (not finished)
Sep 8, 2022
3d98da4
added update procedures for loop iterations
Sep 8, 2022
4240559
edits to showtiming
Sep 9, 2022
164f568
create run_parameters after all other parameters are created
Sep 23, 2022
4678236
fix typo in da_sets when creating DA object
Sep 23, 2022
b5d3585
fix typos calling variables from network and DA objects
Sep 23, 2022
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
380 changes: 380 additions & 0 deletions src/troute-network/troute/nhd_network_utilities_v02.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,386 @@

LOG = logging.getLogger('')

def set_supernetwork_parameters(
supernetwork="", geo_input_folder=None, verbose=True, debuglevel=0
):
# TODO: consider managing path concatenation outside this function (and lose the os dependency)

# The following datasets are extracts from the feature datasets available
# from https://www.nohrsc.noaa.gov/pub/staff/keicher/NWM_live/web/data_tools/
# the CONUS_ge5 and Brazos_LowerColorado_ge5 datasets are included
# in the github test folder

supernetwork_options = {
"Pocono_TEST1",
"Pocono_TEST2",
"LowerColorado_Conchos_FULL_RES",
"Brazos_LowerColorado_ge5",
"Brazos_LowerColorado_FULL_RES",
"Brazos_LowerColorado_Named_Streams",
"CONUS_ge5",
"Mainstems_CONUS",
"CONUS_Named_Streams",
"CONUS_FULL_RES_v20",
"CapeFear_FULL_RES",
"Florence_FULL_RES",
"custom",
}

if supernetwork not in supernetwork_options:
print(
"Note: please call function with supernetworks set to one of the following:"
)
for s in supernetwork_options:
print(f"'{s}'")
raise ValueError

elif supernetwork == "Pocono_TEST1":
return {
"geo_file_path": pathlib.Path(
geo_input_folder, "PoconoSampleData1", "PoconoSampleRouteLink1.shp"
).resolve(),
"columns": {
"key": "link",
"downstream": "to",
"dx": "Length",
"n": "n",
"ncc": "nCC",
"s0": "So",
"bw": "BtmWdth",
"waterbody": "NHDWaterbo",
"tw": "TopWdth",
"twcc": "TopWdthCC",
"alt": "alt",
"musk": "MusK",
"musx": "MusX",
"cs": "ChSlp",
},
"waterbody_null_code": -9999,
"title_string": "Pocono Test Example",
"driver_string": "ESRI Shapefile",
"terminal_code": 0,
"layer_string": 0,
"waterbody_parameter_file_type": "Level_Pool",
"waterbody_parameter_file_path": pathlib.Path(
geo_input_folder, "NWM_2.1_Sample_Datasets", "LAKEPARM_CONUS.nc"
).resolve(),
"waterbody_parameter_columns": {
"waterbody_area": "LkArea", # area of reservoir
"weir_elevation": "WeirE",
"waterbody_max_elevation": "LkMxE",
"outfall_weir_coefficient": "WeirC",
"outfall_weir_length": "WeirL",
"overall_dam_length": "DamL",
"orifice_elevation": "OrificeE",
"orifice_coefficient": "OrificeC",
"orifice_area": "OrificeA",
},
}
elif supernetwork == "Pocono_TEST2":
rv = set_supernetwork_parameters(
supernetwork="CONUS_FULL_RES_v20", geo_input_folder=geo_input_folder
)
rv.update(
{
"title_string": "Pocono Test 2 Example", # overwrites other title...
"mask_file_path": pathlib.Path(
geo_input_folder,
"Channels",
"masks",
"PoconoRouteLink_TEST2_nwm_mc.txt",
).resolve(),
"mask_driver_string": "csv",
"mask_layer_string": "",
"mask_key": 0,
"mask_name": 1, # TODO: Not used yet.
}
)
return rv

# return {
#'geo_file_path' : pathlib.Path(geo_input_folder
# , r'PoconoSampleData2'
# , r'PoconoRouteLink_testsamp1_nwm_mc.shp').resolve()
# , 'key_col' : 18
# , 'downstream_col' : 23
# , 'length_col' : 5
# , 'manningn_col' : 20
# , 'manningncc_col' : 21
# , 'slope_col' : 10
# , 'bottomwidth_col' : 2
# , 'topwidth_col' : 11
# , 'topwidthcc_col' : 12
# , 'MusK_col' : 6
# , 'MusX_col' : 7
# , 'ChSlp_col' : 3
# , 'terminal_code' : 0
# , 'title_string' : 'Pocono Test 2 Example'
# , 'driver_string' : 'ESRI Shapefile'
# , 'layer_string' : 0
# }

elif supernetwork == "LowerColorado_Conchos_FULL_RES":
rv = set_supernetwork_parameters(
supernetwork="CONUS_FULL_RES_v20", geo_input_folder=geo_input_folder
)
rv.update(
{
"title_string": "NHD 2.0 Conchos Basin of the LowerColorado River", # overwrites other title...
"mask_file_path": pathlib.Path(
geo_input_folder,
"Channels",
"masks",
"LowerColorado_Conchos_FULL_RES.txt",
).resolve(),
"mask_driver_string": "csv",
"mask_layer_string": "",
"mask_key": 0,
"mask_name": 1, # TODO: Not used yet.
}
)
return rv

elif supernetwork == "Brazos_LowerColorado_ge5":
return {
"geo_file_path": pathlib.Path(
geo_input_folder, "Channels", "NHD_BrazosLowerColorado_Channels.shp"
).resolve(),
"columns": {
"key": "featureID",
"downstream": "to",
"waterbody": "NHDWaterbo",
"dx": "Length",
"n": "n",
"s0": "So",
"bw": "BtmWdth",
"musk": "MusK",
"musx": "MusX",
"cs": "ChSlp",
},
"waterbody_null_code": -9999,
"title_string": "NHD Subset including Brazos + Lower Colorado\nNHD stream orders 5 and greater",
"driver_string": "ESRI Shapefile",
"terminal_code": 0,
"layer_string": 0,
}

elif supernetwork == "Brazos_LowerColorado_FULL_RES":
rv = set_supernetwork_parameters(
supernetwork="CONUS_FULL_RES_v20", geo_input_folder=geo_input_folder
)
rv.update(
{
"title_string": "NHD 2.0 Brazos and LowerColorado Basins", # overwrites other title...
"mask_file_path": pathlib.Path(
geo_input_folder,
"Channels",
"masks",
"Brazos_LowerColorado_FULL_RES.txt",
).resolve(),
"mask_driver_string": r"csv",
"mask_layer_string": r"",
"mask_key": 0,
"mask_name": 1, # TODO: Not used yet.
}
)
return rv

elif supernetwork == "Brazos_LowerColorado_Named_Streams":
rv = set_supernetwork_parameters(
supernetwork="CONUS_FULL_RES_v20", geo_input_folder=geo_input_folder
)
rv.update(
{
"title_string": "NHD 2.0 GNIS labeled streams in the Brazos and LowerColorado Basins", # overwrites other title...
"mask_file_path": pathlib.Path(
geo_input_folder,
"Channels",
"masks",
"Brazos_LowerColorado_Named_Streams.csv",
).resolve(),
"mask_driver_string": r"csv",
"mask_layer_string": r"",
"mask_key": 0,
"mask_name": 1, # TODO: Not used yet.
}
)
return rv

elif supernetwork == "CONUS_ge5":
rv = set_supernetwork_parameters(
supernetwork="CONUS_FULL_RES_v20", geo_input_folder=geo_input_folder
)
rv.update(
{
"title_string": "NHD CONUS Order 5 and Greater", # overwrites other title...
"mask_file_path": pathlib.Path(
geo_input_folder, "Channels", "masks", "CONUS_ge5.txt"
).resolve(),
"mask_driver_string": "csv",
"mask_layer_string": "",
"mask_key": 0,
"mask_name": 1, # TODO: Not used yet.
}
)
return rv

elif supernetwork == "Mainstems_CONUS":
rv = set_supernetwork_parameters(
supernetwork="CONUS_FULL_RES_v20", geo_input_folder=geo_input_folder
)
rv.update(
{
"title_string": "CONUS 'Mainstems' (Channels below gages and AHPS prediction points)", # overwrites other title...
"mask_file_path": pathlib.Path(
geo_input_folder, r"Channels", r"masks", r"conus_Mainstem_links.txt"
).resolve(),
"mask_driver_string": r"csv",
"mask_layer_string": r"",
"mask_key": 0,
"mask_name": 1, # TODO: Not used yet.
}
)
return rv

# return {
# "geo_file_path": pathlib.Path(
# geo_input_folder, r"Channels", r"conus_routeLink_subset.nc"
# ).resolve(),
# "key_col": 0,
# "downstream_col": 2,
# "length_col": 10,
# "manningn_col": 11,
# "manningncc_col": 20,
# "slope_col": 12,
# "bottomwidth_col": 14,
# "topwidth_col": 22,
# "topwidthcc_col": 21,
# "waterbody_col": 15,
# "waterbody_null_code": -9999,
# "MusK_col": 8,
# "MusX_col": 9,
# "ChSlp_col": 13,
# "terminal_code": 0,
# "title_string": 'CONUS "Mainstem"',
# "driver_string": "NetCDF",
# "layer_string": 0,
# }

elif supernetwork == "CONUS_Named_Streams":
rv = set_supernetwork_parameters(
supernetwork="CONUS_FULL_RES_v20", geo_input_folder=geo_input_folder
)
rv.update(
{
"title_string": "CONUS NWM v2.0 only GNIS labeled streams", # overwrites other title...
"mask_file_path": pathlib.Path(
geo_input_folder,
"Channels",
"masks",
"nwm_reaches_conus_v21_wgnis_name.csv",
).resolve(),
"mask_driver_string": "csv",
"mask_layer_string": "",
"mask_key": 0,
"mask_name": 1, # TODO: Not used yet.
}
)
return rv

elif supernetwork == "CapeFear_FULL_RES":
rv = set_supernetwork_parameters(
supernetwork="CONUS_FULL_RES_v20", geo_input_folder=geo_input_folder
)
rv.update(
{
"title_string": "Cape Fear River Basin, NC", # overwrites other title...
"mask_file_path": pathlib.Path(
geo_input_folder, "Channels", "masks", "CapeFear_FULL_RES.txt",
).resolve(),
"mask_driver_string": "csv",
"mask_layer_string": "",
"mask_key": 0,
"mask_name": 1, # TODO: Not used yet.
}
)
return rv

elif supernetwork == "Florence_FULL_RES":
rv = set_supernetwork_parameters(
supernetwork="CONUS_FULL_RES_v20", geo_input_folder=geo_input_folder
)
rv.update(
{
"title_string": "Hurricane Florence Domain, near Durham NC", # overwrites other title...
"mask_file_path": pathlib.Path(
geo_input_folder, "Channels", "masks", "Florence_FULL_RES.txt",
).resolve(),
"mask_driver_string": "csv",
"mask_layer_string": "",
"mask_key": 0,
"mask_name": 1, # TODO: Not used yet.
}
)
return rv

elif supernetwork == "CONUS_FULL_RES_v20":

ROUTELINK = "RouteLink_NHDPLUS"
ModelVer = "nwm.v2.0.4"
ext = "nc"
sep = "."

return {
"geo_file_path": pathlib.Path(
geo_input_folder, "Channels", sep.join([ROUTELINK, ModelVer, ext])
).resolve(),
"data_link": f"https://www.nco.ncep.noaa.gov/pmb/codes/nwprod/{ModelVer}/parm/domain/{ROUTELINK}{sep}{ext}",
"columns": {
"key": "link",
"downstream": "to",
"dx": "Length",
"n": "n",
"ncc": "nCC",
"s0": "So",
"bw": "BtmWdth",
"tw": "TopWdth",
"twcc": "TopWdthCC",
"alt": "alt",
"waterbody": "NHDWaterbodyComID",
"musk": "MusK",
"musx": "MusX",
"cs": "ChSlp",
},
"waterbody_parameter_file_type": "Level_Pool",
"waterbody_parameter_file_path": pathlib.Path(
geo_input_folder, "NWM_2.1_Sample_Datasets", "LAKEPARM_CONUS.nc"
).resolve(),
"waterbody_parameter_columns": {
"waterbody_area": "LkArea",
"weir_elevation": "WeirE",
"waterbody_max_elevation": "LkMxE",
"outfall_weir_coefficient": "WeirC",
"outfall_weir_length": "WeirL",
"overall_dam_length": "DamL",
"orifice_elevation": "OrificeE",
"oriface_coefficient": "OrificeC",
"oriface_are": "OrifaceA",
},
"waterbody_null_code": -9999,
"title_string": "CONUS Full Resolution NWM v2.0",
"driver_string": "NetCDF",
"terminal_code": 0,
"layer_string": 0,
}

elif supernetwork == "custom":
custominput = pathlib.Path(geo_input_folder).resolve()
with open(custominput, "r") as json_file:
return json.load(json_file)
# TODO: add error trapping for potentially missing files


def build_connections(supernetwork_parameters):
'''
Construct network connections network, parameter dataframe, waterbody mapping,
Expand Down
Loading