Skip to content

Commit

Permalink
update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Travis CI User committed Aug 22, 2024
0 parents commit 77702f5
Show file tree
Hide file tree
Showing 2,391 changed files with 1,219,530 additions and 0 deletions.
46 changes: 46 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
venv
*.spyderproject
*.spyderworkspace
.pydevproject
.project
.settings/*
*.pyc
*.c
*.h
temp
hydpy/inputs.py
hydpy/outputs.py
hydpy/conf/mimetypes.txt
hydpy/cythons/autogen/*.pyd
hydpy/cythons/autogen/*.pyc
hydpy/cythons/autogen/*.pyi
hydpy/cythons/autogen/*.pyx
hydpy/cythons/autogen/*.pxd
hydpy/cythons/autogen/*.c
hydpy/cythons/autogen/*.h
hydpy/conf/HydPyConfigBase.xsd
hydpy/docs/html_/*.html
hydpy/docs/autofigs/*.png
hydpy/docs/auto
hydpy/tests/iotesting/*
!hydpy/test/iotesting/__init__.py
build
_build
dist
gui
helpers
examples
cover/*
coverage.html
coverage.xml
.coverage
HydPy.egg-info/*
MANIFEST
test.py
.spyproject/
.mypy_cache/*
.idea/*
make_hydpy_installer.cfg
lib/*
temp/*
hydpy/docs/bibliography/refs.bib.bak
Empty file added .nojekyll
Empty file.
4 changes: 4 additions & 0 deletions 4.0/.buildinfo
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: e9af4eca04c0973885a124fb46e41c80
tags: 645f666f9bcd5a90fca523b33c5a78b7
186 changes: 186 additions & 0 deletions 4.0/HydPy-A.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,186 @@

<!DOCTYPE html>

<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>HydPy-A (RIMO/RIDO) &#8212; HydPy 4.0.1 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/classic.css" type="text/css" />
<link rel="stylesheet" type="text/css" href="_static/graphviz.css" />

<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>

<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="arma" href="arma.html" />
<link rel="prev" title="Model Collection" href="modelcollection.html" />
</head><body>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="arma.html" title="arma"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="modelcollection.html" title="Model Collection"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">HydPy 4.0.1 documentation</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="modelcollection.html" accesskey="U">Model Collection</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">HydPy-A (RIMO/RIDO)</a></li>
</ul>
</div>

<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">

<div class="section" id="hydpy-a-rimo-rido">
<span id="hydpy-a"></span><h1>HydPy-A (RIMO/RIDO)<a class="headerlink" href="#hydpy-a-rimo-rido" title="Permalink to this headline"></a></h1>
<p>Many hydrologists use linear system approaches to solve flood routing
problems approximately. Famous examples are the Unit Hydrograph approach
and the Muskingum flood routing method. One can understand the Unit
Hydrograph approach as a moving average process (MA), and the Muskingum
method as a mixed autoregressive and moving average process (ARMA).
Unit Hydrographs consist of an arbitrary number of MA coefficients.
The Muskingum method defines three parameters, exactly - two MA
coefficients associated with the “new” and the “old” flow into the
channel, and one AR coefficient associated with the “old” flow out of
the channel.</p>
<p>The HydPy-A base model supports implementing such methods in a generalised
manner. Consider using one of its application models when you require a
robust, computationally efficient, easily calibratable approach. However,
taking nonlinear rating curves or backwater effects into account can be
cumbersome or even impossible.</p>
<p>Base model:</p>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="arma.html">arma</a></li>
</ul>
</div>
<p>Application model:</p>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="arma_v1.html">arma_v1</a><ul>
<li class="toctree-l2"><a class="reference internal" href="arma_v1.html#integration-tests">Integration tests</a><ul>
<li class="toctree-l3"><a class="reference internal" href="arma_v1.html#ma-coefficients">MA coefficients</a></li>
<li class="toctree-l3"><a class="reference internal" href="arma_v1.html#arma-coefficients">ARMA coefficients</a></li>
<li class="toctree-l3"><a class="reference internal" href="arma_v1.html#increased-delay">Increased delay</a></li>
<li class="toctree-l3"><a class="reference internal" href="arma_v1.html#negative-discharge">Negative discharge</a></li>
<li class="toctree-l3"><a class="reference internal" href="arma_v1.html#plausibility">Plausibility</a></li>
<li class="toctree-l3"><a class="reference internal" href="arma_v1.html#nonlinearity">Nonlinearity</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>


<div class="clearer"></div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="index.html">
<img class="logo" src="_static/HydPy_Logo.png" alt="Logo"/>
</a></p>
<h3><a href="index.html">Table of Contents</a></h3>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="install.html">Installation Instructions</a></li>
<li class="toctree-l1"><a class="reference internal" href="quickstart.html">Quick Start</a></li>
<li class="toctree-l1"><a class="reference internal" href="how_to.html">How to…</a></li>
<li class="toctree-l1"><a class="reference internal" href="framework.html">Framework Tools</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="modelcollection.html">Model Collection</a><ul class="current">
<li class="toctree-l2 current"><a class="current reference internal" href="#">HydPy-A (RIMO/RIDO)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="arma.html">arma</a></li>
<li class="toctree-l3"><a class="reference internal" href="arma_v1.html">arma_v1</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="HydPy-C.html">HydPy-C (Conv)</a></li>
<li class="toctree-l2"><a class="reference internal" href="HydPy-E.html">HydPy-E (Evap)</a></li>
<li class="toctree-l2"><a class="reference internal" href="HydPy-D.html">HydPy-D (DAM)</a></li>
<li class="toctree-l2"><a class="reference internal" href="HydPy-Dummy.html">HydPy-Dummy</a></li>
<li class="toctree-l2"><a class="reference internal" href="HydPy-H.html">HydPy-H (HBV)</a></li>
<li class="toctree-l2"><a class="reference internal" href="HydPy-L.html">HydPy-L (LARSIM)</a></li>
<li class="toctree-l2"><a class="reference internal" href="HydPy-T.html">HydPy-T (TESTING)</a></li>
<li class="toctree-l2"><a class="reference internal" href="HydPy-W.html">HydPy-W (WALRUS)</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="development.html">Development</a></li>
<li class="toctree-l1"><a class="reference internal" href="examples.html">Example Projects</a></li>
<li class="toctree-l1"><a class="reference internal" href="zbibliography.html">Bibliography</a></li>
</ul>

<h4>Previous topic</h4>
<p class="topless"><a href="modelcollection.html"
title="previous chapter">Model Collection</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="arma.html"
title="next chapter">arma</a></p>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/HydPy-A.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>

<h3>Versions</h3>
<ul>
<li><a href="../5.0/HydPy-A.html">5.0</a></li>
<li><a href="../4.0/HydPy-A.html">4.0</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" />
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="arma.html" title="arma"
>next</a> |</li>
<li class="right" >
<a href="modelcollection.html" title="Model Collection"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">HydPy 4.0.1 documentation</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="modelcollection.html" >Model Collection</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">HydPy-A (RIMO/RIDO)</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
&#169; Copyright 2021, HydPy Developers.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.5.2.
</div>
</body>
</html>
Loading

0 comments on commit 77702f5

Please sign in to comment.