html
Folders and files
| Name | Name | Last commit date | ||
|---|---|---|---|---|
parent directory.. | ||||
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: https://docutils.sourceforge.net/" />
<title>pyhecdss — pyhecdss 1.1.2+5.ga82763a.dirty documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Installation" href="installation.html" />
<link rel="prev" title="Welcome to pyhecdss’s documentation!" href="index.html" />
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
</head><body>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="pyhecdss">
<h1>pyhecdss<a class="headerlink" href="#pyhecdss" title="Permalink to this headline">¶</a></h1>
<p>For reading/writing HEC-DSS files [<a class="reference external" href="https://www.hec.usace.army.mil/software/hec-dss/">https://www.hec.usace.army.mil/software/hec-dss/</a>]
HEC-DSS is an ancient database used by the Army Corps of Engineers and prevalent
in water related models. This module is a bridge to read and write time series
data from this data format and read it into pandas DataFrame</p>
<ul class="simple">
<li><p>Free software: MIT license</p></li>
<li><p>Documentation: <a class="reference external" href="https://cadwrdeltamodeling.github.io/pyhecdss/">https://cadwrdeltamodeling.github.io/pyhecdss/</a></p></li>
</ul>
<section id="features">
<h2>Features<a class="headerlink" href="#features" title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li><p>Open and close DSS files</p></li>
<li><p>Read catalog of DSS files as pandas DataFrame</p></li>
<li><p>Read and write time series from DSS files</p></li>
</ul>
</section>
<section id="limitations">
<h2>Limitations<a class="headerlink" href="#limitations" title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li><p>Only support for Python 3 - 64 bit for windows and linux</p></li>
<li><p>Relies on pre-compiled libraries the source distribution of which is not allowed</p></li>
</ul>
</section>
<section id="credits">
<h2>Credits<a class="headerlink" href="#credits" title="Permalink to this headline">¶</a></h2>
<p>This package wraps the <a class="reference external" href="https://www.hec.usace.army.mil/software/hec-dss/">HEC-DSS Software</a> using the <a class="reference external" href="https://www.swig.org/">Swig</a> library.</p>
<p>This package was created with <a class="reference external" href="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/audreyr/cookiecutter">Cookiecutter</a> and the <a class="reference external" href="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/audreyr/cookiecutter-pypackage">audreyr/cookiecutter-pypackage</a> project template.</p>
</section>
</section>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="index.html">pyhecdss</a></h1>
<h3>Navigation</h3>
<p class="caption"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#">pyhecdss</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#features">Features</a></li>
<li class="toctree-l2"><a class="reference internal" href="#limitations">Limitations</a></li>
<li class="toctree-l2"><a class="reference internal" href="#credits">Credits</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="usage.html">Usage</a></li>
<li class="toctree-l1"><a class="reference internal" href="notebooks/sample_dss_files.html">Usage with examples</a></li>
<li class="toctree-l1"><a class="reference internal" href="notebooks/period_vs_instval.html">Discussion on PER-* and INST-* period types</a></li>
<li class="toctree-l1"><a class="reference internal" href="modules.html">pyhecdss</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li>
<li class="toctree-l1"><a class="reference internal" href="authors.html">Credits</a></li>
<li class="toctree-l1"><a class="reference internal" href="history.html">CHANGELOG</a></li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="index.html">Documentation overview</a><ul>
<li>Previous: <a href="index.html" title="previous chapter">Welcome to pyhecdss’s documentation!</a></li>
<li>Next: <a href="installation.html" title="next chapter">Installation</a></li>
</ul></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="footer">
©2019, Nicky Sandhu.
|
Powered by <a href="https://sphinx-doc.org/">Sphinx 4.0.2</a>
& <a href="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/bitprophet/alabaster">Alabaster 0.7.12</a>
|
<a href="_sources/readme.rst.txt"
rel="">Page source</a>
</div>
</body>
</html>