Directory Structure

Presented below is a detailed description of directories and files that are either used or generated by RAT 3.0.

Tip

Directories are represented by blue color, files are represented by purple color and the description of files/folder are represented by green color.

RAT Project Directory (project_dir)

Conda environment folder for RAT with its python package and other dependencies.

.rat_env

Global database provided along with RAT and downloaded at the time of initialisation. Please note that this is the default location of the global database which can be changed at the time of initialisation by the flag `-gp or --global_data_dir`.

global_data
global_altimetry
  • geoidegm2008grid.mat
  • j3_tracks.geojson
global_basin_data
  • GRDC Major River Basins.pdf
  • MRB TECHDOC.pdf
shapefiles
  • mrb_basins.json
  • mrb_rivers.json
global_dam_data
  • GRanD_dams_v1_3_filtered.shp
  • GRanD_dams_v1_3_filtered.dbf
  • GRanD_dams_v1_3_filtered.prj
  • GRanD_dams_v1_3_filtered.shp
  • GRanD_dams_v1_3_filtered.shx

Even though hydrosheds flow direction file is provided, it is not used due to lower spatial resolution.

global_drt_flow_file
  • global_drt_flow_16th.tif
  • hyd_glo_dir_30s.tif
  • HydroSHEDS_TechDoc_v1_4.pdf
global_elevation_data
  • World_e-Atlas-UCSD_SRTM30-plus_v8.tif

Unfiltered and original version of GRanD database of dams and reservoirs.

global_grand_data
  • GRanD_dams_v1_3.shp
  • GRanD_reservoirs_v1_3.shp
global_reservoir_data
  • GRanD_reservoirs_v1_3.shp
  • GRanD_reservoirs_v1_3.prj
  • GRanD_reservoirs_v1_3.dbf
  • GRanD_reservoirs_v1_3.sbx
  • GRanD_reservoirs_v1_3.shx
  • GRanD_reservoirs_v1_3.sbn
global_vic_params
  • africa_domain.nc
  • africa_params.nc
  • australia_domain.nc
  • australia_params.nc
  • eurasia_domain.nc
  • eurasia_params.nc
  • kamchatka_domain.nc
  • kamchatka_params.nc
  • namerica_domain.nc
  • namerica_params.nc
  • samerica_domain.nc
  • samerica_params.nc
  • oceania_domain.nc
  • oceania_params.nc

It contains the hydrological models which are used by RAT to estimate inflow.

models

It is the python based conda environment which is used to execute MetSim. It is installed during initialization.

metsim

It is the python based conda environment which is used to execute VIC. It is installed during initialization. It also has the VIC executables for classic and image driver but RAT uses only image driver.

vic
  • vic_classic.exe
  • vic_image.exe

It contains the fortran code for routing and also has the compiled code, file required to compile the code (makefile). It is downloaded and installed during initialization.

routing
  • rout.o
  • rout.f
  • rout
  • makefile

It contains the default parameter files and configuration templates for RAT and the hydrological model which are used by it.

params
  • basins_metadata_texas.csv
  • MRB TECHDOC.pdf

It contains configuration file required to run MetSim. It is updated everytime RAT runs MetSim.

metsim
  • params.yaml

It contains parameter configuration file required to run VIC. It is updated everytime RAT runs VIC.

vic
  • vic_params.txt

It contains parameter configuration file required to run routing. It is updated everytime RAT runs VIC. It also contains the default standard unit hydrograph file used by RAT.

routing
  • route_param.txt
  • uh.txt

It contains all the data produced and generated by RAT. Other than that it contains log files for debugging, test data and outputs of test data. Please note it is just the default location of data directory which can be changed by data_dir parameter in the configuration file.

data (data_dir)
raw

It contains global precipitation files downloaded from IMERG in geotif format. Each file is named according to the date of which it contains the data.

precipitation

It contains global maximum temperature files downloaded from NOAA in NetCDF format. Each file is named according to the year of which it contains the data.

tmax

It contains global minimum temperature files downloaded from NOAA in NetCDF format. Each file is named according to the year of which it contains the data.

tmin

It contains global u direction wind speed files downloaded from NOAA in NetCDF format. Each file is named according to the year of which it contains the data. The data is present at a frequency of 6 hours.

uwnd

It contains global v direction wind speed files downloaded from NOAA in NetCDF format. Each file is named according to the year of which it contains the data. The data is present at a frequency of 6 hours.

vwnd

It contains global u direction wind speed files where data is availale at daily frequency created from 6 hourly files. Each file is named according to the year of which it contains the data.

uwnd_daily

It contains global v direction wind speed files where data is availale at daily frequency created from 6 hourly files. Each file is named according to the year of which it contains the data.

vwnd_daily

It contains brief level (level-1) log file corresponding to the user's RAT execution, providing concise information on the successful execution of each step for each basin, along with any associated errors.

runs

Level-1 log files are named by the convention RAT_run-<date-time>.log.

logs

It contains data required to test the installation, initialization and working of RAT for test basins. It is downloaded by the rat test command.

test_data

It contains data required to test RAT execution for the test basin - Gunnison.

gunnison

It contains data required to test RAT execution for the test basin - Nueces.

Nueces

It is a replication of data_dir and contains RAT generated data for test basins by using rat test command.

test_output
region_name

It contains RAT produced output data for different basins having the same region_name.

basins

It contains RAT produced output data for one basin with name basin_name.

basin_name

It contains river basin's grid file and a river basin mask in Geotif format at a spatial resolution of 0.0625°.

basin_grid_data

It contains preprocessed meteorological data for this particular basin only after scaling, aligning and clipping in 'processed' folder. Also, all this meteorological data is combined into a single NetCDF file and is stored in 'nc' folder. This signle file is used to prepare MetSim inputs.

pre_processing

It contains all data related to MetSim generated by RAT.

metsim

It contains all data related to VIC generated by RAT.

vic

It contains all data related to Routing generated by RAT.

ro

It contains all data related to Google Eearth Engine (GEE) and surface area computations generated by RAT.

gee

It contains all data related to altimetry elevation extraction of reservoirs generated by RAT.

altimetry

It contains all Area Elevation Curves of reservoirs generated by RAT. Please note that it is the default location which can be changed by aec_dir in the RAT configuration file.

post_processing

It contains all the outputs generated by RAT in detail.

rat_outputs

It contains all the final outputs polished and in time-series format generated by RAT. Users are recommended to use these outputs for further analysis.

final_outputs

It contains detailed level (level-2) log file corresponding to a basin for which RAT has been executed and offers a comprehensive description of the computations and processes undertaken by RAT for that basin

logs

It contains level-2 logs for one basin with name basin_name. The log files are named as RAT-basin_namedate-time.log.

basin_name

It contains log files generated by VIC when it is executed by RAT.

vic_logs

It contains vic logs for one basin with name basin_name. The log files are named as vic.log.date-time.txt.

basin_name