def compute_seasonal_initial_rapid_flows(historical_qout_file, input_directory, init_file_location):
"""
Gets the seasonal average from historical file to initialize from
"""
if not os.path.exists(init_file_location):
#check to see if exists and only perform operation once
if historical_qout_file and os.path.exists(historical_qout_file):
rapid_manager = RAPID(Qout_file=historical_qout_file,
rapid_connect_file=os.path.join(input_directory,'rapid_connect.csv'))
rapid_manager.generate_seasonal_intitialization(init_file_location)
else:
print("No historical streamflow file found. Skipping ...")
def compute_seasonal_initial_rapid_flows(historical_qout_file, input_directory, forecast_date_timestep):
"""
Gets the seasonal average from historical file to initialize from
"""
current_forecast_date = datetime.datetime.strptime(forecast_date_timestep[:11],"%Y%m%d.%H")
#move the date back a forecast (12 hrs) to be used in this forecast
forecast_date_string = (current_forecast_date-datetime.timedelta(seconds=12*3600)).strftime("%Y%m%dt%H")
init_file_location = os.path.join(input_directory,'Qinit_%s.csv' % forecast_date_string)
if not os.path.exists(init_file_location):
#check to see if exists and only perform operation once
if historical_qout_file and os.path.exists(historical_qout_file):
rapid_manager = RAPID(Qout_file=historical_qout_file,
rapid_connect_file=os.path.join(input_directory,'rapid_connect.csv'))
rapid_manager.generate_seasonal_intitialization(init_file_location)
else:
print "No seasonal streamflow file found. Skipping ..."
def test_generate_seasonal_qinit(self):
"""
Checks generating seasonal qinit from rapid Qout
"""
rapid_manager = RAPID(Qout_file=os.path.join(self.INPUT_DATA_PATH, 'Qout_erai_t511_24hr_19800101to19861231.nc'),
rapid_connect_file=os.path.join(self.COMPARE_DATA_PATH, 'gis', 'x-x', 'rapid_connect.csv')
)
seasonal_init_file_name = 'Qinit_seasonal_avg_jan_1.csv'
generated_seasonal_init_file = os.path.join(self.OUTPUT_DATA_PATH, seasonal_init_file_name)
rapid_manager.generate_seasonal_intitialization(qinit_file=generated_seasonal_init_file,
datetime_start_initialization=datetime(1984,1,1))
compare_seasonal_init_file = os.path.join(self.COMPARE_DATA_PATH, generated_seasonal_init_file)
compare_csv_decimal_files(generated_seasonal_init_file,compare_seasonal_init_file)
def test_generate_seasonal_qinit(self):
"""
Checks generating seasonal qinit from rapid Qout
"""
print("TEST 3: TEST GENERATE SEASONAL QINIT FROM RAPID QOUT")
rapid_manager = RAPID(Qout_file=os.path.join(self.INPUT_DATA_PATH, 'Qout_erai_t511_24hr_19800101to19861231.nc'),
rapid_connect_file=os.path.join(self.COMPARE_DATA_PATH, 'gis', 'x-x', 'rapid_connect.csv')
)
seasonal_init_file_name = 'Qinit_seasonal_avg_jan_1.csv'
generated_seasonal_init_file = os.path.join(self.OUTPUT_DATA_PATH, seasonal_init_file_name)
rapid_manager.generate_seasonal_intitialization(qinit_file=generated_seasonal_init_file,
datetime_start_initialization=datetime(1984,1,1))
compare_seasonal_init_file = os.path.join(self.COMPARE_DATA_PATH, generated_seasonal_init_file)
compare_csv_decimal_files(generated_seasonal_init_file,compare_seasonal_init_file)
def run_lsm_rapid_process(rapid_executable_location,
rapid_io_files_location,
lsm_data_location,
simulation_start_datetime,
simulation_end_datetime=datetime.utcnow(),
download_era_interim=False,
ensemble_list=[None],
generate_return_periods_file=False,
generate_seasonal_initialization_file=False,
generate_initialization_file=False,
generate_rapid_namelist_file=True,
run_rapid_simulation=True,
use_all_processors=True,
num_processors=1,
ftp_host="",
ftp_login="",
ftp_passwd="",
ftp_directory="",
cygwin_bin_location=""):
"""
This is the main process to generate inflow for RAPID and to run RAPID
"""
time_begin_all = datetime.utcnow()
#use all processors makes precedent over num_processors arg
if use_all_processors == True:
NUM_CPUS = multiprocessing.cpu_count()
elif num_processors > multiprocessing.cpu_count():
print "WARNING: Num processors requested exceeded max. Set to max ..."
NUM_CPUS = multiprocessing.cpu_count()
else:
NUM_CPUS = num_processors
#get list of correclty formatted rapid input directories in rapid directory
rapid_input_directories = get_valid_watershed_list(
os.path.join(rapid_io_files_location, 'input'))
for ensemble in ensemble_list:
ensemble_file_ending = ".nc"
if ensemble != None:
ensemble_file_ending = "_{0}.nc".format(ensemble)
#get list of files
lsm_file_list = []
for subdir, dirs, files in os.walk(lsm_data_location):
for erai_file in files:
if erai_file.endswith(ensemble_file_ending):
lsm_file_list.append(os.path.join(subdir, erai_file))
lsm_file_list_subset = []
for erai_file in sorted(lsm_file_list):
match = re.search(r'\d{8}', erai_file)
file_date = datetime.strptime(match.group(0), "%Y%m%d")
if file_date > simulation_end_datetime:
break
print file_date
if file_date >= simulation_start_datetime:
lsm_file_list_subset.append(os.path.join(subdir, erai_file))
print lsm_file_list_subset[0]
actual_simulation_start_datetime = datetime.strptime(
re.search(r'\d{8}', lsm_file_list_subset[0]).group(0), "%Y%m%d")
print lsm_file_list_subset[-1]
actual_simulation_end_datetime = datetime.strptime(
re.search(r'\d{8}', lsm_file_list_subset[-1]).group(0), "%Y%m%d")
lsm_file_list = sorted(lsm_file_list_subset)
#check to see what kind of file we are dealing with
lsm_example_file = Dataset(lsm_file_list[0])
#INDENTIFY LAT/LON DIMENSIONS
dim_list = lsm_example_file.dimensions.keys()
latitude_dim = "lat"
if 'latitude' in dim_list:
latitude_dim = 'latitude'
elif 'g0_lat_0' in dim_list:
#GLDAS/NLDAS MOSAIC
latitude_dim = 'g0_lat_0'
elif 'lat_110' in dim_list:
#NLDAS NOAH/VIC
latitude_dim = 'lat_110'
elif 'north_south' in dim_list:
#LIS/Joules
latitude_dim = 'north_south'
elif 'south_north' in dim_list:
#WRF Hydro
latitude_dim = 'south_north'
longitude_dim = "lon"
if 'longitude' in dim_list:
longitude_dim = 'longitude'
elif 'g0_lon_1' in dim_list:
#GLDAS/NLDAS MOSAIC
longitude_dim = 'g0_lon_1'
elif 'lon_110' in dim_list:
#NLDAS NOAH/VIC
longitude_dim = 'lon_110'
elif 'east_west' in dim_list:
#LIS/Joules
longitude_dim = 'east_west'
elif 'west_east' in dim_list:
#WRF Hydro
longitude_dim = 'west_east'
lat_dim_size = len(lsm_example_file.dimensions[latitude_dim])
lon_dim_size = len(lsm_example_file.dimensions[longitude_dim])
#IDENTIFY VARIABLES
var_list = lsm_example_file.variables.keys()
latitude_var = "lat"
if 'latitude' in var_list:
latitude_var = 'latitude'
elif 'g0_lat_0' in var_list:
latitude_var = 'g0_lat_0'
elif 'lat_110' in var_list:
latitude_var = 'lat_110'
elif 'north_south' in var_list:
latitude_var = 'north_south'
elif 'XLAT' in var_list:
latitude_var = 'XLAT'
longitude_var = "lon"
if 'longitude' in var_list:
longitude_var = 'longitude'
elif 'g0_lon_1' in var_list:
longitude_var = 'g0_lon_1'
elif 'lon_110' in var_list:
longitude_var = 'lon_110'
elif 'east_west' in var_list:
longitude_var = 'east_west'
elif 'XLONG' in var_list:
longitude_var = 'XLONG'
surface_runoff_var = ""
subsurface_runoff_var = ""
for var in var_list:
if var.startswith("SSRUN"):
#NLDAS/GLDAS
surface_runoff_var = var
elif var.startswith("BGRUN"):
#NLDAS/GLDAS
subsurface_runoff_var = var
elif var == "Qs_inst":
#LIS
surface_runoff_var = var
elif var == "Qsb_inst":
#LIS
subsurface_runoff_var = var
elif var == "SFROFF":
#WRF Hydro
surface_runoff_var = var
elif var == "UDROFF":
#WRF Hydro
subsurface_runoff_var = var
elif var.lower() == "ro":
#ERA Interim
surface_runoff_var = var
#IDENTIFY GRID TYPE & TIME STEP
try:
time_dim = "time"
if "Time" in lsm_example_file.dimensions:
time_dim = "Time"
file_size_time = len(lsm_example_file.dimensions[time_dim])
except Exception as ex:
print "ERROR:", ex
print "Assuming time dimension is 1"
file_size_time = 1
out_file_ending = "{0}to{1}{2}".format(
actual_simulation_start_datetime.strftime("%Y%m%d"),
actual_simulation_end_datetime.strftime("%Y%m%d"),
ensemble_file_ending)
weight_file_name = ''
grid_type = ''
model_name = ''
time_step = 0
description = ""
RAPID_Inflow_Tool = None
total_num_time_steps = 0
institution = ""
try:
institution = lsm_example_file.getncattr("institution")
except AttributeError:
pass
if institution == "European Centre for Medium-Range Weather Forecasts" \
or surface_runoff_var.lower() == "ro":
#these are the ECMWF models
if lat_dim_size == 361 and lon_dim_size == 720:
print "Runoff file identified as ERA Interim Low Res (T255) GRID"
#A) ERA Interim Low Res (T255)
#Downloaded as 0.5 degree grid
# dimensions:
# longitude = 720 ;
# latitude = 361 ;
description = "ERA Interim (T255 Grid)"
model_name = "erai"
weight_file_name = r'weight_era_t255\.csv'
grid_type = 't255'
elif lat_dim_size == 512 and lon_dim_size == 1024:
print "Runoff file identified as ERA Interim High Res (T511) GRID"
#B) ERA Interim High Res (T511)
# dimensions:
# lon = 1024 ;
# lat = 512 ;
description = "ERA Interim (T511 Grid)"
weight_file_name = r'weight_era_t511\.csv'
model_name = "erai"
grid_type = 't511'
elif lat_dim_size == 161 and lon_dim_size == 320:
print "Runoff file identified as ERA 20CM (T159) GRID"
#C) ERA 20CM (T159) - 3hr - 10 ensembles
#Downloaded as 1.125 degree grid
# dimensions:
# longitude = 320 ;
# latitude = 161 ;
description = "ERA 20CM (T159 Grid)"
weight_file_name = r'weight_era_t159\.csv'
model_name = "era_20cm"
grid_type = 't159'
else:
lsm_example_file.close()
raise Exception("Unsupported grid size.")
#time units are in hours
if file_size_time == 1:
time_step = 24 * 3600 #daily
description += " Daily Runoff"
elif file_size_time == 8:
time_step = 3 * 3600 #3 hourly
description += " 3 Hourly Runoff"
else:
lsm_example_file.close()
raise Exception("Unsupported ECMWF time step.")
total_num_time_steps = file_size_time * len(lsm_file_list)
RAPID_Inflow_Tool = CreateInflowFileFromERAInterimRunoff()
elif institution == "NASA GSFC":
print "Runoff file identified as LIS GRID"
#this is the LIS model
weight_file_name = r'weight_lis\.csv'
grid_type = 'lis'
description = "NASA GFC LIS Hourly Runoff"
model_name = "nasa"
#time units are in minutes
if file_size_time == 1:
#time_step = 1*3600 #hourly
time_step = 3 * 3600 #3-hourly
else:
lsm_example_file.close()
raise Exception("Unsupported LIS time step.")
total_num_time_steps = file_size_time * len(lsm_file_list)
RAPID_Inflow_Tool = CreateInflowFileFromLDASRunoff(
latitude_dim, longitude_dim, latitude_var, longitude_var,
surface_runoff_var, subsurface_runoff_var, time_step)
elif institution == "Met Office, UK":
print "Runoff file identified as Joules GRID"
#this is the LIS model
weight_file_name = r'weight_joules\.csv'
grid_type = 'joules'
description = "Met Office Joules Hourly Runoff"
model_name = "met_office"
#time units are in minutes
if file_size_time == 1:
#time_step = 1*3600 #hourly
time_step = 3 * 3600 #3-hourly
else:
lsm_example_file.close()
raise Exception("Unsupported LIS time step.")
total_num_time_steps = file_size_time * len(lsm_file_list)
RAPID_Inflow_Tool = CreateInflowFileFromLDASRunoff(
latitude_dim, longitude_dim, latitude_var, longitude_var,
surface_runoff_var, subsurface_runoff_var, time_step)
elif surface_runoff_var.startswith("SSRUN") \
and subsurface_runoff_var.startswith("BGRUN"):
model_name = "nasa"
if lat_dim_size == 600 and lon_dim_size == 1440:
print "Runoff file identified as GLDAS GRID"
#GLDAS NC FILE
#dimensions:
# g0_lat_0 = 600 ;
# g0_lon_1 = 1440 ;
#variables
#SSRUN_GDS0_SFC_ave1h (surface), BGRUN_GDS0_SFC_ave1h (subsurface)
# or
#SSRUNsfc_GDS0_SFC_ave1h (surface), BGRUNsfc_GDS0_SFC_ave1h (subsurface)
description = "GLDAS 3 Hourly Runoff"
weight_file_name = r'weight_gldas\.csv'
grid_type = 'gldas'
if file_size_time == 1:
time_step = 3 * 3600 #3 hourly
else:
lsm_example_file.close()
raise Exception("Unsupported GLDAS time step.")
total_num_time_steps = file_size_time * len(lsm_file_list)
elif lat_dim_size <= 224 and lon_dim_size <= 464:
print "Runoff file identified as NLDAS GRID"
#NLDAS MOSAIC FILE
#dimensions:
# g0_lat_0 = 224 ;
# g0_lon_1 = 464 ;
#NLDAS NOAH/VIC FILE
#dimensions:
# lat_110 = 224 ;
# lon_110 = 464 ;
description = "NLDAS Hourly Runoff"
weight_file_name = r'weight_nldas\.csv'
grid_type = 'nldas'
if file_size_time == 1:
#time_step = 1*3600 #hourly
time_step = 3 * 3600 #3 hourly
else:
lsm_example_file.close()
raise Exception("Unsupported NLDAS time step.")
else:
lsm_example_file.close()
raise Exception("Unsupported runoff grid.")
RAPID_Inflow_Tool = CreateInflowFileFromLDASRunoff(
latitude_dim, longitude_dim, latitude_var, longitude_var,
surface_runoff_var, subsurface_runoff_var, time_step)
else:
title = ""
try:
title = lsm_example_file.getncattr("TITLE")
except AttributeError:
pass
if "WRF" in title:
description = "WRF-Hydro Hourly Runoff"
weight_file_name = r'weight_wrf\.csv'
grid_type = 'wrf_hydro'
time_step = 1 * 3600 #1 hourly
total_num_time_steps = file_size_time * len(lsm_file_list)
RAPID_Inflow_Tool = CreateInflowFileFromWRFHydroRunoff(
latitude_dim, longitude_dim, latitude_var, longitude_var,
surface_runoff_var, subsurface_runoff_var, time_step)
else:
lsm_example_file.close()
raise Exception("Unsupported runoff grid.")
lsm_example_file.close()
#VALIDATING INPUT IF DIVIDING BY 3
if grid_type == 'nldas' or grid_type == 'lis' or grid_type == 'joules':
num_extra_files = file_size_time * len(lsm_file_list) % 3
if num_extra_files != 0:
print "WARNING: Number of files needs to be divisible by 3. Remainder is", num_extra_files
print "This means your simulation will be truncated"
total_num_time_steps = int(file_size_time * len(lsm_file_list) / 3)
out_file_ending = "{0}_{1}_{2}hr_{3}".format(model_name, grid_type,
time_step / 3600,
out_file_ending)
#set up RAPID manager
rapid_manager = RAPID(
rapid_executable_location=rapid_executable_location,
cygwin_bin_location=cygwin_bin_location,
num_processors=NUM_CPUS,
ZS_TauR=
time_step, #duration of routing procedure (time step of runoff data)
ZS_dtR=15 * 60, #internal routing time step
ZS_TauM=total_num_time_steps * time_step, #total simulation time
ZS_dtM=time_step #RAPID recommended internal time step (1 day)
)
#run ERA Interim processes
for rapid_input_directory in rapid_input_directories:
watershed, subbasin = get_watershed_subbasin_from_folder(
rapid_input_directory)
master_watershed_input_directory = os.path.join(
rapid_io_files_location, 'input', rapid_input_directory)
master_watershed_output_directory = os.path.join(
rapid_io_files_location, 'output', rapid_input_directory)
try:
os.makedirs(master_watershed_output_directory)
except OSError:
pass
#create inflow to dump data into
master_rapid_runoff_file = os.path.join(
master_watershed_output_directory,
'm3_riv_bas_{0}'.format(out_file_ending))
weight_table_file = case_insensitive_file_search(
master_watershed_input_directory, weight_file_name)
RAPID_Inflow_Tool.generateOutputInflowFile(
out_nc=master_rapid_runoff_file,
in_weight_table=weight_table_file,
tot_size_time=total_num_time_steps,
)
job_combinations = []
if grid_type == 'nldas' or grid_type == 'lis' or grid_type == 'joules':
print "Grouping {0} in threes".format(grid_type)
lsm_file_list = [lsm_file_list[nldas_index:nldas_index+3] for nldas_index in range(0, len(lsm_file_list), 3)\
if len(lsm_file_list[nldas_index:nldas_index+3])==3]
partition_list, partition_index_list = partition(
lsm_file_list, NUM_CPUS)
for loop_index, cpu_grouped_file_list in enumerate(partition_list):
job_combinations.append(
(watershed.lower(), subbasin.lower(),
cpu_grouped_file_list, partition_index_list[loop_index],
weight_table_file, grid_type, master_rapid_runoff_file,
RAPID_Inflow_Tool))
#COMMENTED CODE IS FOR DEBUGGING
## generate_inflows_from_runoff((watershed.lower(),
## subbasin.lower(),
## cpu_grouped_file_list,
## partition_index_list[loop_index],
## weight_table_file,
## grid_type,
## master_rapid_runoff_file,
## RAPID_Inflow_Tool))
pool = multiprocessing.Pool(NUM_CPUS)
#chunksize=1 makes it so there is only one task per cpu
pool.imap(generate_inflows_from_runoff,
job_combinations,
chunksize=1)
pool.close()
pool.join()
#run RAPID for the watershed
lsm_rapid_output_file = os.path.join(
master_watershed_output_directory,
'Qout_{0}'.format(out_file_ending))
rapid_manager.update_parameters(
rapid_connect_file=case_insensitive_file_search(
master_watershed_input_directory, r'rapid_connect\.csv'),
Vlat_file=master_rapid_runoff_file,
riv_bas_id_file=case_insensitive_file_search(
master_watershed_input_directory, r'riv_bas_id\.csv'),
k_file=case_insensitive_file_search(
master_watershed_input_directory, r'k\.csv'),
x_file=case_insensitive_file_search(
master_watershed_input_directory, r'x\.csv'),
Qout_file=lsm_rapid_output_file)
rapid_manager.update_reach_number_data()
if generate_rapid_namelist_file:
rapid_manager.generate_namelist_file(
os.path.join(
master_watershed_input_directory,
"rapid_namelist_{}".format(out_file_ending[:-3])))
if run_rapid_simulation:
rapid_manager.run()
try:
comid_lat_lon_z_file = case_insensitive_file_search(
master_watershed_input_directory,
r'comid_lat_lon_z\.csv')
except Exception:
comid_lat_lon_z_file = ""
print "WARNING: comid_lat_lon_z file not found. These will not be added in conversion ..."
pass
rapid_manager.make_output_CF_compliant(
simulation_start_datetime=actual_simulation_start_datetime,
comid_lat_lon_z_file=comid_lat_lon_z_file,
project_name="{0} Based Historical flows by US Army ERDC".
format(description))
#generate return periods
if generate_return_periods_file and os.path.exists(
lsm_rapid_output_file) and lsm_rapid_output_file:
return_periods_file = os.path.join(
master_watershed_output_directory,
'return_periods_{0}'.format(out_file_ending))
#assume storm has 3 day length
storm_length_days = 3
generate_return_periods(lsm_rapid_output_file,
return_periods_file, storm_length_days)
if generate_seasonal_initialization_file and os.path.exists(
lsm_rapid_output_file) and lsm_rapid_output_file:
seasonal_qinit_file = os.path.join(
master_watershed_input_directory,
'seasonal_qinit_{0}.csv'.format(out_file_ending[:-3]))
rapid_manager.generate_seasonal_intitialization(
seasonal_qinit_file)
if generate_initialization_file and os.path.exists(
lsm_rapid_output_file) and lsm_rapid_output_file:
qinit_file = os.path.join(
master_watershed_input_directory,
'qinit_{0}.csv'.format(out_file_ending[:-3]))
rapid_manager.generate_qinit_from_past_qout(qinit_file)
#print info to user
time_end = datetime.utcnow()
print "Time Begin All: " + str(time_begin_all)
print "Time Finish All: " + str(time_end)
print "TOTAL TIME: " + str(time_end - time_begin_all)
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
"""
Created on Fri Jan 25 14:23:11 2019
@author: michael
"""
from RAPIDpy.rapid import RAPID
qout = '/home/michael/host_share/rapid-io/output' \
'/south_america-col_negro_b' \
'/Qout_erai_t511_24hr_19800101to19961231.nc'
connt = '/home/michael/host_share/rapid-io/input' \
'/south_america-col_negro_b/rapid_connect.csv'
rapid_manager = RAPID(
Qout_file=qout,
rapid_connect_file=connt
)
rapid_manager.generate_seasonal_intitialization(
qinit_file='/home/michael/test_seasonal_qinit.csv'
)