Skip to content

Commit 87c63b7

Browse files
JoshCederstromJoshCederstrom
committed
Replace entire repository setup with version from Zenodo and update reference results for tRIBS v5.3.0 release.
1 parent 95c5d6d commit 87c63b7

26 files changed

+143847
-157076
lines changed

‎.gitignore‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
data/.DS_Store
2+
.DS_Store

‎README.html‎

Lines changed: 102 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,102 @@
1+
<!DOCTYPE html>
2+
<html xmlns="http://www.w3.org/1999/xhtml" lang="" xml:lang="">
3+
<head>
4+
<meta charset="utf-8" />
5+
<meta name="generator" content="pandoc" />
6+
<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes" />
7+
<title>README</title>
8+
<style>
9+
code{white-space: pre-wrap;}
10+
span.smallcaps{font-variant: small-caps;}
11+
div.columns{display: flex; gap: min(4vw, 1.5em);}
12+
div.column{flex: auto; overflow-x: auto;}
13+
div.hanging-indent{margin-left: 1.5em; text-indent: -1.5em;}
14+
/* The extra [class] is a hack that increases specificity enough to
15+
override a similar rule in reveal.js */
16+
ul.task-list[class]{list-style: none;}
17+
ul.task-list li input[type="checkbox"] {
18+
font-size: inherit;
19+
width: 0.8em;
20+
margin: 0 0.8em 0.2em -1.6em;
21+
vertical-align: middle;
22+
}
23+
.display.math{display: block; text-align: center; margin: 0.5rem auto;}
24+
</style>
25+
<link rel="stylesheet" href="doc/documentation/github.css" />
26+
</head>
27+
<body>
28+
<header id="title-block-header">
29+
<h1 class="title">README</h1>
30+
</header>
31+
<h1
32+
id="tin-based-real-time-integrated-basin-simulator-point-scale-benchmark">TIN-Based
33+
Real-Time Integrated Basin Simulator point-scale benchmark</h1>
34+
<p>This repository hosts the setup for executing a point-scale model of
35+
the <a href="https://wcc.sc.egov.usda.gov/nwcc/site?sitenum=969">Happy
36+
Jack SNOTEL Site</a> in Northern Arizona, USA, using the TIN-Based
37+
Real-Time Integrated Basin Simulator (<a
38+
href="https://tribshms.readthedocs.io/en/latest/">tRIBS</a>). tRIBS v5.2
39+
(or later) uses CMake as a build system, instructions on downloading and
40+
building tRIBS can be found <a
41+
href="https://tribshms.readthedocs.io/en/latest/man/Model_Execution.html#compilation-instructions">here</a>.
42+
Or alternatively one may use the tRIBS docker image, more information on
43+
this can be found <a
44+
href="https://tribshms.readthedocs.io/en/latest/man/Docker.html#docker">here</a>.</p>
45+
<h2 id="model-execution">Model Execution</h2>
46+
<p>From the command line tRIBS can be executed as follows, assuming the
47+
executable is stored in the sub-directory <code>bin</code>:</p>
48+
<pre><code>bin/tRIBS &lt;path/to/infile&gt;</code></pre>
49+
<p>In this case the happy jack input files can be found in
50+
<code>src/in_files/happy_jack.in</code> and can be further modified to
51+
explore tRIBS functionality. Note: the current input file is setup with
52+
relative paths and results will be saved to <code>results/test</code>.
53+
Also, any modification in <code>data/model</code> may require an update
54+
of the .in file.</p>
55+
<h2 id="benchmark">Benchmark</h2>
56+
<p>The benchmark case results are stored as a zip file under
57+
<code>results/reference</code>. These results can be visualized in
58+
comparison to SNOTEL<a href="#fn1" class="footnote-ref" id="fnref1"
59+
role="doc-noteref"><sup>1</sup></a><sup>,</sup><a href="#fn2"
60+
class="footnote-ref" id="fnref2" role="doc-noteref"><sup>2</sup></a>
61+
data for the Happy Jack site as demonstrated in the jupyter notebook in
62+
<code>src/tRIBS_snotel_comparison.ipynb</code>.</p>
63+
<h2 id="directory-structure">Directory Structure:</h2>
64+
<h3 id="data">data</h3>
65+
<p>Contains all the necessary data to run tRIBS at Happy Jack and
66+
includes Snotel and SWANN data as a calibration/validation set.</p>
67+
<h3 id="doc">doc</h3>
68+
<p>Contains notebooks for running and analyzing this specific benchmark
69+
case, along side additional documentation.</p>
70+
<h3 id="src">src</h3>
71+
<p>Is designed to contain source code for for the tRIBS executable,
72+
which can be obtained <a
73+
href="https://github.com/tribshms/tRIBS">here</a>.</p>
74+
<h3 id="bin">bin</h3>
75+
<p>Directory for building and storing tRIBS executable, with
76+
instructions <a
77+
href="https://tribshms.readthedocs.io/en/latest/man/Model_Execution.html#compilation-instructions">here</a>.</p>
78+
<h3 id="results">results</h3>
79+
<p>Directory for results, with a <em>reference</em> and <em>test</em>
80+
sub-directories. The former contains reference outputs from the Happy
81+
Jack point tRIBS simulation, while the later is empty and intended to
82+
store additional model simulations. Note the main results also contains
83+
a zip of the <em>reference</em> sub-directory.</p>
84+
<h2 id="references">References</h2>
85+
<section id="footnotes" class="footnotes footnotes-end-of-document"
86+
role="doc-endnotes">
87+
<hr />
88+
<ol>
89+
<li id="fn1"><p>Sun N, H Yan, M Wigmosta, R Skaggs, R Leung, and Z Hou.
90+
2019. “Regional snow parameters estimation for large-domain hydrological
91+
applications in the western United States.” Journal of Geophysical
92+
Research: Atmospheres. doi: 10.1029/2018JD030140<a href="#fnref1"
93+
class="footnote-back" role="doc-backlink">↩︎</a></p></li>
94+
<li id="fn2"><p>Yan H, N Sun, M Wigmosta, R Skaggs, Z Hou, and R Leung.
95+
2018. “Next-generation intensity-duration-frequency curves for
96+
hydrologic design in snow-dominated environments.” Water Resources
97+
Research, 54(2), 1093–1108. BCQC Data Format<a href="#fnref2"
98+
class="footnote-back" role="doc-backlink">↩︎</a></p></li>
99+
</ol>
100+
</section>
101+
</body>
102+
</html>

‎README.md‎

Lines changed: 21 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,48 +1,36 @@
1-
# TIN-Based Real-Time Integrated Basin Simulator single point benchmark
1+
# TIN-Based Real-Time Integrated Basin Simulator point-scale benchmark
2+
This repository hosts the setup for executing a point-scale model of the [Happy Jack SNOTEL Site](https://wcc.sc.egov.usda.gov/nwcc/site?sitenum=969) in Northern Arizona, USA, using the TIN-Based Real-Time Integrated Basin Simulator ([tRIBS](https://tribshms.readthedocs.io/en/latest/)). tRIBS v5.2 (or later) uses CMake as a build system, instructions on downloading and building tRIBS can be found [here](https://tribshms.readthedocs.io/en/latest/man/Model_Execution.html#compilation-instructions). Or alternatively one may use the tRIBS docker image, more information on this can be found [here](https://tribshms.readthedocs.io/en/latest/man/Docker.html#docker).
23

3-
This repository hosts the setup for executing a single point model of the [Happy Jack Snotel Site](https://wcc.sc.egov.usda.gov/nwcc/site?sitenum=969) in Northern Arizona, USA, using the TIN-Based Real-Time Integrated Basin Simulator ([tRIBS](https://tribshms.readthedocs.io/en/latest/)).
4+
## Model Execution
5+
From the command line tRIBS can be executed as follows, assuming the executable is stored in the sub-directory `bin`:
46

5-
## The structure of this repository is as follows:
7+
```
8+
bin/tRIBS <path/to/infile>
9+
```
10+
11+
In this case the happy jack input files can be found in ```src/in_files/happy_jack.in``` and can be further modified to explore tRIBS functionality. Note: the current input file is setup with relative paths and results will be saved to ```results/test```. Also, any modification in ```data/model``` may require an update of the .in file.
12+
13+
## Benchmark
14+
The benchmark case results are stored as a zip file under ```results/reference```. These results can be visualized in comparison to SNOTEL[^1]<sup>,</sup>[^2] data for the Happy Jack site as demonstrated in the jupyter notebook in ```src/tRIBS_snotel_comparison.ipynb```.
15+
16+
## Directory Structure:
617
### data
718
Contains all the necessary data to run tRIBS at Happy Jack and includes Snotel and SWANN data as a calibration/validation set.
819
### doc
9-
Contains relevant documentation for running this specific benchmark case and other information regarding working with this repository, including requirements and instructions for building tRIBS.
20+
Contains notebooks for running and analyzing this specific benchmark case, along side additional documentation.
1021
### src
11-
Is designed to contain source code for for the tRIBS executable, which can be obtained [here](https://github.com/tribshms/tribs_sub2020).
22+
Is designed to contain source code for for the tRIBS executable, which can be obtained [here](https://github.com/tribshms/tRIBS).
1223
### bin
13-
Directory for building and storing tRIBS executable, with instructions [here](doc/CMake.md).
24+
Directory for building and storing tRIBS executable, with instructions [here](https://tribshms.readthedocs.io/en/latest/man/Model_Execution.html#compilation-instructions).
1425
### results
15-
Directory for results from the Happy Jack point tRIBS simulation.
26+
Directory for results, with a _reference_ and _test_ sub-directories. The former contains reference outputs from the Happy Jack point tRIBS simulation, while the later is empty and intended to store additional model simulations. Note the main results also contains a zip of the _reference_ sub-directory.
1627

17-
<ins>Note:</ins> There is no content in **bin** and **results**. These directories are intentionally left empty as they should be populated through building and running the model which can be further described in[doc](/doc).
1828

19-
<!--- The content of this folder is designed to test tRIBS performance against SNOTEL data at the [Happy Jack](https://wcc.sc.egov.usda.gov/nwcc/site?sitenum=969) snotel site. This bench is based of the graduate work of Gretchen Hawkins and Josh Cederstrom.
2029

21-
Snotel data from:
30+
## References
2231

23-
Sun N, H Yan, M Wigmosta, R Skaggs, R Leung, and Z Hou. 2019. “Regional snow parameters estimation for large-domain hydrological applications in the western United States.” Journal of Geophysical Research: Atmospheres. doi: 10.1029/2018JD030140
32+
[^1]: Sun N, H Yan, M Wigmosta, R Skaggs, R Leung, and Z Hou. 2019. “Regional snow parameters estimation for large-domain hydrological applications in the western United States.” Journal of Geophysical Research: Atmospheres. doi: 10.1029/2018JD030140
2433

25-
Yan H, N Sun, M Wigmosta, R Skaggs, Z Hou, and R Leung. 2018. “Next-generation intensity-duration-frequency curves for hydrologic design in snow-dominated environments.” Water Resources Research, 54(2), 1093–1108.
34+
[^2]: Yan H, N Sun, M Wigmosta, R Skaggs, Z Hou, and R Leung. 2018. “Next-generation intensity-duration-frequency curves for hydrologic design in snow-dominated environments.” Water Resources Research, 54(2), 1093–1108.
2635
BCQC Data Format
2736

28-
The file of each SNOTEL station is named as “bcqc_<latitude>_<longitude>.txt” (i.e., bcqc_44.43000_-120.33000.txt). In each text file, there are 8 columns separated by a space delimiter:
29-
30-
1st col: year
31-
2nd col: month
32-
3rd col: day
33-
4th col: daily precipitation, in inch
34-
5th col: maximum air temperature, in °F
35-
6th col: minimum air temperature, in °F
36-
7th col: mean air temperature, in °F
37-
8th col: SWE, in inch, reset to zero on 1 October at the start of each water year
38-
In each text file, “nan” indicates missing or filtered out data after the BCQC procedures.
39-
40-
Note: For each SNOTEL station, you can find its information (based on latitude and longitude) in the summary file, which details the SNOTEL ID, location (in latitude and longitude), located state, elevation, name, data start date, and end date.
41-
42-
43-
Within these cases there are mutliple different options that can be turned
44-
on/off in the input file:
45-
- Sheltering DEM (OPTRADSHELT)
46-
- Gridded vegetation parameters (OPTLANDUSE)
47-
- You must have option, OPTLUINTERP set to 1 for this to work
48-
--->

‎bin/README.txt‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
Build and store tRIBS executable here
1+
Store tRIBS source code and pre-and-post processing scripts here.

0 commit comments

Comments
 (0)