hydromad.github.io/index.html at gh-pages · hydromad/hydromad.github.io · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
<!DOCTYPE html>
<!-- Generated by pkgdown: do not edit by hand --><html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>hydromad R package • hydromad</title>
<!-- jquery --><script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.4.1/jquery.min.js" integrity="sha256-CSXorXvZcTkaix6Yvo6HppcZGetbYMGWSFlBw8HfCJo=" crossorigin="anonymous"></script><!-- Bootstrap --><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.4.1/css/bootstrap.min.css" integrity="sha256-bZLfwXAP04zRMK2BjiO8iu9pf4FbLqX6zitd+tIvLhE=" crossorigin="anonymous">
<script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.4.1/js/bootstrap.min.js" integrity="sha256-nuL8/2cJ5NDSSwnKD8VqreErSWHtnEP9E7AySL+1ev4=" crossorigin="anonymous"></script><!-- bootstrap-toc --><link rel="stylesheet" href="bootstrap-toc.css">
<script src="bootstrap-toc.js"></script><!-- Font Awesome icons --><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/all.min.css" integrity="sha256-mmgLkCYLUQbXn0B1SRqzHar6dCnv9oZFPEC1g1cwlkk=" crossorigin="anonymous">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/v4-shims.min.css" integrity="sha256-wZjR52fzng1pJHwx4aV2AO3yyTOXrcDW7jBpJtTwVxw=" crossorigin="anonymous">
<!-- clipboard.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.6/clipboard.min.js" integrity="sha256-inc5kl9MA1hkeYUt+EC3BhlIgyp/2jDIyBLS6k3UxPI=" crossorigin="anonymous"></script><!-- headroom.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/headroom.min.js" integrity="sha256-AsUX4SJE1+yuDu5+mAVzJbuYNPHj/WroHuZ8Ir/CkE0=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/jQuery.headroom.min.js" integrity="sha256-ZX/yNShbjqsohH1k95liqY9Gd8uOiE1S4vZc+9KQ1K4=" crossorigin="anonymous"></script><!-- pkgdown --><link href="pkgdown.css" rel="stylesheet">
<script src="pkgdown.js"></script><meta property="og:title" content="hydromad R package">
<meta property="og:description" content="A modelling framework for environmental hydrology: water
  balance accounting and flow routing in spatially aggregated catchments.
  It supports simulation, estimation, assessment and visualisation of
  flow response to time series of rainfall and other drivers. Includes
  models (such as IHACRES CMD, Sacramento), transfer function estimators
  (including SRIV - Simplified Refined Instrumental Variable), etc.">
<!-- mathjax --><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js" integrity="sha256-nvJJv9wWKEm88qvoQl9ekL2J+k/RWIsaSScxxlsrv8k=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/config/TeX-AMS-MML_HTMLorMML.js" integrity="sha256-84DKXVJXs0/F8OTMzX4UR909+jtl4G7SPypPavF+GfA=" crossorigin="anonymous"></script><!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js"></script>
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
<![endif]-->
</head>
<body data-spy="scroll" data-target="#toc">


    <div class="container template-home">
      <header><div class="navbar navbar-default navbar-fixed-top" role="navigation">
  <div class="container">
    <div class="navbar-header">
      <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar" aria-expanded="false">
        <span class="sr-only">Toggle navigation</span>
        <span class="icon-bar"></span>
        <span class="icon-bar"></span>
        <span class="icon-bar"></span>
      </button>
      <span class="navbar-brand">
        <a class="navbar-link" href="index.html">hydromad</a>
        <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="Released version">0.9-27</span>
      </span>
    </div>

    <div id="navbar" class="navbar-collapse collapse">
      <ul class="nav navbar-nav">
<li>
  <a href="articles/hydromad.html">Get started</a>
</li>
<li>
  <a href="reference/index.html">Reference</a>
</li>
<li class="dropdown">
  <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false">
    Articles

    <span class="caret"></span>
  </a>
  <ul class="dropdown-menu" role="menu">
<li>
      <a href="articles/tutorial.html">Tutorial</a>
    </li>
    <li>
      <a href="articles/hbv.html">HBV model</a>
    </li>
  </ul>
</li>
<li class="dropdown">
  <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false">
    News

    <span class="caret"></span>
  </a>
  <ul class="dropdown-menu" role="menu">
<li class="dropdown-header">Releases</li>
    <li>
      <a href="http://github.com/josephguillaume/hydromad" class="external-link">hydromad 0.9-27</a>
    </li>
    <li class="divider">
    </li>
<li>
      <a href="news/index.html">Changelog</a>
    </li>
  </ul>
</li>
      </ul>
<ul class="nav navbar-nav navbar-right">
<li>
  <a href="https://github.com/josephguillaume/hydromad/" class="external-link">
    <span class="fab fa-github fa-lg"></span>

  </a>
</li>
      </ul>
</div>
<!--/.nav-collapse -->
  </div>
<!--/.container -->
</div>
<!--/.navbar -->


      </header><div class="row">
  <div class="contents col-md-9">
<div class="section level1">
<div class="page-header"><h1 id="hydromad">hydromad<a class="anchor" aria-label="anchor" href="#hydromad"></a>
</h1></div>
<!-- badges: start -->

<p>The goal of hydromad is to provide a modelling framework for environmental hydrology: water balance accounting and flow routing in spatially aggregated catchments.</p>
<p>Hydromad supports simulation, estimation, assessment and visualisation of flow response to time series of rainfall and other drivers. A minimal unit hydrograph framework is used, where areal rainfall is passed through a soil moisture accounting (SMA) model to estimate effective rainfall; this is then passed through a routing model to estimate streamflow. Included are several implementations of common hydrological models consistent with this framework.</p>
<p>The main resource for hydromad is the website: <a href="http://hydromad.catchment.org" class="external-link uri">http://hydromad.catchment.org</a> The website describes the different functions and gives examples of the code applications.</p>
<div class="section level2">
<h2 id="installation">Installation<a class="anchor" aria-label="anchor" href="#installation"></a>
</h2>
<!--- You can install the released version of hydromad from [CRAN](https://CRAN.R-project.org) with:

``` r
install.packages("hydromad")
```
--->
<ul>
<li>Add the <code>hydromad</code> repository for this R session:</li>
</ul>
<!-- --><div class="sourceCode" id="cb1"><pre class="sourceCode R"><code class="sourceCode r"><span id="cb1-1"><a href="#cb1-1"></a><span class="kw">options</span>(<span class="dt">repos=</span><span class="kw">c</span>(<span class="st">"http://hydromad.catchment.org"</span>,<span class="kw">getOption</span>(<span class="st">"repos"</span>)))</span></code></pre></div>
<ul>
<li>Install hydromad:</li>
</ul>
<!-- --><div class="sourceCode" id="cb2"><pre class="sourceCode R"><code class="sourceCode r"><span id="cb2-1"><a href="#cb2-1"></a><span class="kw">install.packages</span>(<span class="st">"hydromad"</span>)</span></code></pre></div>
<ul>
<li>Optionally install other packages required for certain functions:</li>
</ul>
<!-- --><div class="sourceCode" id="cb3"><pre class="sourceCode R"><code class="sourceCode r"><span id="cb3-1"><a href="#cb3-1"></a><span class="kw">install.packages</span>(<span class="st">"DEoptim"</span>)</span>
<span id="cb3-2"><a href="#cb3-2"></a><span class="kw">install.packages</span>(<span class="st">"dream"</span>)</span></code></pre></div>
<p>Once it is installed, get started with</p>
<div class="sourceCode" id="cb4"><pre class="sourceCode R"><code class="sourceCode r"><span id="cb4-1"><a href="#cb4-1"></a><span class="kw">library</span>(<span class="dt">package =</span> <span class="st">"hydromad"</span>)</span>
<span id="cb4-2"><a href="#cb4-2"></a><span class="kw">help</span>(<span class="st">"hydromad"</span>)</span></code></pre></div>
<p>The development version can be installed from <a href="https://github.com/" class="external-link">GitHub</a> with:</p>
<div class="sourceCode" id="cb5"><pre class="sourceCode R"><code class="sourceCode r"><span id="cb5-1"><a href="#cb5-1"></a><span class="co"># install.packages("devtools")</span></span>
<span id="cb5-2"><a href="#cb5-2"></a>devtools<span class="op">::</span><span class="kw">install_github</span>(<span class="st">"JosephGuillaume/hydromad"</span>)</span></code></pre></div>
</div>
<div class="section level2">
<h2 id="contributing">Contributing<a class="anchor" aria-label="anchor" href="#contributing"></a>
</h2>
<p>The maintainers of hydromad are always keen to receive contributions. However to help us we would like you to consider the following:</p>
<ul>
<li>Please read and use our <a href="https://github.com/josephguillaume/hydromad/blob/master/docs/CONTRIBUTING.md" class="external-link">CONTRIBUTING document</a>, this will really help us integrating your solution into hydromad.<br>
</li>
<li>This is a list of the <a href="https://github.com/josephguillaume/hydromad/issues" class="external-link">current issues</a> (which you might be able to help with).<br>
</li>
<li>As part of contributing we would like you to consider the ropensci <a href="https://ropensci.org/code-of-conduct/" class="external-link">Code of Conduct</a>, which we use for hydromad.</li>
</ul>
</div>
<div class="section level2">
<h2 id="usage">Usage<a class="anchor" aria-label="anchor" href="#usage"></a>
</h2>
<p>This is a basic example of defining a model in hydromad:</p>
<div class="sourceCode" id="cb6"><pre class="sourceCode R"><code class="sourceCode r"><span id="cb6-1"><a href="#cb6-1"></a><span class="kw">library</span>(hydromad)</span>
<span id="cb6-2"><a href="#cb6-2"></a><span class="co">## basic example code</span></span>
<span id="cb6-3"><a href="#cb6-3"></a><span class="kw">data</span>(Cotter)</span>
<span id="cb6-4"><a href="#cb6-4"></a><span class="co">## IHACRES CWI model with exponential unit hydrograph</span></span>
<span id="cb6-5"><a href="#cb6-5"></a><span class="co">## an unfitted model, with ranges of possible parameter values</span></span>
<span id="cb6-6"><a href="#cb6-6"></a>modx &lt;-<span class="st"> </span><span class="kw">hydromad</span>(Cotter[<span class="dv">1</span><span class="op">:</span><span class="dv">1000</span>], <span class="dt">sma =</span> <span class="st">"cwi"</span>, <span class="dt">routing =</span> <span class="st">"expuh"</span>,</span>
<span id="cb6-7"><a href="#cb6-7"></a>                 <span class="dt">tau_s =</span> <span class="kw">c</span>(<span class="dv">2</span>, <span class="dv">100</span>), <span class="dt">v_s =</span> <span class="kw">c</span>(<span class="dv">0</span>, <span class="dv">1</span>))</span>
<span id="cb6-8"><a href="#cb6-8"></a>modx</span>
<span id="cb6-9"><a href="#cb6-9"></a><span class="co">#&gt; </span></span>
<span id="cb6-10"><a href="#cb6-10"></a><span class="co">#&gt; Hydromad model with "cwi" SMA and "expuh" routing:</span></span>
<span id="cb6-11"><a href="#cb6-11"></a><span class="co">#&gt; Start = 1966-05-01, End = 1969-01-24</span></span>
<span id="cb6-12"><a href="#cb6-12"></a><span class="co">#&gt; </span></span>
<span id="cb6-13"><a href="#cb6-13"></a><span class="co">#&gt; SMA Parameters:</span></span>
<span id="cb6-14"><a href="#cb6-14"></a><span class="co">#&gt;       lower upper     </span></span>
<span id="cb6-15"><a href="#cb6-15"></a><span class="co">#&gt; tw        0   100     </span></span>
<span id="cb6-16"><a href="#cb6-16"></a><span class="co">#&gt; f         0     8     </span></span>
<span id="cb6-17"><a href="#cb6-17"></a><span class="co">#&gt; scale    NA    NA     </span></span>
<span id="cb6-18"><a href="#cb6-18"></a><span class="co">#&gt; l         0     0 (==)</span></span>
<span id="cb6-19"><a href="#cb6-19"></a><span class="co">#&gt; p         1     1 (==)</span></span>
<span id="cb6-20"><a href="#cb6-20"></a><span class="co">#&gt; t_ref    20    20 (==)</span></span>
<span id="cb6-21"><a href="#cb6-21"></a><span class="co">#&gt; Routing Parameters:</span></span>
<span id="cb6-22"><a href="#cb6-22"></a><span class="co">#&gt;       lower upper  </span></span>
<span id="cb6-23"><a href="#cb6-23"></a><span class="co">#&gt; tau_s     2   100  </span></span>
<span id="cb6-24"><a href="#cb6-24"></a><span class="co">#&gt; v_s       0     1</span></span></code></pre></div>
</div>
<div class="section level2">
<h2 id="license">License<a class="anchor" aria-label="anchor" href="#license"></a>
</h2>
<p>This project is licensed under the terms of <a href="https://github.com/josephguillaume/hydromad/blob/master/DESCRIPTION" class="external-link">GPL (&gt;=2)</a></p>
</div>
<div class="section level2">
<h2 id="acknowledgements">Acknowledgements<a class="anchor" aria-label="anchor" href="#acknowledgements"></a>
</h2>
<p>This research was supported by the Sydney Informatics Hub, a Core Research Facility of the University of Sydney.</p>
</div>
</div>
  </div>

  <div class="col-md-3 hidden-xs hidden-sm" id="pkgdown-sidebar">
    <div class="links">
<h2 data-toc-skip>Links</h2>
<ul class="list-unstyled">
<li><a href="https://github.com/josephguillaume/hydromad/" class="external-link">Browse source code</a></li>
<li><a href="http://github.com/josephguillaume/hydromad/issues" class="external-link">Report a bug at</a></li>
</ul>
</div>

<div class="license">
<h2 data-toc-skip>License</h2>
<ul class="list-unstyled">
<li>GPL (&gt;= 2)</li>
</ul>
</div>


<div class="citation">
<h2 data-toc-skip>Citation</h2>
<ul class="list-unstyled">
<li><a href="authors.html#citation">Citing hydromad</a></li>
</ul>
</div>

<div class="developers">
<h2 data-toc-skip>Developers</h2>
<ul class="list-unstyled">
<li>Joseph Guillaume <br><small class="roles"> Maintainer </small>  </li>
</ul>
</div>

<div class="dev-status">
<h2 data-toc-skip>Dev status</h2>
<ul class="list-unstyled">
<li><a href="https://github.com/josephguillaume/hydromad/actions" class="external-link"><img src="https://github.com/josephguillaume/hydromad/workflows/R-CMD-check/badge.svg" alt="R build status"></a></li>
<li><a href="https://codecov.io/gh/josephguillaume/hydromad" class="external-link"><img src="https://codecov.io/gh/josephguillaume/hydromad/branch/master/graph/badge.svg" alt="codecov"></a></li>
</ul>
</div>

  </div>
</div>


      <footer><div class="copyright">
  <p></p>
<p>Developed by Joseph Guillaume.</p>
</div>

<div class="pkgdown">
  <p></p>
<p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.1.</p>
</div>

      </footer>
</div>


  </body>
</html>