Merge pull request #2 from WrenRaming/main

Updating structure

Author: WrenRaming

.gitignore

@@ -4,13 +4,13 @@ This repository hosts the setup for executing a single point model of the [Happy
 
 ## The structure of this repository is as follows:
 ### data
- Contains all the necessary data to run tRIBS at Happy Jack and includes Snotel and SWANN data as a calibration/validation set.
+Contains all the necessary data to run tRIBS at Happy Jack and includes Snotel and SWANN data as a calibration/validation set.
 ### doc 
-Contains relevant documentation to running this specific benchmark case and other information regarding working with this repository, including requirements.
+Contains relevant documentation for running this specific benchmark case and other information regarding working with this repository, including requirements and instructions for building tRIBS.
 ### src
-Contains two shell scripts: one (*runall.sh*) to execute the model and generate a log of the relevant model runs and the other(*summarize.sh*)a script that summarizes the results from the model run. This directory also contains two sub-directories: [inFile](/src/inFile) whic holds the .in files used to execute tRIBS and another, [scripts](/src/scripts) that contains subroutines for (*runall.sh*) and (*summarize.sh*).
+Is designed to contain source code for for the tRIBS executable, which can be obtained [here](https://github.com/tribshms/tribs_sub2020).
 ### bin
-Directory for the tRIBS executable, which can be obtained and built from [here](https://github.com/tribshms/tribs_sub2020).
+Directory for building and storing tRIBS executable, with instructions [here](doc/CMake.md).
 ### results
 Directory for results from the Happy Jack point tRIBS simulation. 
 

README.md

@@ -0,0 +1 @@
+Build and store tRIBS executable here

bin/.gitignore

@@ -0,0 +1 @@
+Store tRIBS forcing and inputs here

bin/README.txt

@@ -0,0 +1,35 @@
+# CMake 
+
+## instructions for compiling tRIBS on your machine using CMake
+
+Note: these instructions are for using CMake via terminal, there is additional documentation [here](https://cmake.org/cmake/help/latest/guide/user-interaction/index.html#guide:User%20Interaction%20Guide) for using the CMake gui. 
+
+1) Use [Homebrew](https://formulae.brew.sh/formula/cmake)to install CMake, alternatively you can download [CMake](https://cmake.org/download/), but Homebrew is preferred as it will catch additional dependencies.
+
+2) You can check to see if CMake is on your path, by typing cmake into the command line. If it says its not found then you will need to set cmake to your path. For example if you downloaded CMake and its now in your application folder you can use:
+
+```bash
+sudo "/Applications/CMake.app/Contents/bin/cmake-gui" --install
+```
+3) Next obtain the tRIBS source code from [here](https://github.com/tribshms/tribs_sub2020) and store in src.
+
+4) Then execute the following code in the terminal, assuming you are in the root directory of HJ_Benchmark
+
+```bash
+cmake -S src/tribs_sub2020 . -B bin/build 
+cmake --build bin/build --target all  
+```
+The first command tells CMake to generate the make files for tribs in a folder called build in bin. Followed by the second line which effectively compiles the code. 
+
+5) After you can check to see that the executable was made by using.
+```bash
+ ls bin/build/
+ ```
+ The executable will have a name specifed in the CMakeList.txt file. Currently it is set to tRIBS.
+
+ ## Content of CMakeFile.txt
+
+ In some instance you may want to modify the CMakeFile.txt, for example if you want to change the name of the executable, or change compilation parallel mode to serial, or add additional compiler flags. This section will be updated with more detail to demonstrate how this is possible here, but the CMakeFile.txt is documented with where these changes can be made.
+
+
+## Return to [README](./README.md)

data/README.txt

@@ -0,0 +1 @@
+Store tRIBS results, notes, and model execution scripts here

doc/CMake.md

@@ -0,0 +1 @@
+Store tRIBS sourc code and pre and post processing scripts here

results/.gitignore

@@ -34,19 +34,19 @@ OPTSNOW:	Option for single layer snow model
 1
 
 OUTFILENAME:	   Base name of the tMesh and variable output or HJ_results_off_
-Output/Results/Voi/HJ_results_on_
+results/HJ_results
 
 OUTHYDROFILENAME:  Base name for hydrograph output
-Output/Results/Hyd/HJ_results_on_
+results/HJ_results
 
 GAUGESTATIONS: 	   Rain Gauge station file (*.sdf) HJR_GF_2002-2018.sdf HJR_2002_AugEvent.sdf
-Rain/HJR_GF_2002-2018.sdf
+data/HJR_GF_2002-2018.sdf
 
 GAUGECONVERT:      Rain Gauge data conversion file (*.mdi)
 
 
 GAUGEBASENAME:	   Rain Gauge data BASE name (*.mdf) HJR_GF_2002-2018.mdf HJR_2002_AugEvent.mdf
-Rain/HJR_GF_2002-2018.mdf
+data/HJR_GF_2002-2018.mdf
 
 
 
@@ -257,33 +257,33 @@ ARCINFOFILENAME:  tMesh input file base name Arc files
 
 
 POINTFILENAME:    tMesh input file name Points files
-Input/HappyJack.points
+data/HappyJack.points
 
 
 ## Resampling Grids
 ## -----------------
 
 
 SOILTABLENAME:    Soil parameter reference table (*.sdt)
-Input/HJ_Soil_Table.sdt
+data/HJ_Soil_Table.sdt
 
 SOILMAPNAME:      Soil texture ASCII grid (*.soi)
-Input/HJ_Soil_Map.soi
+data/HJ_Soil_Map.soi
 
 LANDTABLENAME:    Land use parameter reference table (*.ldt)
-Input/HJ_Veg_Table.ldt
+data/HJ_Veg_Table.ldt
 
 LANDMAPNAME:  	  Land use ASCII grid (*.lan)
-Input/HJ_Veg_Map.lan
+data/HJ_Veg_Map.lan
 
 GWATERFILE:       Ground water ASCII grid (*.iwt) 
-Input/HJ_Water_Table_Map.iwt
+data/HJ_Water_Table_Map.iwt
 
 DEMFILE:	  DEM ASCII grid for sky and land view factors (*.dem)
-Input/Sheltering_DEM.dem
+data/Sheltering_DEM.dem
 
 RAINFILE:         Base name of the radar ASCII grid
-Rain/
+data/
 
 RAINEXTENSION:    Extension for the radar ASCII grid 
 txt
@@ -292,10 +292,10 @@ DEPTHTOBEDROCK:   Uniform depth to bedrock (meters)
 15
 
 BEDROCKFILE:      Bedrock depth ASCII grid (*.brd)
-Input/
+data/
 
 LUGRID:		  Land cover grid data file (*.gdf)
-Input/Dynamic_Veg_Grid_Data.gdf
+data/Dynamic_Veg_Grid_Data.gdf
 
 
 ## Meteorological Variables
@@ -323,7 +323,7 @@ PRECLAPSE:	  Precipitation lapse rate
 
 
 HYDROMETSTATIONS:  Hydrometeorological station file (*.sdf)
-Weather/HJW_GF_2002-2018.sdf
+data/HJW_GF_2002-2018.sdf
 
 HYDROMETGRID:  	   Hydrometeorological grid data file (*.gdf)
 
@@ -332,7 +332,7 @@ HYDROMETCONVERT:   Hydrometeorological data conversion file (*.mdi)
 
 
 HYDROMETBASENAME:  Hydrometeorological data BASE name (*.mdf)
-Weather/HJW_GF_2002-2018.mdf
+data/HJW_GF_2002-2018.mdf
 
 
 
@@ -347,13 +347,13 @@ RIBSHYDOUTPUT:	   Compatibility with RIBS User Interphase
 0
 
 NODEOUTPUTLIST:    Filename with Nodes for Dynamic Output (*.nol)
-Input/Nodes/pNodes.dat
+data/Nodes/pNodes.dat
 
 HYDRONODELIST:     Filename with Nodes for HydroModel Output (*.nol)
-Input/Nodes/hNodes.dat
+data/Nodes/hNodes.dat
 
 OUTLETNODELIST:    Filename with Interior Nodes for  Output (*.nol)
-Input/Nodes/oNodes.dat
+data/Nodes/oNodes.dat
 
 ##=========================================================================
 ##
@@ -394,7 +394,7 @@ FORECASTLENGTH:	   Forecast Window Length (hours)
 0
 
 FORECASTFILE:	   Base name of the radar QPF grids
-Rain/
+data/
 
 CLIMATOLOGY:	   Rainfall climatology (mm/hr)
 0
@@ -457,7 +457,7 @@ RESTARTINTRVL:      Time set for restart output (hours)
 12
 
 RESTARTDIR:         Path of directory for restart output
-Restart/
+data/
 
 RESTARTFILE:        Actual file to restart a run
 tRIBS_Rstrt_00012