diff --git a/docs/_build/doctrees/DataFormats.doctree b/docs/_build/doctrees/DataFormats.doctree
new file mode 100644
index 0000000000000000000000000000000000000000..577a4e65f8bd3ec6f4e2c3a8f0bcec46c46bdeb5
Binary files /dev/null and b/docs/_build/doctrees/DataFormats.doctree differ
diff --git a/docs/_build/doctrees/Geometry.doctree b/docs/_build/doctrees/Geometry.doctree
new file mode 100644
index 0000000000000000000000000000000000000000..a018c7a51fe97f7d5695546a2ea62a347ed4d2b0
Binary files /dev/null and b/docs/_build/doctrees/Geometry.doctree differ
diff --git a/docs/_build/doctrees/Graphics.doctree b/docs/_build/doctrees/Graphics.doctree
new file mode 100644
index 0000000000000000000000000000000000000000..efb3eb38bff8ff1c3f1cc0332b5638c9f32c583c
Binary files /dev/null and b/docs/_build/doctrees/Graphics.doctree differ
diff --git a/docs/_build/doctrees/MatchUpDatabase.doctree b/docs/_build/doctrees/MatchUpDatabase.doctree
new file mode 100644
index 0000000000000000000000000000000000000000..50e205685f6faed43d8284f17a7851461831b136
Binary files /dev/null and b/docs/_build/doctrees/MatchUpDatabase.doctree differ
diff --git a/docs/_build/doctrees/ModelData.doctree b/docs/_build/doctrees/ModelData.doctree
new file mode 100644
index 0000000000000000000000000000000000000000..470bb05878d3a3bb92a2bba70c65f9e75660947f
Binary files /dev/null and b/docs/_build/doctrees/ModelData.doctree differ
diff --git a/docs/_build/doctrees/ObsData.doctree b/docs/_build/doctrees/ObsData.doctree
new file mode 100644
index 0000000000000000000000000000000000000000..e6335e5530540d76a49b8dc6d14362c60daeef86
Binary files /dev/null and b/docs/_build/doctrees/ObsData.doctree differ
diff --git a/docs/_build/doctrees/TimeFuncs.doctree b/docs/_build/doctrees/TimeFuncs.doctree
new file mode 100644
index 0000000000000000000000000000000000000000..57f0f850f6287494062ecef9981c99de8f08dc11
Binary files /dev/null and b/docs/_build/doctrees/TimeFuncs.doctree differ
diff --git a/docs/_build/doctrees/Validation.doctree b/docs/_build/doctrees/Validation.doctree
new file mode 100644
index 0000000000000000000000000000000000000000..a87fc488ed66647721c2e28d19f132b39e012d50
Binary files /dev/null and b/docs/_build/doctrees/Validation.doctree differ
diff --git a/docs/_build/doctrees/WaveSpectra.doctree b/docs/_build/doctrees/WaveSpectra.doctree
new file mode 100644
index 0000000000000000000000000000000000000000..5e6ecd02f9e9dc62b77a88fc4f2ad89bc45cd0be
Binary files /dev/null and b/docs/_build/doctrees/WaveSpectra.doctree differ
diff --git a/docs/_build/doctrees/WaveStats.doctree b/docs/_build/doctrees/WaveStats.doctree
new file mode 100644
index 0000000000000000000000000000000000000000..4d34e3d99f57ec216a9a4f3761971d191866f04e
Binary files /dev/null and b/docs/_build/doctrees/WaveStats.doctree differ
diff --git a/docs/_build/doctrees/about.doctree b/docs/_build/doctrees/about.doctree
new file mode 100644
index 0000000000000000000000000000000000000000..9b5dcd693e96f47a1ae187a893af35340922053d
Binary files /dev/null and b/docs/_build/doctrees/about.doctree differ
diff --git a/docs/_build/doctrees/automate.doctree b/docs/_build/doctrees/automate.doctree
new file mode 100644
index 0000000000000000000000000000000000000000..6719e5a55481665021b8d29fba8122e56f6f193f
Binary files /dev/null and b/docs/_build/doctrees/automate.doctree differ
diff --git a/docs/_build/doctrees/data_access.doctree b/docs/_build/doctrees/data_access.doctree
new file mode 100644
index 0000000000000000000000000000000000000000..70625df16bde81f518df0828bfe1e22696f44fd1
Binary files /dev/null and b/docs/_build/doctrees/data_access.doctree differ
diff --git a/docs/_build/doctrees/environment.pickle b/docs/_build/doctrees/environment.pickle
new file mode 100644
index 0000000000000000000000000000000000000000..9a7d9bb38436aeabb6df25ea103d1dee6ffad7d2
Binary files /dev/null and b/docs/_build/doctrees/environment.pickle differ
diff --git a/docs/_build/doctrees/examples.doctree b/docs/_build/doctrees/examples.doctree
new file mode 100644
index 0000000000000000000000000000000000000000..a6110d9167de4b3489a5fe5f7fd97bdb8f04b47c
Binary files /dev/null and b/docs/_build/doctrees/examples.doctree differ
diff --git a/docs/_build/doctrees/formats.doctree b/docs/_build/doctrees/formats.doctree
new file mode 100644
index 0000000000000000000000000000000000000000..38367628effcaf577a1b486133b24bc61d1a4abf
Binary files /dev/null and b/docs/_build/doctrees/formats.doctree differ
diff --git a/docs/_build/doctrees/index.doctree b/docs/_build/doctrees/index.doctree
new file mode 100644
index 0000000000000000000000000000000000000000..c8ed241971e889d2da36bcab66f83dbacc473ae4
Binary files /dev/null and b/docs/_build/doctrees/index.doctree differ
diff --git a/docs/_build/doctrees/quickstart.doctree b/docs/_build/doctrees/quickstart.doctree
new file mode 100644
index 0000000000000000000000000000000000000000..c939c848421e659f813cbf78f7c5fe40c28d29b9
Binary files /dev/null and b/docs/_build/doctrees/quickstart.doctree differ
diff --git a/docs/_build/html/.buildinfo b/docs/_build/html/.buildinfo
new file mode 100644
index 0000000000000000000000000000000000000000..e383457047a1495dd087bf34b9c5ab7f6e6860f4
--- /dev/null
+++ b/docs/_build/html/.buildinfo
@@ -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: 73704d5c997b6ddd29358c9609fc3030
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/_build/html/DataFormats.html b/docs/_build/html/DataFormats.html
new file mode 100644
index 0000000000000000000000000000000000000000..c06dfd11f11a223f65b217446ab6fdb1a3a9241b
--- /dev/null
+++ b/docs/_build/html/DataFormats.html
@@ -0,0 +1,202 @@
+
+
+<!doctype html>
+
+<html lang="en">
+ <head>
+ <meta charset="utf-8" />
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
+
+ <title>DataFormats — WaveVal documentation</title>
+ <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
+ <link rel="stylesheet" type="text/css" href="_static/bizstyle.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 src="_static/bizstyle.js"></script>
+ <link rel="author" title="About these documents" href="about.html" />
+ <link rel="index" title="Index" href="genindex.html" />
+ <link rel="search" title="Search" href="search.html" />
+ <link rel="next" title="TimeFuncs" href="TimeFuncs.html" />
+ <link rel="prev" title="ObsData" href="ObsData.html" />
+ <meta name="viewport" content="width=device-width,initial-scale=1.0" />
+ <!--[if lt IE 9]>
+ <script src="_static/css3-mediaqueries.js"></script>
+ <![endif]-->
+ </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="TimeFuncs.html" title="TimeFuncs"
+ accesskey="N">next</a> |</li>
+ <li class="right" >
+ <a href="ObsData.html" title="ObsData"
+ accesskey="P">previous</a> |</li>
+ <li class="nav-item nav-item-0"><a href="index.html">WaveVal documentation</a> »</li>
+ <li class="nav-item nav-item-this"><a href="">DataFormats</a></li>
+ </ul>
+ </div>
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body" role="main">
+
+ <section id="module-DataFormats">
+<span id="dataformats"></span><h1>DataFormats<a class="headerlink" href="#module-DataFormats" title="Permalink to this headline">¶</a></h1>
+<p>Generic base data format class structures for building loaders for specific
+data set.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Dependencies [External]</dt>
+<dd class="field-odd"><p>os, numpy, netCDF4</p>
+</dd>
+<dt class="field-even">Dependencies [Internal]</dt>
+<dd class="field-even"><p></p></dd>
+</dl>
+<dl class="py class">
+<dt class="sig sig-object py" id="DataFormats.netcdfGeneric">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">DataFormats.</span></span><span class="sig-name descname"><span class="pre">netcdfGeneric</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">fileName</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/DataFormats.html#netcdfGeneric"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#DataFormats.netcdfGeneric" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3.7/library/functions.html#object" title="(in Python v3.7)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
+<p>Base class for loading and interogating netCDF4 data files.</p>
+<dl class="py method">
+<dt class="sig sig-object py" id="DataFormats.netcdfGeneric.getDim">
+<span class="sig-name descname"><span class="pre">getDim</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dimName</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/DataFormats.html#netcdfGeneric.getDim"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#DataFormats.netcdfGeneric.getDim" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="DataFormats.netcdfGeneric.getGlobalAttr">
+<span class="sig-name descname"><span class="pre">getGlobalAttr</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">attrName</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/DataFormats.html#netcdfGeneric.getGlobalAttr"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#DataFormats.netcdfGeneric.getGlobalAttr" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="DataFormats.netcdfGeneric.getVar">
+<span class="sig-name descname"><span class="pre">getVar</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">varName</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/DataFormats.html#netcdfGeneric.getVar"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#DataFormats.netcdfGeneric.getVar" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="DataFormats.netcdfGeneric.getVarAttr">
+<span class="sig-name descname"><span class="pre">getVarAttr</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">varName</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">attrName</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/DataFormats.html#netcdfGeneric.getVarAttr"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#DataFormats.netcdfGeneric.getVarAttr" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="DataFormats.netcdfGeneric.getVarAttrList">
+<span class="sig-name descname"><span class="pre">getVarAttrList</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">varName</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/DataFormats.html#netcdfGeneric.getVarAttrList"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#DataFormats.netcdfGeneric.getVarAttrList" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="DataFormats.netcdfGeneric.getVarDimNames">
+<span class="sig-name descname"><span class="pre">getVarDimNames</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">varName</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/DataFormats.html#netcdfGeneric.getVarDimNames"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#DataFormats.netcdfGeneric.getVarDimNames" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="DataFormats.netcdfGeneric.getVarDimSizes">
+<span class="sig-name descname"><span class="pre">getVarDimSizes</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">varName</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/DataFormats.html#netcdfGeneric.getVarDimSizes"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#DataFormats.netcdfGeneric.getVarDimSizes" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="DataFormats.netcdfGeneric.hasAttr">
+<span class="sig-name descname"><span class="pre">hasAttr</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">varName</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">attrName</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/DataFormats.html#netcdfGeneric.hasAttr"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#DataFormats.netcdfGeneric.hasAttr" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="DataFormats.netcdfGeneric.hasDim">
+<span class="sig-name descname"><span class="pre">hasDim</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dimName</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/DataFormats.html#netcdfGeneric.hasDim"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#DataFormats.netcdfGeneric.hasDim" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="DataFormats.netcdfGeneric.hasGlobalAttr">
+<span class="sig-name descname"><span class="pre">hasGlobalAttr</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">attrName</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/DataFormats.html#netcdfGeneric.hasGlobalAttr"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#DataFormats.netcdfGeneric.hasGlobalAttr" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="DataFormats.netcdfGeneric.hasVar">
+<span class="sig-name descname"><span class="pre">hasVar</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">varName</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/DataFormats.html#netcdfGeneric.hasVar"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#DataFormats.netcdfGeneric.hasVar" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="DataFormats.netcdfGeneric.listDims">
+<span class="sig-name descname"><span class="pre">listDims</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/DataFormats.html#netcdfGeneric.listDims"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#DataFormats.netcdfGeneric.listDims" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="DataFormats.netcdfGeneric.listGlobalAttr">
+<span class="sig-name descname"><span class="pre">listGlobalAttr</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/DataFormats.html#netcdfGeneric.listGlobalAttr"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#DataFormats.netcdfGeneric.listGlobalAttr" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="DataFormats.netcdfGeneric.listVars">
+<span class="sig-name descname"><span class="pre">listVars</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/DataFormats.html#netcdfGeneric.listVars"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#DataFormats.netcdfGeneric.listVars" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
+</section>
+
+
+ <div class="clearer"></div>
+ </div>
+ </div>
+ </div>
+ <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+ <div class="sphinxsidebarwrapper">
+ <h4>Previous topic</h4>
+ <p class="topless"><a href="ObsData.html"
+ title="previous chapter">ObsData</a></p>
+ <h4>Next topic</h4>
+ <p class="topless"><a href="TimeFuncs.html"
+ title="next chapter">TimeFuncs</a></p>
+ <div role="note" aria-label="source link">
+ <h3>This Page</h3>
+ <ul class="this-page-menu">
+ <li><a href="_sources/DataFormats.rst.txt"
+ rel="nofollow">Show Source</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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
+ <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="TimeFuncs.html" title="TimeFuncs"
+ >next</a> |</li>
+ <li class="right" >
+ <a href="ObsData.html" title="ObsData"
+ >previous</a> |</li>
+ <li class="nav-item nav-item-0"><a href="index.html">WaveVal documentation</a> »</li>
+ <li class="nav-item nav-item-this"><a href="">DataFormats</a></li>
+ </ul>
+ </div>
+ <div class="footer" role="contentinfo">
+ © Copyright 2022.
+ Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 4.3.0.
+ </div>
+ </body>
+</html>
\ No newline at end of file
diff --git a/docs/_build/html/Geometry.html b/docs/_build/html/Geometry.html
new file mode 100644
index 0000000000000000000000000000000000000000..ab1cbb54a62a4d9e01b10497366c018a3665fefc
--- /dev/null
+++ b/docs/_build/html/Geometry.html
@@ -0,0 +1,309 @@
+
+
+<!doctype html>
+
+<html lang="en">
+ <head>
+ <meta charset="utf-8" />
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
+
+ <title>Geometry — WaveVal documentation</title>
+ <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
+ <link rel="stylesheet" type="text/css" href="_static/bizstyle.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 src="_static/bizstyle.js"></script>
+ <link rel="author" title="About these documents" href="about.html" />
+ <link rel="index" title="Index" href="genindex.html" />
+ <link rel="search" title="Search" href="search.html" />
+ <link rel="next" title="Graphics" href="Graphics.html" />
+ <link rel="prev" title="TimeFuncs" href="TimeFuncs.html" />
+ <meta name="viewport" content="width=device-width,initial-scale=1.0" />
+ <!--[if lt IE 9]>
+ <script src="_static/css3-mediaqueries.js"></script>
+ <![endif]-->
+ </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="Graphics.html" title="Graphics"
+ accesskey="N">next</a> |</li>
+ <li class="right" >
+ <a href="TimeFuncs.html" title="TimeFuncs"
+ accesskey="P">previous</a> |</li>
+ <li class="nav-item nav-item-0"><a href="index.html">WaveVal documentation</a> »</li>
+ <li class="nav-item nav-item-this"><a href="">Geometry</a></li>
+ </ul>
+ </div>
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body" role="main">
+
+ <section id="module-Geometry">
+<span id="geometry"></span><h1>Geometry<a class="headerlink" href="#module-Geometry" title="Permalink to this headline">¶</a></h1>
+<p>General geometry functions associated with unstructured triangular meshes and
+functions used within the WaveVal package.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Dependencies [External]</dt>
+<dd class="field-odd"><p>numpy</p>
+</dd>
+<dt class="field-even">Dependencies [Internal]</dt>
+<dd class="field-even"><p></p></dd>
+</dl>
+<dl class="py function">
+<dt class="sig sig-object py" id="Geometry.cart2cmplx">
+<span class="sig-prename descclassname"><span class="pre">Geometry.</span></span><span class="sig-name descname"><span class="pre">cart2cmplx</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">x</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">y</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/Geometry.html#cart2cmplx"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#Geometry.cart2cmplx" title="Permalink to this definition">¶</a></dt>
+<dd><p>Coordinate conversion: Cartesian to Complex</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters</dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>x</strong> – Cartesian x-coord</p></li>
+<li><p><strong>y</strong> – Cartesian y-coord</p></li>
+</ul>
+</dd>
+<dt class="field-even">Returns</dt>
+<dd class="field-even"><p>cmplx</p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="Geometry.cart2pol">
+<span class="sig-prename descclassname"><span class="pre">Geometry.</span></span><span class="sig-name descname"><span class="pre">cart2pol</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">x</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">y</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/Geometry.html#cart2pol"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#Geometry.cart2pol" title="Permalink to this definition">¶</a></dt>
+<dd><p>Coordinate conversion: Cartesian to Polar</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters</dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>x</strong> – Cartesian x-coord</p></li>
+<li><p><strong>y</strong> – Cartesian y-coord</p></li>
+</ul>
+</dd>
+<dt class="field-even">Returns</dt>
+<dd class="field-even"><p>r</p>
+</dd>
+<dt class="field-odd">Returns</dt>
+<dd class="field-odd"><p>theta (in degrees)</p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="Geometry.cmplx2cart">
+<span class="sig-prename descclassname"><span class="pre">Geometry.</span></span><span class="sig-name descname"><span class="pre">cmplx2cart</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">c</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/Geometry.html#cmplx2cart"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#Geometry.cmplx2cart" title="Permalink to this definition">¶</a></dt>
+<dd><p>Coordinate conversion: Complex to Cartesian</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters</dt>
+<dd class="field-odd"><p><strong>c</strong> – complex numbers (x + jy)</p>
+</dd>
+<dt class="field-even">Returns</dt>
+<dd class="field-even"><p>x</p>
+</dd>
+<dt class="field-odd">Returns</dt>
+<dd class="field-odd"><p>y</p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="Geometry.cmplx2pol">
+<span class="sig-prename descclassname"><span class="pre">Geometry.</span></span><span class="sig-name descname"><span class="pre">cmplx2pol</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">x</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">angularUnits</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/Geometry.html#cmplx2pol"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#Geometry.cmplx2pol" title="Permalink to this definition">¶</a></dt>
+<dd><p>Coordinate conversion: Complex to Polar</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters</dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>x</strong> – complex numbers (x + jy)</p></li>
+<li><p><strong>anglularUnits</strong> – 0 = degress [default], 1 = radians</p></li>
+</ul>
+</dd>
+<dt class="field-even">Returns</dt>
+<dd class="field-even"><p>radii</p>
+</dd>
+<dt class="field-odd">Returns</dt>
+<dd class="field-odd"><p>angles</p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="Geometry.getBarycentricWeights">
+<span class="sig-prename descclassname"><span class="pre">Geometry.</span></span><span class="sig-name descname"><span class="pre">getBarycentricWeights</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">p1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">p2</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">p3</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">p</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/Geometry.html#getBarycentricWeights"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#Geometry.getBarycentricWeights" title="Permalink to this definition">¶</a></dt>
+<dd><p>Calculate Barycentric weights for interpolating data from the triangle
+node points <em>p1</em>, <em>p2</em>, <em>p3</em> onto the point <em>p</em>.</p>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="Geometry.getCentroidWeights">
+<span class="sig-prename descclassname"><span class="pre">Geometry.</span></span><span class="sig-name descname"><span class="pre">getCentroidWeights</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">p1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">p2</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">p3</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Centroid</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/Geometry.html#getCentroidWeights"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#Geometry.getCentroidWeights" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="Geometry.getNearestNode">
+<span class="sig-prename descclassname"><span class="pre">Geometry.</span></span><span class="sig-name descname"><span class="pre">getNearestNode</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">X</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Y</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">LocX</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">LocY</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/Geometry.html#getNearestNode"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#Geometry.getNearestNode" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="Geometry.getNodesWeights">
+<span class="sig-prename descclassname"><span class="pre">Geometry.</span></span><span class="sig-name descname"><span class="pre">getNodesWeights</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">Mesh</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">LocX</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">LocY</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/Geometry.html#getNodesWeights"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#Geometry.getNodesWeights" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="Geometry.getTriangle">
+<span class="sig-prename descclassname"><span class="pre">Geometry.</span></span><span class="sig-name descname"><span class="pre">getTriangle</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">Mesh</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">LocX</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">LocY</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/Geometry.html#getTriangle"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#Geometry.getTriangle" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="Geometry.getTriangleArea">
+<span class="sig-prename descclassname"><span class="pre">Geometry.</span></span><span class="sig-name descname"><span class="pre">getTriangleArea</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">p1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">p2</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">p3</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/Geometry.html#getTriangleArea"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#Geometry.getTriangleArea" title="Permalink to this definition">¶</a></dt>
+<dd><p>Calculate the area of a triangle defined by the points <em>p1</em>, <em>p2</em>, <em>p3</em>.</p>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="Geometry.getTriangleCentroid">
+<span class="sig-prename descclassname"><span class="pre">Geometry.</span></span><span class="sig-name descname"><span class="pre">getTriangleCentroid</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">p1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">p2</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">p3</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/Geometry.html#getTriangleCentroid"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#Geometry.getTriangleCentroid" title="Permalink to this definition">¶</a></dt>
+<dd><p>Calculate the position of the centroid for a triangle defined by the
+points <em>p1</em>, <em>p2</em>, <em>p3</em>.</p>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="Geometry.getWgtsMatrix">
+<span class="sig-prename descclassname"><span class="pre">Geometry.</span></span><span class="sig-name descname"><span class="pre">getWgtsMatrix</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">NWghts</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">nstps</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/Geometry.html#getWgtsMatrix"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#Geometry.getWgtsMatrix" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="Geometry.interpTriangle">
+<span class="sig-prename descclassname"><span class="pre">Geometry.</span></span><span class="sig-name descname"><span class="pre">interpTriangle</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">p1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">p2</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">p3</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">p</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">v1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">v2</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">v3</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/Geometry.html#interpTriangle"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#Geometry.interpTriangle" title="Permalink to this definition">¶</a></dt>
+<dd><p>Interpolate the values <em>v1</em>, <em>v2</em>, <em>v3</em> from the triangle nodes
+defined by the points <em>p1</em>, <em>p2</em>, <em>p3</em> onto the location <em>p</em> using
+the Barycentric wighting method.</p>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="Geometry.isInsideTriangle">
+<span class="sig-prename descclassname"><span class="pre">Geometry.</span></span><span class="sig-name descname"><span class="pre">isInsideTriangle</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">p1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">p2</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">p3</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">p</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/Geometry.html#isInsideTriangle"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#Geometry.isInsideTriangle" title="Permalink to this definition">¶</a></dt>
+<dd><p>Determine whether the point <em>p</em> lies within the triangle defined by
+the points <em>p1</em>, <em>p2</em>, <em>p3</em>.</p>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="Geometry.pol2cart">
+<span class="sig-prename descclassname"><span class="pre">Geometry.</span></span><span class="sig-name descname"><span class="pre">pol2cart</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">r</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">theta</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/Geometry.html#pol2cart"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#Geometry.pol2cart" title="Permalink to this definition">¶</a></dt>
+<dd><p>Coordinate conversion: Polar to Cartesian</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters</dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>r</strong> – radial distance</p></li>
+<li><p><strong>theta</strong> – angle in degrees</p></li>
+</ul>
+</dd>
+<dt class="field-even">Returns</dt>
+<dd class="field-even"><p>x</p>
+</dd>
+<dt class="field-odd">Returns</dt>
+<dd class="field-odd"><p>y</p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="Geometry.pol2cmplx">
+<span class="sig-prename descclassname"><span class="pre">Geometry.</span></span><span class="sig-name descname"><span class="pre">pol2cmplx</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">radii</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">angles</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">angularUnits</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/Geometry.html#pol2cmplx"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#Geometry.pol2cmplx" title="Permalink to this definition">¶</a></dt>
+<dd><p>Coordinate conversion: Polar to Complex</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters</dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>radii</strong> – radial distance</p></li>
+<li><p><strong>angles</strong> – angle</p></li>
+<li><p><strong>anglularUnits</strong> – 0 = degress [default], 1 = radians</p></li>
+</ul>
+</dd>
+<dt class="field-even">Returns</dt>
+<dd class="field-even"><p>cmplx</p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="Geometry.rotateVectorField">
+<span class="sig-prename descclassname"><span class="pre">Geometry.</span></span><span class="sig-name descname"><span class="pre">rotateVectorField</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">U</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">V</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">W</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Theta</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/Geometry.html#rotateVectorField"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#Geometry.rotateVectorField" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="Geometry.spatialCoverage">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">Geometry.</span></span><span class="sig-name descname"><span class="pre">spatialCoverage</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">lat_min</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lat_max</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lon_min</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lon_max</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/Geometry.html#spatialCoverage"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#Geometry.spatialCoverage" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3.7/library/functions.html#object" title="(in Python v3.7)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
+<p>Base class for setting spatial coverage of data in lat/lon ranges.</p>
+</dd></dl>
+
+</section>
+
+
+ <div class="clearer"></div>
+ </div>
+ </div>
+ </div>
+ <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+ <div class="sphinxsidebarwrapper">
+ <h4>Previous topic</h4>
+ <p class="topless"><a href="TimeFuncs.html"
+ title="previous chapter">TimeFuncs</a></p>
+ <h4>Next topic</h4>
+ <p class="topless"><a href="Graphics.html"
+ title="next chapter">Graphics</a></p>
+ <div role="note" aria-label="source link">
+ <h3>This Page</h3>
+ <ul class="this-page-menu">
+ <li><a href="_sources/Geometry.rst.txt"
+ rel="nofollow">Show Source</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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
+ <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="Graphics.html" title="Graphics"
+ >next</a> |</li>
+ <li class="right" >
+ <a href="TimeFuncs.html" title="TimeFuncs"
+ >previous</a> |</li>
+ <li class="nav-item nav-item-0"><a href="index.html">WaveVal documentation</a> »</li>
+ <li class="nav-item nav-item-this"><a href="">Geometry</a></li>
+ </ul>
+ </div>
+ <div class="footer" role="contentinfo">
+ © Copyright 2022.
+ Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 4.3.0.
+ </div>
+ </body>
+</html>
\ No newline at end of file
diff --git a/docs/_build/html/Graphics.html b/docs/_build/html/Graphics.html
new file mode 100644
index 0000000000000000000000000000000000000000..c7fd620d6b6b2ac279c45a46f1783d812c2bc8a5
--- /dev/null
+++ b/docs/_build/html/Graphics.html
@@ -0,0 +1,157 @@
+
+
+<!doctype html>
+
+<html lang="en">
+ <head>
+ <meta charset="utf-8" />
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
+
+ <title>Graphics — WaveVal documentation</title>
+ <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
+ <link rel="stylesheet" type="text/css" href="_static/bizstyle.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 src="_static/bizstyle.js"></script>
+ <link rel="author" title="About these documents" href="about.html" />
+ <link rel="index" title="Index" href="genindex.html" />
+ <link rel="search" title="Search" href="search.html" />
+ <link rel="prev" title="Geometry" href="Geometry.html" />
+ <meta name="viewport" content="width=device-width,initial-scale=1.0" />
+ <!--[if lt IE 9]>
+ <script src="_static/css3-mediaqueries.js"></script>
+ <![endif]-->
+ </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="Geometry.html" title="Geometry"
+ accesskey="P">previous</a> |</li>
+ <li class="nav-item nav-item-0"><a href="index.html">WaveVal documentation</a> »</li>
+ <li class="nav-item nav-item-this"><a href="">Graphics</a></li>
+ </ul>
+ </div>
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body" role="main">
+
+ <section id="module-Graphics">
+<span id="graphics"></span><h1>Graphics<a class="headerlink" href="#module-Graphics" title="Permalink to this headline">¶</a></h1>
+<p>Standardised graphics generating functions for displaying resuls from the model
+validation analysis.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Dependencies [External]</dt>
+<dd class="field-odd"><p>matplotlib, cartopy</p>
+</dd>
+<dt class="field-even">Dependencies [Internal]</dt>
+<dd class="field-even"><p>waveval.TimeFuncs</p>
+</dd>
+</dl>
+<dl class="py function">
+<dt class="sig sig-object py" id="Graphics.Regional">
+<span class="sig-prename descclassname"><span class="pre">Graphics.</span></span><span class="sig-name descname"><span class="pre">Regional</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">lat</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3.7/library/stdtypes.html#list" title="(in Python v3.7)"><span class="pre">list</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">lon</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3.7/library/stdtypes.html#list" title="(in Python v3.7)"><span class="pre">list</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">plot_area</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3.7/library/stdtypes.html#list" title="(in Python v3.7)"><span class="pre">list</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">lat_div</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3.7/library/stdtypes.html#list" title="(in Python v3.7)"><span class="pre">list</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">lon_div</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3.7/library/stdtypes.html#list" title="(in Python v3.7)"><span class="pre">list</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">outpath</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3.7/library/stdtypes.html#str" title="(in Python v3.7)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">outname</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3.7/library/stdtypes.html#str" title="(in Python v3.7)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">saveplot</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3.7/library/functions.html#bool" title="(in Python v3.7)"><span class="pre">bool</span></a></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/Graphics.html#Regional"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#Graphics.Regional" title="Permalink to this definition">¶</a></dt>
+<dd><p>Regional map of specific locations.</p>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="Graphics.Regional_Weighted">
+<span class="sig-prename descclassname"><span class="pre">Graphics.</span></span><span class="sig-name descname"><span class="pre">Regional_Weighted</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">lat</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3.7/library/stdtypes.html#list" title="(in Python v3.7)"><span class="pre">list</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">lon</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3.7/library/stdtypes.html#list" title="(in Python v3.7)"><span class="pre">list</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">wght</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3.7/library/stdtypes.html#list" title="(in Python v3.7)"><span class="pre">list</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">plot_area</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3.7/library/stdtypes.html#list" title="(in Python v3.7)"><span class="pre">list</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">clims</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3.7/library/stdtypes.html#list" title="(in Python v3.7)"><span class="pre">list</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">plotTitle</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3.7/library/stdtypes.html#str" title="(in Python v3.7)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">outpath</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3.7/library/stdtypes.html#str" title="(in Python v3.7)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">outname</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3.7/library/stdtypes.html#str" title="(in Python v3.7)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">saveplot</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3.7/library/functions.html#bool" title="(in Python v3.7)"><span class="pre">bool</span></a></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/Graphics.html#Regional_Weighted"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#Graphics.Regional_Weighted" title="Permalink to this definition">¶</a></dt>
+<dd><p>Regional map of parameters at specific locations colourised by a
+wieghting factor.</p>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="Graphics.plot_1d_spec">
+<span class="sig-prename descclassname"><span class="pre">Graphics.</span></span><span class="sig-name descname"><span class="pre">plot_1d_spec</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">freq</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">spec1D</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">titleStr</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3.7/library/stdtypes.html#str" title="(in Python v3.7)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">outpath</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3.7/library/stdtypes.html#str" title="(in Python v3.7)"><span class="pre">str</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'./'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">outname</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3.7/library/stdtypes.html#str" title="(in Python v3.7)"><span class="pre">str</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'spec_1d'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">saveplot</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3.7/library/functions.html#bool" title="(in Python v3.7)"><span class="pre">bool</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/Graphics.html#plot_1d_spec"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#Graphics.plot_1d_spec" title="Permalink to this definition">¶</a></dt>
+<dd><p>Plot of a 1-D wave frequency spectrum</p>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="Graphics.plot_2d_spec">
+<span class="sig-prename descclassname"><span class="pre">Graphics.</span></span><span class="sig-name descname"><span class="pre">plot_2d_spec</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">freq</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ntheta</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">spec2D</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fmax</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3.7/library/functions.html#float" title="(in Python v3.7)"><span class="pre">float</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">0.25</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cmax</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3.7/library/functions.html#float" title="(in Python v3.7)"><span class="pre">float</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">2.0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">titleStr</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3.7/library/stdtypes.html#str" title="(in Python v3.7)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/Graphics.html#plot_2d_spec"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#Graphics.plot_2d_spec" title="Permalink to this definition">¶</a></dt>
+<dd><p>Plot of a 2-D wave frequency spectrum</p>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="Graphics.plot_close">
+<span class="sig-prename descclassname"><span class="pre">Graphics.</span></span><span class="sig-name descname"><span class="pre">plot_close</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">figHnd</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/Graphics.html#plot_close"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#Graphics.plot_close" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="Graphics.plot_correlation">
+<span class="sig-prename descclassname"><span class="pre">Graphics.</span></span><span class="sig-name descname"><span class="pre">plot_correlation</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">obs</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">model</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">obsVar</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">obsPlatform</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">modVar</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">modfname</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">year</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">month</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">metrics</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/Graphics.html#plot_correlation"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#Graphics.plot_correlation" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="Graphics.plot_time_series">
+<span class="sig-prename descclassname"><span class="pre">Graphics.</span></span><span class="sig-name descname"><span class="pre">plot_time_series</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">t_mod</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">v_mod</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">t_obs</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">v_obs</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">obsVar</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">obsPlatform</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">modVar</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">modfname</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">year</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">month</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">xlims</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ylims</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/Graphics.html#plot_time_series"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#Graphics.plot_time_series" title="Permalink to this definition">¶</a></dt>
+<dd><p>Overlaid plot of model and observed time series of specified parameter.</p>
+</dd></dl>
+
+</section>
+
+
+ <div class="clearer"></div>
+ </div>
+ </div>
+ </div>
+ <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+ <div class="sphinxsidebarwrapper">
+ <h4>Previous topic</h4>
+ <p class="topless"><a href="Geometry.html"
+ title="previous chapter">Geometry</a></p>
+ <div role="note" aria-label="source link">
+ <h3>This Page</h3>
+ <ul class="this-page-menu">
+ <li><a href="_sources/Graphics.rst.txt"
+ rel="nofollow">Show Source</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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
+ <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="Geometry.html" title="Geometry"
+ >previous</a> |</li>
+ <li class="nav-item nav-item-0"><a href="index.html">WaveVal documentation</a> »</li>
+ <li class="nav-item nav-item-this"><a href="">Graphics</a></li>
+ </ul>
+ </div>
+ <div class="footer" role="contentinfo">
+ © Copyright 2022.
+ Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 4.3.0.
+ </div>
+ </body>
+</html>
\ No newline at end of file
diff --git a/docs/_build/html/MatchUpDatabase.html b/docs/_build/html/MatchUpDatabase.html
new file mode 100644
index 0000000000000000000000000000000000000000..ec61b4e49e087363c65e732e901113eb1a3e9cf3
--- /dev/null
+++ b/docs/_build/html/MatchUpDatabase.html
@@ -0,0 +1,286 @@
+
+
+<!doctype html>
+
+<html lang="en">
+ <head>
+ <meta charset="utf-8" />
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
+
+ <title>MatchUpDatabase — WaveVal documentation</title>
+ <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
+ <link rel="stylesheet" type="text/css" href="_static/bizstyle.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 src="_static/bizstyle.js"></script>
+ <link rel="author" title="About these documents" href="about.html" />
+ <link rel="index" title="Index" href="genindex.html" />
+ <link rel="search" title="Search" href="search.html" />
+ <link rel="next" title="WaveStats" href="WaveStats.html" />
+ <link rel="prev" title="Validation" href="Validation.html" />
+ <meta name="viewport" content="width=device-width,initial-scale=1.0" />
+ <!--[if lt IE 9]>
+ <script src="_static/css3-mediaqueries.js"></script>
+ <![endif]-->
+ </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="WaveStats.html" title="WaveStats"
+ accesskey="N">next</a> |</li>
+ <li class="right" >
+ <a href="Validation.html" title="Validation"
+ accesskey="P">previous</a> |</li>
+ <li class="nav-item nav-item-0"><a href="index.html">WaveVal documentation</a> »</li>
+ <li class="nav-item nav-item-this"><a href="">MatchUpDatabase</a></li>
+ </ul>
+ </div>
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body" role="main">
+
+ <section id="module-MatchUpDatabase">
+<span id="matchupdatabase"></span><h1>MatchUpDatabase<a class="headerlink" href="#module-MatchUpDatabase" title="Permalink to this headline">¶</a></h1>
+<p>Tools for generating an SQLite matchup database from a set of model extracts
+and an archive of wavebuoy data.</p>
+<p>These tools are tied to the ResourceCode WaveWatch III model hindcast data,
+but the undelying functions for opening, populating and querying and SQLite
+dataase are generic.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Dependencies [External]</dt>
+<dd class="field-odd"><p>os, re, sqlite, csv</p>
+</dd>
+<dt class="field-even">Dependencies [Internal]</dt>
+<dd class="field-even"><p>waveval.Geomtery, waveval.TimeFuncs, waveval.ObsData, waveval.ModelData</p>
+</dd>
+</dl>
+<dl class="py function">
+<dt class="sig sig-object py" id="MatchUpDatabase.close_database">
+<span class="sig-prename descclassname"><span class="pre">MatchUpDatabase.</span></span><span class="sig-name descname"><span class="pre">close_database</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">db_conn</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/MatchUpDatabase.html#close_database"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#MatchUpDatabase.close_database" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="MatchUpDatabase.construct_rscd_mdb">
+<span class="sig-prename descclassname"><span class="pre">MatchUpDatabase.</span></span><span class="sig-name descname"><span class="pre">construct_rscd_mdb</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">db_path</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3.7/library/stdtypes.html#str" title="(in Python v3.7)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">db_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3.7/library/stdtypes.html#str" title="(in Python v3.7)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">rscdpath</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3.7/library/stdtypes.html#str" title="(in Python v3.7)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">rscddataset</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3.7/library/stdtypes.html#str" title="(in Python v3.7)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">months</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3.7/library/stdtypes.html#list" title="(in Python v3.7)"><span class="pre">list</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">buoypath</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3.7/library/stdtypes.html#str" title="(in Python v3.7)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">buoydataset</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3.7/library/stdtypes.html#str" title="(in Python v3.7)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">buoydatafmt</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3.7/library/stdtypes.html#str" title="(in Python v3.7)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">bfilt</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">chunkSize</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">500</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/MatchUpDatabase.html#construct_rscd_mdb"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#MatchUpDatabase.construct_rscd_mdb" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="MatchUpDatabase.create_buoy_table">
+<span class="sig-prename descclassname"><span class="pre">MatchUpDatabase.</span></span><span class="sig-name descname"><span class="pre">create_buoy_table</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">db_conn</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/MatchUpDatabase.html#create_buoy_table"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#MatchUpDatabase.create_buoy_table" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="MatchUpDatabase.create_connection">
+<span class="sig-prename descclassname"><span class="pre">MatchUpDatabase.</span></span><span class="sig-name descname"><span class="pre">create_connection</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">db_file</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/MatchUpDatabase.html#create_connection"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#MatchUpDatabase.create_connection" title="Permalink to this definition">¶</a></dt>
+<dd><p>Create a database connection to the SQLite database
+specified by db_file.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters</dt>
+<dd class="field-odd"><p><strong>db_file</strong> – database file</p>
+</dd>
+<dt class="field-even">Returns</dt>
+<dd class="field-even"><p>Connection object or None</p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="MatchUpDatabase.create_database">
+<span class="sig-prename descclassname"><span class="pre">MatchUpDatabase.</span></span><span class="sig-name descname"><span class="pre">create_database</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">db_path</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">db_name</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/MatchUpDatabase.html#create_database"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#MatchUpDatabase.create_database" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="MatchUpDatabase.create_match_table">
+<span class="sig-prename descclassname"><span class="pre">MatchUpDatabase.</span></span><span class="sig-name descname"><span class="pre">create_match_table</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">db_conn</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/MatchUpDatabase.html#create_match_table"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#MatchUpDatabase.create_match_table" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="MatchUpDatabase.create_rscd_table">
+<span class="sig-prename descclassname"><span class="pre">MatchUpDatabase.</span></span><span class="sig-name descname"><span class="pre">create_rscd_table</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">db_conn</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/MatchUpDatabase.html#create_rscd_table"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#MatchUpDatabase.create_rscd_table" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="MatchUpDatabase.csv2tuples">
+<span class="sig-prename descclassname"><span class="pre">MatchUpDatabase.</span></span><span class="sig-name descname"><span class="pre">csv2tuples</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">csv_file</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/MatchUpDatabase.html#csv2tuples"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#MatchUpDatabase.csv2tuples" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="MatchUpDatabase.db_match_to_csv">
+<span class="sig-prename descclassname"><span class="pre">MatchUpDatabase.</span></span><span class="sig-name descname"><span class="pre">db_match_to_csv</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">db_path</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">db_name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">csv_path</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">csv_fname</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/MatchUpDatabase.html#db_match_to_csv"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#MatchUpDatabase.db_match_to_csv" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="MatchUpDatabase.getPlatformList">
+<span class="sig-prename descclassname"><span class="pre">MatchUpDatabase.</span></span><span class="sig-name descname"><span class="pre">getPlatformList</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">records</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/MatchUpDatabase.html#getPlatformList"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#MatchUpDatabase.getPlatformList" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="MatchUpDatabase.getPlatformRecords">
+<span class="sig-prename descclassname"><span class="pre">MatchUpDatabase.</span></span><span class="sig-name descname"><span class="pre">getPlatformRecords</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">records</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">platform</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/MatchUpDatabase.html#getPlatformRecords"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#MatchUpDatabase.getPlatformRecords" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="MatchUpDatabase.get_match_records">
+<span class="sig-prename descclassname"><span class="pre">MatchUpDatabase.</span></span><span class="sig-name descname"><span class="pre">get_match_records</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">db_path</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">db_name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sql_query</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/MatchUpDatabase.html#get_match_records"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#MatchUpDatabase.get_match_records" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="MatchUpDatabase.insert_buoy_records">
+<span class="sig-prename descclassname"><span class="pre">MatchUpDatabase.</span></span><span class="sig-name descname"><span class="pre">insert_buoy_records</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">db_conn</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">records</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/MatchUpDatabase.html#insert_buoy_records"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#MatchUpDatabase.insert_buoy_records" title="Permalink to this definition">¶</a></dt>
+<dd><p>Create a new record in the rscd_files table</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters</dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>db_conn</strong> – </p></li>
+<li><p><strong>record</strong> – </p></li>
+</ul>
+</dd>
+<dt class="field-even">Returns</dt>
+<dd class="field-even"><p>row count</p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="MatchUpDatabase.insert_match_record">
+<span class="sig-prename descclassname"><span class="pre">MatchUpDatabase.</span></span><span class="sig-name descname"><span class="pre">insert_match_record</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">db_conn</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">records</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/MatchUpDatabase.html#insert_match_record"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#MatchUpDatabase.insert_match_record" title="Permalink to this definition">¶</a></dt>
+<dd><p>Create a new record in the match_files table</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters</dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>db_conn</strong> – </p></li>
+<li><p><strong>records</strong> – </p></li>
+</ul>
+</dd>
+<dt class="field-even">Returns</dt>
+<dd class="field-even"><p>row count</p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="MatchUpDatabase.insert_rscd_records">
+<span class="sig-prename descclassname"><span class="pre">MatchUpDatabase.</span></span><span class="sig-name descname"><span class="pre">insert_rscd_records</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">db_conn</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">records</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/MatchUpDatabase.html#insert_rscd_records"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#MatchUpDatabase.insert_rscd_records" title="Permalink to this definition">¶</a></dt>
+<dd><p>Create a new record in the rscd_files table</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters</dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>db_conn</strong> – </p></li>
+<li><p><strong>records</strong> – </p></li>
+</ul>
+</dd>
+<dt class="field-even">Returns</dt>
+<dd class="field-even"><p>row count</p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="MatchUpDatabase.load_buoy_archive">
+<span class="sig-prename descclassname"><span class="pre">MatchUpDatabase.</span></span><span class="sig-name descname"><span class="pre">load_buoy_archive</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">db_conn</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">archivePath</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3.7/library/stdtypes.html#str" title="(in Python v3.7)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">dataSet</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3.7/library/stdtypes.html#str" title="(in Python v3.7)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">dataFmt</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3.7/library/stdtypes.html#str" title="(in Python v3.7)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">recFilter</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">chunkSize</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">500</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">verbose</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/MatchUpDatabase.html#load_buoy_archive"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#MatchUpDatabase.load_buoy_archive" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="MatchUpDatabase.load_rscd_archive">
+<span class="sig-prename descclassname"><span class="pre">MatchUpDatabase.</span></span><span class="sig-name descname"><span class="pre">load_rscd_archive</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">db_conn</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">archivePath</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dataSet</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">chunkSize</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">500</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/MatchUpDatabase.html#load_rscd_archive"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#MatchUpDatabase.load_rscd_archive" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="MatchUpDatabase.mapRecord">
+<span class="sig-prename descclassname"><span class="pre">MatchUpDatabase.</span></span><span class="sig-name descname"><span class="pre">mapRecord</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">startYr</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">stopYr</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">record</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dataset</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/MatchUpDatabase.html#mapRecord"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#MatchUpDatabase.mapRecord" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="MatchUpDatabase.recordFilter">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">MatchUpDatabase.</span></span><span class="sig-name descname"><span class="pre">recordFilter</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">coverage</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3.7/library/stdtypes.html#list" title="(in Python v3.7)"><span class="pre">list</span></a></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/MatchUpDatabase.html#recordFilter"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#MatchUpDatabase.recordFilter" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3.7/library/functions.html#object" title="(in Python v3.7)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
+<dl class="py method">
+<dt class="sig sig-object py" id="MatchUpDatabase.recordFilter.includeRecord">
+<span class="sig-name descname"><span class="pre">includeRecord</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">record</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">verbose</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/MatchUpDatabase.html#recordFilter.includeRecord"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#MatchUpDatabase.recordFilter.includeRecord" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="MatchUpDatabase.touch">
+<span class="sig-prename descclassname"><span class="pre">MatchUpDatabase.</span></span><span class="sig-name descname"><span class="pre">touch</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">path</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/MatchUpDatabase.html#touch"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#MatchUpDatabase.touch" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="MatchUpDatabase.tuples2csv">
+<span class="sig-prename descclassname"><span class="pre">MatchUpDatabase.</span></span><span class="sig-name descname"><span class="pre">tuples2csv</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">records</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">csv_file</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/MatchUpDatabase.html#tuples2csv"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#MatchUpDatabase.tuples2csv" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</section>
+
+
+ <div class="clearer"></div>
+ </div>
+ </div>
+ </div>
+ <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+ <div class="sphinxsidebarwrapper">
+ <h4>Previous topic</h4>
+ <p class="topless"><a href="Validation.html"
+ title="previous chapter">Validation</a></p>
+ <h4>Next topic</h4>
+ <p class="topless"><a href="WaveStats.html"
+ title="next chapter">WaveStats</a></p>
+ <div role="note" aria-label="source link">
+ <h3>This Page</h3>
+ <ul class="this-page-menu">
+ <li><a href="_sources/MatchUpDatabase.rst.txt"
+ rel="nofollow">Show Source</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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
+ <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="WaveStats.html" title="WaveStats"
+ >next</a> |</li>
+ <li class="right" >
+ <a href="Validation.html" title="Validation"
+ >previous</a> |</li>
+ <li class="nav-item nav-item-0"><a href="index.html">WaveVal documentation</a> »</li>
+ <li class="nav-item nav-item-this"><a href="">MatchUpDatabase</a></li>
+ </ul>
+ </div>
+ <div class="footer" role="contentinfo">
+ © Copyright 2022.
+ Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 4.3.0.
+ </div>
+ </body>
+</html>
\ No newline at end of file
diff --git a/docs/_build/html/ModelData.html b/docs/_build/html/ModelData.html
new file mode 100644
index 0000000000000000000000000000000000000000..6d1903864bcbb0e68a3c3d7a9d275fbc7884d2a6
--- /dev/null
+++ b/docs/_build/html/ModelData.html
@@ -0,0 +1,184 @@
+
+
+<!doctype html>
+
+<html lang="en">
+ <head>
+ <meta charset="utf-8" />
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
+
+ <title>ModelData — WaveVal documentation</title>
+ <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
+ <link rel="stylesheet" type="text/css" href="_static/bizstyle.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 src="_static/bizstyle.js"></script>
+ <link rel="author" title="About these documents" href="about.html" />
+ <link rel="index" title="Index" href="genindex.html" />
+ <link rel="search" title="Search" href="search.html" />
+ <link rel="next" title="ObsData" href="ObsData.html" />
+ <link rel="prev" title="WaveSpectra" href="WaveSpectra.html" />
+ <meta name="viewport" content="width=device-width,initial-scale=1.0" />
+ <!--[if lt IE 9]>
+ <script src="_static/css3-mediaqueries.js"></script>
+ <![endif]-->
+ </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="ObsData.html" title="ObsData"
+ accesskey="N">next</a> |</li>
+ <li class="right" >
+ <a href="WaveSpectra.html" title="WaveSpectra"
+ accesskey="P">previous</a> |</li>
+ <li class="nav-item nav-item-0"><a href="index.html">WaveVal documentation</a> »</li>
+ <li class="nav-item nav-item-this"><a href="">ModelData</a></li>
+ </ul>
+ </div>
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body" role="main">
+
+ <section id="module-ModelData">
+<span id="modeldata"></span><h1>ModelData<a class="headerlink" href="#module-ModelData" title="Permalink to this headline">¶</a></h1>
+<p>Class structures and functions for loading numerical model output data in
+netCDF formats.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Dependencies [External]</dt>
+<dd class="field-odd"><p>os, numpy, datetime</p>
+</dd>
+<dt class="field-even">Dependencies [Internal]</dt>
+<dd class="field-even"><p>waveval.DataFormats. waveval.TimeFunc, waveval.Geometry</p>
+</dd>
+</dl>
+<dl class="py function">
+<dt class="sig sig-object py" id="ModelData.mesh2sms2dm">
+<span class="sig-prename descclassname"><span class="pre">ModelData.</span></span><span class="sig-name descname"><span class="pre">mesh2sms2dm</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">outpath</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">outfile</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mesh</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ModelData.html#mesh2sms2dm"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ModelData.mesh2sms2dm" title="Permalink to this definition">¶</a></dt>
+<dd><p>Convert mesh data to SMS2DM mesh format.</p>
+</dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="ModelData.sswMesh">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">ModelData.</span></span><span class="sig-name descname"><span class="pre">sswMesh</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">sswFile</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ModelData.html#sswMesh"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ModelData.sswMesh" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3.7/library/functions.html#object" title="(in Python v3.7)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
+<p>Class structure for extracting the model mesh data from the a
+Marine Scotland SSW model output netCDF files that contains the
+mesh definition.</p>
+</dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="ModelData.ssw_rs">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">ModelData.</span></span><span class="sig-name descname"><span class="pre">ssw_rs</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">fileName</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ModelData.html#ssw_rs"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ModelData.ssw_rs" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">waveval.DataFormats.netcdfGeneric</span></code></p>
+<p>Class structure for reading the Marine Scotland SSW model output netCDF files.</p>
+<dl class="py method">
+<dt class="sig sig-object py" id="ModelData.ssw_rs.getMetaData">
+<span class="sig-name descname"><span class="pre">getMetaData</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/ModelData.html#ssw_rs.getMetaData"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ModelData.ssw_rs.getMetaData" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="ModelData.ssw_rs.getVar">
+<span class="sig-name descname"><span class="pre">getVar</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">varName</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ModelData.html#ssw_rs.getVar"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ModelData.ssw_rs.getVar" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="ModelData.ww3">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">ModelData.</span></span><span class="sig-name descname"><span class="pre">ww3</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">fileName</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ModelData.html#ww3"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ModelData.ww3" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">waveval.DataFormats.netcdfGeneric</span></code></p>
+<p>Class structure for reading the ResourceCode WW3 model output netCDF files.</p>
+<dl class="py method">
+<dt class="sig sig-object py" id="ModelData.ww3.getMetaData">
+<span class="sig-name descname"><span class="pre">getMetaData</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/ModelData.html#ww3.getMetaData"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ModelData.ww3.getMetaData" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="ModelData.ww3.getVar">
+<span class="sig-name descname"><span class="pre">getVar</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">varName</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ModelData.html#ww3.getVar"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ModelData.ww3.getVar" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="ModelData.ww3Mesh">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">ModelData.</span></span><span class="sig-name descname"><span class="pre">ww3Mesh</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">meshFile</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ModelData.html#ww3Mesh"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ModelData.ww3Mesh" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3.7/library/functions.html#object" title="(in Python v3.7)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
+<p>Class structure for extracting the model mesh data from the a
+ResourceCode WW3 model output netCDF files that contains the
+mesh definition.</p>
+</dd></dl>
+
+</section>
+
+
+ <div class="clearer"></div>
+ </div>
+ </div>
+ </div>
+ <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+ <div class="sphinxsidebarwrapper">
+ <h4>Previous topic</h4>
+ <p class="topless"><a href="WaveSpectra.html"
+ title="previous chapter">WaveSpectra</a></p>
+ <h4>Next topic</h4>
+ <p class="topless"><a href="ObsData.html"
+ title="next chapter">ObsData</a></p>
+ <div role="note" aria-label="source link">
+ <h3>This Page</h3>
+ <ul class="this-page-menu">
+ <li><a href="_sources/ModelData.rst.txt"
+ rel="nofollow">Show Source</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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
+ <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="ObsData.html" title="ObsData"
+ >next</a> |</li>
+ <li class="right" >
+ <a href="WaveSpectra.html" title="WaveSpectra"
+ >previous</a> |</li>
+ <li class="nav-item nav-item-0"><a href="index.html">WaveVal documentation</a> »</li>
+ <li class="nav-item nav-item-this"><a href="">ModelData</a></li>
+ </ul>
+ </div>
+ <div class="footer" role="contentinfo">
+ © Copyright 2022.
+ Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 4.3.0.
+ </div>
+ </body>
+</html>
\ No newline at end of file
diff --git a/docs/_build/html/ObsData.html b/docs/_build/html/ObsData.html
new file mode 100644
index 0000000000000000000000000000000000000000..b79a7ea0fa924d829d3624d85707b488d63a2f80
--- /dev/null
+++ b/docs/_build/html/ObsData.html
@@ -0,0 +1,227 @@
+
+
+<!doctype html>
+
+<html lang="en">
+ <head>
+ <meta charset="utf-8" />
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
+
+ <title>ObsData — WaveVal documentation</title>
+ <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
+ <link rel="stylesheet" type="text/css" href="_static/bizstyle.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 src="_static/bizstyle.js"></script>
+ <link rel="author" title="About these documents" href="about.html" />
+ <link rel="index" title="Index" href="genindex.html" />
+ <link rel="search" title="Search" href="search.html" />
+ <link rel="next" title="DataFormats" href="DataFormats.html" />
+ <link rel="prev" title="ModelData" href="ModelData.html" />
+ <meta name="viewport" content="width=device-width,initial-scale=1.0" />
+ <!--[if lt IE 9]>
+ <script src="_static/css3-mediaqueries.js"></script>
+ <![endif]-->
+ </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="DataFormats.html" title="DataFormats"
+ accesskey="N">next</a> |</li>
+ <li class="right" >
+ <a href="ModelData.html" title="ModelData"
+ accesskey="P">previous</a> |</li>
+ <li class="nav-item nav-item-0"><a href="index.html">WaveVal documentation</a> »</li>
+ <li class="nav-item nav-item-this"><a href="">ObsData</a></li>
+ </ul>
+ </div>
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body" role="main">
+
+ <section id="module-ObsData">
+<span id="obsdata"></span><h1>ObsData<a class="headerlink" href="#module-ObsData" title="Permalink to this headline">¶</a></h1>
+<p>Class structures and functions for loading observation data stored in
+netCDF formats.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Dependencies [External]</dt>
+<dd class="field-odd"><p>os, numpy, datetime</p>
+</dd>
+<dt class="field-even">Dependencies [Internal]</dt>
+<dd class="field-even"><p>waveval.DataFormats. waveval.TimeFunc, waveval.Geometry</p>
+</dd>
+</dl>
+<dl class="py class">
+<dt class="sig sig-object py" id="ObsData.drifter">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">ObsData.</span></span><span class="sig-name descname"><span class="pre">drifter</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">fileName</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ObsData.html#drifter"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ObsData.drifter" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">waveval.DataFormats.netcdfGeneric</span></code></p>
+<p>Class structure for reading the CMEMS formatted drifter netCDF files.</p>
+<dl class="py method">
+<dt class="sig sig-object py" id="ObsData.drifter.crossesDomain">
+<span class="sig-name descname"><span class="pre">crossesDomain</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">domain</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">waveval.Geometry.spatialCoverage</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ObsData.html#drifter.crossesDomain"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ObsData.drifter.crossesDomain" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="ObsData.drifter.getMetaData">
+<span class="sig-name descname"><span class="pre">getMetaData</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/ObsData.html#drifter.getMetaData"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ObsData.drifter.getMetaData" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="ObsData.drifter.getTrackCoverage">
+<span class="sig-name descname"><span class="pre">getTrackCoverage</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/ObsData.html#drifter.getTrackCoverage"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ObsData.drifter.getTrackCoverage" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="ObsData.drifter.getVar">
+<span class="sig-name descname"><span class="pre">getVar</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">varName</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ObsData.html#drifter.getVar"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ObsData.drifter.getVar" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="ObsData.emecwb">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">ObsData.</span></span><span class="sig-name descname"><span class="pre">emecwb</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">fileName</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ObsData.html#emecwb"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ObsData.emecwb" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">waveval.DataFormats.netcdfGeneric</span></code></p>
+<p>Class structure for reading the EMEC formatted wavebuoy netCDF files.</p>
+<dl class="py method">
+<dt class="sig sig-object py" id="ObsData.emecwb.gapFillTimeseries">
+<span class="sig-name descname"><span class="pre">gapFillTimeseries</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">times</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">values</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ObsData.html#emecwb.gapFillTimeseries"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ObsData.emecwb.gapFillTimeseries" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="ObsData.emecwb.getMetaData">
+<span class="sig-name descname"><span class="pre">getMetaData</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/ObsData.html#emecwb.getMetaData"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ObsData.emecwb.getMetaData" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="ObsData.emecwb.getQCTimeseries">
+<span class="sig-name descname"><span class="pre">getQCTimeseries</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">varName</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">varIndex</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ObsData.html#emecwb.getQCTimeseries"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ObsData.emecwb.getQCTimeseries" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="ObsData.emecwb.getQCVar">
+<span class="sig-name descname"><span class="pre">getQCVar</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">varName</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ObsData.html#emecwb.getQCVar"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ObsData.emecwb.getQCVar" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="ObsData.emecwb.getVar">
+<span class="sig-name descname"><span class="pre">getVar</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">varName</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ObsData.html#emecwb.getVar"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ObsData.emecwb.getVar" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="ObsData.get_nc_var">
+<span class="sig-prename descclassname"><span class="pre">ObsData.</span></span><span class="sig-name descname"><span class="pre">get_nc_var</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ncHnd</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">varName</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ObsData.html#get_nc_var"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ObsData.get_nc_var" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="ObsData.is_masked">
+<span class="sig-prename descclassname"><span class="pre">ObsData.</span></span><span class="sig-name descname"><span class="pre">is_masked</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ObsData.html#is_masked"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ObsData.is_masked" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="ObsData.wavebuoy">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">ObsData.</span></span><span class="sig-name descname"><span class="pre">wavebuoy</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">fileName</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ObsData.html#wavebuoy"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ObsData.wavebuoy" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">waveval.DataFormats.netcdfGeneric</span></code></p>
+<p>Class structure for reading the CMEMS formatted wavebuoy netCDF files.</p>
+<dl class="py method">
+<dt class="sig sig-object py" id="ObsData.wavebuoy.gapFillTimeseries">
+<span class="sig-name descname"><span class="pre">gapFillTimeseries</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">times</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">values</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ObsData.html#wavebuoy.gapFillTimeseries"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ObsData.wavebuoy.gapFillTimeseries" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="ObsData.wavebuoy.getMetaData">
+<span class="sig-name descname"><span class="pre">getMetaData</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/ObsData.html#wavebuoy.getMetaData"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ObsData.wavebuoy.getMetaData" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="ObsData.wavebuoy.getQCTimeseries">
+<span class="sig-name descname"><span class="pre">getQCTimeseries</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">varName</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">varIndex</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ObsData.html#wavebuoy.getQCTimeseries"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ObsData.wavebuoy.getQCTimeseries" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="ObsData.wavebuoy.getQCVar">
+<span class="sig-name descname"><span class="pre">getQCVar</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">varName</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ObsData.html#wavebuoy.getQCVar"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ObsData.wavebuoy.getQCVar" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="ObsData.wavebuoy.getVar">
+<span class="sig-name descname"><span class="pre">getVar</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">varName</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ObsData.html#wavebuoy.getVar"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ObsData.wavebuoy.getVar" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
+</section>
+
+
+ <div class="clearer"></div>
+ </div>
+ </div>
+ </div>
+ <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+ <div class="sphinxsidebarwrapper">
+ <h4>Previous topic</h4>
+ <p class="topless"><a href="ModelData.html"
+ title="previous chapter">ModelData</a></p>
+ <h4>Next topic</h4>
+ <p class="topless"><a href="DataFormats.html"
+ title="next chapter">DataFormats</a></p>
+ <div role="note" aria-label="source link">
+ <h3>This Page</h3>
+ <ul class="this-page-menu">
+ <li><a href="_sources/ObsData.rst.txt"
+ rel="nofollow">Show Source</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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
+ <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="DataFormats.html" title="DataFormats"
+ >next</a> |</li>
+ <li class="right" >
+ <a href="ModelData.html" title="ModelData"
+ >previous</a> |</li>
+ <li class="nav-item nav-item-0"><a href="index.html">WaveVal documentation</a> »</li>
+ <li class="nav-item nav-item-this"><a href="">ObsData</a></li>
+ </ul>
+ </div>
+ <div class="footer" role="contentinfo">
+ © Copyright 2022.
+ Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 4.3.0.
+ </div>
+ </body>
+</html>
\ No newline at end of file
diff --git a/docs/_build/html/TimeFuncs.html b/docs/_build/html/TimeFuncs.html
new file mode 100644
index 0000000000000000000000000000000000000000..2fd7a64b892fa100c80725cd160c2a4b451701fe
--- /dev/null
+++ b/docs/_build/html/TimeFuncs.html
@@ -0,0 +1,161 @@
+
+
+<!doctype html>
+
+<html lang="en">
+ <head>
+ <meta charset="utf-8" />
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
+
+ <title>TimeFuncs — WaveVal documentation</title>
+ <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
+ <link rel="stylesheet" type="text/css" href="_static/bizstyle.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 src="_static/bizstyle.js"></script>
+ <link rel="author" title="About these documents" href="about.html" />
+ <link rel="index" title="Index" href="genindex.html" />
+ <link rel="search" title="Search" href="search.html" />
+ <link rel="next" title="Geometry" href="Geometry.html" />
+ <link rel="prev" title="DataFormats" href="DataFormats.html" />
+ <meta name="viewport" content="width=device-width,initial-scale=1.0" />
+ <!--[if lt IE 9]>
+ <script src="_static/css3-mediaqueries.js"></script>
+ <![endif]-->
+ </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="Geometry.html" title="Geometry"
+ accesskey="N">next</a> |</li>
+ <li class="right" >
+ <a href="DataFormats.html" title="DataFormats"
+ accesskey="P">previous</a> |</li>
+ <li class="nav-item nav-item-0"><a href="index.html">WaveVal documentation</a> »</li>
+ <li class="nav-item nav-item-this"><a href="">TimeFuncs</a></li>
+ </ul>
+ </div>
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body" role="main">
+
+ <section id="module-TimeFuncs">
+<span id="timefuncs"></span><h1>TimeFuncs<a class="headerlink" href="#module-TimeFuncs" title="Permalink to this headline">¶</a></h1>
+<p>Internal date/time manipulation functions.</p>
+<p>These functions are used to standardise the time stamping between data types.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Dependencies [External]</dt>
+<dd class="field-odd"><p>datetime, netCDF4</p>
+</dd>
+<dt class="field-even">Dependencies [Internal]</dt>
+<dd class="field-even"><p></p></dd>
+</dl>
+<dl class="py function">
+<dt class="sig sig-object py" id="TimeFuncs.dateNumFromStr">
+<span class="sig-prename descclassname"><span class="pre">TimeFuncs.</span></span><span class="sig-name descname"><span class="pre">dateNumFromStr</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dateStr</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/TimeFuncs.html#dateNumFromStr"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#TimeFuncs.dateNumFromStr" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="TimeFuncs.dateStr">
+<span class="sig-prename descclassname"><span class="pre">TimeFuncs.</span></span><span class="sig-name descname"><span class="pre">dateStr</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dateNum</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/TimeFuncs.html#dateStr"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#TimeFuncs.dateStr" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="TimeFuncs.isLeapYear">
+<span class="sig-prename descclassname"><span class="pre">TimeFuncs.</span></span><span class="sig-name descname"><span class="pre">isLeapYear</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">year</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/TimeFuncs.html#isLeapYear"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#TimeFuncs.isLeapYear" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="TimeFuncs.matlab2std">
+<span class="sig-prename descclassname"><span class="pre">TimeFuncs.</span></span><span class="sig-name descname"><span class="pre">matlab2std</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dateNum</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">isLeapYear</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3.7/library/functions.html#bool" title="(in Python v3.7)"><span class="pre">bool</span></a></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/TimeFuncs.html#matlab2std"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#TimeFuncs.matlab2std" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="TimeFuncs.std2matlab">
+<span class="sig-prename descclassname"><span class="pre">TimeFuncs.</span></span><span class="sig-name descname"><span class="pre">std2matlab</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dateNum</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">isLeapYear</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3.7/library/functions.html#bool" title="(in Python v3.7)"><span class="pre">bool</span></a></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/TimeFuncs.html#std2matlab"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#TimeFuncs.std2matlab" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="TimeFuncs.temporalCoverage">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">TimeFuncs.</span></span><span class="sig-name descname"><span class="pre">temporalCoverage</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">timeStart</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3.7/library/stdtypes.html#str" title="(in Python v3.7)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">timeEnd</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3.7/library/stdtypes.html#str" title="(in Python v3.7)"><span class="pre">str</span></a></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/TimeFuncs.html#temporalCoverage"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#TimeFuncs.temporalCoverage" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3.7/library/functions.html#object" title="(in Python v3.7)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
+<dl class="py method">
+<dt class="sig sig-object py" id="TimeFuncs.temporalCoverage.timeOverlap">
+<span class="sig-name descname"><span class="pre">timeOverlap</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">tRec</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/TimeFuncs.html#temporalCoverage.timeOverlap"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#TimeFuncs.temporalCoverage.timeOverlap" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
+</section>
+
+
+ <div class="clearer"></div>
+ </div>
+ </div>
+ </div>
+ <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+ <div class="sphinxsidebarwrapper">
+ <h4>Previous topic</h4>
+ <p class="topless"><a href="DataFormats.html"
+ title="previous chapter">DataFormats</a></p>
+ <h4>Next topic</h4>
+ <p class="topless"><a href="Geometry.html"
+ title="next chapter">Geometry</a></p>
+ <div role="note" aria-label="source link">
+ <h3>This Page</h3>
+ <ul class="this-page-menu">
+ <li><a href="_sources/TimeFuncs.rst.txt"
+ rel="nofollow">Show Source</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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
+ <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="Geometry.html" title="Geometry"
+ >next</a> |</li>
+ <li class="right" >
+ <a href="DataFormats.html" title="DataFormats"
+ >previous</a> |</li>
+ <li class="nav-item nav-item-0"><a href="index.html">WaveVal documentation</a> »</li>
+ <li class="nav-item nav-item-this"><a href="">TimeFuncs</a></li>
+ </ul>
+ </div>
+ <div class="footer" role="contentinfo">
+ © Copyright 2022.
+ Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 4.3.0.
+ </div>
+ </body>
+</html>
\ No newline at end of file
diff --git a/docs/_build/html/Validation.html b/docs/_build/html/Validation.html
new file mode 100644
index 0000000000000000000000000000000000000000..17bc7d05650b77f80951a8a1f49a08cad7b086e6
--- /dev/null
+++ b/docs/_build/html/Validation.html
@@ -0,0 +1,480 @@
+
+
+<!doctype html>
+
+<html lang="en">
+ <head>
+ <meta charset="utf-8" />
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
+
+ <title>Validation — WaveVal documentation</title>
+ <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
+ <link rel="stylesheet" type="text/css" href="_static/bizstyle.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 src="_static/bizstyle.js"></script>
+ <link rel="author" title="About these documents" href="about.html" />
+ <link rel="index" title="Index" href="genindex.html" />
+ <link rel="search" title="Search" href="search.html" />
+ <link rel="next" title="MatchUpDatabase" href="MatchUpDatabase.html" />
+ <link rel="prev" title="External data archives" href="data_access.html" />
+ <meta name="viewport" content="width=device-width,initial-scale=1.0" />
+ <!--[if lt IE 9]>
+ <script src="_static/css3-mediaqueries.js"></script>
+ <![endif]-->
+ </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="MatchUpDatabase.html" title="MatchUpDatabase"
+ accesskey="N">next</a> |</li>
+ <li class="right" >
+ <a href="data_access.html" title="External data archives"
+ accesskey="P">previous</a> |</li>
+ <li class="nav-item nav-item-0"><a href="index.html">WaveVal documentation</a> »</li>
+ <li class="nav-item nav-item-this"><a href="">Validation</a></li>
+ </ul>
+ </div>
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body" role="main">
+
+ <section id="module-Validation">
+<span id="validation"></span><h1>Validation<a class="headerlink" href="#module-Validation" title="Permalink to this headline">¶</a></h1>
+<p>This module contains the functions for calculating parameter based validation statistics for
+a set of matchup records.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Dependencies [External]</dt>
+<dd class="field-odd"><p>os, scipy, numpy, copy</p>
+</dd>
+<dt class="field-even">Dependencies [Internal]</dt>
+<dd class="field-even"><p>waveval.ModelData, waveval.ObsData, waveval.MatchUpDatabase, waveval.Geometry</p>
+</dd>
+</dl>
+<dl class="py function">
+<dt class="sig sig-object py" id="Validation.bias">
+<span class="sig-prename descclassname"><span class="pre">Validation.</span></span><span class="sig-name descname"><span class="pre">bias</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">model</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">obs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/Validation.html#bias"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#Validation.bias" title="Permalink to this definition">¶</a></dt>
+<dd><p>Validation Metric: Bias</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters</dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>model</strong> – model data time series</p></li>
+<li><p><strong>obs</strong> – observation time series mapped onto model time stamps</p></li>
+</ul>
+</dd>
+<dt class="field-even">Returns</dt>
+<dd class="field-even"><p>b</p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="Validation.calculate_circular_metrics">
+<span class="sig-prename descclassname"><span class="pre">Validation.</span></span><span class="sig-name descname"><span class="pre">calculate_circular_metrics</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">model</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">obs</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">nsampl</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">degrees</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/Validation.html#calculate_circular_metrics"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#Validation.calculate_circular_metrics" title="Permalink to this definition">¶</a></dt>
+<dd><p>Calculate circlar validation metrics for a pair of modelled and observation time series</p>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="Validation.calculate_metrics">
+<span class="sig-prename descclassname"><span class="pre">Validation.</span></span><span class="sig-name descname"><span class="pre">calculate_metrics</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">model</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">obs</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">nsampl</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/Validation.html#calculate_metrics"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#Validation.calculate_metrics" title="Permalink to this definition">¶</a></dt>
+<dd><p>Calculate standard validation metrics for a pair of modelled and observation time series</p>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="Validation.circ_corr">
+<span class="sig-prename descclassname"><span class="pre">Validation.</span></span><span class="sig-name descname"><span class="pre">circ_corr</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">theta1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">theta2</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">degrees</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/Validation.html#circ_corr"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#Validation.circ_corr" title="Permalink to this definition">¶</a></dt>
+<dd><p>Validation Metric (Circular): Correlation Coefficient</p>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="Validation.circ_mean_abs_error">
+<span class="sig-prename descclassname"><span class="pre">Validation.</span></span><span class="sig-name descname"><span class="pre">circ_mean_abs_error</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">theta1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">theta2</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">degrees</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/Validation.html#circ_mean_abs_error"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#Validation.circ_mean_abs_error" title="Permalink to this definition">¶</a></dt>
+<dd><p>Validation Metric (Circular): Mean absolute error</p>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="Validation.circ_mean_bias">
+<span class="sig-prename descclassname"><span class="pre">Validation.</span></span><span class="sig-name descname"><span class="pre">circ_mean_bias</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">theta1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">theta2</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">degrees</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/Validation.html#circ_mean_bias"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#Validation.circ_mean_bias" title="Permalink to this definition">¶</a></dt>
+<dd><p>Validation Metric (Circular): Mean Bias</p>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="Validation.circ_mod_pi">
+<span class="sig-prename descclassname"><span class="pre">Validation.</span></span><span class="sig-name descname"><span class="pre">circ_mod_pi</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">theta</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/Validation.html#circ_mod_pi"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#Validation.circ_mod_pi" title="Permalink to this definition">¶</a></dt>
+<dd><p>Fix angular range in radians to -pi <= theta <= pi</p>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="Validation.circ_norm_ma_error">
+<span class="sig-prename descclassname"><span class="pre">Validation.</span></span><span class="sig-name descname"><span class="pre">circ_norm_ma_error</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">theta1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">theta2</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">degrees</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/Validation.html#circ_norm_ma_error"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#Validation.circ_norm_ma_error" title="Permalink to this definition">¶</a></dt>
+<dd><p>Validation Metric (Circular): Normalised mean absolute error</p>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="Validation.circ_norm_mean_bias">
+<span class="sig-prename descclassname"><span class="pre">Validation.</span></span><span class="sig-name descname"><span class="pre">circ_norm_mean_bias</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">theta1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">theta2</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">degrees</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/Validation.html#circ_norm_mean_bias"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#Validation.circ_norm_mean_bias" title="Permalink to this definition">¶</a></dt>
+<dd><p>Validation Metric (Circular): Normalised mean Bias</p>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="Validation.circ_norm_rmse">
+<span class="sig-prename descclassname"><span class="pre">Validation.</span></span><span class="sig-name descname"><span class="pre">circ_norm_rmse</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">theta1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">theta2</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">degrees</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/Validation.html#circ_norm_rmse"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#Validation.circ_norm_rmse" title="Permalink to this definition">¶</a></dt>
+<dd><p>Validation Metric (Circular): Normalised root-mean-square error</p>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="Validation.circ_rms_error">
+<span class="sig-prename descclassname"><span class="pre">Validation.</span></span><span class="sig-name descname"><span class="pre">circ_rms_error</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">theta1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">theta2</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">degrees</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/Validation.html#circ_rms_error"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#Validation.circ_rms_error" title="Permalink to this definition">¶</a></dt>
+<dd><p>Validation Metric (Circular): Root-mean-square error</p>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="Validation.circ_scatter_index">
+<span class="sig-prename descclassname"><span class="pre">Validation.</span></span><span class="sig-name descname"><span class="pre">circ_scatter_index</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">theta1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">theta2</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">degrees</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/Validation.html#circ_scatter_index"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#Validation.circ_scatter_index" title="Permalink to this definition">¶</a></dt>
+<dd><p>Validation Metric (Circular): Scatter index</p>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="Validation.corr_coef">
+<span class="sig-prename descclassname"><span class="pre">Validation.</span></span><span class="sig-name descname"><span class="pre">corr_coef</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">model</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">obs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/Validation.html#corr_coef"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#Validation.corr_coef" title="Permalink to this definition">¶</a></dt>
+<dd><p>Validation Metric: Correlation Coefficient</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters</dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>model</strong> – model data time series</p></li>
+<li><p><strong>obs</strong> – observation time series mapped onto model time stamps</p></li>
+</ul>
+</dd>
+<dt class="field-even">Returns</dt>
+<dd class="field-even"><p>R</p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="Validation.display_tabulated_results">
+<span class="sig-prename descclassname"><span class="pre">Validation.</span></span><span class="sig-name descname"><span class="pre">display_tabulated_results</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">store</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mVarName</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/Validation.html#display_tabulated_results"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#Validation.display_tabulated_results" title="Permalink to this definition">¶</a></dt>
+<dd><p>Display validation results as a table on the standard output</p>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="Validation.extract_model">
+<span class="sig-prename descclassname"><span class="pre">Validation.</span></span><span class="sig-name descname"><span class="pre">extract_model</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">rscdfile</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mVarName</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3.7/library/stdtypes.html#str" title="(in Python v3.7)"><span class="pre">str</span></a></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/Validation.html#extract_model"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#Validation.extract_model" title="Permalink to this definition">¶</a></dt>
+<dd><p>Extract model output for a specified variable</p>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="Validation.extract_obs">
+<span class="sig-prename descclassname"><span class="pre">Validation.</span></span><span class="sig-name descname"><span class="pre">extract_obs</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">buoyfile</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">buoyDataFmt</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3.7/library/stdtypes.html#str" title="(in Python v3.7)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">varOptions</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3.7/library/stdtypes.html#list" title="(in Python v3.7)"><span class="pre">list</span></a></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/Validation.html#extract_obs"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#Validation.extract_obs" title="Permalink to this definition">¶</a></dt>
+<dd><p>Extract <em>in situ</em> buoy data for a specified data foramt and variable</p>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="Validation.getSurfaceIndx">
+<span class="sig-prename descclassname"><span class="pre">Validation.</span></span><span class="sig-name descname"><span class="pre">getSurfaceIndx</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">record</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dataFmt</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/Validation.html#getSurfaceIndx"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#Validation.getSurfaceIndx" title="Permalink to this definition">¶</a></dt>
+<dd><p>Get index of surface layer in depth data</p>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="Validation.getVarName">
+<span class="sig-prename descclassname"><span class="pre">Validation.</span></span><span class="sig-name descname"><span class="pre">getVarName</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">record</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Options</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3.7/library/stdtypes.html#list" title="(in Python v3.7)"><span class="pre">list</span></a></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/Validation.html#getVarName"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#Validation.getVarName" title="Permalink to this definition">¶</a></dt>
+<dd><p>Get variable names based on processsing options list</p>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="Validation.initialize_results">
+<span class="sig-prename descclassname"><span class="pre">Validation.</span></span><span class="sig-name descname"><span class="pre">initialize_results</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/Validation.html#initialize_results"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#Validation.initialize_results" title="Permalink to this definition">¶</a></dt>
+<dd><p>Initialise a dictionary for collecting validation results</p>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="Validation.load_binary_results">
+<span class="sig-prename descclassname"><span class="pre">Validation.</span></span><span class="sig-name descname"><span class="pre">load_binary_results</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">platform</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mVarName</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">datapath</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/Validation.html#load_binary_results"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#Validation.load_binary_results" title="Permalink to this definition">¶</a></dt>
+<dd><p>load binary results from a matlab file</p>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="Validation.mean_absolute_error">
+<span class="sig-prename descclassname"><span class="pre">Validation.</span></span><span class="sig-name descname"><span class="pre">mean_absolute_error</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">model</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">obs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/Validation.html#mean_absolute_error"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#Validation.mean_absolute_error" title="Permalink to this definition">¶</a></dt>
+<dd><p>Validation Metric: Mean absolute error</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters</dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>model</strong> – model data time series</p></li>
+<li><p><strong>obs</strong> – observation time series mapped onto model time stamps</p></li>
+</ul>
+</dd>
+<dt class="field-even">Returns</dt>
+<dd class="field-even"><p>mae</p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="Validation.mean_bias">
+<span class="sig-prename descclassname"><span class="pre">Validation.</span></span><span class="sig-name descname"><span class="pre">mean_bias</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">model</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">obs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/Validation.html#mean_bias"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#Validation.mean_bias" title="Permalink to this definition">¶</a></dt>
+<dd><p>Validation Metric: Mean Bias</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters</dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>model</strong> – model data time series</p></li>
+<li><p><strong>obs</strong> – observation time series mapped onto model time stamps</p></li>
+</ul>
+</dd>
+<dt class="field-even">Returns</dt>
+<dd class="field-even"><p>mb</p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="Validation.model_efficiency">
+<span class="sig-prename descclassname"><span class="pre">Validation.</span></span><span class="sig-name descname"><span class="pre">model_efficiency</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">model</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">obs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/Validation.html#model_efficiency"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#Validation.model_efficiency" title="Permalink to this definition">¶</a></dt>
+<dd><p>Validation Metric: Model efficiency</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters</dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>model</strong> – model data time series</p></li>
+<li><p><strong>obs</strong> – observation time series mapped onto model time stamps</p></li>
+</ul>
+</dd>
+<dt class="field-even">Returns</dt>
+<dd class="field-even"><p>mef</p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="Validation.norm_ma_error">
+<span class="sig-prename descclassname"><span class="pre">Validation.</span></span><span class="sig-name descname"><span class="pre">norm_ma_error</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">model</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">obs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/Validation.html#norm_ma_error"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#Validation.norm_ma_error" title="Permalink to this definition">¶</a></dt>
+<dd><p>Validation Metric: Normalised mean absolute error</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters</dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>model</strong> – model data time series</p></li>
+<li><p><strong>obs</strong> – observation time series mapped onto model time stamps</p></li>
+</ul>
+</dd>
+<dt class="field-even">Returns</dt>
+<dd class="field-even"><p>nmae</p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="Validation.norm_mean_bias">
+<span class="sig-prename descclassname"><span class="pre">Validation.</span></span><span class="sig-name descname"><span class="pre">norm_mean_bias</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">model</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">obs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/Validation.html#norm_mean_bias"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#Validation.norm_mean_bias" title="Permalink to this definition">¶</a></dt>
+<dd><p>Validation Metric: Normalised mean bias</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters</dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>model</strong> – model data time series</p></li>
+<li><p><strong>obs</strong> – observation time series mapped onto model time stamps</p></li>
+</ul>
+</dd>
+<dt class="field-even">Returns</dt>
+<dd class="field-even"><p>nmb</p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="Validation.norm_rmse">
+<span class="sig-prename descclassname"><span class="pre">Validation.</span></span><span class="sig-name descname"><span class="pre">norm_rmse</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">model</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">obs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/Validation.html#norm_rmse"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#Validation.norm_rmse" title="Permalink to this definition">¶</a></dt>
+<dd><p>Validation Metric: Normalised root-mean-square error</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters</dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>model</strong> – model data time series</p></li>
+<li><p><strong>obs</strong> – observation time series mapped onto model time stamps</p></li>
+</ul>
+</dd>
+<dt class="field-even">Returns</dt>
+<dd class="field-even"><p>nrmse</p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="Validation.process_record">
+<span class="sig-prename descclassname"><span class="pre">Validation.</span></span><span class="sig-name descname"><span class="pre">process_record</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">rec</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">buoyFmt</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3.7/library/stdtypes.html#str" title="(in Python v3.7)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">platform</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3.7/library/stdtypes.html#str" title="(in Python v3.7)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">mVarName</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3.7/library/stdtypes.html#str" title="(in Python v3.7)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">varOptions</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3.7/library/stdtypes.html#list" title="(in Python v3.7)"><span class="pre">list</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">pVarName</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3.7/library/stdtypes.html#str" title="(in Python v3.7)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">results_dir</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3.7/library/stdtypes.html#str" title="(in Python v3.7)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">angularData</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">plot_results</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/Validation.html#process_record"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#Validation.process_record" title="Permalink to this definition">¶</a></dt>
+<dd><p>Process a matched model/buoy data record</p>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="Validation.reliability_index">
+<span class="sig-prename descclassname"><span class="pre">Validation.</span></span><span class="sig-name descname"><span class="pre">reliability_index</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">model</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">obs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/Validation.html#reliability_index"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#Validation.reliability_index" title="Permalink to this definition">¶</a></dt>
+<dd><p>Validation Metric: Reliability index</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters</dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>model</strong> – model data time series</p></li>
+<li><p><strong>obs</strong> – observation time series mapped onto model time stamps</p></li>
+</ul>
+</dd>
+<dt class="field-even">Returns</dt>
+<dd class="field-even"><p>ri</p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="Validation.results_record">
+<span class="sig-prename descclassname"><span class="pre">Validation.</span></span><span class="sig-name descname"><span class="pre">results_record</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">modelFileName</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">obsFileName</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">obsVarName</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">year</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">month</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">metrics</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/Validation.html#results_record"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#Validation.results_record" title="Permalink to this definition">¶</a></dt>
+<dd><p>Create results recod from calculated validation metrics</p>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="Validation.rms_error">
+<span class="sig-prename descclassname"><span class="pre">Validation.</span></span><span class="sig-name descname"><span class="pre">rms_error</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">model</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">obs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/Validation.html#rms_error"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#Validation.rms_error" title="Permalink to this definition">¶</a></dt>
+<dd><p>Validation Metric: Root-mean-square error</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters</dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>model</strong> – model data time series</p></li>
+<li><p><strong>obs</strong> – observation time series mapped onto model time stamps</p></li>
+</ul>
+</dd>
+<dt class="field-even">Returns</dt>
+<dd class="field-even"><p>rmse</p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="Validation.save_cleaned_ts_data">
+<span class="sig-prename descclassname"><span class="pre">Validation.</span></span><span class="sig-name descname"><span class="pre">save_cleaned_ts_data</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">t</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">rscd</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">buoy</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">platform</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mVarName</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">outpath</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">year</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">month</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/Validation.html#save_cleaned_ts_data"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#Validation.save_cleaned_ts_data" title="Permalink to this definition">¶</a></dt>
+<dd><p>Save cleaned matched model and buoy timeseries as a matlab *.mat binary file</p>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="Validation.save_tabulated_results">
+<span class="sig-prename descclassname"><span class="pre">Validation.</span></span><span class="sig-name descname"><span class="pre">save_tabulated_results</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">store</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">platform</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mVarName</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">outpath</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/Validation.html#save_tabulated_results"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#Validation.save_tabulated_results" title="Permalink to this definition">¶</a></dt>
+<dd><p>Save tabulated validation results as an ASCII file</p>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="Validation.scatter_index">
+<span class="sig-prename descclassname"><span class="pre">Validation.</span></span><span class="sig-name descname"><span class="pre">scatter_index</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">model</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">obs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/Validation.html#scatter_index"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#Validation.scatter_index" title="Permalink to this definition">¶</a></dt>
+<dd><p>Validation Metric: Scatter index</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters</dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>model</strong> – model data time series</p></li>
+<li><p><strong>obs</strong> – observation time series mapped onto model time stamps</p></li>
+</ul>
+</dd>
+<dt class="field-even">Returns</dt>
+<dd class="field-even"><p>si</p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="Validation.skill_score">
+<span class="sig-prename descclassname"><span class="pre">Validation.</span></span><span class="sig-name descname"><span class="pre">skill_score</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">model</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">obs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/Validation.html#skill_score"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#Validation.skill_score" title="Permalink to this definition">¶</a></dt>
+<dd><p>Validation Metric: Skill score</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters</dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>model</strong> – model data time series</p></li>
+<li><p><strong>obs</strong> – observation time series mapped onto model time stamps</p></li>
+</ul>
+</dd>
+<dt class="field-even">Returns</dt>
+<dd class="field-even"><p>ss</p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="Validation.store_valid_results">
+<span class="sig-prename descclassname"><span class="pre">Validation.</span></span><span class="sig-name descname"><span class="pre">store_valid_results</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">store</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">results</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/Validation.html#store_valid_results"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#Validation.store_valid_results" title="Permalink to this definition">¶</a></dt>
+<dd><p>Store validation results record in the results dictionary</p>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="Validation.time_interpolate_obs">
+<span class="sig-prename descclassname"><span class="pre">Validation.</span></span><span class="sig-name descname"><span class="pre">time_interpolate_obs</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">t_obs</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">t_var</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">t_model</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/Validation.html#time_interpolate_obs"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#Validation.time_interpolate_obs" title="Permalink to this definition">¶</a></dt>
+<dd><p>Interpolation of observation data onto the model output timestamps</p>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="Validation.validate_records">
+<span class="sig-prename descclassname"><span class="pre">Validation.</span></span><span class="sig-name descname"><span class="pre">validate_records</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">records</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dataFmt</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3.7/library/stdtypes.html#str" title="(in Python v3.7)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">platform</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3.7/library/stdtypes.html#str" title="(in Python v3.7)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">mVarName</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3.7/library/stdtypes.html#str" title="(in Python v3.7)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">varOptions</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3.7/library/stdtypes.html#list" title="(in Python v3.7)"><span class="pre">list</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">pVarName</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">results_dir</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">plot_results</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/Validation.html#validate_records"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#Validation.validate_records" title="Permalink to this definition">¶</a></dt>
+<dd><p>Process a set of matched model/buoy data records</p>
+</dd></dl>
+
+</section>
+
+
+ <div class="clearer"></div>
+ </div>
+ </div>
+ </div>
+ <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+ <div class="sphinxsidebarwrapper">
+ <h4>Previous topic</h4>
+ <p class="topless"><a href="data_access.html"
+ title="previous chapter">External data archives</a></p>
+ <h4>Next topic</h4>
+ <p class="topless"><a href="MatchUpDatabase.html"
+ title="next chapter">MatchUpDatabase</a></p>
+ <div role="note" aria-label="source link">
+ <h3>This Page</h3>
+ <ul class="this-page-menu">
+ <li><a href="_sources/Validation.rst.txt"
+ rel="nofollow">Show Source</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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
+ <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="MatchUpDatabase.html" title="MatchUpDatabase"
+ >next</a> |</li>
+ <li class="right" >
+ <a href="data_access.html" title="External data archives"
+ >previous</a> |</li>
+ <li class="nav-item nav-item-0"><a href="index.html">WaveVal documentation</a> »</li>
+ <li class="nav-item nav-item-this"><a href="">Validation</a></li>
+ </ul>
+ </div>
+ <div class="footer" role="contentinfo">
+ © Copyright 2022.
+ Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 4.3.0.
+ </div>
+ </body>
+</html>
\ No newline at end of file
diff --git a/docs/_build/html/WaveSpectra.html b/docs/_build/html/WaveSpectra.html
new file mode 100644
index 0000000000000000000000000000000000000000..42b2eb8afa657a44dc6c4201543a6b5c08853233
--- /dev/null
+++ b/docs/_build/html/WaveSpectra.html
@@ -0,0 +1,316 @@
+
+
+<!doctype html>
+
+<html lang="en">
+ <head>
+ <meta charset="utf-8" />
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
+
+ <title>WaveSpectra — WaveVal documentation</title>
+ <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
+ <link rel="stylesheet" type="text/css" href="_static/bizstyle.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 src="_static/bizstyle.js"></script>
+ <link rel="author" title="About these documents" href="about.html" />
+ <link rel="index" title="Index" href="genindex.html" />
+ <link rel="search" title="Search" href="search.html" />
+ <link rel="next" title="ModelData" href="ModelData.html" />
+ <link rel="prev" title="WaveStats" href="WaveStats.html" />
+ <meta name="viewport" content="width=device-width,initial-scale=1.0" />
+ <!--[if lt IE 9]>
+ <script src="_static/css3-mediaqueries.js"></script>
+ <![endif]-->
+ </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="ModelData.html" title="ModelData"
+ accesskey="N">next</a> |</li>
+ <li class="right" >
+ <a href="WaveStats.html" title="WaveStats"
+ accesskey="P">previous</a> |</li>
+ <li class="nav-item nav-item-0"><a href="index.html">WaveVal documentation</a> »</li>
+ <li class="nav-item nav-item-this"><a href="">WaveSpectra</a></li>
+ </ul>
+ </div>
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body" role="main">
+
+ <section id="module-WaveSpectra">
+<span id="wavespectra"></span><h1>WaveSpectra<a class="headerlink" href="#module-WaveSpectra" title="Permalink to this headline">¶</a></h1>
+<p>This module contains functions for calculating intergated wave parameters and
+reconstructing 2-D wave spectra from spectral parameters.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Dependencies [External]</dt>
+<dd class="field-odd"><p>numpy</p>
+</dd>
+<dt class="field-even">Dependencies [Internal]</dt>
+<dd class="field-even"><p></p></dd>
+</dl>
+<dl class="py function">
+<dt class="sig sig-object py" id="WaveSpectra.dsfunc">
+<span class="sig-prename descclassname"><span class="pre">WaveSpectra.</span></span><span class="sig-name descname"><span class="pre">dsfunc</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">freq</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">df</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">th1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">th2</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sth1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sth2</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ntheta</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/WaveSpectra.html#dsfunc"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#WaveSpectra.dsfunc" title="Permalink to this definition">¶</a></dt>
+<dd><p>Directional spreading function</p>
+<p>Based on description of <a class="reference external" href="https://forge.ifremer.fr/plugins/mediawiki/wiki/ww3/index.php/En:buoy_data:meds">MEDS</a>
+buoy data format given on the IFREMER Wiki pages.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters</dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>freq</strong> – </p></li>
+<li><p><strong>df</strong> – </p></li>
+<li><p><strong>th1</strong> – </p></li>
+<li><p><strong>th2</strong> – </p></li>
+<li><p><strong>sth1</strong> – </p></li>
+<li><p><strong>sth2</strong> – </p></li>
+<li><p><strong>ntheta</strong> – </p></li>
+</ul>
+</dd>
+<dt class="field-even">Returns</dt>
+<dd class="field-even"><p>dsFnc</p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="WaveSpectra.dsfuncnorm">
+<span class="sig-prename descclassname"><span class="pre">WaveSpectra.</span></span><span class="sig-name descname"><span class="pre">dsfuncnorm</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">freq</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">df</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">th1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sth1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ntheta</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/WaveSpectra.html#dsfuncnorm"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#WaveSpectra.dsfuncnorm" title="Permalink to this definition">¶</a></dt>
+<dd><p>Normalised 2-D directional spreading function</p>
+<p>Based on description given on NOAA <a class="reference external" href="https://www.ndbc.noaa.gov/measdes.shtml">NDBC</a> web site.</p>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="WaveSpectra.getSpectralMoments">
+<span class="sig-prename descclassname"><span class="pre">WaveSpectra.</span></span><span class="sig-name descname"><span class="pre">getSpectralMoments</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">f</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">df</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">S</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/WaveSpectra.html#getSpectralMoments"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#WaveSpectra.getSpectralMoments" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="WaveSpectra.getSpectralParameters">
+<span class="sig-prename descclassname"><span class="pre">WaveSpectra.</span></span><span class="sig-name descname"><span class="pre">getSpectralParameters</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">moments</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/WaveSpectra.html#getSpectralParameters"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#WaveSpectra.getSpectralParameters" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="WaveSpectra.mean_wave_period">
+<span class="sig-prename descclassname"><span class="pre">WaveSpectra.</span></span><span class="sig-name descname"><span class="pre">mean_wave_period</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">moments</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/WaveSpectra.html#mean_wave_period"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#WaveSpectra.mean_wave_period" title="Permalink to this definition">¶</a></dt>
+<dd><p>Integrated Wave Parameter: Mean wave period</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters</dt>
+<dd class="field-odd"><p><strong>moments</strong> – Spectral moments calculated from the wave energy spectrum using <code class="xref py py-func docutils literal notranslate"><span class="pre">WaveVal.WaveSpectra.spectralMoment()</span></code>.</p>
+</dd>
+<dt class="field-even">Returns</dt>
+<dd class="field-even"><p>Tm01.</p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="WaveSpectra.significant_wave_height">
+<span class="sig-prename descclassname"><span class="pre">WaveSpectra.</span></span><span class="sig-name descname"><span class="pre">significant_wave_height</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">moments</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/WaveSpectra.html#significant_wave_height"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#WaveSpectra.significant_wave_height" title="Permalink to this definition">¶</a></dt>
+<dd><p>Integrated Wave Parameter: Significant wave height</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters</dt>
+<dd class="field-odd"><p><strong>moments</strong> – Spectral moments calculated from the wave energy spectrum using <code class="xref py py-func docutils literal notranslate"><span class="pre">WaveVal.WaveSpectra.spectralMoment()</span></code>.</p>
+</dd>
+<dt class="field-even">Returns</dt>
+<dd class="field-even"><p>Hm0.</p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="WaveSpectra.spec2d">
+<span class="sig-prename descclassname"><span class="pre">WaveSpectra.</span></span><span class="sig-name descname"><span class="pre">spec2d</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">freq</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sf</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">df</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">th1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">th2</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sth1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sth2</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ntheta</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/WaveSpectra.html#spec2d"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#WaveSpectra.spec2d" title="Permalink to this definition">¶</a></dt>
+<dd><p>Generate 2-D directional spectrum from standard parameters retrieve from
+a wavebuoy.</p>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="WaveSpectra.spec2dnorm">
+<span class="sig-prename descclassname"><span class="pre">WaveSpectra.</span></span><span class="sig-name descname"><span class="pre">spec2dnorm</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">freq</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sf</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">df</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">th1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sth1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ntheta</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/WaveSpectra.html#spec2dnorm"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#WaveSpectra.spec2dnorm" title="Permalink to this definition">¶</a></dt>
+<dd><p>Generate normlaised 2-D directional spectrum from standard parameters retrieve
+from a wavebuoy.</p>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="WaveSpectra.spectralMoment">
+<span class="sig-prename descclassname"><span class="pre">WaveSpectra.</span></span><span class="sig-name descname"><span class="pre">spectralMoment</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">f</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">df</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">S</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">moment</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/WaveSpectra.html#spectralMoment"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#WaveSpectra.spectralMoment" title="Permalink to this definition">¶</a></dt>
+<dd><dl class="field-list simple">
+<dt class="field-odd">Parameters</dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>f</strong> – frequency bin centre values</p></li>
+<li><p><strong>df</strong> – frequency bin widths</p></li>
+<li><p><strong>S</strong> – spectral energy density in frquency bins</p></li>
+<li><p><strong>moment</strong> – interger representing moment to be calculated</p></li>
+</ul>
+</dd>
+<dt class="field-even">Returns</dt>
+<dd class="field-even"><p>specMom</p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="WaveSpectra.spectral_narrowness">
+<span class="sig-prename descclassname"><span class="pre">WaveSpectra.</span></span><span class="sig-name descname"><span class="pre">spectral_narrowness</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">moments</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/WaveSpectra.html#spectral_narrowness"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#WaveSpectra.spectral_narrowness" title="Permalink to this definition">¶</a></dt>
+<dd><p>Integrated Wave Parameter: Spectral narrowness</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters</dt>
+<dd class="field-odd"><p><strong>moments</strong> – Spectral moments calculated from the wave energy spectrum using <code class="xref py py-func docutils literal notranslate"><span class="pre">WaveVal.WaveSpectra.spectralMoment()</span></code>.</p>
+</dd>
+<dt class="field-even">Returns</dt>
+<dd class="field-even"><p>nu.</p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="WaveSpectra.spectral_period">
+<span class="sig-prename descclassname"><span class="pre">WaveSpectra.</span></span><span class="sig-name descname"><span class="pre">spectral_period</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">moments</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/WaveSpectra.html#spectral_period"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#WaveSpectra.spectral_period" title="Permalink to this definition">¶</a></dt>
+<dd><p>Integrated Wave Parameter: Peak spectral period</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters</dt>
+<dd class="field-odd"><p><strong>moments</strong> – Spectral moments calculated from the wave energy spectrum using <code class="xref py py-func docutils literal notranslate"><span class="pre">WaveVal.WaveSpectra.spectralMoment()</span></code>.</p>
+</dd>
+<dt class="field-even">Returns</dt>
+<dd class="field-even"><p>Tm02.</p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="WaveSpectra.spectral_width">
+<span class="sig-prename descclassname"><span class="pre">WaveSpectra.</span></span><span class="sig-name descname"><span class="pre">spectral_width</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">moments</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/WaveSpectra.html#spectral_width"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#WaveSpectra.spectral_width" title="Permalink to this definition">¶</a></dt>
+<dd><p>Integrated Wave Parameter: Spectral width</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters</dt>
+<dd class="field-odd"><p><strong>moments</strong> – Spectral moments calculated from the wave energy spectrum using <code class="xref py py-func docutils literal notranslate"><span class="pre">WaveVal.WaveSpectra.spectralMoment()</span></code>.</p>
+</dd>
+<dt class="field-even">Returns</dt>
+<dd class="field-even"><p>eps.</p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="WaveSpectra.wave_energy_period">
+<span class="sig-prename descclassname"><span class="pre">WaveSpectra.</span></span><span class="sig-name descname"><span class="pre">wave_energy_period</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">moments</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/WaveSpectra.html#wave_energy_period"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#WaveSpectra.wave_energy_period" title="Permalink to this definition">¶</a></dt>
+<dd><p>Integrated Wave Parameter: Wave energy period</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters</dt>
+<dd class="field-odd"><p><strong>moments</strong> – Spectral moments calculated from the wave energy spectrum using <code class="xref py py-func docutils literal notranslate"><span class="pre">WaveVal.WaveSpectra.spectralMoment()</span></code>.</p>
+</dd>
+<dt class="field-even">Returns</dt>
+<dd class="field-even"><p>Tm10.</p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="WaveSpectra.wave_steepness">
+<span class="sig-prename descclassname"><span class="pre">WaveSpectra.</span></span><span class="sig-name descname"><span class="pre">wave_steepness</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">moments</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/WaveSpectra.html#wave_steepness"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#WaveSpectra.wave_steepness" title="Permalink to this definition">¶</a></dt>
+<dd><p>Integrated Wave Parameter: Wave steepness</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters</dt>
+<dd class="field-odd"><p><strong>moments</strong> – Spectral moments calculated from the wave energy spectrum using <code class="xref py py-func docutils literal notranslate"><span class="pre">WaveVal.WaveSpectra.spectralMoment()</span></code>.</p>
+</dd>
+<dt class="field-even">Returns</dt>
+<dd class="field-even"><p>Tdw2.</p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="WaveSpectra.wavehgtvar">
+<span class="sig-prename descclassname"><span class="pre">WaveSpectra.</span></span><span class="sig-name descname"><span class="pre">wavehgtvar</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">freq</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">df</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dt</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">spec2D</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/WaveSpectra.html#wavehgtvar"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#WaveSpectra.wavehgtvar" title="Permalink to this definition">¶</a></dt>
+<dd><p>Convert 2-D wave spectrum into wave height variance map in (f,theta) space.</p>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="WaveSpectra.zero_crossing_period">
+<span class="sig-prename descclassname"><span class="pre">WaveSpectra.</span></span><span class="sig-name descname"><span class="pre">zero_crossing_period</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">moments</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/WaveSpectra.html#zero_crossing_period"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#WaveSpectra.zero_crossing_period" title="Permalink to this definition">¶</a></dt>
+<dd><p>Integrated Wave Parameter: Zero crossing period</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters</dt>
+<dd class="field-odd"><p><strong>moments</strong> – Spectral moments calculated from the wave energy spectrum using <code class="xref py py-func docutils literal notranslate"><span class="pre">WaveVal.WaveSpectra.spectralMoment()</span></code>.</p>
+</dd>
+<dt class="field-even">Returns</dt>
+<dd class="field-even"><p>Tm02.</p>
+</dd>
+</dl>
+</dd></dl>
+
+</section>
+
+
+ <div class="clearer"></div>
+ </div>
+ </div>
+ </div>
+ <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+ <div class="sphinxsidebarwrapper">
+ <h4>Previous topic</h4>
+ <p class="topless"><a href="WaveStats.html"
+ title="previous chapter">WaveStats</a></p>
+ <h4>Next topic</h4>
+ <p class="topless"><a href="ModelData.html"
+ title="next chapter">ModelData</a></p>
+ <div role="note" aria-label="source link">
+ <h3>This Page</h3>
+ <ul class="this-page-menu">
+ <li><a href="_sources/WaveSpectra.rst.txt"
+ rel="nofollow">Show Source</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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
+ <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="ModelData.html" title="ModelData"
+ >next</a> |</li>
+ <li class="right" >
+ <a href="WaveStats.html" title="WaveStats"
+ >previous</a> |</li>
+ <li class="nav-item nav-item-0"><a href="index.html">WaveVal documentation</a> »</li>
+ <li class="nav-item nav-item-this"><a href="">WaveSpectra</a></li>
+ </ul>
+ </div>
+ <div class="footer" role="contentinfo">
+ © Copyright 2022.
+ Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 4.3.0.
+ </div>
+ </body>
+</html>
\ No newline at end of file
diff --git a/docs/_build/html/WaveStats.html b/docs/_build/html/WaveStats.html
new file mode 100644
index 0000000000000000000000000000000000000000..befa32f17616764111ed886f1d2e3e7d7d49e853
--- /dev/null
+++ b/docs/_build/html/WaveStats.html
@@ -0,0 +1,164 @@
+
+
+<!doctype html>
+
+<html lang="en">
+ <head>
+ <meta charset="utf-8" />
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
+
+ <title>WaveStats — WaveVal documentation</title>
+ <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
+ <link rel="stylesheet" type="text/css" href="_static/bizstyle.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 src="_static/bizstyle.js"></script>
+ <link rel="author" title="About these documents" href="about.html" />
+ <link rel="index" title="Index" href="genindex.html" />
+ <link rel="search" title="Search" href="search.html" />
+ <link rel="next" title="WaveSpectra" href="WaveSpectra.html" />
+ <link rel="prev" title="MatchUpDatabase" href="MatchUpDatabase.html" />
+ <meta name="viewport" content="width=device-width,initial-scale=1.0" />
+ <!--[if lt IE 9]>
+ <script src="_static/css3-mediaqueries.js"></script>
+ <![endif]-->
+ </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="WaveSpectra.html" title="WaveSpectra"
+ accesskey="N">next</a> |</li>
+ <li class="right" >
+ <a href="MatchUpDatabase.html" title="MatchUpDatabase"
+ accesskey="P">previous</a> |</li>
+ <li class="nav-item nav-item-0"><a href="index.html">WaveVal documentation</a> »</li>
+ <li class="nav-item nav-item-this"><a href="">WaveStats</a></li>
+ </ul>
+ </div>
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body" role="main">
+
+ <section id="module-WaveStats">
+<span id="wavestats"></span><h1>WaveStats<a class="headerlink" href="#module-WaveStats" title="Permalink to this headline">¶</a></h1>
+<p>This module contains functions for post-processing the validation statistics.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Dependencies [External]</dt>
+<dd class="field-odd"><p>os, scipy, numpy</p>
+</dd>
+<dt class="field-even">Dependencies [Internal]</dt>
+<dd class="field-even"><p></p></dd>
+</dl>
+<dl class="py function">
+<dt class="sig sig-object py" id="WaveStats.get_buoy_locations">
+<span class="sig-prename descclassname"><span class="pre">WaveStats.</span></span><span class="sig-name descname"><span class="pre">get_buoy_locations</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">records</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/WaveStats.html#get_buoy_locations"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#WaveStats.get_buoy_locations" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="WaveStats.get_metric_stats_by_buoy">
+<span class="sig-prename descclassname"><span class="pre">WaveStats.</span></span><span class="sig-name descname"><span class="pre">get_metric_stats_by_buoy</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dpath</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">files</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">metric</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3.7/library/stdtypes.html#str" title="(in Python v3.7)"><span class="pre">str</span></a></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/WaveStats.html#get_metric_stats_by_buoy"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#WaveStats.get_metric_stats_by_buoy" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="WaveStats.get_metric_stats_by_year">
+<span class="sig-prename descclassname"><span class="pre">WaveStats.</span></span><span class="sig-name descname"><span class="pre">get_metric_stats_by_year</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dpath</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">files</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">metric</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3.7/library/stdtypes.html#str" title="(in Python v3.7)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">yr</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3.7/library/functions.html#int" title="(in Python v3.7)"><span class="pre">int</span></a></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/WaveStats.html#get_metric_stats_by_year"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#WaveStats.get_metric_stats_by_year" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="WaveStats.get_metric_stats_global">
+<span class="sig-prename descclassname"><span class="pre">WaveStats.</span></span><span class="sig-name descname"><span class="pre">get_metric_stats_global</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dpath</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">files</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">metric</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3.7/library/stdtypes.html#str" title="(in Python v3.7)"><span class="pre">str</span></a></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/WaveStats.html#get_metric_stats_global"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#WaveStats.get_metric_stats_global" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="WaveStats.get_parameter_stats_by_buoy">
+<span class="sig-prename descclassname"><span class="pre">WaveStats.</span></span><span class="sig-name descname"><span class="pre">get_parameter_stats_by_buoy</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dpath</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3.7/library/stdtypes.html#str" title="(in Python v3.7)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">param</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3.7/library/stdtypes.html#str" title="(in Python v3.7)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">metric</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3.7/library/stdtypes.html#str" title="(in Python v3.7)"><span class="pre">str</span></a></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/WaveStats.html#get_parameter_stats_by_buoy"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#WaveStats.get_parameter_stats_by_buoy" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="WaveStats.get_parameter_stats_by_year">
+<span class="sig-prename descclassname"><span class="pre">WaveStats.</span></span><span class="sig-name descname"><span class="pre">get_parameter_stats_by_year</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dpath</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3.7/library/stdtypes.html#str" title="(in Python v3.7)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">param</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3.7/library/stdtypes.html#str" title="(in Python v3.7)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">metricStr</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3.7/library/stdtypes.html#list" title="(in Python v3.7)"><span class="pre">list</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">year</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3.7/library/functions.html#int" title="(in Python v3.7)"><span class="pre">int</span></a></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/WaveStats.html#get_parameter_stats_by_year"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#WaveStats.get_parameter_stats_by_year" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="WaveStats.get_parameter_stats_global">
+<span class="sig-prename descclassname"><span class="pre">WaveStats.</span></span><span class="sig-name descname"><span class="pre">get_parameter_stats_global</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dpath</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3.7/library/stdtypes.html#str" title="(in Python v3.7)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">param</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3.7/library/stdtypes.html#str" title="(in Python v3.7)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">metricStr</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3.7/library/stdtypes.html#list" title="(in Python v3.7)"><span class="pre">list</span></a></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/WaveStats.html#get_parameter_stats_global"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#WaveStats.get_parameter_stats_global" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="WaveStats.test_for_failure">
+<span class="sig-prename descclassname"><span class="pre">WaveStats.</span></span><span class="sig-name descname"><span class="pre">test_for_failure</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">meanV</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">metric</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3.7/library/stdtypes.html#str" title="(in Python v3.7)"><span class="pre">str</span></a></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/WaveStats.html#test_for_failure"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#WaveStats.test_for_failure" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</section>
+
+
+ <div class="clearer"></div>
+ </div>
+ </div>
+ </div>
+ <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+ <div class="sphinxsidebarwrapper">
+ <h4>Previous topic</h4>
+ <p class="topless"><a href="MatchUpDatabase.html"
+ title="previous chapter">MatchUpDatabase</a></p>
+ <h4>Next topic</h4>
+ <p class="topless"><a href="WaveSpectra.html"
+ title="next chapter">WaveSpectra</a></p>
+ <div role="note" aria-label="source link">
+ <h3>This Page</h3>
+ <ul class="this-page-menu">
+ <li><a href="_sources/WaveStats.rst.txt"
+ rel="nofollow">Show Source</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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
+ <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="WaveSpectra.html" title="WaveSpectra"
+ >next</a> |</li>
+ <li class="right" >
+ <a href="MatchUpDatabase.html" title="MatchUpDatabase"
+ >previous</a> |</li>
+ <li class="nav-item nav-item-0"><a href="index.html">WaveVal documentation</a> »</li>
+ <li class="nav-item nav-item-this"><a href="">WaveStats</a></li>
+ </ul>
+ </div>
+ <div class="footer" role="contentinfo">
+ © Copyright 2022.
+ Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 4.3.0.
+ </div>
+ </body>
+</html>
\ No newline at end of file
diff --git a/docs/_build/html/_images/waveval_example.png b/docs/_build/html/_images/waveval_example.png
new file mode 100644
index 0000000000000000000000000000000000000000..5c05dce84017e09a1f6a0c34ea49682910078ca5
Binary files /dev/null and b/docs/_build/html/_images/waveval_example.png differ
diff --git a/docs/_build/html/_modules/DataFormats.html b/docs/_build/html/_modules/DataFormats.html
new file mode 100644
index 0000000000000000000000000000000000000000..b9dc480a69680bfb36cac065422ae2406b3ec8a4
--- /dev/null
+++ b/docs/_build/html/_modules/DataFormats.html
@@ -0,0 +1,263 @@
+
+
+<!doctype html>
+
+<html lang="en">
+ <head>
+ <meta charset="utf-8" />
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+ <title>DataFormats — WaveVal documentation</title>
+ <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
+ <link rel="stylesheet" type="text/css" href="../_static/bizstyle.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 src="../_static/bizstyle.js"></script>
+ <link rel="author" title="About these documents" href="../about.html" />
+ <link rel="index" title="Index" href="../genindex.html" />
+ <link rel="search" title="Search" href="../search.html" />
+ <meta name="viewport" content="width=device-width,initial-scale=1.0" />
+ <!--[if lt IE 9]>
+ <script src="_static/css3-mediaqueries.js"></script>
+ <![endif]-->
+ </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="nav-item nav-item-0"><a href="../index.html">WaveVal documentation</a> »</li>
+ <li class="nav-item nav-item-1"><a href="index.html" accesskey="U">Module code</a> »</li>
+ <li class="nav-item nav-item-this"><a href="">DataFormats</a></li>
+ </ul>
+ </div>
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body" role="main">
+
+ <h1>Source code for DataFormats</h1><div class="highlight"><pre>
+<span></span><span class="c1"># -*- coding: utf-8 -*-</span>
+<span class="sd">"""</span>
+<span class="sd">Generic base data format class structures for building loaders for specific </span>
+<span class="sd">data set.</span>
+
+<span class="sd">:Dependencies [External]: os, numpy, netCDF4</span>
+<span class="sd">:Dependencies [Internal]: </span>
+
+<span class="sd">"""</span>
+<span class="c1"># ----------------------------------------------------------------------------</span>
+<span class="c1"># IMPORTS</span>
+<span class="c1"># ----------------------------------------------------------------------------</span>
+<span class="c1"># Standard Python Dependencies</span>
+<span class="kn">import</span> <span class="nn">os</span>
+<span class="c1"># Non-Standard Python Dependencies</span>
+<span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
+<span class="kn">from</span> <span class="nn">netCDF4</span> <span class="kn">import</span> <span class="n">Dataset</span> <span class="k">as</span> <span class="n">ncdata</span>
+<span class="c1"># Local Module Dependencies</span>
+<span class="c1"># Other Dependencies</span>
+
+<span class="c1"># ----------------------------------------------------------------------------</span>
+<span class="c1"># GLOBAL VARIABLES</span>
+<span class="c1"># ----------------------------------------------------------------------------</span>
+
+
+<span class="c1"># ----------------------------------------------------------------------------</span>
+<span class="c1"># CLASS DEFINITIONS</span>
+<span class="c1"># ----------------------------------------------------------------------------</span>
+<div class="viewcode-block" id="netcdfGeneric"><a class="viewcode-back" href="../DataFormats.html#DataFormats.netcdfGeneric">[docs]</a><span class="k">class</span> <span class="nc">netcdfGeneric</span><span class="p">:</span>
+ <span class="sd">"""</span>
+<span class="sd"> Base class for loading and interogating netCDF4 data files.</span>
+<span class="sd"> """</span>
+ <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">fileName</span><span class="p">):</span>
+
+ <span class="bp">self</span><span class="o">.</span><span class="n">file</span> <span class="o">=</span> <span class="p">{}</span>
+
+ <span class="k">if</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">isfile</span><span class="p">(</span><span class="n">fileName</span><span class="p">):</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">file</span><span class="o">.</span><span class="n">update</span><span class="p">({</span><span class="s1">'name'</span><span class="p">:</span> <span class="n">fileName</span><span class="p">})</span>
+ <span class="k">with</span> <span class="n">ncdata</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">file</span><span class="p">[</span><span class="s1">'name'</span><span class="p">],</span> <span class="s1">'r'</span><span class="p">,</span> <span class="nb">format</span><span class="o">=</span><span class="s1">'NETCDF4'</span><span class="p">)</span> <span class="k">as</span> <span class="n">nc</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">file</span><span class="o">.</span><span class="n">update</span><span class="p">({</span><span class="s1">'attribs'</span><span class="p">:</span> <span class="n">nc</span><span class="o">.</span><span class="n">ncattrs</span><span class="p">()})</span>
+ <span class="n">dimNames</span> <span class="o">=</span> <span class="p">[]</span>
+ <span class="k">for</span> <span class="n">key</span> <span class="ow">in</span> <span class="n">nc</span><span class="o">.</span><span class="n">dimensions</span><span class="o">.</span><span class="n">keys</span><span class="p">():</span>
+ <span class="n">dimNames</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">nc</span><span class="o">.</span><span class="n">dimensions</span><span class="p">[</span><span class="n">key</span><span class="p">]</span><span class="o">.</span><span class="n">name</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">file</span><span class="o">.</span><span class="n">update</span><span class="p">({</span><span class="s1">'dims'</span><span class="p">:</span> <span class="n">dimNames</span><span class="p">})</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">file</span><span class="o">.</span><span class="n">update</span><span class="p">({</span><span class="s1">'vars'</span><span class="p">:</span> <span class="nb">list</span><span class="p">(</span><span class="n">nc</span><span class="o">.</span><span class="n">variables</span><span class="p">)})</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">file</span><span class="o">.</span><span class="n">update</span><span class="p">({</span><span class="s1">'name'</span><span class="p">:</span> <span class="s1">''</span><span class="p">})</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">file</span><span class="o">.</span><span class="n">update</span><span class="p">({</span><span class="s1">'attribs'</span><span class="p">:</span> <span class="p">[]})</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">file</span><span class="o">.</span><span class="n">update</span><span class="p">({</span><span class="s1">'vars'</span><span class="p">:</span> <span class="p">[]})</span>
+ <span class="nb">print</span><span class="p">(</span><span class="s1">'WARNING: File '</span><span class="o">+</span><span class="n">fileName</span><span class="o">+</span><span class="s1">' does not exist.'</span><span class="p">)</span>
+
+<div class="viewcode-block" id="netcdfGeneric.listGlobalAttr"><a class="viewcode-back" href="../DataFormats.html#DataFormats.netcdfGeneric.listGlobalAttr">[docs]</a> <span class="k">def</span> <span class="nf">listGlobalAttr</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="k">with</span> <span class="n">ncdata</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">file</span><span class="p">[</span><span class="s1">'name'</span><span class="p">],</span> <span class="s1">'r'</span><span class="p">,</span> <span class="nb">format</span><span class="o">=</span><span class="s1">'NETCDF4'</span><span class="p">)</span> <span class="k">as</span> <span class="n">nc</span><span class="p">:</span>
+ <span class="n">attrList</span> <span class="o">=</span> <span class="n">nc</span><span class="o">.</span><span class="n">ncattrs</span><span class="p">()</span>
+ <span class="k">return</span> <span class="n">attrList</span></div>
+
+<div class="viewcode-block" id="netcdfGeneric.hasGlobalAttr"><a class="viewcode-back" href="../DataFormats.html#DataFormats.netcdfGeneric.hasGlobalAttr">[docs]</a> <span class="k">def</span> <span class="nf">hasGlobalAttr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">attrName</span><span class="p">):</span>
+ <span class="k">return</span> <span class="n">attrName</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">file</span><span class="p">[</span><span class="s1">'attribs'</span><span class="p">]</span></div>
+
+<div class="viewcode-block" id="netcdfGeneric.getGlobalAttr"><a class="viewcode-back" href="../DataFormats.html#DataFormats.netcdfGeneric.getGlobalAttr">[docs]</a> <span class="k">def</span> <span class="nf">getGlobalAttr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">attrName</span><span class="p">):</span>
+ <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">hasGlobalAttr</span><span class="p">(</span><span class="n">attrName</span><span class="p">):</span>
+ <span class="k">with</span> <span class="n">ncdata</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">file</span><span class="p">[</span><span class="s1">'name'</span><span class="p">],</span> <span class="s1">'r'</span><span class="p">,</span> <span class="nb">format</span><span class="o">=</span><span class="s1">'NETCDF4'</span><span class="p">)</span> <span class="k">as</span> <span class="n">nc</span><span class="p">:</span>
+ <span class="n">attrib</span> <span class="o">=</span> <span class="n">nc</span><span class="o">.</span><span class="fm">__getattr__</span><span class="p">(</span><span class="n">attrName</span><span class="p">)</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="nb">print</span><span class="p">(</span><span class="s1">'WARNING: Global Attribute '</span><span class="o">+</span><span class="n">attrName</span><span class="o">+</span><span class="s1">' does not exist.'</span><span class="p">)</span>
+ <span class="nb">print</span><span class="p">(</span><span class="s1">'Available global attributes:'</span><span class="p">)</span>
+ <span class="nb">print</span><span class="p">(</span><span class="nb">list</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">file</span><span class="p">[</span><span class="s1">'attribs'</span><span class="p">]))</span>
+ <span class="n">attrib</span> <span class="o">=</span> <span class="kc">None</span>
+ <span class="k">return</span> <span class="n">attrib</span></div>
+
+<div class="viewcode-block" id="netcdfGeneric.listDims"><a class="viewcode-back" href="../DataFormats.html#DataFormats.netcdfGeneric.listDims">[docs]</a> <span class="k">def</span> <span class="nf">listDims</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="n">dimsList</span> <span class="o">=</span> <span class="p">[]</span>
+ <span class="k">with</span> <span class="n">ncdata</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">file</span><span class="p">[</span><span class="s1">'name'</span><span class="p">],</span> <span class="s1">'r'</span><span class="p">,</span> <span class="nb">format</span><span class="o">=</span><span class="s1">'NETCDF4'</span><span class="p">)</span> <span class="k">as</span> <span class="n">nc</span><span class="p">:</span>
+ <span class="k">for</span> <span class="n">key</span> <span class="ow">in</span> <span class="n">nc</span><span class="o">.</span><span class="n">dimensions</span><span class="o">.</span><span class="n">keys</span><span class="p">():</span>
+ <span class="n">dimsList</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">nc</span><span class="o">.</span><span class="n">dimensions</span><span class="p">[</span><span class="n">key</span><span class="p">]</span><span class="o">.</span><span class="n">name</span><span class="p">)</span>
+ <span class="k">return</span> <span class="n">dimsList</span></div>
+
+<div class="viewcode-block" id="netcdfGeneric.hasDim"><a class="viewcode-back" href="../DataFormats.html#DataFormats.netcdfGeneric.hasDim">[docs]</a> <span class="k">def</span> <span class="nf">hasDim</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">dimName</span><span class="p">):</span>
+ <span class="k">return</span> <span class="n">dimName</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">file</span><span class="p">[</span><span class="s1">'dims'</span><span class="p">]</span></div>
+
+<div class="viewcode-block" id="netcdfGeneric.getDim"><a class="viewcode-back" href="../DataFormats.html#DataFormats.netcdfGeneric.getDim">[docs]</a> <span class="k">def</span> <span class="nf">getDim</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">dimName</span><span class="p">):</span>
+ <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">hasDim</span><span class="p">(</span><span class="n">dimName</span><span class="p">):</span>
+ <span class="k">with</span> <span class="n">ncdata</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">file</span><span class="p">[</span><span class="s1">'name'</span><span class="p">],</span> <span class="s1">'r'</span><span class="p">,</span> <span class="nb">format</span><span class="o">=</span><span class="s1">'NETCDF4'</span><span class="p">)</span> <span class="k">as</span> <span class="n">nc</span><span class="p">:</span>
+ <span class="n">dimSize</span> <span class="o">=</span> <span class="n">nc</span><span class="o">.</span><span class="n">dimensions</span><span class="p">[</span><span class="n">dimName</span><span class="p">]</span><span class="o">.</span><span class="n">size</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="nb">print</span><span class="p">(</span><span class="s1">'WARNING: Dimension '</span><span class="o">+</span><span class="n">dimName</span><span class="o">+</span><span class="s1">' does not exist.'</span><span class="p">)</span>
+ <span class="nb">print</span><span class="p">(</span><span class="s1">'Available dimensions:'</span><span class="p">)</span>
+ <span class="nb">print</span><span class="p">(</span><span class="nb">list</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">file</span><span class="p">[</span><span class="s1">'dims'</span><span class="p">]))</span>
+ <span class="n">dimSize</span> <span class="o">=</span> <span class="kc">None</span>
+ <span class="k">return</span> <span class="n">dimSize</span></div>
+
+<div class="viewcode-block" id="netcdfGeneric.listVars"><a class="viewcode-back" href="../DataFormats.html#DataFormats.netcdfGeneric.listVars">[docs]</a> <span class="k">def</span> <span class="nf">listVars</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="k">with</span> <span class="n">ncdata</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">file</span><span class="p">[</span><span class="s1">'name'</span><span class="p">],</span> <span class="s1">'r'</span><span class="p">,</span> <span class="nb">format</span><span class="o">=</span><span class="s1">'NETCDF4'</span><span class="p">)</span> <span class="k">as</span> <span class="n">nc</span><span class="p">:</span>
+ <span class="n">varList</span> <span class="o">=</span> <span class="nb">list</span><span class="p">(</span><span class="n">nc</span><span class="o">.</span><span class="n">variables</span><span class="p">)</span>
+ <span class="k">return</span> <span class="n">varList</span></div>
+
+<div class="viewcode-block" id="netcdfGeneric.hasVar"><a class="viewcode-back" href="../DataFormats.html#DataFormats.netcdfGeneric.hasVar">[docs]</a> <span class="k">def</span> <span class="nf">hasVar</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">varName</span><span class="p">):</span>
+ <span class="k">return</span> <span class="n">varName</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">file</span><span class="p">[</span><span class="s1">'vars'</span><span class="p">]</span></div>
+
+<div class="viewcode-block" id="netcdfGeneric.getVarAttrList"><a class="viewcode-back" href="../DataFormats.html#DataFormats.netcdfGeneric.getVarAttrList">[docs]</a> <span class="k">def</span> <span class="nf">getVarAttrList</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">varName</span><span class="p">):</span>
+ <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">hasVar</span><span class="p">(</span><span class="n">varName</span><span class="p">):</span>
+ <span class="k">with</span> <span class="n">ncdata</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">file</span><span class="p">[</span><span class="s1">'name'</span><span class="p">],</span> <span class="s1">'r'</span><span class="p">,</span> <span class="nb">format</span><span class="o">=</span><span class="s1">'NETCDF4'</span><span class="p">)</span> <span class="k">as</span> <span class="n">nc</span><span class="p">:</span>
+ <span class="n">attrList</span> <span class="o">=</span> <span class="n">nc</span><span class="o">.</span><span class="n">variables</span><span class="p">[</span><span class="n">varName</span><span class="p">]</span><span class="o">.</span><span class="n">ncattrs</span><span class="p">()</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="nb">print</span><span class="p">(</span><span class="s1">'WARNING: Variable '</span><span class="o">+</span><span class="n">varName</span><span class="o">+</span><span class="s1">' does not exist.'</span><span class="p">)</span>
+ <span class="nb">print</span><span class="p">(</span><span class="s1">'Available variables:'</span><span class="p">)</span>
+ <span class="nb">print</span><span class="p">(</span><span class="nb">list</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">file</span><span class="p">[</span><span class="s1">'vars'</span><span class="p">]))</span>
+ <span class="n">attrList</span> <span class="o">=</span> <span class="p">[]</span>
+ <span class="k">return</span> <span class="n">attrList</span></div>
+
+<div class="viewcode-block" id="netcdfGeneric.hasAttr"><a class="viewcode-back" href="../DataFormats.html#DataFormats.netcdfGeneric.hasAttr">[docs]</a> <span class="k">def</span> <span class="nf">hasAttr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">varName</span><span class="p">,</span> <span class="n">attrName</span><span class="p">):</span>
+ <span class="n">attrList</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">getVarAttrList</span><span class="p">(</span><span class="n">varName</span><span class="p">)</span>
+ <span class="k">return</span> <span class="n">attrName</span> <span class="ow">in</span> <span class="n">attrList</span></div>
+
+<div class="viewcode-block" id="netcdfGeneric.getVarAttr"><a class="viewcode-back" href="../DataFormats.html#DataFormats.netcdfGeneric.getVarAttr">[docs]</a> <span class="k">def</span> <span class="nf">getVarAttr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">varName</span><span class="p">,</span> <span class="n">attrName</span><span class="p">):</span>
+ <span class="k">if</span> <span class="n">varName</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">file</span><span class="p">[</span><span class="s1">'vars'</span><span class="p">]:</span>
+ <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">hasAttr</span><span class="p">(</span><span class="n">varName</span><span class="p">,</span> <span class="n">attrName</span><span class="p">):</span>
+ <span class="k">with</span> <span class="n">ncdata</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">file</span><span class="p">[</span><span class="s1">'name'</span><span class="p">],</span> <span class="s1">'r'</span><span class="p">,</span> <span class="nb">format</span><span class="o">=</span><span class="s1">'NETCDF4'</span><span class="p">)</span> <span class="k">as</span> <span class="n">nc</span><span class="p">:</span>
+ <span class="n">attr</span> <span class="o">=</span> <span class="n">nc</span><span class="o">.</span><span class="n">variables</span><span class="p">[</span><span class="n">varName</span><span class="p">]</span><span class="o">.</span><span class="n">getncattr</span><span class="p">(</span><span class="n">attrName</span><span class="p">)</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="nb">print</span><span class="p">(</span><span class="s1">'WARNING: Attribute '</span><span class="o">+</span><span class="n">attrName</span><span class="o">+</span><span class="s1">' does not exist.'</span><span class="p">)</span>
+ <span class="nb">print</span><span class="p">(</span><span class="s1">'Available attributes:'</span><span class="p">)</span>
+ <span class="nb">print</span><span class="p">(</span><span class="nb">list</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">getVarAttrList</span><span class="p">(</span><span class="n">varName</span><span class="p">)))</span>
+ <span class="n">attr</span> <span class="o">=</span> <span class="kc">None</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="nb">print</span><span class="p">(</span><span class="s1">'WARNING: Variable '</span><span class="o">+</span><span class="n">varName</span><span class="o">+</span><span class="s1">' does not exist.'</span><span class="p">)</span>
+ <span class="nb">print</span><span class="p">(</span><span class="s1">'Available variables:'</span><span class="p">)</span>
+ <span class="nb">print</span><span class="p">(</span><span class="nb">list</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">file</span><span class="p">[</span><span class="s1">'vars'</span><span class="p">]))</span>
+ <span class="n">attr</span> <span class="o">=</span> <span class="kc">None</span>
+ <span class="k">return</span> <span class="n">attr</span></div>
+
+<div class="viewcode-block" id="netcdfGeneric.getVarDimNames"><a class="viewcode-back" href="../DataFormats.html#DataFormats.netcdfGeneric.getVarDimNames">[docs]</a> <span class="k">def</span> <span class="nf">getVarDimNames</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">varName</span><span class="p">):</span>
+ <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">hasVar</span><span class="p">(</span><span class="n">varName</span><span class="p">):</span>
+ <span class="k">with</span> <span class="n">ncdata</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">file</span><span class="p">[</span><span class="s1">'name'</span><span class="p">],</span> <span class="s1">'r'</span><span class="p">,</span> <span class="nb">format</span><span class="o">=</span><span class="s1">'NETCDF4'</span><span class="p">)</span> <span class="k">as</span> <span class="n">nc</span><span class="p">:</span>
+ <span class="n">dimNames</span> <span class="o">=</span> <span class="nb">list</span><span class="p">(</span><span class="n">nc</span><span class="o">.</span><span class="n">variables</span><span class="p">[</span><span class="n">varName</span><span class="p">]</span><span class="o">.</span><span class="n">dimensions</span><span class="p">)</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="nb">print</span><span class="p">(</span><span class="s1">'WARNING: Variable '</span><span class="o">+</span><span class="n">varName</span><span class="o">+</span><span class="s1">' does not exist.'</span><span class="p">)</span>
+ <span class="nb">print</span><span class="p">(</span><span class="s1">'Available variables:'</span><span class="p">)</span>
+ <span class="nb">print</span><span class="p">(</span><span class="nb">list</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">file</span><span class="p">[</span><span class="s1">'vars'</span><span class="p">]))</span>
+ <span class="n">dimNames</span> <span class="o">=</span> <span class="kc">None</span>
+ <span class="k">return</span> <span class="n">dimNames</span></div>
+
+<div class="viewcode-block" id="netcdfGeneric.getVarDimSizes"><a class="viewcode-back" href="../DataFormats.html#DataFormats.netcdfGeneric.getVarDimSizes">[docs]</a> <span class="k">def</span> <span class="nf">getVarDimSizes</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">varName</span><span class="p">):</span>
+ <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">hasVar</span><span class="p">(</span><span class="n">varName</span><span class="p">):</span>
+ <span class="k">with</span> <span class="n">ncdata</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">file</span><span class="p">[</span><span class="s1">'name'</span><span class="p">],</span> <span class="s1">'r'</span><span class="p">,</span> <span class="nb">format</span><span class="o">=</span><span class="s1">'NETCDF4'</span><span class="p">)</span> <span class="k">as</span> <span class="n">nc</span><span class="p">:</span>
+ <span class="n">dimSizes</span> <span class="o">=</span> <span class="nb">list</span><span class="p">(</span><span class="n">nc</span><span class="o">.</span><span class="n">variables</span><span class="p">[</span><span class="n">varName</span><span class="p">]</span><span class="o">.</span><span class="n">shape</span><span class="p">)</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="nb">print</span><span class="p">(</span><span class="s1">'WARNING: Variable '</span><span class="o">+</span><span class="n">varName</span><span class="o">+</span><span class="s1">' does not exist.'</span><span class="p">)</span>
+ <span class="nb">print</span><span class="p">(</span><span class="s1">'Available variables:'</span><span class="p">)</span>
+ <span class="nb">print</span><span class="p">(</span><span class="nb">list</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">file</span><span class="p">[</span><span class="s1">'vars'</span><span class="p">]))</span>
+ <span class="n">dimSizes</span> <span class="o">=</span> <span class="kc">None</span>
+ <span class="k">return</span> <span class="n">dimSizes</span></div>
+
+<div class="viewcode-block" id="netcdfGeneric.getVar"><a class="viewcode-back" href="../DataFormats.html#DataFormats.netcdfGeneric.getVar">[docs]</a> <span class="k">def</span> <span class="nf">getVar</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">varName</span><span class="p">):</span>
+ <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">hasVar</span><span class="p">(</span><span class="n">varName</span><span class="p">):</span>
+ <span class="k">with</span> <span class="n">ncdata</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">file</span><span class="p">[</span><span class="s1">'name'</span><span class="p">],</span> <span class="s1">'r'</span><span class="p">,</span> <span class="nb">format</span><span class="o">=</span><span class="s1">'NETCDF4'</span><span class="p">)</span> <span class="k">as</span> <span class="n">nc</span><span class="p">:</span>
+ <span class="k">if</span> <span class="n">np</span><span class="o">.</span><span class="n">ma</span><span class="o">.</span><span class="n">isMaskedArray</span><span class="p">(</span><span class="n">nc</span><span class="o">.</span><span class="n">variables</span><span class="p">[</span><span class="n">varName</span><span class="p">][:]):</span>
+ <span class="n">var</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">ma</span><span class="o">.</span><span class="n">getdata</span><span class="p">(</span><span class="n">nc</span><span class="o">.</span><span class="n">variables</span><span class="p">[</span><span class="n">varName</span><span class="p">][:])</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">var</span> <span class="o">=</span> <span class="n">nc</span><span class="o">.</span><span class="n">variables</span><span class="p">[</span><span class="n">varName</span><span class="p">][:]</span>
+ <span class="k">if</span> <span class="n">var</span><span class="o">.</span><span class="n">dtype</span> <span class="o">==</span> <span class="s1">'|S1'</span><span class="p">:</span>
+ <span class="n">var</span> <span class="o">=</span> <span class="p">(</span><span class="sa">b</span><span class="s1">''</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="nb">list</span><span class="p">(</span><span class="n">var</span><span class="p">)))</span><span class="o">.</span><span class="n">decode</span><span class="p">(</span><span class="s1">'utf-8'</span><span class="p">)</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="nb">print</span><span class="p">(</span><span class="s1">'WARNING: Variable '</span><span class="o">+</span><span class="n">varName</span><span class="o">+</span><span class="s1">' does not exist.'</span><span class="p">)</span>
+ <span class="nb">print</span><span class="p">(</span><span class="s1">'Available variables:'</span><span class="p">)</span>
+ <span class="nb">print</span><span class="p">(</span><span class="nb">list</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">file</span><span class="p">[</span><span class="s1">'vars'</span><span class="p">]))</span>
+ <span class="n">var</span> <span class="o">=</span> <span class="kc">None</span>
+ <span class="k">return</span> <span class="n">var</span></div></div>
+
+
+<span class="c1"># ----------------------------------------------------------------------------</span>
+<span class="c1"># FUNCTION DEFINITIONS</span>
+<span class="c1"># ----------------------------------------------------------------------------</span>
+
+
+</pre></div>
+
+ <div class="clearer"></div>
+ </div>
+ </div>
+ </div>
+ <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+ <div class="sphinxsidebarwrapper">
+<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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
+ <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="nav-item nav-item-0"><a href="../index.html">WaveVal documentation</a> »</li>
+ <li class="nav-item nav-item-1"><a href="index.html" >Module code</a> »</li>
+ <li class="nav-item nav-item-this"><a href="">DataFormats</a></li>
+ </ul>
+ </div>
+ <div class="footer" role="contentinfo">
+ © Copyright 2022.
+ Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 4.3.0.
+ </div>
+ </body>
+</html>
\ No newline at end of file
diff --git a/docs/_build/html/_modules/Geometry.html b/docs/_build/html/_modules/Geometry.html
new file mode 100644
index 0000000000000000000000000000000000000000..a5ac610eede8f37136eaa1791806ded2da8ee1c0
--- /dev/null
+++ b/docs/_build/html/_modules/Geometry.html
@@ -0,0 +1,358 @@
+
+
+<!doctype html>
+
+<html lang="en">
+ <head>
+ <meta charset="utf-8" />
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+ <title>Geometry — WaveVal documentation</title>
+ <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
+ <link rel="stylesheet" type="text/css" href="../_static/bizstyle.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 src="../_static/bizstyle.js"></script>
+ <link rel="author" title="About these documents" href="../about.html" />
+ <link rel="index" title="Index" href="../genindex.html" />
+ <link rel="search" title="Search" href="../search.html" />
+ <meta name="viewport" content="width=device-width,initial-scale=1.0" />
+ <!--[if lt IE 9]>
+ <script src="_static/css3-mediaqueries.js"></script>
+ <![endif]-->
+ </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="nav-item nav-item-0"><a href="../index.html">WaveVal documentation</a> »</li>
+ <li class="nav-item nav-item-1"><a href="index.html" accesskey="U">Module code</a> »</li>
+ <li class="nav-item nav-item-this"><a href="">Geometry</a></li>
+ </ul>
+ </div>
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body" role="main">
+
+ <h1>Source code for Geometry</h1><div class="highlight"><pre>
+<span></span><span class="c1"># -*- coding: utf-8 -*-</span>
+<span class="sd">"""</span>
+<span class="sd">General geometry functions associated with unstructured triangular meshes and</span>
+<span class="sd">functions used within the WaveVal package.</span>
+
+<span class="sd">:Dependencies [External]: numpy</span>
+<span class="sd">:Dependencies [Internal]: </span>
+
+<span class="sd">"""</span>
+<span class="c1"># ----------------------------------------------------------------------------</span>
+<span class="c1"># IMPORTS</span>
+<span class="c1"># ----------------------------------------------------------------------------</span>
+<span class="c1"># Standard Python Dependencies</span>
+<span class="c1"># Non-Standard Python Dependencies</span>
+<span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
+<span class="c1"># Local Module Dependencies</span>
+<span class="c1"># Other Dependencies</span>
+
+<span class="c1"># ----------------------------------------------------------------------------</span>
+<span class="c1"># GLOBAL VARIABLES</span>
+<span class="c1"># ----------------------------------------------------------------------------</span>
+
+
+<span class="c1"># ----------------------------------------------------------------------------</span>
+<span class="c1"># CLASS DEFINITIONS</span>
+<span class="c1"># ----------------------------------------------------------------------------</span>
+<div class="viewcode-block" id="spatialCoverage"><a class="viewcode-back" href="../Geometry.html#Geometry.spatialCoverage">[docs]</a><span class="k">class</span> <span class="nc">spatialCoverage</span><span class="p">:</span>
+ <span class="sd">"""</span>
+<span class="sd"> Base class for setting spatial coverage of data in lat/lon ranges.</span>
+<span class="sd"> """</span>
+ <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">lat_min</span><span class="p">,</span> <span class="n">lat_max</span><span class="p">,</span> <span class="n">lon_min</span><span class="p">,</span> <span class="n">lon_max</span><span class="p">):</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">lat_range</span> <span class="o">=</span> <span class="p">[</span><span class="n">lat_min</span><span class="p">,</span> <span class="n">lat_max</span><span class="p">]</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">lon_range</span> <span class="o">=</span> <span class="p">[</span><span class="n">lon_min</span><span class="p">,</span> <span class="n">lon_max</span><span class="p">]</span></div>
+
+
+<span class="c1"># ----------------------------------------------------------------------------</span>
+<span class="c1"># FUNCTION DEFINITIONS</span>
+<span class="c1"># ----------------------------------------------------------------------------</span>
+<span class="c1"># ======================== Triangles ==============================</span>
+<div class="viewcode-block" id="getBarycentricWeights"><a class="viewcode-back" href="../Geometry.html#Geometry.getBarycentricWeights">[docs]</a><span class="k">def</span> <span class="nf">getBarycentricWeights</span><span class="p">(</span><span class="n">p1</span><span class="p">,</span> <span class="n">p2</span><span class="p">,</span> <span class="n">p3</span><span class="p">,</span> <span class="n">p</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Calculate Barycentric weights for interpolating data from the triangle</span>
+<span class="sd"> node points *p1*, *p2*, *p3* onto the point *p*.</span>
+<span class="sd"> """</span>
+ <span class="n">w</span> <span class="o">=</span> <span class="p">(</span><span class="n">p2</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span><span class="o">-</span><span class="n">p3</span><span class="p">[</span><span class="mi">1</span><span class="p">])</span><span class="o">*</span><span class="p">(</span><span class="n">p1</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">-</span><span class="n">p3</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span> <span class="o">+</span> <span class="p">(</span><span class="n">p3</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">-</span><span class="n">p2</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span><span class="o">*</span><span class="p">(</span><span class="n">p1</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span><span class="o">-</span><span class="n">p3</span><span class="p">[</span><span class="mi">1</span><span class="p">])</span>
+ <span class="n">w1</span> <span class="o">=</span> <span class="p">((</span><span class="n">p2</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span><span class="o">-</span><span class="n">p3</span><span class="p">[</span><span class="mi">1</span><span class="p">])</span><span class="o">*</span><span class="p">(</span><span class="n">p</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">-</span><span class="n">p3</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span> <span class="o">+</span> <span class="p">(</span><span class="n">p3</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">-</span><span class="n">p2</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span><span class="o">*</span><span class="p">(</span><span class="n">p</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span><span class="o">-</span><span class="n">p3</span><span class="p">[</span><span class="mi">1</span><span class="p">]))</span> <span class="o">/</span> <span class="n">w</span>
+ <span class="n">w2</span> <span class="o">=</span> <span class="p">((</span><span class="n">p3</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span><span class="o">-</span><span class="n">p1</span><span class="p">[</span><span class="mi">1</span><span class="p">])</span><span class="o">*</span><span class="p">(</span><span class="n">p</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">-</span><span class="n">p3</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span> <span class="o">+</span> <span class="p">(</span><span class="n">p1</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">-</span><span class="n">p3</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span><span class="o">*</span><span class="p">(</span><span class="n">p</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span><span class="o">-</span><span class="n">p3</span><span class="p">[</span><span class="mi">1</span><span class="p">]))</span> <span class="o">/</span> <span class="n">w</span>
+ <span class="n">w3</span> <span class="o">=</span> <span class="mf">1.0</span> <span class="o">-</span> <span class="n">w1</span> <span class="o">-</span> <span class="n">w2</span>
+ <span class="k">return</span> <span class="p">[</span><span class="n">w1</span><span class="p">,</span> <span class="n">w2</span><span class="p">,</span> <span class="n">w3</span><span class="p">]</span></div>
+
+
+<div class="viewcode-block" id="getTriangleArea"><a class="viewcode-back" href="../Geometry.html#Geometry.getTriangleArea">[docs]</a><span class="k">def</span> <span class="nf">getTriangleArea</span><span class="p">(</span><span class="n">p1</span><span class="p">,</span> <span class="n">p2</span><span class="p">,</span> <span class="n">p3</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Calculate the area of a triangle defined by the points *p1*, *p2*, *p3*.</span>
+<span class="sd"> """</span>
+ <span class="n">area</span> <span class="o">=</span> <span class="mf">0.5</span><span class="o">*</span><span class="n">np</span><span class="o">.</span><span class="n">abs</span><span class="p">(</span><span class="n">p1</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">*</span><span class="p">(</span><span class="n">p2</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span><span class="o">-</span><span class="n">p3</span><span class="p">[</span><span class="mi">1</span><span class="p">])</span> <span class="o">-</span>
+ <span class="n">p1</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span><span class="o">*</span><span class="p">(</span><span class="n">p2</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">-</span><span class="n">p3</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span> <span class="o">+</span>
+ <span class="p">(</span><span class="n">p2</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">*</span><span class="n">p3</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span><span class="o">-</span><span class="n">p3</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">*</span><span class="n">p2</span><span class="p">[</span><span class="mi">1</span><span class="p">]))</span>
+ <span class="k">return</span> <span class="n">area</span></div>
+
+
+<div class="viewcode-block" id="getTriangleCentroid"><a class="viewcode-back" href="../Geometry.html#Geometry.getTriangleCentroid">[docs]</a><span class="k">def</span> <span class="nf">getTriangleCentroid</span><span class="p">(</span><span class="n">p1</span><span class="p">,</span> <span class="n">p2</span><span class="p">,</span> <span class="n">p3</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Calculate the position of the centroid for a triangle defined by the </span>
+<span class="sd"> points *p1*, *p2*, *p3*.</span>
+<span class="sd"> """</span>
+ <span class="n">centroid</span> <span class="o">=</span> <span class="p">[(</span><span class="n">p1</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">+</span><span class="n">p2</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">+</span><span class="n">p3</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span><span class="o">/</span><span class="mf">3.</span><span class="p">,</span> <span class="p">(</span><span class="n">p1</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span><span class="o">+</span><span class="n">p2</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span><span class="o">+</span><span class="n">p3</span><span class="p">[</span><span class="mi">1</span><span class="p">])</span><span class="o">/</span><span class="mf">3.</span><span class="p">]</span>
+ <span class="k">return</span> <span class="n">centroid</span></div>
+
+
+<div class="viewcode-block" id="isInsideTriangle"><a class="viewcode-back" href="../Geometry.html#Geometry.isInsideTriangle">[docs]</a><span class="k">def</span> <span class="nf">isInsideTriangle</span><span class="p">(</span><span class="n">p1</span><span class="p">,</span> <span class="n">p2</span><span class="p">,</span> <span class="n">p3</span><span class="p">,</span> <span class="n">p</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Determine whether the point *p* lies within the triangle defined by </span>
+<span class="sd"> the points *p1*, *p2*, *p3*.</span>
+<span class="sd"> """</span>
+ <span class="p">[</span><span class="n">w1</span><span class="p">,</span> <span class="n">w2</span><span class="p">,</span> <span class="n">w3</span><span class="p">]</span> <span class="o">=</span> <span class="n">getBarycentricWeights</span><span class="p">(</span><span class="n">p1</span><span class="p">,</span> <span class="n">p2</span><span class="p">,</span> <span class="n">p3</span><span class="p">,</span> <span class="n">p</span><span class="p">)</span>
+ <span class="n">negValues</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">where</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">asarray</span><span class="p">([</span><span class="n">w1</span><span class="p">,</span> <span class="n">w2</span><span class="p">,</span> <span class="n">w3</span><span class="p">])</span> <span class="o"><</span> <span class="mf">0.</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span>
+ <span class="k">if</span> <span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">negValues</span><span class="p">)</span> <span class="o">==</span> <span class="mi">0</span><span class="p">):</span>
+ <span class="n">isInside</span> <span class="o">=</span> <span class="kc">True</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">isInside</span> <span class="o">=</span> <span class="kc">False</span>
+ <span class="k">return</span> <span class="n">isInside</span></div>
+
+
+<div class="viewcode-block" id="interpTriangle"><a class="viewcode-back" href="../Geometry.html#Geometry.interpTriangle">[docs]</a><span class="k">def</span> <span class="nf">interpTriangle</span><span class="p">(</span><span class="n">p1</span><span class="p">,</span> <span class="n">p2</span><span class="p">,</span> <span class="n">p3</span><span class="p">,</span> <span class="n">p</span><span class="p">,</span> <span class="n">v1</span><span class="p">,</span> <span class="n">v2</span><span class="p">,</span> <span class="n">v3</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Interpolate the values *v1*, *v2*, *v3* from the triangle nodes </span>
+<span class="sd"> defined by the points *p1*, *p2*, *p3* onto the location *p* using </span>
+<span class="sd"> the Barycentric wighting method.</span>
+<span class="sd"> """</span>
+ <span class="p">[</span><span class="n">w1</span><span class="p">,</span> <span class="n">w2</span><span class="p">,</span> <span class="n">w3</span><span class="p">]</span> <span class="o">=</span> <span class="n">getBarycentricWeights</span><span class="p">(</span><span class="n">p1</span><span class="p">,</span> <span class="n">p2</span><span class="p">,</span> <span class="n">p3</span><span class="p">,</span> <span class="n">p</span><span class="p">)</span>
+ <span class="n">vp</span> <span class="o">=</span> <span class="p">(</span><span class="n">w1</span><span class="o">*</span><span class="n">v1</span> <span class="o">+</span> <span class="n">w2</span><span class="o">*</span><span class="n">v2</span> <span class="o">+</span> <span class="n">w3</span><span class="o">*</span><span class="n">v3</span><span class="p">)</span> <span class="o">/</span> <span class="p">(</span><span class="n">w1</span> <span class="o">+</span> <span class="n">w2</span> <span class="o">+</span> <span class="n">w3</span><span class="p">)</span>
+ <span class="k">return</span> <span class="n">vp</span></div>
+
+
+<div class="viewcode-block" id="getNearestNode"><a class="viewcode-back" href="../Geometry.html#Geometry.getNearestNode">[docs]</a><span class="k">def</span> <span class="nf">getNearestNode</span><span class="p">(</span><span class="n">X</span><span class="p">,</span> <span class="n">Y</span><span class="p">,</span> <span class="n">LocX</span><span class="p">,</span> <span class="n">LocY</span><span class="p">):</span>
+ <span class="n">dr</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">sqrt</span><span class="p">((</span><span class="n">X</span><span class="o">-</span><span class="n">LocX</span><span class="p">)</span><span class="o">**</span><span class="mi">2</span><span class="o">+</span><span class="p">(</span><span class="n">Y</span><span class="o">-</span><span class="n">LocY</span><span class="p">)</span><span class="o">**</span><span class="mi">2</span><span class="p">)</span>
+ <span class="n">NNode</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">where</span><span class="p">(</span><span class="n">dr</span> <span class="o">==</span> <span class="n">np</span><span class="o">.</span><span class="n">min</span><span class="p">(</span><span class="n">dr</span><span class="p">))[</span><span class="mi">0</span><span class="p">]</span>
+ <span class="k">return</span> <span class="n">NNode</span></div>
+
+
+<div class="viewcode-block" id="getTriangle"><a class="viewcode-back" href="../Geometry.html#Geometry.getTriangle">[docs]</a><span class="k">def</span> <span class="nf">getTriangle</span><span class="p">(</span><span class="n">Mesh</span><span class="p">,</span> <span class="n">LocX</span><span class="p">,</span> <span class="n">LocY</span><span class="p">):</span>
+ <span class="n">X</span> <span class="o">=</span> <span class="n">Mesh</span><span class="o">.</span><span class="n">X</span><span class="o">.</span><span class="n">copy</span><span class="p">()</span>
+ <span class="n">Y</span> <span class="o">=</span> <span class="n">Mesh</span><span class="o">.</span><span class="n">Y</span><span class="o">.</span><span class="n">copy</span><span class="p">()</span>
+ <span class="n">NNode</span> <span class="o">=</span> <span class="n">getNearestNode</span><span class="p">(</span><span class="n">X</span><span class="p">,</span> <span class="n">Y</span><span class="p">,</span> <span class="n">LocX</span><span class="p">,</span> <span class="n">LocY</span><span class="p">)</span>
+ <span class="c1"># elmOff = np.min(Mesh.elems)</span>
+ <span class="c1"># elems = np.where(Mesh.elems[:, :] == NNode[0]+elmOff)[0]</span>
+ <span class="n">elems</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">where</span><span class="p">(</span><span class="n">Mesh</span><span class="o">.</span><span class="n">elems</span><span class="p">[:,</span> <span class="p">:]</span> <span class="o">==</span> <span class="n">NNode</span><span class="p">[</span><span class="mi">0</span><span class="p">])[</span><span class="mi">0</span><span class="p">]</span>
+ <span class="n">nelems</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">size</span><span class="p">(</span><span class="n">elems</span><span class="p">)</span>
+ <span class="n">nodes</span> <span class="o">=</span> <span class="n">Mesh</span><span class="o">.</span><span class="n">elems</span><span class="p">[</span><span class="n">elems</span><span class="p">,</span> <span class="p">:]</span>
+ <span class="n">p</span> <span class="o">=</span> <span class="p">[</span><span class="n">LocX</span><span class="p">,</span> <span class="n">LocY</span><span class="p">]</span>
+ <span class="k">for</span> <span class="n">elem</span> <span class="ow">in</span> <span class="n">np</span><span class="o">.</span><span class="n">arange</span><span class="p">(</span><span class="n">nelems</span><span class="p">):</span>
+ <span class="n">p1</span> <span class="o">=</span> <span class="p">[</span><span class="n">X</span><span class="p">[</span><span class="n">nodes</span><span class="p">[</span><span class="n">elem</span><span class="p">,</span> <span class="mi">0</span><span class="p">]],</span> <span class="n">Y</span><span class="p">[</span><span class="n">nodes</span><span class="p">[</span><span class="n">elem</span><span class="p">,</span> <span class="mi">0</span><span class="p">]]]</span>
+ <span class="n">p2</span> <span class="o">=</span> <span class="p">[</span><span class="n">X</span><span class="p">[</span><span class="n">nodes</span><span class="p">[</span><span class="n">elem</span><span class="p">,</span> <span class="mi">1</span><span class="p">]],</span> <span class="n">Y</span><span class="p">[</span><span class="n">nodes</span><span class="p">[</span><span class="n">elem</span><span class="p">,</span> <span class="mi">1</span><span class="p">]]]</span>
+ <span class="n">p3</span> <span class="o">=</span> <span class="p">[</span><span class="n">X</span><span class="p">[</span><span class="n">nodes</span><span class="p">[</span><span class="n">elem</span><span class="p">,</span> <span class="mi">2</span><span class="p">]],</span> <span class="n">Y</span><span class="p">[</span><span class="n">nodes</span><span class="p">[</span><span class="n">elem</span><span class="p">,</span> <span class="mi">2</span><span class="p">]]]</span>
+ <span class="k">if</span> <span class="n">isInsideTriangle</span><span class="p">(</span><span class="n">p1</span><span class="p">,</span> <span class="n">p2</span><span class="p">,</span> <span class="n">p3</span><span class="p">,</span> <span class="n">p</span><span class="p">):</span>
+ <span class="k">break</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="k">continue</span>
+ <span class="k">if</span> <span class="n">elem</span> <span class="o">==</span> <span class="n">nelems</span><span class="p">:</span>
+ <span class="n">NNodes</span> <span class="o">=</span> <span class="p">[]</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">NNodes</span> <span class="o">=</span> <span class="n">nodes</span><span class="p">[</span><span class="n">elem</span><span class="p">,</span> <span class="p">:]</span><span class="o">.</span><span class="n">copy</span><span class="p">()</span>
+ <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">NNode</span><span class="p">)</span> <span class="o">></span> <span class="mi">1</span><span class="p">:</span>
+ <span class="n">dn</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">diff</span><span class="p">(</span><span class="n">NNode</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span>
+ <span class="n">nl</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="n">NNode</span><span class="p">)</span>
+ <span class="n">NNodes</span><span class="o">.</span><span class="n">resize</span><span class="p">(</span><span class="mi">3</span><span class="o">*</span><span class="n">nl</span><span class="p">)</span>
+ <span class="k">for</span> <span class="n">lay</span> <span class="ow">in</span> <span class="n">np</span><span class="o">.</span><span class="n">arange</span><span class="p">(</span><span class="n">nl</span><span class="o">-</span><span class="mi">1</span><span class="p">):</span>
+ <span class="n">indx</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">arange</span><span class="p">(</span><span class="mi">3</span><span class="p">)</span><span class="o">+</span><span class="p">(</span><span class="n">lay</span><span class="o">+</span><span class="mi">1</span><span class="p">)</span><span class="o">*</span><span class="mi">3</span>
+ <span class="n">NNodes</span><span class="p">[</span><span class="n">indx</span><span class="p">]</span> <span class="o">=</span> <span class="n">NNodes</span><span class="p">[</span><span class="mi">0</span><span class="p">:</span><span class="mi">3</span><span class="p">]</span><span class="o">+</span><span class="p">(</span><span class="n">lay</span><span class="o">+</span><span class="mi">1</span><span class="p">)</span><span class="o">*</span><span class="n">dn</span>
+ <span class="k">return</span> <span class="n">NNodes</span></div>
+
+
+<div class="viewcode-block" id="getWgtsMatrix"><a class="viewcode-back" href="../Geometry.html#Geometry.getWgtsMatrix">[docs]</a><span class="k">def</span> <span class="nf">getWgtsMatrix</span><span class="p">(</span><span class="n">NWghts</span><span class="p">,</span> <span class="n">nstps</span><span class="p">):</span>
+ <span class="n">w</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">asarray</span><span class="p">(</span><span class="n">NWghts</span><span class="p">)</span>
+ <span class="n">w</span> <span class="o">=</span> <span class="n">w</span><span class="p">[:,</span> <span class="n">np</span><span class="o">.</span><span class="n">newaxis</span><span class="p">]</span>
+ <span class="n">cols</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">ones</span><span class="p">([</span><span class="mi">1</span><span class="p">,</span> <span class="n">nstps</span><span class="p">])</span>
+ <span class="n">wgts</span> <span class="o">=</span> <span class="n">w</span><span class="o">*</span><span class="n">cols</span>
+ <span class="k">return</span> <span class="n">wgts</span></div>
+
+
+<div class="viewcode-block" id="getCentroidWeights"><a class="viewcode-back" href="../Geometry.html#Geometry.getCentroidWeights">[docs]</a><span class="k">def</span> <span class="nf">getCentroidWeights</span><span class="p">(</span><span class="n">p1</span><span class="p">,</span> <span class="n">p2</span><span class="p">,</span> <span class="n">p3</span><span class="p">,</span> <span class="n">Centroid</span><span class="p">):</span>
+ <span class="n">CWghts</span> <span class="o">=</span> <span class="n">getBarycentricWeights</span><span class="p">(</span><span class="n">p1</span><span class="p">,</span> <span class="n">p2</span><span class="p">,</span> <span class="n">p3</span><span class="p">,</span> <span class="n">Centroid</span><span class="p">)</span>
+ <span class="k">return</span> <span class="n">CWghts</span></div>
+
+
+<div class="viewcode-block" id="getNodesWeights"><a class="viewcode-back" href="../Geometry.html#Geometry.getNodesWeights">[docs]</a><span class="k">def</span> <span class="nf">getNodesWeights</span><span class="p">(</span><span class="n">Mesh</span><span class="p">,</span> <span class="n">LocX</span><span class="p">,</span> <span class="n">LocY</span><span class="p">):</span>
+ <span class="n">NNodes</span> <span class="o">=</span> <span class="n">getTriangle</span><span class="p">(</span><span class="n">Mesh</span><span class="p">,</span> <span class="n">LocX</span><span class="p">,</span> <span class="n">LocY</span><span class="p">)</span>
+ <span class="n">p1</span> <span class="o">=</span> <span class="p">[</span><span class="n">Mesh</span><span class="o">.</span><span class="n">X</span><span class="p">[</span><span class="n">NNodes</span><span class="p">[</span><span class="mi">0</span><span class="p">]],</span> <span class="n">Mesh</span><span class="o">.</span><span class="n">Y</span><span class="p">[</span><span class="n">NNodes</span><span class="p">[</span><span class="mi">0</span><span class="p">]]]</span>
+ <span class="n">p2</span> <span class="o">=</span> <span class="p">[</span><span class="n">Mesh</span><span class="o">.</span><span class="n">X</span><span class="p">[</span><span class="n">NNodes</span><span class="p">[</span><span class="mi">1</span><span class="p">]],</span> <span class="n">Mesh</span><span class="o">.</span><span class="n">Y</span><span class="p">[</span><span class="n">NNodes</span><span class="p">[</span><span class="mi">1</span><span class="p">]]]</span>
+ <span class="n">p3</span> <span class="o">=</span> <span class="p">[</span><span class="n">Mesh</span><span class="o">.</span><span class="n">X</span><span class="p">[</span><span class="n">NNodes</span><span class="p">[</span><span class="mi">2</span><span class="p">]],</span> <span class="n">Mesh</span><span class="o">.</span><span class="n">Y</span><span class="p">[</span><span class="n">NNodes</span><span class="p">[</span><span class="mi">2</span><span class="p">]]]</span>
+ <span class="n">p</span> <span class="o">=</span> <span class="p">[</span><span class="n">LocX</span><span class="p">,</span> <span class="n">LocY</span><span class="p">]</span>
+ <span class="n">NLocs</span> <span class="o">=</span> <span class="p">[</span><span class="n">p1</span><span class="p">,</span> <span class="n">p2</span><span class="p">,</span> <span class="n">p3</span><span class="p">]</span>
+ <span class="n">NWghts</span> <span class="o">=</span> <span class="n">getBarycentricWeights</span><span class="p">(</span><span class="n">p1</span><span class="p">,</span> <span class="n">p2</span><span class="p">,</span> <span class="n">p3</span><span class="p">,</span> <span class="n">p</span><span class="p">)</span>
+ <span class="k">return</span> <span class="n">NNodes</span><span class="p">,</span> <span class="n">NWghts</span><span class="p">,</span> <span class="n">NLocs</span></div>
+
+<span class="c1"># ====================== Scalar Fields ===========================</span>
+
+
+<span class="c1"># ====================== Vector Fields ===========================</span>
+<div class="viewcode-block" id="pol2cart"><a class="viewcode-back" href="../Geometry.html#Geometry.pol2cart">[docs]</a><span class="k">def</span> <span class="nf">pol2cart</span><span class="p">(</span><span class="n">r</span><span class="p">,</span> <span class="n">theta</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Coordinate conversion: Polar to Cartesian</span>
+<span class="sd"> </span>
+<span class="sd"> :param r: radial distance</span>
+<span class="sd"> :param theta: angle in degrees</span>
+
+<span class="sd"> :return: x </span>
+<span class="sd"> :return: y</span>
+<span class="sd"> """</span>
+ <span class="n">x</span> <span class="o">=</span> <span class="n">r</span> <span class="o">*</span> <span class="n">np</span><span class="o">.</span><span class="n">cos</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">deg2rad</span><span class="p">(</span><span class="n">theta</span><span class="p">,</span><span class="n">dtype</span><span class="o">=</span><span class="s1">'double'</span><span class="p">),</span><span class="n">dtype</span><span class="o">=</span><span class="s1">'double'</span><span class="p">)</span>
+ <span class="n">y</span> <span class="o">=</span> <span class="n">r</span> <span class="o">*</span> <span class="n">np</span><span class="o">.</span><span class="n">sin</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">deg2rad</span><span class="p">(</span><span class="n">theta</span><span class="p">,</span><span class="n">dtype</span><span class="o">=</span><span class="s1">'double'</span><span class="p">),</span><span class="n">dtype</span><span class="o">=</span><span class="s1">'double'</span><span class="p">)</span>
+ <span class="k">return</span> <span class="n">x</span><span class="p">,</span><span class="n">y</span></div>
+
+
+<div class="viewcode-block" id="cart2pol"><a class="viewcode-back" href="../Geometry.html#Geometry.cart2pol">[docs]</a><span class="k">def</span> <span class="nf">cart2pol</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">y</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Coordinate conversion: Cartesian to Polar</span>
+<span class="sd"> </span>
+<span class="sd"> :param x: Cartesian x-coord</span>
+<span class="sd"> :param y: Cartesian y-coord</span>
+<span class="sd"> </span>
+<span class="sd"> :return: r</span>
+<span class="sd"> :return: theta (in degrees)</span>
+<span class="sd"> """</span>
+ <span class="n">r</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">sqrt</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">power</span><span class="p">(</span><span class="n">x</span><span class="p">,</span><span class="mf">2.0</span><span class="p">,</span><span class="n">dtype</span><span class="o">=</span><span class="s1">'double'</span><span class="p">)</span> <span class="o">+</span>
+ <span class="n">np</span><span class="o">.</span><span class="n">power</span><span class="p">(</span><span class="n">y</span><span class="p">,</span><span class="mf">2.0</span><span class="p">,</span><span class="n">dtype</span><span class="o">=</span><span class="s1">'double'</span><span class="p">),</span><span class="n">dtype</span><span class="o">=</span><span class="s1">'double'</span><span class="p">)</span>
+ <span class="n">theta</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">rad2deg</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">arctan2</span><span class="p">(</span><span class="n">y</span><span class="p">,</span><span class="n">x</span><span class="p">),</span><span class="n">dtype</span><span class="o">=</span><span class="s1">'double'</span><span class="p">)</span>
+ <span class="k">return</span> <span class="n">r</span><span class="p">,</span> <span class="n">theta</span></div>
+
+
+<div class="viewcode-block" id="pol2cmplx"><a class="viewcode-back" href="../Geometry.html#Geometry.pol2cmplx">[docs]</a><span class="k">def</span> <span class="nf">pol2cmplx</span><span class="p">(</span><span class="n">radii</span><span class="p">,</span> <span class="n">angles</span><span class="p">,</span> <span class="n">angularUnits</span><span class="o">=</span><span class="mi">0</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Coordinate conversion: Polar to Complex</span>
+<span class="sd"> </span>
+<span class="sd"> :param radii: radial distance</span>
+<span class="sd"> :param angles: angle </span>
+<span class="sd"> :param anglularUnits: 0 = degress [default], 1 = radians</span>
+
+<span class="sd"> :return: cmplx</span>
+<span class="sd"> """</span>
+ <span class="k">if</span> <span class="n">angularUnits</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
+ <span class="n">cmplx</span> <span class="o">=</span> <span class="n">radii</span> <span class="o">*</span> <span class="n">np</span><span class="o">.</span><span class="n">exp</span><span class="p">(</span><span class="mi">1</span><span class="n">j</span><span class="o">*</span><span class="n">angles</span><span class="p">)</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">cmplx</span> <span class="o">=</span> <span class="n">radii</span> <span class="o">*</span> <span class="n">np</span><span class="o">.</span><span class="n">exp</span><span class="p">(</span><span class="mi">1</span><span class="n">j</span><span class="o">*</span><span class="n">np</span><span class="o">.</span><span class="n">deg2rad</span><span class="p">(</span><span class="n">angles</span><span class="p">))</span>
+ <span class="k">return</span> <span class="n">cmplx</span></div>
+
+
+<div class="viewcode-block" id="cmplx2pol"><a class="viewcode-back" href="../Geometry.html#Geometry.cmplx2pol">[docs]</a><span class="k">def</span> <span class="nf">cmplx2pol</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">angularUnits</span><span class="o">=</span><span class="mi">0</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Coordinate conversion: Complex to Polar</span>
+<span class="sd"> </span>
+<span class="sd"> :param x: complex numbers (x + jy)</span>
+<span class="sd"> :param anglularUnits: 0 = degress [default], 1 = radians</span>
+
+<span class="sd"> :return: radii</span>
+<span class="sd"> :return: angles</span>
+<span class="sd"> """</span>
+ <span class="k">if</span> <span class="n">angularUnits</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
+ <span class="n">radii</span> <span class="o">=</span> <span class="nb">abs</span><span class="p">(</span><span class="n">x</span><span class="p">)</span>
+ <span class="n">angles</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">angle</span><span class="p">(</span><span class="n">x</span><span class="p">)</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">radii</span> <span class="o">=</span> <span class="nb">abs</span><span class="p">(</span><span class="n">x</span><span class="p">)</span>
+ <span class="n">angles</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">rad2deg</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">angle</span><span class="p">(</span><span class="n">x</span><span class="p">))</span>
+ <span class="k">return</span> <span class="n">radii</span><span class="p">,</span> <span class="n">angles</span></div>
+
+
+<div class="viewcode-block" id="cart2cmplx"><a class="viewcode-back" href="../Geometry.html#Geometry.cart2cmplx">[docs]</a><span class="k">def</span> <span class="nf">cart2cmplx</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">y</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Coordinate conversion: Cartesian to Complex</span>
+<span class="sd"> </span>
+<span class="sd"> :param x: Cartesian x-coord</span>
+<span class="sd"> :param y: Cartesian y-coord</span>
+<span class="sd"> </span>
+<span class="sd"> :return: cmplx</span>
+<span class="sd"> """</span>
+ <span class="n">cmplx</span> <span class="o">=</span> <span class="n">x</span> <span class="o">+</span> <span class="mi">1</span><span class="n">j</span><span class="o">*</span><span class="n">y</span>
+ <span class="k">return</span> <span class="n">cmplx</span></div>
+
+
+<div class="viewcode-block" id="cmplx2cart"><a class="viewcode-back" href="../Geometry.html#Geometry.cmplx2cart">[docs]</a><span class="k">def</span> <span class="nf">cmplx2cart</span><span class="p">(</span><span class="n">c</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Coordinate conversion: Complex to Cartesian</span>
+<span class="sd"> </span>
+<span class="sd"> :param c: complex numbers (x + jy)</span>
+
+<span class="sd"> :return: x </span>
+<span class="sd"> :return: y</span>
+<span class="sd"> """</span>
+ <span class="n">x</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">real</span><span class="p">(</span><span class="n">c</span><span class="p">)</span>
+ <span class="n">y</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">imag</span><span class="p">(</span><span class="n">c</span><span class="p">)</span>
+ <span class="k">return</span> <span class="n">x</span><span class="p">,</span> <span class="n">y</span></div>
+
+
+<div class="viewcode-block" id="rotateVectorField"><a class="viewcode-back" href="../Geometry.html#Geometry.rotateVectorField">[docs]</a><span class="k">def</span> <span class="nf">rotateVectorField</span><span class="p">(</span><span class="n">U</span><span class="p">,</span> <span class="n">V</span><span class="p">,</span> <span class="n">W</span><span class="p">,</span> <span class="n">Theta</span><span class="p">):</span>
+ <span class="n">thetaRad</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">deg2rad</span><span class="p">(</span><span class="n">Theta</span><span class="p">)</span>
+ <span class="n">Rz</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">asarray</span><span class="p">([[</span><span class="n">np</span><span class="o">.</span><span class="n">cos</span><span class="p">(</span><span class="n">thetaRad</span><span class="p">),</span> <span class="o">-</span><span class="n">np</span><span class="o">.</span><span class="n">sin</span><span class="p">(</span><span class="n">thetaRad</span><span class="p">),</span> <span class="mf">0.0</span><span class="p">],</span>
+ <span class="p">[</span><span class="n">np</span><span class="o">.</span><span class="n">sin</span><span class="p">(</span><span class="n">thetaRad</span><span class="p">),</span> <span class="n">np</span><span class="o">.</span><span class="n">cos</span><span class="p">(</span><span class="n">thetaRad</span><span class="p">),</span> <span class="mf">0.0</span><span class="p">],</span>
+ <span class="p">[</span><span class="mf">0.0</span><span class="p">,</span> <span class="mf">0.0</span><span class="p">,</span> <span class="mf">1.0</span><span class="p">]])</span>
+ <span class="n">orig_shape</span> <span class="o">=</span> <span class="n">U</span><span class="o">.</span><span class="n">shape</span>
+ <span class="n">Uf</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">reshape</span><span class="p">(</span><span class="n">U</span><span class="p">,</span> <span class="n">np</span><span class="o">.</span><span class="n">size</span><span class="p">(</span><span class="n">U</span><span class="p">))</span>
+ <span class="n">Vf</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">reshape</span><span class="p">(</span><span class="n">V</span><span class="p">,</span> <span class="n">np</span><span class="o">.</span><span class="n">size</span><span class="p">(</span><span class="n">V</span><span class="p">))</span>
+ <span class="n">Wf</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">reshape</span><span class="p">(</span><span class="n">W</span><span class="p">,</span> <span class="n">np</span><span class="o">.</span><span class="n">size</span><span class="p">(</span><span class="n">W</span><span class="p">))</span>
+ <span class="n">vel_rot</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">matmul</span><span class="p">(</span><span class="n">Rz</span><span class="p">,</span> <span class="p">[</span><span class="n">Uf</span><span class="p">,</span> <span class="n">Vf</span><span class="p">,</span> <span class="n">Wf</span><span class="p">])</span>
+ <span class="n">Ur</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">reshape</span><span class="p">(</span><span class="n">vel_rot</span><span class="p">[</span><span class="mi">0</span><span class="p">,</span> <span class="p">:],</span> <span class="n">orig_shape</span><span class="p">)</span>
+ <span class="n">Vr</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">reshape</span><span class="p">(</span><span class="n">vel_rot</span><span class="p">[</span><span class="mi">1</span><span class="p">,</span> <span class="p">:],</span> <span class="n">orig_shape</span><span class="p">)</span>
+ <span class="n">Wr</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">reshape</span><span class="p">(</span><span class="n">vel_rot</span><span class="p">[</span><span class="mi">2</span><span class="p">,</span> <span class="p">:],</span> <span class="n">orig_shape</span><span class="p">)</span>
+ <span class="k">return</span> <span class="n">Ur</span><span class="p">,</span> <span class="n">Vr</span><span class="p">,</span> <span class="n">Wr</span></div>
+
+
+</pre></div>
+
+ <div class="clearer"></div>
+ </div>
+ </div>
+ </div>
+ <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+ <div class="sphinxsidebarwrapper">
+<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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
+ <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="nav-item nav-item-0"><a href="../index.html">WaveVal documentation</a> »</li>
+ <li class="nav-item nav-item-1"><a href="index.html" >Module code</a> »</li>
+ <li class="nav-item nav-item-this"><a href="">Geometry</a></li>
+ </ul>
+ </div>
+ <div class="footer" role="contentinfo">
+ © Copyright 2022.
+ Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 4.3.0.
+ </div>
+ </body>
+</html>
\ No newline at end of file
diff --git a/docs/_build/html/_modules/Graphics.html b/docs/_build/html/_modules/Graphics.html
new file mode 100644
index 0000000000000000000000000000000000000000..165a063ee893a842f5aea7c244e76ac8507a864c
--- /dev/null
+++ b/docs/_build/html/_modules/Graphics.html
@@ -0,0 +1,333 @@
+
+
+<!doctype html>
+
+<html lang="en">
+ <head>
+ <meta charset="utf-8" />
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+ <title>Graphics — WaveVal documentation</title>
+ <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
+ <link rel="stylesheet" type="text/css" href="../_static/bizstyle.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 src="../_static/bizstyle.js"></script>
+ <link rel="author" title="About these documents" href="../about.html" />
+ <link rel="index" title="Index" href="../genindex.html" />
+ <link rel="search" title="Search" href="../search.html" />
+ <meta name="viewport" content="width=device-width,initial-scale=1.0" />
+ <!--[if lt IE 9]>
+ <script src="_static/css3-mediaqueries.js"></script>
+ <![endif]-->
+ </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="nav-item nav-item-0"><a href="../index.html">WaveVal documentation</a> »</li>
+ <li class="nav-item nav-item-1"><a href="index.html" accesskey="U">Module code</a> »</li>
+ <li class="nav-item nav-item-this"><a href="">Graphics</a></li>
+ </ul>
+ </div>
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body" role="main">
+
+ <h1>Source code for Graphics</h1><div class="highlight"><pre>
+<span></span><span class="c1"># -*- coding: utf-8 -*-</span>
+<span class="sd">"""</span>
+<span class="sd">Standardised graphics generating functions for displaying resuls from the model </span>
+<span class="sd">validation analysis.</span>
+
+<span class="sd">:Dependencies [External]: matplotlib, cartopy</span>
+<span class="sd">:Dependencies [Internal]: waveval.TimeFuncs</span>
+
+<span class="sd">"""</span>
+<span class="c1"># ----------------------------------------------------------------------------</span>
+<span class="c1"># IMPORTS</span>
+<span class="c1"># ----------------------------------------------------------------------------</span>
+<span class="c1"># Standard Python Dependencies</span>
+<span class="c1"># Non-Standard Python Dependencies</span>
+<span class="kn">import</span> <span class="nn">matplotlib.pyplot</span> <span class="k">as</span> <span class="nn">plt</span>
+<span class="kn">import</span> <span class="nn">matplotlib.ticker</span> <span class="k">as</span> <span class="nn">mticker</span>
+<span class="kn">import</span> <span class="nn">matplotlib.cm</span> <span class="k">as</span> <span class="nn">cm</span>
+<span class="kn">import</span> <span class="nn">cartopy.crs</span> <span class="k">as</span> <span class="nn">ccrs</span>
+<span class="kn">import</span> <span class="nn">cartopy.feature</span> <span class="k">as</span> <span class="nn">cfeature</span>
+<span class="kn">from</span> <span class="nn">cartopy.mpl.gridliner</span> <span class="kn">import</span> <span class="n">LONGITUDE_FORMATTER</span><span class="p">,</span> <span class="n">LATITUDE_FORMATTER</span>
+<span class="c1"># Local Module Dependencies</span>
+<span class="kn">from</span> <span class="nn">waveval.TimeFuncs</span> <span class="kn">import</span> <span class="n">dateStr</span><span class="p">,</span> <span class="n">datetime</span><span class="p">,</span> <span class="n">stdTimeFmt</span><span class="p">,</span> <span class="n">np</span>
+<span class="c1"># Other Dependencies</span>
+
+<span class="c1"># ----------------------------------------------------------------------------</span>
+<span class="c1"># GLOBAL VARIABLES</span>
+<span class="c1"># ----------------------------------------------------------------------------</span>
+
+
+<span class="c1"># ----------------------------------------------------------------------------</span>
+<span class="c1"># CLASS DEFINITIONS</span>
+<span class="c1"># ----------------------------------------------------------------------------</span>
+
+
+<span class="c1"># ----------------------------------------------------------------------------</span>
+<span class="c1"># FUNCTION DEFINITIONS</span>
+<span class="c1"># ----------------------------------------------------------------------------</span>
+<div class="viewcode-block" id="plot_time_series"><a class="viewcode-back" href="../Graphics.html#Graphics.plot_time_series">[docs]</a><span class="k">def</span> <span class="nf">plot_time_series</span><span class="p">(</span><span class="n">t_mod</span><span class="p">,</span> <span class="n">v_mod</span><span class="p">,</span> <span class="n">t_obs</span><span class="p">,</span> <span class="n">v_obs</span><span class="p">,</span>
+ <span class="n">obsVar</span><span class="p">,</span> <span class="n">obsPlatform</span><span class="p">,</span> <span class="n">modVar</span><span class="p">,</span> <span class="n">modfname</span><span class="p">,</span>
+ <span class="n">year</span><span class="p">,</span> <span class="n">month</span><span class="p">,</span>
+ <span class="n">xlims</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">ylims</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Overlaid plot of model and observed time series of specified parameter.</span>
+<span class="sd"> """</span>
+ <span class="n">i_b</span> <span class="o">=</span> <span class="s1">'INSITU_GLO_WAVE'</span>
+ <span class="n">obsDates</span> <span class="o">=</span> <span class="p">[</span><span class="n">datetime</span><span class="o">.</span><span class="n">strptime</span><span class="p">(</span><span class="n">dstr</span><span class="p">,</span> <span class="n">stdTimeFmt</span><span class="p">)</span> <span class="k">for</span> <span class="n">dstr</span> <span class="ow">in</span> <span class="n">dateStr</span><span class="p">(</span><span class="n">t_obs</span><span class="p">)]</span>
+ <span class="n">modDates</span> <span class="o">=</span> <span class="p">[</span><span class="n">datetime</span><span class="o">.</span><span class="n">strptime</span><span class="p">(</span><span class="n">dstr</span><span class="p">,</span> <span class="n">stdTimeFmt</span><span class="p">)</span> <span class="k">for</span> <span class="n">dstr</span> <span class="ow">in</span> <span class="n">dateStr</span><span class="p">(</span><span class="n">t_mod</span><span class="p">)]</span>
+ <span class="n">figHnd</span> <span class="o">=</span> <span class="n">plt</span><span class="o">.</span><span class="n">figure</span><span class="p">(</span><span class="n">figsize</span><span class="o">=</span><span class="p">(</span><span class="mi">10</span><span class="p">,</span><span class="mi">5</span><span class="p">))</span> <span class="c1"># create first figure</span>
+ <span class="n">label</span> <span class="o">=</span> <span class="n">obsPlatform</span><span class="o">+</span><span class="s1">' | year: '</span><span class="o">+</span><span class="nb">str</span><span class="p">(</span><span class="n">year</span><span class="p">)</span><span class="o">+</span><span class="s1">' | month: '</span><span class="o">+</span><span class="nb">str</span><span class="p">(</span><span class="n">month</span><span class="p">)</span>
+ <span class="n">plt</span><span class="o">.</span><span class="n">plot</span><span class="p">(</span><span class="n">obsDates</span><span class="p">,</span> <span class="n">v_obs</span><span class="p">,</span> <span class="s1">'bo-'</span><span class="p">,</span> <span class="n">linewidth</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span> <span class="n">markersize</span><span class="o">=</span><span class="mi">3</span><span class="p">,</span> <span class="n">label</span><span class="o">=</span><span class="n">label</span><span class="p">)</span>
+ <span class="n">label</span><span class="o">=</span> <span class="s1">'RSCD file: '</span><span class="o">+</span><span class="n">modfname</span>
+ <span class="n">plt</span><span class="o">.</span><span class="n">plot</span><span class="p">(</span><span class="n">modDates</span><span class="p">,</span> <span class="n">v_mod</span><span class="p">,</span> <span class="s1">'ro--'</span><span class="p">,</span> <span class="n">linewidth</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span> <span class="n">markersize</span><span class="o">=</span><span class="mi">3</span><span class="p">,</span> <span class="n">label</span><span class="o">=</span><span class="n">label</span><span class="p">)</span>
+ <span class="n">plt</span><span class="o">.</span><span class="n">legend</span><span class="p">()</span>
+ <span class="n">plt</span><span class="o">.</span><span class="n">grid</span><span class="p">(</span><span class="kc">True</span><span class="p">)</span>
+ <span class="n">plt</span><span class="o">.</span><span class="n">title</span><span class="p">(</span><span class="s1">'Buoy source: '</span><span class="o">+</span><span class="n">i_b</span><span class="p">,</span><span class="n">fontsize</span><span class="o">=</span><span class="mi">12</span><span class="p">)</span>
+ <span class="n">plt</span><span class="o">.</span><span class="n">xlabel</span><span class="p">(</span><span class="s1">'Time (dates)'</span><span class="p">,</span><span class="n">fontsize</span><span class="o">=</span><span class="mi">10</span><span class="p">)</span>
+ <span class="n">plt</span><span class="o">.</span><span class="n">ylabel</span><span class="p">(</span><span class="n">obsVar</span><span class="o">+</span><span class="s1">' / '</span><span class="o">+</span><span class="n">modVar</span><span class="o">+</span><span class="s1">' [m]'</span><span class="p">,</span><span class="n">fontsize</span><span class="o">=</span><span class="mi">10</span><span class="p">)</span>
+ <span class="n">plt</span><span class="o">.</span><span class="n">tight_layout</span><span class="p">()</span>
+ <span class="c1">#figHnd.show()</span>
+ <span class="k">return</span> <span class="n">figHnd</span></div>
+
+
+<div class="viewcode-block" id="plot_correlation"><a class="viewcode-back" href="../Graphics.html#Graphics.plot_correlation">[docs]</a><span class="k">def</span> <span class="nf">plot_correlation</span><span class="p">(</span><span class="n">obs</span><span class="p">,</span> <span class="n">model</span><span class="p">,</span> <span class="n">obsVar</span><span class="p">,</span> <span class="n">obsPlatform</span><span class="p">,</span> <span class="n">modVar</span><span class="p">,</span> <span class="n">modfname</span><span class="p">,</span>
+ <span class="n">year</span><span class="p">,</span> <span class="n">month</span><span class="p">,</span> <span class="n">metrics</span><span class="p">):</span>
+ <span class="n">figHnd</span> <span class="o">=</span> <span class="n">plt</span><span class="o">.</span><span class="n">figure</span><span class="p">(</span><span class="n">figsize</span><span class="o">=</span><span class="p">(</span><span class="mi">6</span><span class="p">,</span><span class="mi">6</span><span class="p">))</span> <span class="c1"># create first figure</span>
+ <span class="n">sc</span> <span class="o">=</span> <span class="n">plt</span><span class="o">.</span><span class="n">scatter</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">obs</span><span class="p">,</span> <span class="n">s</span><span class="o">=</span><span class="mi">3</span><span class="p">)</span>
+ <span class="c1">#plt.colorbar(sc)</span>
+ <span class="k">if</span> <span class="nb">max</span><span class="p">(</span><span class="n">obs</span><span class="p">)</span> <span class="o">></span> <span class="nb">max</span><span class="p">(</span><span class="n">model</span><span class="p">):</span>
+ <span class="n">max_plot_val</span> <span class="o">=</span> <span class="nb">max</span><span class="p">(</span><span class="n">obs</span><span class="p">)</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">max_plot_val</span> <span class="o">=</span> <span class="nb">max</span><span class="p">(</span><span class="n">model</span><span class="p">)</span>
+ <span class="n">plt</span><span class="o">.</span><span class="n">plot</span><span class="p">([</span><span class="mi">0</span><span class="p">,</span> <span class="n">max_plot_val</span><span class="o">+</span><span class="mi">1</span><span class="p">],</span> <span class="p">[</span><span class="mi">0</span><span class="p">,</span> <span class="n">max_plot_val</span><span class="o">+</span><span class="mi">1</span><span class="p">],</span> <span class="n">color</span><span class="o">=</span><span class="s1">'k'</span><span class="p">,</span> <span class="n">label</span><span class="o">=</span><span class="s1">'1:1'</span><span class="p">)</span>
+ <span class="n">plt</span><span class="o">.</span><span class="n">legend</span><span class="p">(</span><span class="n">loc</span><span class="o">=</span><span class="s1">'upper right'</span><span class="p">)</span>
+ <span class="n">plt</span><span class="o">.</span><span class="n">title</span><span class="p">(</span><span class="n">obsVar</span><span class="o">+</span><span class="s1">' vs '</span><span class="o">+</span><span class="n">modVar</span><span class="p">,</span> <span class="n">fontsize</span><span class="o">=</span><span class="mi">12</span><span class="p">)</span>
+ <span class="n">plt</span><span class="o">.</span><span class="n">xlabel</span><span class="p">(</span><span class="n">modfname</span><span class="p">,</span> <span class="n">fontsize</span><span class="o">=</span><span class="mi">10</span><span class="p">)</span>
+ <span class="n">plt</span><span class="o">.</span><span class="n">ylabel</span><span class="p">(</span><span class="s1">'Buoy: '</span><span class="o">+</span><span class="n">obsPlatform</span><span class="p">,</span> <span class="n">fontsize</span><span class="o">=</span><span class="mi">10</span><span class="p">)</span>
+
+ <span class="n">ax</span> <span class="o">=</span> <span class="n">plt</span><span class="o">.</span><span class="n">gca</span><span class="p">()</span>
+ <span class="n">plt</span><span class="o">.</span><span class="n">text</span><span class="p">(</span><span class="mf">0.05</span><span class="p">,</span><span class="mf">0.9</span><span class="p">,</span>
+ <span class="s1">'Corr. : '</span><span class="o">+</span><span class="nb">str</span><span class="p">(</span><span class="nb">round</span><span class="p">(</span><span class="n">metrics</span><span class="p">[</span><span class="s1">'R'</span><span class="p">],</span> <span class="mi">3</span><span class="p">))</span><span class="o">+</span>\
+ <span class="s1">' RMSE : '</span><span class="o">+</span><span class="nb">str</span><span class="p">(</span><span class="nb">round</span><span class="p">(</span><span class="n">metrics</span><span class="p">[</span><span class="s1">'RMSE'</span><span class="p">],</span> <span class="mi">3</span><span class="p">))</span><span class="o">+</span><span class="s1">' [m]'</span><span class="o">+</span>\
+ <span class="s1">' NRMSE : '</span><span class="o">+</span><span class="nb">str</span><span class="p">(</span><span class="nb">round</span><span class="p">(</span><span class="n">metrics</span><span class="p">[</span><span class="s1">'NRMSE'</span><span class="p">],</span> <span class="mi">3</span><span class="p">))</span><span class="o">+</span><span class="s1">' [%]'</span><span class="o">+</span>\
+ <span class="s1">'</span><span class="se">\n</span><span class="s1">SI : '</span><span class="o">+</span><span class="nb">str</span><span class="p">(</span><span class="nb">round</span><span class="p">(</span><span class="n">metrics</span><span class="p">[</span><span class="s1">'SI'</span><span class="p">],</span> <span class="mi">3</span><span class="p">))</span><span class="o">+</span>\
+ <span class="s1">' NMB : '</span><span class="o">+</span><span class="nb">str</span><span class="p">(</span><span class="nb">round</span><span class="p">(</span><span class="n">metrics</span><span class="p">[</span><span class="s1">'NMB'</span><span class="p">],</span> <span class="mi">3</span><span class="p">))</span><span class="o">+</span><span class="s1">' [%]'</span><span class="p">,</span>\
+ <span class="n">bbox</span><span class="o">=</span><span class="nb">dict</span><span class="p">(</span><span class="n">fc</span><span class="o">=</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">1</span><span class="p">)),</span> <span class="n">fontsize</span><span class="o">=</span><span class="mi">10</span><span class="p">,</span>
+ <span class="n">transform</span><span class="o">=</span><span class="n">ax</span><span class="o">.</span><span class="n">transAxes</span><span class="p">)</span>
+
+ <span class="n">plt</span><span class="o">.</span><span class="n">grid</span><span class="p">(</span><span class="kc">True</span><span class="p">)</span>
+ <span class="n">plt</span><span class="o">.</span><span class="n">tight_layout</span><span class="p">()</span>
+ <span class="c1">#figHnd.show()</span>
+ <span class="k">return</span> <span class="n">figHnd</span></div>
+
+
+<div class="viewcode-block" id="plot_close"><a class="viewcode-back" href="../Graphics.html#Graphics.plot_close">[docs]</a><span class="k">def</span> <span class="nf">plot_close</span><span class="p">(</span><span class="n">figHnd</span><span class="p">):</span>
+ <span class="n">plt</span><span class="o">.</span><span class="n">close</span><span class="p">(</span><span class="n">figHnd</span><span class="p">)</span>
+ <span class="k">return</span></div>
+
+
+<div class="viewcode-block" id="Regional_Weighted"><a class="viewcode-back" href="../Graphics.html#Graphics.Regional_Weighted">[docs]</a><span class="k">def</span> <span class="nf">Regional_Weighted</span><span class="p">(</span><span class="n">lat</span><span class="p">:</span> <span class="nb">list</span><span class="p">,</span> <span class="n">lon</span><span class="p">:</span> <span class="nb">list</span><span class="p">,</span> <span class="n">wght</span><span class="p">:</span> <span class="nb">list</span><span class="p">,</span> <span class="n">plot_area</span><span class="p">:</span> <span class="nb">list</span><span class="p">,</span>
+ <span class="n">clims</span><span class="p">:</span> <span class="nb">list</span><span class="p">,</span>
+ <span class="n">plotTitle</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">outpath</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">outname</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
+ <span class="n">saveplot</span><span class="p">:</span> <span class="nb">bool</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Regional map of parameters at specific locations colourised by a </span>
+<span class="sd"> wieghting factor.</span>
+<span class="sd"> """</span>
+ <span class="c1"># plot_area = [-15, 15, 35, 70]</span>
+ <span class="n">lon_div</span> <span class="o">=</span> <span class="p">[</span><span class="n">plot_area</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span>
+ <span class="n">plot_area</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">+</span><span class="mi">5</span><span class="p">,</span>
+ <span class="n">plot_area</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">+</span><span class="mi">10</span><span class="p">,</span>
+ <span class="mi">0</span><span class="p">,</span>
+ <span class="n">plot_area</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span><span class="o">-</span><span class="mi">10</span><span class="p">,</span>
+ <span class="n">plot_area</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span><span class="o">-</span><span class="mi">5</span><span class="p">,</span>
+ <span class="n">plot_area</span><span class="p">[</span><span class="mi">1</span><span class="p">]]</span>
+ <span class="n">lat_div</span> <span class="o">=</span> <span class="p">[</span><span class="n">plot_area</span><span class="p">[</span><span class="mi">2</span><span class="p">],</span>
+ <span class="n">plot_area</span><span class="p">[</span><span class="mi">2</span><span class="p">]</span><span class="o">+</span><span class="mi">5</span><span class="p">,</span>
+ <span class="n">plot_area</span><span class="p">[</span><span class="mi">2</span><span class="p">]</span><span class="o">+</span><span class="mi">10</span><span class="p">,</span>
+ <span class="n">plot_area</span><span class="p">[</span><span class="mi">2</span><span class="p">]</span><span class="o">+</span><span class="mi">15</span><span class="p">,</span>
+ <span class="n">plot_area</span><span class="p">[</span><span class="mi">3</span><span class="p">]</span><span class="o">-</span><span class="mi">15</span><span class="p">,</span>
+ <span class="n">plot_area</span><span class="p">[</span><span class="mi">3</span><span class="p">]</span><span class="o">-</span><span class="mi">10</span><span class="p">,</span>
+ <span class="n">plot_area</span><span class="p">[</span><span class="mi">3</span><span class="p">]</span><span class="o">-</span><span class="mi">5</span><span class="p">,</span>
+ <span class="n">plot_area</span><span class="p">[</span><span class="mi">3</span><span class="p">]]</span>
+
+ <span class="c1">#fig = plt.figure(figsize=(11, 10))</span>
+ <span class="n">fig</span> <span class="o">=</span> <span class="n">plt</span><span class="o">.</span><span class="n">figure</span><span class="p">(</span><span class="n">figsize</span><span class="o">=</span><span class="p">(</span><span class="mi">9</span><span class="p">,</span> <span class="mi">10</span><span class="p">))</span>
+ <span class="n">cm</span> <span class="o">=</span> <span class="n">plt</span><span class="o">.</span><span class="n">cm</span><span class="o">.</span><span class="n">get_cmap</span><span class="p">(</span><span class="s1">'YlOrRd'</span><span class="p">)</span>
+ <span class="n">ax</span> <span class="o">=</span> <span class="n">plt</span><span class="o">.</span><span class="n">axes</span><span class="p">(</span><span class="n">projection</span><span class="o">=</span><span class="n">ccrs</span><span class="o">.</span><span class="n">PlateCarree</span><span class="p">())</span>
+ <span class="n">ax</span><span class="o">.</span><span class="n">add_feature</span><span class="p">(</span><span class="n">cfeature</span><span class="o">.</span><span class="n">LAND</span><span class="p">,</span><span class="n">color</span><span class="o">=</span><span class="s1">'grey'</span><span class="p">,</span><span class="n">alpha</span><span class="o">=</span><span class="mf">0.7</span><span class="p">)</span>
+ <span class="n">ax</span><span class="o">.</span><span class="n">add_feature</span><span class="p">(</span><span class="n">cfeature</span><span class="o">.</span><span class="n">OCEAN</span><span class="p">,</span><span class="n">color</span><span class="o">=</span><span class="s1">'grey'</span><span class="p">,</span><span class="n">alpha</span><span class="o">=</span><span class="mf">0.15</span><span class="p">)</span>
+ <span class="n">ax</span><span class="o">.</span><span class="n">coastlines</span><span class="p">(</span><span class="n">resolution</span><span class="o">=</span><span class="s1">'10m'</span><span class="p">)</span> <span class="c1"># Options are 110, 50m, or 10m</span>
+ <span class="n">sc</span> <span class="o">=</span> <span class="n">plt</span><span class="o">.</span><span class="n">scatter</span><span class="p">(</span><span class="n">lon</span><span class="p">,</span> <span class="n">lat</span><span class="p">,</span> <span class="n">c</span><span class="o">=</span><span class="n">wght</span><span class="p">,</span> <span class="n">transform</span><span class="o">=</span><span class="n">ccrs</span><span class="o">.</span><span class="n">PlateCarree</span><span class="p">(),</span>
+ <span class="n">s</span><span class="o">=</span><span class="mi">80</span><span class="p">,</span><span class="n">alpha</span><span class="o">=</span><span class="mf">0.8</span><span class="p">,</span> <span class="n">cmap</span><span class="o">=</span><span class="n">cm</span><span class="p">,</span> <span class="n">zorder</span> <span class="o">=</span> <span class="mi">3</span><span class="p">)</span>
+ <span class="k">if</span> <span class="n">clims</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
+ <span class="n">plt</span><span class="o">.</span><span class="n">clim</span><span class="p">(</span><span class="n">clims</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span><span class="n">clims</span><span class="p">[</span><span class="mi">1</span><span class="p">])</span>
+ <span class="c1">#plt.colorbar(sc, fraction=0.05, aspect=30, pad=0.1, shrink=0.95)</span>
+ <span class="n">plt</span><span class="o">.</span><span class="n">colorbar</span><span class="p">(</span><span class="n">sc</span><span class="p">,</span> <span class="n">fraction</span><span class="o">=</span><span class="mf">0.05</span><span class="p">,</span> <span class="n">aspect</span><span class="o">=</span><span class="mi">30</span><span class="p">,</span> <span class="n">pad</span><span class="o">=</span><span class="mf">0.1</span><span class="p">,</span> <span class="n">shrink</span><span class="o">=</span><span class="mf">0.80</span><span class="p">)</span>
+ <span class="n">ax</span><span class="o">.</span><span class="n">set_extent</span><span class="p">(</span><span class="n">plot_area</span><span class="p">)</span>
+ <span class="n">gl</span> <span class="o">=</span> <span class="n">ax</span><span class="o">.</span><span class="n">gridlines</span><span class="p">(</span><span class="n">crs</span><span class="o">=</span><span class="n">ccrs</span><span class="o">.</span><span class="n">PlateCarree</span><span class="p">(),</span> <span class="n">draw_labels</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
+ <span class="n">linewidth</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span> <span class="n">color</span><span class="o">=</span><span class="s1">'gray'</span><span class="p">,</span> <span class="n">alpha</span><span class="o">=</span><span class="mf">0.8</span><span class="p">)</span>
+ <span class="n">gl</span><span class="o">.</span><span class="n">xlabel_style</span> <span class="o">=</span> <span class="p">{</span><span class="s1">'size'</span><span class="p">:</span> <span class="mi">12</span><span class="p">,</span><span class="s1">'color'</span><span class="p">:</span> <span class="s1">'gray'</span><span class="p">}</span><span class="c1">#, 'weight': 'bold'}</span>
+ <span class="n">gl</span><span class="o">.</span><span class="n">ylabel_style</span> <span class="o">=</span> <span class="p">{</span><span class="s1">'size'</span><span class="p">:</span> <span class="mi">12</span><span class="p">,</span><span class="s1">'color'</span><span class="p">:</span> <span class="s1">'gray'</span><span class="p">}</span><span class="c1">#, 'weight': 'bold'}</span>
+ <span class="n">gl</span><span class="o">.</span><span class="n">xlocator</span> <span class="o">=</span> <span class="n">mticker</span><span class="o">.</span><span class="n">FixedLocator</span><span class="p">(</span><span class="n">lon_div</span><span class="p">)</span>
+ <span class="n">gl</span><span class="o">.</span><span class="n">ylocator</span> <span class="o">=</span> <span class="n">mticker</span><span class="o">.</span><span class="n">FixedLocator</span><span class="p">(</span><span class="n">lat_div</span><span class="p">)</span>
+ <span class="n">gl</span><span class="o">.</span><span class="n">xformatter</span> <span class="o">=</span> <span class="n">LONGITUDE_FORMATTER</span>
+ <span class="n">gl</span><span class="o">.</span><span class="n">yformatter</span> <span class="o">=</span> <span class="n">LATITUDE_FORMATTER</span>
+ <span class="n">plt</span><span class="o">.</span><span class="n">title</span><span class="p">(</span><span class="n">plotTitle</span><span class="p">)</span>
+ <span class="n">plt</span><span class="o">.</span><span class="n">tight_layout</span><span class="p">(</span><span class="n">pad</span><span class="o">=</span><span class="mi">5</span><span class="p">)</span>
+
+ <span class="k">if</span> <span class="n">saveplot</span><span class="p">:</span>
+ <span class="n">fig</span><span class="o">.</span><span class="n">savefig</span><span class="p">(</span><span class="n">outpath</span><span class="o">+</span><span class="s1">'/'</span><span class="o">+</span><span class="n">outname</span><span class="o">+</span><span class="s1">'.png'</span><span class="p">)</span>
+
+ <span class="k">return</span></div>
+
+
+<div class="viewcode-block" id="Regional"><a class="viewcode-back" href="../Graphics.html#Graphics.Regional">[docs]</a><span class="k">def</span> <span class="nf">Regional</span><span class="p">(</span><span class="n">lat</span><span class="p">:</span> <span class="nb">list</span><span class="p">,</span> <span class="n">lon</span><span class="p">:</span> <span class="nb">list</span><span class="p">,</span>
+ <span class="n">plot_area</span><span class="p">:</span> <span class="nb">list</span><span class="p">,</span> <span class="n">lat_div</span><span class="p">:</span> <span class="nb">list</span><span class="p">,</span> <span class="n">lon_div</span><span class="p">:</span> <span class="nb">list</span><span class="p">,</span>
+ <span class="n">outpath</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">outname</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
+ <span class="n">saveplot</span><span class="p">:</span> <span class="nb">bool</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Regional map of specific locations.</span>
+<span class="sd"> """</span>
+
+ <span class="c1"># plot_area = [-15, 15, 35, 70]</span>
+ <span class="sd">'''</span>
+<span class="sd"> lon_div = [plot_area[0],</span>
+<span class="sd"> plot_area[0]+5,</span>
+<span class="sd"> plot_area[0]+10,</span>
+<span class="sd"> 0,</span>
+<span class="sd"> plot_area[1]-10,</span>
+<span class="sd"> plot_area[1]-5,</span>
+<span class="sd"> plot_area[1]]</span>
+<span class="sd"> lat_div = [plot_area[2],</span>
+<span class="sd"> plot_area[2]+5,</span>
+<span class="sd"> plot_area[2]+10,</span>
+<span class="sd"> plot_area[2]+15,</span>
+<span class="sd"> plot_area[3]-15,</span>
+<span class="sd"> plot_area[3]-10,</span>
+<span class="sd"> plot_area[3]-5,</span>
+<span class="sd"> plot_area[3]]</span>
+<span class="sd"> '''</span>
+ <span class="n">fig</span> <span class="o">=</span> <span class="n">plt</span><span class="o">.</span><span class="n">figure</span><span class="p">(</span><span class="n">figsize</span><span class="o">=</span><span class="p">(</span><span class="mf">9.5</span><span class="p">,</span> <span class="mi">10</span><span class="p">))</span>
+ <span class="n">cm</span> <span class="o">=</span> <span class="n">plt</span><span class="o">.</span><span class="n">cm</span><span class="o">.</span><span class="n">get_cmap</span><span class="p">(</span><span class="s1">'YlOrRd'</span><span class="p">)</span>
+ <span class="n">ax</span> <span class="o">=</span> <span class="n">plt</span><span class="o">.</span><span class="n">axes</span><span class="p">(</span><span class="n">projection</span><span class="o">=</span><span class="n">ccrs</span><span class="o">.</span><span class="n">PlateCarree</span><span class="p">())</span>
+ <span class="n">ax</span><span class="o">.</span><span class="n">add_feature</span><span class="p">(</span><span class="n">cfeature</span><span class="o">.</span><span class="n">LAND</span><span class="p">,</span><span class="n">color</span><span class="o">=</span><span class="s1">'grey'</span><span class="p">,</span><span class="n">alpha</span><span class="o">=</span><span class="mf">0.7</span><span class="p">)</span>
+ <span class="n">ax</span><span class="o">.</span><span class="n">add_feature</span><span class="p">(</span><span class="n">cfeature</span><span class="o">.</span><span class="n">OCEAN</span><span class="p">,</span><span class="n">color</span><span class="o">=</span><span class="s1">'grey'</span><span class="p">,</span><span class="n">alpha</span><span class="o">=</span><span class="mf">0.15</span><span class="p">)</span>
+ <span class="n">ax</span><span class="o">.</span><span class="n">coastlines</span><span class="p">(</span><span class="n">resolution</span><span class="o">=</span><span class="s1">'10m'</span><span class="p">)</span> <span class="c1"># Options are 110, 50m, or 10m</span>
+ <span class="n">sc</span> <span class="o">=</span> <span class="n">plt</span><span class="o">.</span><span class="n">scatter</span><span class="p">(</span><span class="n">lon</span><span class="p">,</span> <span class="n">lat</span><span class="p">,</span> <span class="n">c</span><span class="o">=</span><span class="s1">'c'</span><span class="p">,</span> <span class="n">transform</span><span class="o">=</span><span class="n">ccrs</span><span class="o">.</span><span class="n">PlateCarree</span><span class="p">(),</span>
+ <span class="n">s</span><span class="o">=</span><span class="mi">20</span><span class="p">,</span><span class="n">alpha</span><span class="o">=</span><span class="mf">0.8</span><span class="p">,</span> <span class="n">cmap</span><span class="o">=</span><span class="n">cm</span><span class="p">,</span><span class="n">zorder</span> <span class="o">=</span> <span class="mi">3</span><span class="p">)</span>
+ <span class="n">ax</span><span class="o">.</span><span class="n">set_extent</span><span class="p">(</span><span class="n">plot_area</span><span class="p">)</span>
+ <span class="n">gl</span> <span class="o">=</span> <span class="n">ax</span><span class="o">.</span><span class="n">gridlines</span><span class="p">(</span><span class="n">crs</span><span class="o">=</span><span class="n">ccrs</span><span class="o">.</span><span class="n">PlateCarree</span><span class="p">(),</span> <span class="n">draw_labels</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
+ <span class="n">linewidth</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span> <span class="n">color</span><span class="o">=</span><span class="s1">'gray'</span><span class="p">,</span> <span class="n">alpha</span><span class="o">=</span><span class="mf">0.8</span><span class="p">)</span>
+ <span class="n">gl</span><span class="o">.</span><span class="n">xlabel_style</span> <span class="o">=</span> <span class="p">{</span><span class="s1">'size'</span><span class="p">:</span> <span class="mi">12</span><span class="p">,</span><span class="s1">'color'</span><span class="p">:</span> <span class="s1">'gray'</span><span class="p">}</span><span class="c1">#, 'weight': 'bold'}</span>
+ <span class="n">gl</span><span class="o">.</span><span class="n">ylabel_style</span> <span class="o">=</span> <span class="p">{</span><span class="s1">'size'</span><span class="p">:</span> <span class="mi">12</span><span class="p">,</span><span class="s1">'color'</span><span class="p">:</span> <span class="s1">'gray'</span><span class="p">}</span><span class="c1">#, 'weight': 'bold'}</span>
+ <span class="n">gl</span><span class="o">.</span><span class="n">xlocator</span> <span class="o">=</span> <span class="n">mticker</span><span class="o">.</span><span class="n">FixedLocator</span><span class="p">(</span><span class="n">lon_div</span><span class="p">)</span>
+ <span class="n">gl</span><span class="o">.</span><span class="n">ylocator</span> <span class="o">=</span> <span class="n">mticker</span><span class="o">.</span><span class="n">FixedLocator</span><span class="p">(</span><span class="n">lat_div</span><span class="p">)</span>
+ <span class="n">gl</span><span class="o">.</span><span class="n">xformatter</span> <span class="o">=</span> <span class="n">LONGITUDE_FORMATTER</span>
+ <span class="n">gl</span><span class="o">.</span><span class="n">yformatter</span> <span class="o">=</span> <span class="n">LATITUDE_FORMATTER</span>
+ <span class="n">plt</span><span class="o">.</span><span class="n">tight_layout</span><span class="p">(</span><span class="n">pad</span><span class="o">=</span><span class="mi">5</span><span class="p">)</span>
+
+ <span class="k">if</span> <span class="n">saveplot</span><span class="p">:</span>
+ <span class="n">fig</span><span class="o">.</span><span class="n">savefig</span><span class="p">(</span><span class="n">outpath</span><span class="o">+</span><span class="s1">'/'</span><span class="o">+</span><span class="n">outname</span><span class="o">+</span><span class="s1">'.png'</span><span class="p">)</span>
+
+ <span class="k">return</span></div>
+
+<div class="viewcode-block" id="plot_1d_spec"><a class="viewcode-back" href="../Graphics.html#Graphics.plot_1d_spec">[docs]</a><span class="k">def</span> <span class="nf">plot_1d_spec</span><span class="p">(</span><span class="n">freq</span><span class="p">,</span> <span class="n">spec1D</span><span class="p">,</span> <span class="n">titleStr</span><span class="p">:</span><span class="nb">str</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
+ <span class="n">outpath</span><span class="p">:</span><span class="nb">str</span><span class="o">=</span><span class="s1">'./'</span><span class="p">,</span> <span class="n">outname</span><span class="p">:</span><span class="nb">str</span><span class="o">=</span><span class="s1">'spec_1d'</span><span class="p">,</span> <span class="n">saveplot</span><span class="p">:</span><span class="nb">bool</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Plot of a 1-D wave frequency spectrum</span>
+<span class="sd"> """</span>
+ <span class="n">fhnd</span> <span class="o">=</span> <span class="n">plt</span><span class="o">.</span><span class="n">figure</span><span class="p">(</span><span class="n">figsize</span><span class="o">=</span><span class="p">(</span><span class="mi">10</span><span class="p">,</span><span class="mi">5</span><span class="p">))</span>
+ <span class="n">plt</span><span class="o">.</span><span class="n">plot</span><span class="p">(</span><span class="n">freq</span><span class="p">,</span><span class="n">spec1D</span><span class="p">,</span><span class="s1">'k'</span><span class="p">)</span>
+ <span class="n">plt</span><span class="o">.</span><span class="n">grid</span><span class="p">()</span>
+ <span class="n">plt</span><span class="o">.</span><span class="n">xlabel</span><span class="p">(</span><span class="s1">'Frequency [Hz]'</span><span class="p">)</span>
+ <span class="n">plt</span><span class="o">.</span><span class="n">ylabel</span><span class="p">(</span><span class="s1">'S(f) [$m^2 s$]'</span><span class="p">)</span>
+ <span class="n">plt</span><span class="o">.</span><span class="n">title</span><span class="p">(</span><span class="n">titleStr</span><span class="p">)</span>
+
+ <span class="k">if</span> <span class="n">saveplot</span><span class="p">:</span>
+ <span class="n">fhnd</span><span class="o">.</span><span class="n">savefig</span><span class="p">(</span><span class="n">outpath</span><span class="o">+</span><span class="s1">'/'</span><span class="o">+</span><span class="n">outname</span><span class="o">+</span><span class="s1">'.png'</span><span class="p">)</span>
+
+ <span class="k">return</span></div>
+
+
+<div class="viewcode-block" id="plot_2d_spec"><a class="viewcode-back" href="../Graphics.html#Graphics.plot_2d_spec">[docs]</a><span class="k">def</span> <span class="nf">plot_2d_spec</span><span class="p">(</span><span class="n">freq</span><span class="p">,</span> <span class="n">ntheta</span><span class="p">,</span> <span class="n">spec2D</span><span class="p">,</span> <span class="n">fmax</span><span class="p">:</span><span class="nb">float</span><span class="o">=</span><span class="mf">0.25</span><span class="p">,</span> <span class="n">cmax</span><span class="p">:</span><span class="nb">float</span><span class="o">=</span><span class="mf">2.0</span><span class="p">,</span> <span class="n">titleStr</span><span class="p">:</span><span class="nb">str</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Plot of a 2-D wave frequency spectrum</span>
+<span class="sd"> """</span>
+ <span class="n">ifrq</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">where</span><span class="p">(</span><span class="n">freq</span> <span class="o"><=</span> <span class="n">fmax</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span>
+ <span class="n">f</span> <span class="o">=</span> <span class="n">freq</span><span class="p">[</span><span class="n">ifrq</span><span class="p">]</span>
+ <span class="n">nfreq</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="n">f</span><span class="p">)</span>
+ <span class="n">sp</span> <span class="o">=</span> <span class="n">spec2D</span><span class="p">[</span><span class="n">ifrq</span><span class="p">,:]</span>
+ <span class="n">sp</span> <span class="o">=</span> <span class="mf">100.0</span> <span class="o">*</span> <span class="n">sp</span> <span class="o">/</span> <span class="n">np</span><span class="o">.</span><span class="n">nansum</span><span class="p">(</span><span class="n">sp</span><span class="p">)</span>
+ <span class="c1">#print(np.nanmax(sp))</span>
+ <span class="n">sp</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">sp</span><span class="p">,</span><span class="n">sp</span><span class="p">[:,</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">reshape</span><span class="p">(</span><span class="n">nfreq</span><span class="p">,</span><span class="mi">1</span><span class="p">),</span><span class="mi">1</span><span class="p">)</span>
+ <span class="n">theta</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">linspace</span><span class="p">(</span><span class="mf">0.0</span><span class="p">,</span><span class="mf">360.0</span><span class="p">,</span><span class="n">ntheta</span><span class="o">+</span><span class="mi">1</span><span class="p">)</span>
+ <span class="n">r</span><span class="p">,</span> <span class="n">t</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">meshgrid</span><span class="p">(</span><span class="n">f</span><span class="p">,</span> <span class="n">np</span><span class="o">.</span><span class="n">radians</span><span class="p">(</span><span class="n">theta</span><span class="p">))</span>
+ <span class="c1">#clevels = np.arange(0,0.75,0.01)</span>
+ <span class="n">clevels</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">arange</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span><span class="mf">2.0</span><span class="p">,</span><span class="mf">0.01</span><span class="p">)</span>
+ <span class="n">fig</span><span class="p">,</span> <span class="n">ax</span> <span class="o">=</span> <span class="n">plt</span><span class="o">.</span><span class="n">subplots</span><span class="p">(</span><span class="n">subplot_kw</span><span class="o">=</span><span class="nb">dict</span><span class="p">(</span><span class="n">projection</span><span class="o">=</span><span class="s1">'polar'</span><span class="p">),</span> <span class="n">figsize</span><span class="o">=</span><span class="p">(</span><span class="mi">10</span><span class="p">,</span><span class="mi">10</span><span class="p">))</span>
+ <span class="n">ax</span><span class="o">.</span><span class="n">contourf</span><span class="p">(</span><span class="n">t</span><span class="p">,</span> <span class="n">r</span><span class="p">,</span> <span class="n">sp</span><span class="o">.</span><span class="n">transpose</span><span class="p">(),</span> <span class="n">clevels</span><span class="p">,</span> <span class="n">cmap</span><span class="o">=</span><span class="n">cm</span><span class="o">.</span><span class="n">twilight</span><span class="p">)</span>
+ <span class="n">clevels</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">arange</span><span class="p">(</span><span class="mf">0.1</span><span class="p">,</span><span class="n">cmax</span><span class="p">,</span><span class="mf">0.05</span><span class="p">)</span>
+ <span class="n">ax</span><span class="o">.</span><span class="n">contour</span><span class="p">(</span><span class="n">t</span><span class="p">,</span> <span class="n">r</span><span class="p">,</span> <span class="n">sp</span><span class="o">.</span><span class="n">transpose</span><span class="p">(),</span> <span class="n">clevels</span><span class="p">,</span> <span class="n">colors</span><span class="o">=</span><span class="p">[</span><span class="s1">'k'</span><span class="p">],</span> <span class="n">linewidths</span><span class="o">=</span><span class="mf">0.2</span><span class="p">)</span>
+ <span class="k">if</span> <span class="n">titleStr</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
+ <span class="n">plt</span><span class="o">.</span><span class="n">title</span><span class="p">(</span><span class="n">titleStr</span><span class="p">)</span>
+ <span class="k">return</span> <span class="n">fig</span></div>
+
+</pre></div>
+
+ <div class="clearer"></div>
+ </div>
+ </div>
+ </div>
+ <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+ <div class="sphinxsidebarwrapper">
+<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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
+ <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="nav-item nav-item-0"><a href="../index.html">WaveVal documentation</a> »</li>
+ <li class="nav-item nav-item-1"><a href="index.html" >Module code</a> »</li>
+ <li class="nav-item nav-item-this"><a href="">Graphics</a></li>
+ </ul>
+ </div>
+ <div class="footer" role="contentinfo">
+ © Copyright 2022.
+ Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 4.3.0.
+ </div>
+ </body>
+</html>
\ No newline at end of file
diff --git a/docs/_build/html/_modules/MatchUpDatabase.html b/docs/_build/html/_modules/MatchUpDatabase.html
new file mode 100644
index 0000000000000000000000000000000000000000..72ffb4b8fd4db6e2b6cc92697386b0eb7f28866f
--- /dev/null
+++ b/docs/_build/html/_modules/MatchUpDatabase.html
@@ -0,0 +1,693 @@
+
+
+<!doctype html>
+
+<html lang="en">
+ <head>
+ <meta charset="utf-8" />
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+ <title>MatchUpDatabase — WaveVal documentation</title>
+ <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
+ <link rel="stylesheet" type="text/css" href="../_static/bizstyle.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 src="../_static/bizstyle.js"></script>
+ <link rel="author" title="About these documents" href="../about.html" />
+ <link rel="index" title="Index" href="../genindex.html" />
+ <link rel="search" title="Search" href="../search.html" />
+ <meta name="viewport" content="width=device-width,initial-scale=1.0" />
+ <!--[if lt IE 9]>
+ <script src="_static/css3-mediaqueries.js"></script>
+ <![endif]-->
+ </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="nav-item nav-item-0"><a href="../index.html">WaveVal documentation</a> »</li>
+ <li class="nav-item nav-item-1"><a href="index.html" accesskey="U">Module code</a> »</li>
+ <li class="nav-item nav-item-this"><a href="">MatchUpDatabase</a></li>
+ </ul>
+ </div>
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body" role="main">
+
+ <h1>Source code for MatchUpDatabase</h1><div class="highlight"><pre>
+<span></span><span class="c1"># -*- coding: utf-8 -*-</span>
+<span class="sd">"""</span>
+<span class="sd">Tools for generating an SQLite matchup database from a set of model extracts </span>
+<span class="sd">and an archive of wavebuoy data.</span>
+
+<span class="sd">These tools are tied to the ResourceCode WaveWatch III model hindcast data, </span>
+<span class="sd">but the undelying functions for opening, populating and querying and SQLite </span>
+<span class="sd">dataase are generic. </span>
+
+<span class="sd">:Dependencies [External]: os, re, sqlite, csv</span>
+<span class="sd">:Dependencies [Internal]: waveval.Geomtery, waveval.TimeFuncs, waveval.ObsData, waveval.ModelData</span>
+
+<span class="sd">"""</span>
+<span class="c1"># ----------------------------------------------------------------------------</span>
+<span class="c1"># IMPORTS</span>
+<span class="c1"># ----------------------------------------------------------------------------</span>
+<span class="c1"># Standard Python Dependencies</span>
+<span class="kn">import</span> <span class="nn">os</span>
+<span class="kn">import</span> <span class="nn">re</span>
+<span class="kn">import</span> <span class="nn">sqlite3</span>
+<span class="kn">import</span> <span class="nn">csv</span>
+<span class="c1"># Non-Standard Python Dependencies</span>
+<span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
+<span class="c1"># Local Module Dependencies</span>
+<span class="kn">from</span> <span class="nn">waveval.Geometry</span> <span class="kn">import</span> <span class="n">spatialCoverage</span>
+<span class="kn">from</span> <span class="nn">waveval.TimeFuncs</span> <span class="kn">import</span> <span class="n">temporalCoverage</span><span class="p">,</span> <span class="n">dateNumFromStr</span>
+<span class="kn">import</span> <span class="nn">waveval.ObsData</span> <span class="k">as</span> <span class="nn">OData</span>
+<span class="kn">import</span> <span class="nn">waveval.ModelData</span> <span class="k">as</span> <span class="nn">MData</span>
+<span class="c1"># Other Dependencies</span>
+
+<span class="c1"># ----------------------------------------------------------------------------</span>
+<span class="c1"># GLOBAL VARIABLES</span>
+<span class="c1"># ----------------------------------------------------------------------------</span>
+<span class="n">rscd_table_sql</span> <span class="o">=</span> <span class="s2">""" CREATE TABLE IF NOT EXISTS rscd_files (</span>
+<span class="s2"> id integer PRIMARY KEY,</span>
+<span class="s2"> platform text NOT NULL,</span>
+<span class="s2"> filePath text NOT NULL,</span>
+<span class="s2"> fileName text NOT NULL,</span>
+<span class="s2"> latitude real NOT NULL,</span>
+<span class="s2"> longitude real NOT NULL,</span>
+<span class="s2"> beginDate timestamp NOT NULL,</span>
+<span class="s2"> endDate timestamp NOT NULL,</span>
+<span class="s2"> year integer NOT NULL,</span>
+<span class="s2"> month integer NOT NULL,</span>
+<span class="s2"> samplePeriod real NOT NULL</span>
+<span class="s2"> ); """</span>
+
+<span class="n">buoy_table_sql</span> <span class="o">=</span> <span class="s2">""" CREATE TABLE IF NOT EXISTS buoy_files (</span>
+<span class="s2"> id integer PRIMARY KEY,</span>
+<span class="s2"> platform text NOT NULL,</span>
+<span class="s2"> filePath text NOT NULL,</span>
+<span class="s2"> fileName text NOT NULL,</span>
+<span class="s2"> latitude real NOT NULL,</span>
+<span class="s2"> longitude real NOT NULL,</span>
+<span class="s2"> beginDate timestamp NOT NULL,</span>
+<span class="s2"> endDate timestamp NOT NULL,</span>
+<span class="s2"> samplePeriod real NOT NULL</span>
+<span class="s2"> ); """</span>
+
+<span class="n">match_table_sql</span> <span class="o">=</span> <span class="s2">""" CREATE TABLE IF NOT EXISTS match_files (</span>
+<span class="s2"> id integer PRIMARY KEY,</span>
+<span class="s2"> rscdRecID integer NOT NULL,</span>
+<span class="s2"> buoyRecID integer NOT NULL,</span>
+<span class="s2"> year integer NOT NULL,</span>
+<span class="s2"> month integer NOT NULL</span>
+<span class="s2"> ); """</span>
+
+<span class="n">match_recs_sql</span> <span class="o">=</span> \
+<span class="sd">"""\</span>
+<span class="sd">SELECT rscd_files.filepath, rscd_files.filename, \</span>
+<span class="sd">buoy_files.filepath, buoy_files.filename, \</span>
+<span class="sd">rscd_files.year, rscd_files.month, \</span>
+<span class="sd">rscd_files.latitude, rscd_files.longitude \</span>
+<span class="sd">FROM buoy_files, rscd_files \</span>
+<span class="sd">WHERE \</span>
+<span class="sd">(((Abs([rscd_files].[latitude]-[buoy_files].[latitude])<0.001) \</span>
+<span class="sd">AND \</span>
+<span class="sd">(Abs([rscd_files].[longitude]-[buoy_files].[longitude])<0.001)) \</span>
+<span class="sd">OR \</span>
+<span class="sd">(upper([rscd_files].[platform]) == upper([buoy_files].[platform]))) \</span>
+<span class="sd">AND \</span>
+<span class="sd">((buoy_files.beginDate <= rscd_files.beginDate) \</span>
+<span class="sd">AND \</span>
+<span class="sd">(buoy_files.endDate >= rscd_files.endDate)) \</span>
+<span class="sd">ORDER BY rscd_files.fileName;\</span>
+<span class="sd">"""</span>
+
+<span class="n">match_select_sql</span> <span class="o">=</span> \
+<span class="sd">"""\</span>
+<span class="sd">SELECT rscd_files.filepath, rscd_files.filename, \</span>
+<span class="sd">buoy_files.filepath, buoy_files.filename, \</span>
+<span class="sd">rscd_files.year, rscd_files.month \</span>
+<span class="sd">FROM buoy_files, rscd_files \</span>
+<span class="sd">"""</span>
+
+<span class="n">val_site_select_sql</span> <span class="o">=</span> \
+<span class="sd">"""\</span>
+<span class="sd">SELECT rscd_files.filepath, rscd_files.filename, \</span>
+<span class="sd">buoy_files.filepath, buoy_files.filename, \</span>
+<span class="sd">rscd_files.year, rscd_files.month, \</span>
+<span class="sd">buoy_files.beginDate, buoy_files.endDate,</span>
+<span class="sd">buoy_files.platform \</span>
+<span class="sd">FROM buoy_files, rscd_files \</span>
+<span class="sd">"""</span>
+
+<span class="n">val_match_select_sql</span> <span class="o">=</span> \
+<span class="sd">"""\</span>
+<span class="sd">SELECT rscd_files.filepath, rscd_files.filename, \</span>
+<span class="sd">buoy_files.filepath, buoy_files.filename, \</span>
+<span class="sd">rscd_files.year, rscd_files.month, \</span>
+<span class="sd">rscd_files.latitude, rscd_files.longitude, \</span>
+<span class="sd">buoy_files.platform, buoy_files.beginDate, buoy_files.endDate \</span>
+<span class="sd">FROM buoy_files, rscd_files \</span>
+<span class="sd">"""</span>
+
+<span class="n">location_filter_sql</span> <span class="o">=</span> \
+<span class="sd">"""\</span>
+<span class="sd">((Abs([rscd_files].[latitude]-[buoy_files].[latitude])<0.001) \</span>
+<span class="sd">AND \</span>
+<span class="sd">(Abs([rscd_files].[longitude]-[buoy_files].[longitude])<0.001))\</span>
+<span class="sd">"""</span>
+
+<span class="n">platform_filter_sql</span> <span class="o">=</span> \
+<span class="sd">"""\</span>
+<span class="sd">(upper([rscd_files].[platform]) == upper([buoy_files].[platform]))\</span>
+<span class="sd">"""</span>
+
+<span class="n">time_window_filter_sql</span> <span class="o">=</span> \
+<span class="sd">"""\</span>
+<span class="sd">((buoy_files.beginDate <= rscd_files.beginDate) \</span>
+<span class="sd">AND \</span>
+<span class="sd">(buoy_files.endDate >= rscd_files.endDate)) \</span>
+<span class="sd">"""</span>
+
+<span class="n">excludeFiles</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'RSCD_WW3-RSCD-UG-62107_201705_freq.nc'</span><span class="p">,</span>
+ <span class="s1">'RSCD_WW3-RSCD-UG-62101_201704_freq.nc'</span><span class="p">,</span>
+ <span class="s1">'RSCD_WW3-RSCD-UG-63057_201706_freq.nc'</span><span class="p">,</span>
+ <span class="s1">'RSCD_WW3-RSCD-UG-62068_201710_freq.nc'</span><span class="p">]</span>
+
+<span class="c1"># ----------------------------------------------------------------------------</span>
+<span class="c1"># CLASS DEFINITIONS</span>
+<span class="c1"># ----------------------------------------------------------------------------</span>
+<div class="viewcode-block" id="recordFilter"><a class="viewcode-back" href="../MatchUpDatabase.html#MatchUpDatabase.recordFilter">[docs]</a><span class="k">class</span> <span class="nc">recordFilter</span><span class="p">:</span>
+ <span class="sd">"""</span>
+<span class="sd"> """</span>
+ <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">coverage</span><span class="p">:</span> <span class="nb">list</span><span class="p">):</span>
+ <span class="k">for</span> <span class="n">cover</span> <span class="ow">in</span> <span class="n">coverage</span><span class="p">:</span>
+ <span class="k">if</span> <span class="nb">type</span><span class="p">(</span><span class="n">cover</span><span class="p">)</span> <span class="o">==</span> <span class="n">spatialCoverage</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">domain</span> <span class="o">=</span> <span class="n">cover</span>
+ <span class="k">if</span> <span class="nb">type</span><span class="p">(</span><span class="n">cover</span><span class="p">)</span> <span class="o">==</span> <span class="n">temporalCoverage</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">window</span> <span class="o">=</span> <span class="n">cover</span>
+
+<div class="viewcode-block" id="recordFilter.includeRecord"><a class="viewcode-back" href="../MatchUpDatabase.html#MatchUpDatabase.recordFilter.includeRecord">[docs]</a> <span class="k">def</span> <span class="nf">includeRecord</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">record</span><span class="p">,</span> <span class="n">verbose</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
+
+ <span class="n">hasdomain</span> <span class="o">=</span> <span class="nb">hasattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s1">'domain'</span><span class="p">)</span>
+ <span class="k">if</span> <span class="n">hasdomain</span><span class="p">:</span>
+ <span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">record</span><span class="p">,</span> <span class="s1">'lat'</span><span class="p">)</span> <span class="o">&</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">record</span><span class="p">,</span> <span class="s1">'lon'</span><span class="p">):</span>
+ <span class="n">indomain</span> <span class="o">=</span> <span class="p">(</span><span class="n">record</span><span class="o">.</span><span class="n">lat</span> <span class="o">></span> <span class="nb">min</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">domain</span><span class="o">.</span><span class="n">lat_range</span><span class="p">))</span> <span class="o">&</span> \
+ <span class="p">(</span><span class="n">record</span><span class="o">.</span><span class="n">lat</span> <span class="o"><</span> <span class="nb">max</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">domain</span><span class="o">.</span><span class="n">lat_range</span><span class="p">))</span> <span class="o">&</span> \
+ <span class="p">(</span><span class="n">record</span><span class="o">.</span><span class="n">lon</span> <span class="o">></span> <span class="nb">min</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">domain</span><span class="o">.</span><span class="n">lon_range</span><span class="p">))</span> <span class="o">&</span> \
+ <span class="p">(</span><span class="n">record</span><span class="o">.</span><span class="n">lon</span> <span class="o"><</span> <span class="nb">max</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">domain</span><span class="o">.</span><span class="n">lon_range</span><span class="p">))</span>
+ <span class="k">if</span> <span class="p">(</span><span class="ow">not</span> <span class="n">indomain</span><span class="p">)</span> <span class="o">&</span> <span class="n">verbose</span><span class="p">:</span>
+ <span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">record</span><span class="p">,</span> <span class="s1">'platform'</span><span class="p">):</span>
+ <span class="nb">print</span><span class="p">(</span><span class="n">record</span><span class="o">.</span><span class="n">platform</span><span class="o">+</span><span class="s1">' outside spatial coverage.'</span><span class="p">)</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="nb">print</span><span class="p">(</span><span class="s1">'record outside spatial coverage.'</span><span class="p">)</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="k">if</span> <span class="n">verbose</span><span class="p">:</span>
+ <span class="nb">print</span><span class="p">(</span><span class="s1">'WARNING: Record missing lat or lon data.'</span><span class="p">)</span>
+ <span class="n">indomain</span> <span class="o">=</span> <span class="kc">False</span>
+
+ <span class="n">haswindow</span> <span class="o">=</span> <span class="nb">hasattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s1">'window'</span><span class="p">)</span>
+ <span class="k">if</span> <span class="n">haswindow</span><span class="p">:</span>
+ <span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">record</span><span class="p">,</span> <span class="s1">'time_start'</span><span class="p">)</span> <span class="o">&</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">record</span><span class="p">,</span> <span class="s1">'time_end'</span><span class="p">):</span>
+ <span class="n">t0</span> <span class="o">=</span> <span class="n">dateNumFromStr</span><span class="p">(</span><span class="n">record</span><span class="o">.</span><span class="n">time_start</span><span class="p">)</span>
+ <span class="n">t1</span> <span class="o">=</span> <span class="n">dateNumFromStr</span><span class="p">(</span><span class="n">record</span><span class="o">.</span><span class="n">time_end</span><span class="p">)</span>
+ <span class="n">case01</span> <span class="o">=</span> <span class="p">(</span><span class="n">t0</span> <span class="o">>=</span> <span class="nb">min</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">window</span><span class="o">.</span><span class="n">timeRangeNum</span><span class="p">))</span> <span class="o">&</span> \
+ <span class="p">(</span><span class="n">t1</span> <span class="o"><=</span> <span class="nb">max</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">window</span><span class="o">.</span><span class="n">timeRangeNum</span><span class="p">))</span>
+ <span class="n">case02</span> <span class="o">=</span> <span class="p">(</span><span class="n">t0</span> <span class="o"><</span> <span class="nb">min</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">window</span><span class="o">.</span><span class="n">timeRangeNum</span><span class="p">))</span> <span class="o">&</span> \
+ <span class="p">(</span><span class="n">t1</span> <span class="o">>=</span> <span class="nb">min</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">window</span><span class="o">.</span><span class="n">timeRangeNum</span><span class="p">))</span>
+ <span class="n">case03</span> <span class="o">=</span> <span class="p">(</span><span class="n">t0</span> <span class="o"><</span> <span class="nb">max</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">window</span><span class="o">.</span><span class="n">timeRangeNum</span><span class="p">))</span> <span class="o">&</span> \
+ <span class="p">(</span><span class="n">t1</span> <span class="o">>=</span> <span class="nb">max</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">window</span><span class="o">.</span><span class="n">timeRangeNum</span><span class="p">))</span>
+ <span class="n">case04</span> <span class="o">=</span> <span class="p">(</span><span class="n">t0</span> <span class="o"><</span> <span class="nb">min</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">window</span><span class="o">.</span><span class="n">timeRangeNum</span><span class="p">))</span> <span class="o">&</span> \
+ <span class="p">(</span><span class="n">t1</span> <span class="o">></span> <span class="nb">max</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">window</span><span class="o">.</span><span class="n">timeRangeNum</span><span class="p">))</span>
+ <span class="n">inwindow</span> <span class="o">=</span> <span class="n">case01</span> <span class="ow">or</span> <span class="n">case02</span> <span class="ow">or</span> <span class="n">case03</span> <span class="ow">or</span> <span class="n">case04</span>
+ <span class="k">if</span> <span class="p">(</span><span class="ow">not</span> <span class="n">inwindow</span><span class="p">)</span> <span class="o">&</span> <span class="n">verbose</span><span class="p">:</span>
+ <span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">record</span><span class="p">,</span> <span class="s1">'platform'</span><span class="p">):</span>
+ <span class="nb">print</span><span class="p">(</span><span class="n">record</span><span class="o">.</span><span class="n">platform</span><span class="o">+</span><span class="s1">' outside temporal coverage.'</span><span class="p">)</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="nb">print</span><span class="p">(</span><span class="s1">'record outside temporal coverage.'</span><span class="p">)</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="k">if</span> <span class="n">verbose</span><span class="p">:</span>
+ <span class="nb">print</span><span class="p">(</span><span class="s1">'WARNING: Record missing time data.'</span><span class="p">)</span>
+ <span class="n">inwindow</span> <span class="o">=</span> <span class="kc">False</span>
+
+ <span class="k">if</span> <span class="n">hasdomain</span><span class="p">:</span>
+ <span class="n">include</span> <span class="o">=</span> <span class="n">indomain</span>
+ <span class="k">if</span> <span class="n">haswindow</span><span class="p">:</span>
+ <span class="n">include</span> <span class="o">=</span> <span class="n">include</span> <span class="ow">and</span> <span class="n">inwindow</span>
+ <span class="k">elif</span> <span class="n">haswindow</span><span class="p">:</span>
+ <span class="n">include</span> <span class="o">=</span> <span class="n">inwindow</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">include</span> <span class="o">=</span> <span class="kc">False</span>
+ <span class="k">return</span> <span class="n">include</span></div></div>
+
+
+<span class="c1"># ----------------------------------------------------------------------------</span>
+<span class="c1"># FUNCTION DEFINITIONS</span>
+<span class="c1"># ----------------------------------------------------------------------------</span>
+
+<div class="viewcode-block" id="tuples2csv"><a class="viewcode-back" href="../MatchUpDatabase.html#MatchUpDatabase.tuples2csv">[docs]</a><span class="k">def</span> <span class="nf">tuples2csv</span><span class="p">(</span><span class="n">records</span><span class="p">,</span> <span class="n">csv_file</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> """</span>
+ <span class="c1"># open file in write mode</span>
+ <span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="n">csv_file</span><span class="p">,</span> <span class="s1">'w'</span><span class="p">,</span> <span class="n">newline</span><span class="o">=</span><span class="s1">''</span><span class="p">,</span> <span class="n">encoding</span><span class="o">=</span><span class="s1">'utf-8'</span><span class="p">)</span> <span class="k">as</span> <span class="n">out</span><span class="p">:</span>
+ <span class="n">csv_out</span><span class="o">=</span><span class="n">csv</span><span class="o">.</span><span class="n">writer</span><span class="p">(</span><span class="n">out</span><span class="p">)</span>
+ <span class="k">for</span> <span class="n">row</span> <span class="ow">in</span> <span class="n">records</span><span class="p">:</span>
+ <span class="n">csv_out</span><span class="o">.</span><span class="n">writerow</span><span class="p">(</span><span class="n">row</span><span class="p">)</span>
+ <span class="k">return</span></div>
+
+<div class="viewcode-block" id="csv2tuples"><a class="viewcode-back" href="../MatchUpDatabase.html#MatchUpDatabase.csv2tuples">[docs]</a><span class="k">def</span> <span class="nf">csv2tuples</span><span class="p">(</span><span class="n">csv_file</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> """</span>
+ <span class="c1"># open file in read mode</span>
+ <span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="n">csv_file</span><span class="p">,</span> <span class="s1">'r'</span><span class="p">)</span> <span class="k">as</span> <span class="n">read_obj</span><span class="p">:</span>
+ <span class="n">csv_reader</span> <span class="o">=</span> <span class="n">csv</span><span class="o">.</span><span class="n">reader</span><span class="p">(</span><span class="n">read_obj</span><span class="p">)</span>
+ <span class="n">list_of_tuples</span> <span class="o">=</span> <span class="nb">list</span><span class="p">(</span><span class="nb">map</span><span class="p">(</span><span class="nb">tuple</span><span class="p">,</span> <span class="n">csv_reader</span><span class="p">))</span>
+ <span class="k">return</span> <span class="n">list_of_tuples</span></div>
+
+<div class="viewcode-block" id="mapRecord"><a class="viewcode-back" href="../MatchUpDatabase.html#MatchUpDatabase.mapRecord">[docs]</a><span class="k">def</span> <span class="nf">mapRecord</span><span class="p">(</span><span class="n">startYr</span><span class="p">,</span> <span class="n">stopYr</span><span class="p">,</span> <span class="n">record</span><span class="p">,</span> <span class="n">dataset</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> """</span>
+ <span class="n">records</span> <span class="o">=</span> <span class="p">[]</span>
+ <span class="n">rscdpath</span> <span class="o">=</span> <span class="n">record</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
+ <span class="n">dpath</span> <span class="o">=</span> <span class="n">rscdpath</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="n">record</span><span class="p">[</span><span class="mi">4</span><span class="p">])[</span><span class="mi">0</span><span class="p">]</span>
+ <span class="n">rscdfile</span> <span class="o">=</span> <span class="n">record</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span>
+ <span class="n">defStr</span> <span class="o">=</span> <span class="n">record</span><span class="p">[</span><span class="mi">4</span><span class="p">]</span><span class="o">+</span><span class="n">record</span><span class="p">[</span><span class="mi">5</span><span class="p">]</span><span class="o">.</span><span class="n">zfill</span><span class="p">(</span><span class="mi">2</span><span class="p">)</span>
+ <span class="n">nyrs</span> <span class="o">=</span> <span class="n">stopYr</span><span class="o">-</span><span class="n">startYr</span> <span class="o">+</span> <span class="mi">1</span>
+ <span class="k">for</span> <span class="n">dyr</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">nyrs</span><span class="p">):</span>
+ <span class="n">yr</span> <span class="o">=</span> <span class="n">startYr</span> <span class="o">+</span> <span class="n">dyr</span>
+ <span class="n">yrstr</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="n">yr</span><span class="p">)</span>
+ <span class="k">for</span> <span class="n">m</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="mi">12</span><span class="p">):</span>
+ <span class="n">mnth</span> <span class="o">=</span> <span class="n">m</span> <span class="o">+</span> <span class="mi">1</span>
+ <span class="n">mnstr</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="n">mnth</span><span class="p">)</span><span class="o">.</span><span class="n">zfill</span><span class="p">(</span><span class="mi">2</span><span class="p">)</span>
+ <span class="n">dstr</span> <span class="o">=</span> <span class="n">yrstr</span><span class="o">+</span><span class="n">mnstr</span>
+ <span class="n">rpath</span> <span class="o">=</span> <span class="n">dpath</span><span class="o">+</span><span class="n">yrstr</span><span class="o">+</span><span class="s1">'/'</span><span class="o">+</span><span class="n">mnstr</span><span class="o">+</span><span class="s1">'/'</span><span class="o">+</span><span class="n">dataset</span>
+ <span class="n">rfile</span> <span class="o">=</span> <span class="n">rscdfile</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="n">defStr</span><span class="p">,</span><span class="n">dstr</span><span class="p">)</span>
+ <span class="n">rec</span> <span class="o">=</span> <span class="nb">list</span><span class="p">(</span><span class="n">record</span><span class="p">)</span>
+ <span class="n">rec</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">=</span> <span class="n">rpath</span>
+ <span class="n">rec</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="o">=</span> <span class="n">rfile</span>
+ <span class="n">rec</span><span class="p">[</span><span class="mi">4</span><span class="p">]</span> <span class="o">=</span> <span class="n">yrstr</span>
+ <span class="n">rec</span><span class="p">[</span><span class="mi">5</span><span class="p">]</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="n">mnth</span><span class="p">)</span>
+ <span class="n">records</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="nb">tuple</span><span class="p">(</span><span class="n">rec</span><span class="p">))</span>
+ <span class="k">return</span> <span class="n">records</span></div>
+
+<div class="viewcode-block" id="getPlatformRecords"><a class="viewcode-back" href="../MatchUpDatabase.html#MatchUpDatabase.getPlatformRecords">[docs]</a><span class="k">def</span> <span class="nf">getPlatformRecords</span><span class="p">(</span><span class="n">records</span><span class="p">,</span><span class="n">platform</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> """</span>
+ <span class="n">pfrecindx</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">where</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">(</span><span class="n">records</span><span class="p">)[:,</span><span class="mi">8</span><span class="p">]</span> <span class="o">==</span> <span class="n">platform</span><span class="p">)</span>
+ <span class="n">platformRecs</span> <span class="o">=</span> <span class="p">[]</span>
+ <span class="k">for</span> <span class="n">indx</span> <span class="ow">in</span> <span class="n">pfrecindx</span><span class="p">[</span><span class="mi">0</span><span class="p">]:</span>
+ <span class="n">platformRecs</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">records</span><span class="p">[</span><span class="n">indx</span><span class="p">])</span>
+ <span class="k">return</span> <span class="n">platformRecs</span></div>
+
+<div class="viewcode-block" id="getPlatformList"><a class="viewcode-back" href="../MatchUpDatabase.html#MatchUpDatabase.getPlatformList">[docs]</a><span class="k">def</span> <span class="nf">getPlatformList</span><span class="p">(</span><span class="n">records</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> """</span>
+ <span class="n">platforms</span> <span class="o">=</span> <span class="nb">list</span><span class="p">(</span><span class="nb">set</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">(</span><span class="n">records</span><span class="p">)[:,</span><span class="mi">8</span><span class="p">]))</span>
+ <span class="k">return</span> <span class="n">platforms</span></div>
+
+<div class="viewcode-block" id="touch"><a class="viewcode-back" href="../MatchUpDatabase.html#MatchUpDatabase.touch">[docs]</a><span class="k">def</span> <span class="nf">touch</span><span class="p">(</span><span class="n">path</span><span class="p">):</span>
+ <span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="s1">'a'</span><span class="p">):</span>
+ <span class="n">os</span><span class="o">.</span><span class="n">utime</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
+ <span class="k">return</span></div>
+
+<div class="viewcode-block" id="db_match_to_csv"><a class="viewcode-back" href="../MatchUpDatabase.html#MatchUpDatabase.db_match_to_csv">[docs]</a><span class="k">def</span> <span class="nf">db_match_to_csv</span><span class="p">(</span><span class="n">db_path</span><span class="p">,</span> <span class="n">db_name</span><span class="p">,</span> <span class="n">csv_path</span><span class="p">,</span> <span class="n">csv_fname</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> """</span>
+ <span class="n">db_file</span> <span class="o">=</span> <span class="n">db_path</span><span class="o">+</span><span class="s1">'/'</span><span class="o">+</span><span class="n">db_name</span><span class="o">+</span><span class="s1">'.db'</span>
+ <span class="n">db_conn</span> <span class="o">=</span> <span class="n">create_connection</span><span class="p">(</span><span class="n">db_file</span><span class="p">)</span>
+
+ <span class="n">cur</span> <span class="o">=</span> <span class="n">db_conn</span><span class="o">.</span><span class="n">cursor</span><span class="p">()</span>
+
+ <span class="c1"># Define mathc query string</span>
+ <span class="n">match_sql</span> <span class="o">=</span> \
+ <span class="s2">"SELECT rscd_files.id, </span><span class="se">\</span>
+<span class="s2"> buoy_files.id, </span><span class="se">\</span>
+<span class="s2"> rscd_files.year, </span><span class="se">\</span>
+<span class="s2"> rscd_files.month </span><span class="se">\</span>
+<span class="s2"> FROM buoy_files, rscd_files </span><span class="se">\</span>
+<span class="s2"> WHERE (((Abs([rscd_files].[latitude]-[buoy_files].[latitude])<0.001) </span><span class="se">\</span>
+<span class="s2"> AND </span><span class="se">\</span>
+<span class="s2"> (Abs([rscd_files].[longitude]-[buoy_files].[longitude])<0.001)) </span><span class="se">\</span>
+<span class="s2"> OR </span><span class="se">\</span>
+<span class="s2"> (upper([rscd_files].[platform]) == upper([buoy_files].[platform])) </span><span class="se">\</span>
+<span class="s2"> ) </span><span class="se">\</span>
+<span class="s2"> AND </span><span class="se">\</span>
+<span class="s2"> ((buoy_files.beginDate <= rscd_files.beginDate) </span><span class="se">\</span>
+<span class="s2"> AND </span><span class="se">\</span>
+<span class="s2"> (buoy_files.endDate >= rscd_files.endDate)) </span><span class="se">\</span>
+<span class="s2"> ORDER BY rscd_files.fileName;"</span>
+
+ <span class="c1"># Get matches from db</span>
+ <span class="n">res</span> <span class="o">=</span> <span class="n">cur</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="n">match_sql</span><span class="p">)</span>
+ <span class="n">records</span> <span class="o">=</span> <span class="n">res</span><span class="o">.</span><span class="n">fetchall</span><span class="p">()</span>
+ <span class="c1"># Generate record list for writing to csv file</span>
+ <span class="n">reclist</span> <span class="o">=</span> <span class="p">[]</span>
+ <span class="k">for</span> <span class="n">rec</span> <span class="ow">in</span> <span class="n">records</span><span class="p">:</span>
+ <span class="n">sql_str</span> <span class="o">=</span> <span class="s2">"SELECT * FROM rscd_files WHERE rscd_files.id == "</span><span class="o">+</span><span class="nb">str</span><span class="p">(</span><span class="n">rec</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span><span class="o">+</span><span class="s2">";"</span>
+ <span class="n">res</span> <span class="o">=</span> <span class="n">cur</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="n">sql_str</span><span class="p">)</span>
+ <span class="n">modrec</span> <span class="o">=</span> <span class="n">res</span><span class="o">.</span><span class="n">fetchall</span><span class="p">()[</span><span class="mi">0</span><span class="p">]</span>
+ <span class="n">sql_str</span> <span class="o">=</span> <span class="s2">"SELECT * FROM buoy_files WHERE buoy_files.id == "</span><span class="o">+</span><span class="nb">str</span><span class="p">(</span><span class="n">rec</span><span class="p">[</span><span class="mi">1</span><span class="p">])</span><span class="o">+</span><span class="s2">";"</span>
+ <span class="n">res</span> <span class="o">=</span> <span class="n">cur</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="n">sql_str</span><span class="p">)</span>
+ <span class="n">obsrec</span> <span class="o">=</span> <span class="n">res</span><span class="o">.</span><span class="n">fetchall</span><span class="p">()[</span><span class="mi">0</span><span class="p">]</span>
+ <span class="n">modpath</span> <span class="o">=</span> <span class="n">modrec</span><span class="p">[</span><span class="mi">2</span><span class="p">]</span>
+ <span class="n">modfile</span> <span class="o">=</span> <span class="n">modrec</span><span class="p">[</span><span class="mi">3</span><span class="p">]</span>
+ <span class="n">obspath</span> <span class="o">=</span> <span class="n">obsrec</span><span class="p">[</span><span class="mi">2</span><span class="p">]</span>
+ <span class="n">obsfile</span> <span class="o">=</span> <span class="n">obsrec</span><span class="p">[</span><span class="mi">3</span><span class="p">]</span>
+ <span class="n">year</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="n">rec</span><span class="p">[</span><span class="mi">2</span><span class="p">])</span>
+ <span class="n">month</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="n">rec</span><span class="p">[</span><span class="mi">3</span><span class="p">])</span>
+ <span class="n">starttime</span> <span class="o">=</span> <span class="n">obsrec</span><span class="p">[</span><span class="mi">6</span><span class="p">]</span>
+ <span class="n">stoptime</span> <span class="o">=</span> <span class="n">obsrec</span><span class="p">[</span><span class="mi">7</span><span class="p">]</span>
+ <span class="n">pltfrm</span> <span class="o">=</span> <span class="n">obsrec</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span>
+ <span class="n">lat</span> <span class="o">=</span> <span class="n">obsrec</span><span class="p">[</span><span class="mi">4</span><span class="p">]</span>
+ <span class="n">lon</span> <span class="o">=</span> <span class="n">obsrec</span><span class="p">[</span><span class="mi">5</span><span class="p">]</span>
+ <span class="n">arec</span> <span class="o">=</span> <span class="p">(</span><span class="n">modpath</span><span class="p">,</span> <span class="n">modfile</span><span class="p">,</span> <span class="n">obspath</span><span class="p">,</span> <span class="n">obsfile</span><span class="p">,</span> <span class="n">year</span><span class="p">,</span> <span class="n">month</span><span class="p">,</span> <span class="n">starttime</span><span class="p">,</span> <span class="n">stoptime</span><span class="p">,</span> <span class="n">pltfrm</span><span class="p">,</span> <span class="n">lat</span><span class="p">,</span> <span class="n">lon</span><span class="p">)</span>
+ <span class="n">reclist</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">arec</span><span class="p">)</span>
+ <span class="c1"># Write records list to csv file</span>
+ <span class="n">csvfile</span> <span class="o">=</span> <span class="n">csv_path</span><span class="o">+</span><span class="s1">'/'</span><span class="o">+</span><span class="n">csv_fname</span>
+ <span class="n">tuples2csv</span><span class="p">(</span><span class="n">reclist</span><span class="p">,</span><span class="n">csvfile</span><span class="p">)</span>
+ <span class="n">db_conn</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
+ <span class="k">return</span></div>
+
+<div class="viewcode-block" id="create_connection"><a class="viewcode-back" href="../MatchUpDatabase.html#MatchUpDatabase.create_connection">[docs]</a><span class="k">def</span> <span class="nf">create_connection</span><span class="p">(</span><span class="n">db_file</span><span class="p">):</span>
+ <span class="sd">""" Create a database connection to the SQLite database </span>
+<span class="sd"> specified by db_file.</span>
+<span class="sd"> </span>
+<span class="sd"> :param db_file: database file</span>
+<span class="sd"> </span>
+<span class="sd"> :return: Connection object or None</span>
+<span class="sd"> """</span>
+ <span class="n">db_conn</span> <span class="o">=</span> <span class="kc">None</span>
+ <span class="k">try</span><span class="p">:</span>
+ <span class="n">db_conn</span> <span class="o">=</span> <span class="n">sqlite3</span><span class="o">.</span><span class="n">connect</span><span class="p">(</span><span class="n">db_file</span><span class="p">)</span>
+ <span class="k">return</span> <span class="n">db_conn</span>
+ <span class="k">except</span> <span class="n">sqlite3</span><span class="o">.</span><span class="n">Error</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
+ <span class="nb">print</span><span class="p">(</span><span class="n">e</span><span class="p">)</span>
+ <span class="k">return</span> <span class="n">db_conn</span></div>
+
+
+<div class="viewcode-block" id="close_database"><a class="viewcode-back" href="../MatchUpDatabase.html#MatchUpDatabase.close_database">[docs]</a><span class="k">def</span> <span class="nf">close_database</span><span class="p">(</span><span class="n">db_conn</span><span class="p">):</span>
+ <span class="k">if</span> <span class="n">db_conn</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
+ <span class="n">db_conn</span><span class="o">.</span><span class="n">commit</span><span class="p">()</span>
+ <span class="n">db_conn</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
+ <span class="k">return</span></div>
+
+
+<div class="viewcode-block" id="create_rscd_table"><a class="viewcode-back" href="../MatchUpDatabase.html#MatchUpDatabase.create_rscd_table">[docs]</a><span class="k">def</span> <span class="nf">create_rscd_table</span><span class="p">(</span><span class="n">db_conn</span><span class="p">):</span>
+ <span class="k">try</span><span class="p">:</span>
+ <span class="n">c</span> <span class="o">=</span> <span class="n">db_conn</span><span class="o">.</span><span class="n">cursor</span><span class="p">()</span>
+ <span class="n">c</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="n">rscd_table_sql</span><span class="p">)</span>
+ <span class="k">except</span> <span class="n">sqlite3</span><span class="o">.</span><span class="n">Error</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
+ <span class="nb">print</span><span class="p">(</span><span class="n">e</span><span class="p">)</span>
+ <span class="k">return</span></div>
+
+
+<div class="viewcode-block" id="create_buoy_table"><a class="viewcode-back" href="../MatchUpDatabase.html#MatchUpDatabase.create_buoy_table">[docs]</a><span class="k">def</span> <span class="nf">create_buoy_table</span><span class="p">(</span><span class="n">db_conn</span><span class="p">):</span>
+ <span class="k">try</span><span class="p">:</span>
+ <span class="n">c</span> <span class="o">=</span> <span class="n">db_conn</span><span class="o">.</span><span class="n">cursor</span><span class="p">()</span>
+ <span class="n">c</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="n">buoy_table_sql</span><span class="p">)</span>
+ <span class="k">except</span> <span class="n">sqlite3</span><span class="o">.</span><span class="n">Error</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
+ <span class="nb">print</span><span class="p">(</span><span class="n">e</span><span class="p">)</span>
+ <span class="k">return</span></div>
+
+
+<div class="viewcode-block" id="create_match_table"><a class="viewcode-back" href="../MatchUpDatabase.html#MatchUpDatabase.create_match_table">[docs]</a><span class="k">def</span> <span class="nf">create_match_table</span><span class="p">(</span><span class="n">db_conn</span><span class="p">):</span>
+ <span class="k">try</span><span class="p">:</span>
+ <span class="n">c</span> <span class="o">=</span> <span class="n">db_conn</span><span class="o">.</span><span class="n">cursor</span><span class="p">()</span>
+ <span class="n">c</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="n">match_table_sql</span><span class="p">)</span>
+ <span class="k">except</span> <span class="n">sqlite3</span><span class="o">.</span><span class="n">Error</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
+ <span class="nb">print</span><span class="p">(</span><span class="n">e</span><span class="p">)</span>
+ <span class="k">return</span></div>
+
+
+<div class="viewcode-block" id="create_database"><a class="viewcode-back" href="../MatchUpDatabase.html#MatchUpDatabase.create_database">[docs]</a><span class="k">def</span> <span class="nf">create_database</span><span class="p">(</span><span class="n">db_path</span><span class="p">,</span> <span class="n">db_name</span><span class="p">):</span>
+ <span class="n">db_file</span> <span class="o">=</span> <span class="n">db_name</span><span class="o">+</span><span class="s1">'.db'</span>
+ <span class="n">db_conn</span> <span class="o">=</span> <span class="n">create_connection</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">db_path</span><span class="p">,</span> <span class="n">db_file</span><span class="p">))</span>
+ <span class="n">create_rscd_table</span><span class="p">(</span><span class="n">db_conn</span><span class="p">)</span>
+ <span class="n">create_buoy_table</span><span class="p">(</span><span class="n">db_conn</span><span class="p">)</span>
+ <span class="n">create_match_table</span><span class="p">(</span><span class="n">db_conn</span><span class="p">)</span>
+ <span class="n">db_conn</span><span class="o">.</span><span class="n">commit</span><span class="p">()</span>
+ <span class="k">return</span> <span class="n">db_conn</span></div>
+
+
+<div class="viewcode-block" id="insert_rscd_records"><a class="viewcode-back" href="../MatchUpDatabase.html#MatchUpDatabase.insert_rscd_records">[docs]</a><span class="k">def</span> <span class="nf">insert_rscd_records</span><span class="p">(</span><span class="n">db_conn</span><span class="p">,</span> <span class="n">records</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Create a new record in the rscd_files table</span>
+
+<span class="sd"> :param db_conn:</span>
+<span class="sd"> :param records:</span>
+
+<span class="sd"> :return: row count</span>
+<span class="sd"> """</span>
+ <span class="n">sql</span> <span class="o">=</span> <span class="s1">''' INSERT INTO rscd_files(platform,</span>
+<span class="s1"> filePath, fileName,</span>
+<span class="s1"> latitude, longitude,</span>
+<span class="s1"> beginDate, endDate,</span>
+<span class="s1"> year, month, samplePeriod)</span>
+<span class="s1"> VALUES(?,?,?,?,?,?,?,?,?,?) '''</span>
+ <span class="n">cur</span> <span class="o">=</span> <span class="n">db_conn</span><span class="o">.</span><span class="n">cursor</span><span class="p">()</span>
+ <span class="n">cur</span><span class="o">.</span><span class="n">executemany</span><span class="p">(</span><span class="n">sql</span><span class="p">,</span> <span class="n">records</span><span class="p">)</span>
+ <span class="n">db_conn</span><span class="o">.</span><span class="n">commit</span><span class="p">()</span>
+ <span class="n">rowcount</span> <span class="o">=</span> <span class="n">cur</span><span class="o">.</span><span class="n">rowcount</span>
+ <span class="k">del</span> <span class="n">cur</span>
+ <span class="k">return</span> <span class="n">rowcount</span></div>
+
+
+<div class="viewcode-block" id="insert_buoy_records"><a class="viewcode-back" href="../MatchUpDatabase.html#MatchUpDatabase.insert_buoy_records">[docs]</a><span class="k">def</span> <span class="nf">insert_buoy_records</span><span class="p">(</span><span class="n">db_conn</span><span class="p">,</span> <span class="n">records</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Create a new record in the rscd_files table</span>
+
+<span class="sd"> :param db_conn:</span>
+<span class="sd"> :param record:</span>
+<span class="sd"> </span>
+<span class="sd"> :return: row count</span>
+<span class="sd"> """</span>
+ <span class="n">sql</span> <span class="o">=</span> <span class="s1">''' INSERT INTO buoy_files(platform,</span>
+<span class="s1"> filePath, fileName,</span>
+<span class="s1"> latitude, longitude,</span>
+<span class="s1"> beginDate, endDate,</span>
+<span class="s1"> samplePeriod)</span>
+<span class="s1"> VALUES(?,?,?,?,?,?,?,?) '''</span>
+ <span class="n">cur</span> <span class="o">=</span> <span class="n">db_conn</span><span class="o">.</span><span class="n">cursor</span><span class="p">()</span>
+ <span class="n">cur</span><span class="o">.</span><span class="n">executemany</span><span class="p">(</span><span class="n">sql</span><span class="p">,</span> <span class="n">records</span><span class="p">)</span>
+ <span class="n">db_conn</span><span class="o">.</span><span class="n">commit</span><span class="p">()</span>
+ <span class="n">rowcount</span> <span class="o">=</span> <span class="n">cur</span><span class="o">.</span><span class="n">rowcount</span>
+ <span class="k">del</span> <span class="n">cur</span>
+ <span class="k">return</span> <span class="n">rowcount</span></div>
+
+
+<div class="viewcode-block" id="get_match_records"><a class="viewcode-back" href="../MatchUpDatabase.html#MatchUpDatabase.get_match_records">[docs]</a><span class="k">def</span> <span class="nf">get_match_records</span><span class="p">(</span><span class="n">db_path</span><span class="p">,</span> <span class="n">db_name</span><span class="p">,</span> <span class="n">sql_query</span><span class="p">):</span>
+ <span class="n">db_file</span> <span class="o">=</span> <span class="n">db_path</span><span class="o">+</span><span class="s1">'/'</span><span class="o">+</span><span class="n">db_name</span><span class="o">+</span><span class="s1">'.db'</span>
+ <span class="n">db_conn</span> <span class="o">=</span> <span class="n">create_connection</span><span class="p">(</span><span class="n">db_file</span><span class="p">)</span>
+
+ <span class="n">cur</span> <span class="o">=</span> <span class="n">db_conn</span><span class="o">.</span><span class="n">cursor</span><span class="p">()</span>
+ <span class="n">res</span> <span class="o">=</span> <span class="n">cur</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="n">sql_query</span><span class="p">)</span>
+ <span class="n">records</span> <span class="o">=</span> <span class="n">res</span><span class="o">.</span><span class="n">fetchall</span><span class="p">()</span>
+
+ <span class="n">db_conn</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
+ <span class="k">return</span> <span class="n">records</span></div>
+
+
+<div class="viewcode-block" id="insert_match_record"><a class="viewcode-back" href="../MatchUpDatabase.html#MatchUpDatabase.insert_match_record">[docs]</a><span class="k">def</span> <span class="nf">insert_match_record</span><span class="p">(</span><span class="n">db_conn</span><span class="p">,</span> <span class="n">records</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Create a new record in the match_files table</span>
+<span class="sd"> </span>
+<span class="sd"> :param db_conn:</span>
+<span class="sd"> :param records:</span>
+<span class="sd"> </span>
+<span class="sd"> :return: row count</span>
+<span class="sd"> """</span>
+ <span class="n">sql</span> <span class="o">=</span> <span class="s1">''' INSERT INTO match_files(rscdRecID, buoyRecID, year, month)</span>
+<span class="s1"> VALUES(?,?,?,?) '''</span>
+ <span class="n">cur</span> <span class="o">=</span> <span class="n">db_conn</span><span class="o">.</span><span class="n">cursor</span><span class="p">()</span>
+ <span class="n">cur</span><span class="o">.</span><span class="n">executemany</span><span class="p">(</span><span class="n">sql</span><span class="p">,</span> <span class="n">records</span><span class="p">)</span>
+ <span class="n">db_conn</span><span class="o">.</span><span class="n">commit</span><span class="p">()</span>
+ <span class="k">return</span> <span class="n">cur</span><span class="o">.</span><span class="n">rowcount</span></div>
+
+
+<div class="viewcode-block" id="load_rscd_archive"><a class="viewcode-back" href="../MatchUpDatabase.html#MatchUpDatabase.load_rscd_archive">[docs]</a><span class="k">def</span> <span class="nf">load_rscd_archive</span><span class="p">(</span><span class="n">db_conn</span><span class="p">,</span> <span class="n">archivePath</span><span class="p">,</span> <span class="n">dataSet</span><span class="p">,</span> <span class="n">chunkSize</span><span class="o">=</span><span class="mi">500</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> """</span>
+ <span class="n">records</span> <span class="o">=</span> <span class="p">[]</span>
+ <span class="n">recs_added</span> <span class="o">=</span> <span class="mi">0</span>
+ <span class="nb">print</span><span class="p">(</span><span class="s1">'Start time: '</span><span class="p">,</span> <span class="nb">str</span><span class="p">(</span><span class="n">MData</span><span class="o">.</span><span class="n">datetime</span><span class="o">.</span><span class="n">now</span><span class="p">()))</span>
+ <span class="k">for</span> <span class="n">root</span><span class="p">,</span> <span class="n">subFolders</span><span class="p">,</span> <span class="n">files</span> <span class="ow">in</span> <span class="n">os</span><span class="o">.</span><span class="n">walk</span><span class="p">(</span><span class="n">archivePath</span><span class="p">):</span>
+ <span class="k">if</span> <span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="n">root</span><span class="p">)[</span><span class="o">-</span><span class="mi">1</span><span class="p">])</span> <span class="o">==</span> <span class="n">dataSet</span><span class="p">:</span>
+ <span class="nb">print</span><span class="p">(</span><span class="n">root</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">'</span><span class="se">\\</span><span class="s1">'</span><span class="p">,</span> <span class="s1">'/'</span><span class="p">))</span>
+ <span class="nb">print</span><span class="p">(</span><span class="s1">'Files to process = '</span><span class="p">,</span><span class="nb">len</span><span class="p">(</span><span class="n">files</span><span class="p">))</span>
+ <span class="k">for</span> <span class="n">count</span><span class="p">,</span> <span class="n">file</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">files</span><span class="p">):</span>
+ <span class="n">fextn</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">splitext</span><span class="p">(</span><span class="n">file</span><span class="p">)[</span><span class="mi">1</span><span class="p">]</span>
+ <span class="n">tst01</span> <span class="o">=</span> <span class="n">fextn</span> <span class="o">==</span> <span class="s1">'.nc'</span>
+ <span class="n">tst02</span> <span class="o">=</span> <span class="ow">not</span> <span class="n">re</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="s1">'W......N....._2017'</span><span class="p">,</span><span class="n">file</span><span class="p">)</span>
+ <span class="n">tst03</span> <span class="o">=</span> <span class="ow">not</span> <span class="n">re</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="s1">'E......N....._2017'</span><span class="p">,</span><span class="n">file</span><span class="p">)</span>
+ <span class="n">tst04</span> <span class="o">=</span> <span class="ow">not</span> <span class="n">file</span> <span class="ow">in</span> <span class="n">excludeFiles</span>
+ <span class="k">if</span> <span class="n">tst01</span> <span class="o">&</span> <span class="n">tst02</span> <span class="o">&</span> <span class="n">tst03</span> <span class="o">&</span> <span class="n">tst04</span><span class="p">:</span>
+ <span class="c1"># print(file)</span>
+ <span class="n">rscdFile</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">root</span><span class="p">,</span> <span class="n">file</span><span class="p">)</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">'</span><span class="se">\\</span><span class="s1">'</span><span class="p">,</span> <span class="s1">'/'</span><span class="p">)</span>
+ <span class="k">try</span><span class="p">:</span>
+ <span class="n">rscd</span> <span class="o">=</span> <span class="n">MData</span><span class="o">.</span><span class="n">ww3</span><span class="p">(</span><span class="n">rscdFile</span><span class="p">)</span>
+ <span class="n">records</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="nb">tuple</span><span class="p">(</span><span class="n">rscd</span><span class="o">.</span><span class="n">getMetaData</span><span class="p">()))</span>
+ <span class="k">del</span> <span class="n">rscd</span>
+ <span class="k">except</span><span class="p">:</span>
+ <span class="nb">print</span><span class="p">(</span><span class="s1">'CORRUPT FILE: '</span><span class="p">,</span> <span class="n">file</span><span class="p">)</span>
+ <span class="k">if</span> <span class="p">(</span><span class="n">count</span> <span class="o">></span> <span class="mi">0</span><span class="p">)</span> <span class="o">&</span> <span class="p">((</span><span class="n">count</span> <span class="o">%</span> <span class="n">chunkSize</span><span class="p">)</span> <span class="o">==</span> <span class="mi">0</span><span class="p">):</span>
+ <span class="n">rec_count</span> <span class="o">=</span> <span class="n">insert_rscd_records</span><span class="p">(</span><span class="n">db_conn</span><span class="p">,</span> <span class="n">records</span><span class="p">)</span>
+ <span class="n">recs_added</span> <span class="o">+=</span> <span class="n">rec_count</span>
+ <span class="nb">print</span><span class="p">(</span><span class="n">recs_added</span><span class="p">,</span><span class="s1">' RSCD records added to the database'</span><span class="p">)</span>
+ <span class="k">del</span> <span class="n">records</span>
+ <span class="n">records</span> <span class="o">=</span> <span class="p">[]</span>
+ <span class="c1"># print('Time stamp: ', str(MData.datetime.now()))</span>
+ <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">records</span><span class="p">)</span> <span class="o">></span> <span class="mi">0</span><span class="p">:</span>
+ <span class="n">rec_count</span> <span class="o">=</span> <span class="n">insert_rscd_records</span><span class="p">(</span><span class="n">db_conn</span><span class="p">,</span> <span class="n">records</span><span class="p">)</span>
+ <span class="n">recs_added</span> <span class="o">+=</span> <span class="n">rec_count</span>
+ <span class="nb">print</span><span class="p">(</span><span class="n">recs_added</span><span class="p">,</span><span class="s1">' RSCD records added to the database'</span><span class="p">)</span>
+ <span class="nb">print</span><span class="p">(</span><span class="s1">'Time stamp: '</span><span class="p">,</span> <span class="nb">str</span><span class="p">(</span><span class="n">MData</span><span class="o">.</span><span class="n">datetime</span><span class="o">.</span><span class="n">now</span><span class="p">()))</span>
+ <span class="k">return</span> <span class="n">recs_added</span></div>
+
+
+<div class="viewcode-block" id="load_buoy_archive"><a class="viewcode-back" href="../MatchUpDatabase.html#MatchUpDatabase.load_buoy_archive">[docs]</a><span class="k">def</span> <span class="nf">load_buoy_archive</span><span class="p">(</span><span class="n">db_conn</span><span class="p">,</span>
+ <span class="n">archivePath</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">dataSet</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">dataFmt</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
+ <span class="n">recFilter</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">chunkSize</span><span class="o">=</span><span class="mi">500</span><span class="p">,</span>
+ <span class="n">verbose</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> """</span>
+ <span class="n">records</span> <span class="o">=</span> <span class="p">[]</span>
+ <span class="n">recs_added</span> <span class="o">=</span> <span class="mi">0</span>
+ <span class="nb">print</span><span class="p">(</span><span class="s1">'Start time: '</span><span class="p">,</span> <span class="nb">str</span><span class="p">(</span><span class="n">MData</span><span class="o">.</span><span class="n">datetime</span><span class="o">.</span><span class="n">now</span><span class="p">()))</span>
+ <span class="k">for</span> <span class="n">root</span><span class="p">,</span> <span class="n">subFolders</span><span class="p">,</span> <span class="n">files</span> <span class="ow">in</span> <span class="n">os</span><span class="o">.</span><span class="n">walk</span><span class="p">(</span><span class="n">archivePath</span><span class="p">):</span>
+ <span class="k">if</span> <span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="n">root</span><span class="p">)[</span><span class="o">-</span><span class="mi">1</span><span class="p">])</span> <span class="o">==</span> <span class="n">dataSet</span><span class="p">:</span>
+ <span class="nb">print</span><span class="p">(</span><span class="n">root</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">'</span><span class="se">\\</span><span class="s1">'</span><span class="p">,</span> <span class="s1">'/'</span><span class="p">))</span>
+ <span class="k">for</span> <span class="n">count</span><span class="p">,</span> <span class="n">file</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">files</span><span class="p">):</span>
+ <span class="n">fextn</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">splitext</span><span class="p">(</span><span class="n">file</span><span class="p">)[</span><span class="mi">1</span><span class="p">]</span>
+ <span class="k">if</span> <span class="n">fextn</span> <span class="o">==</span> <span class="s1">'.nc'</span><span class="p">:</span>
+ <span class="n">buoyFile</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">root</span><span class="p">,</span> <span class="n">file</span><span class="p">)</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">'</span><span class="se">\\</span><span class="s1">'</span><span class="p">,</span> <span class="s1">'/'</span><span class="p">)</span>
+ <span class="k">if</span> <span class="n">dataFmt</span> <span class="o">==</span> <span class="s1">'InSituTAC'</span><span class="p">:</span>
+ <span class="n">buoy</span> <span class="o">=</span> <span class="n">OData</span><span class="o">.</span><span class="n">wavebuoy</span><span class="p">(</span><span class="n">buoyFile</span><span class="p">)</span>
+ <span class="k">elif</span> <span class="n">dataFmt</span> <span class="o">==</span> <span class="s1">'SeaDataNet'</span><span class="p">:</span>
+ <span class="n">buoy</span> <span class="o">=</span> <span class="n">OData</span><span class="o">.</span><span class="n">emecwb</span><span class="p">(</span><span class="n">buoyFile</span><span class="p">)</span>
+ <span class="k">if</span> <span class="n">recFilter</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
+ <span class="n">records</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="nb">tuple</span><span class="p">(</span><span class="n">buoy</span><span class="o">.</span><span class="n">getMetaData</span><span class="p">()))</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="k">if</span> <span class="n">recFilter</span><span class="o">.</span><span class="n">includeRecord</span><span class="p">(</span><span class="n">buoy</span><span class="p">,</span> <span class="n">verbose</span><span class="p">):</span>
+ <span class="n">records</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="nb">tuple</span><span class="p">(</span><span class="n">buoy</span><span class="o">.</span><span class="n">getMetaData</span><span class="p">()))</span>
+ <span class="k">del</span> <span class="n">buoy</span>
+ <span class="k">if</span> <span class="p">(</span><span class="n">count</span> <span class="o">></span> <span class="mi">0</span><span class="p">)</span> <span class="o">&</span> <span class="p">((</span><span class="n">count</span> <span class="o">%</span> <span class="n">chunkSize</span><span class="p">)</span> <span class="o">==</span> <span class="mi">0</span><span class="p">):</span>
+ <span class="n">rec_count</span> <span class="o">=</span> <span class="n">insert_buoy_records</span><span class="p">(</span><span class="n">db_conn</span><span class="p">,</span> <span class="n">records</span><span class="p">)</span>
+ <span class="n">recs_added</span> <span class="o">+=</span> <span class="n">rec_count</span>
+ <span class="nb">print</span><span class="p">(</span><span class="n">recs_added</span><span class="p">,</span><span class="s1">' BUOY records added to the database'</span><span class="p">)</span>
+ <span class="n">records</span> <span class="o">=</span> <span class="p">[]</span>
+ <span class="nb">print</span><span class="p">(</span><span class="s1">'Time stamp: '</span><span class="p">,</span> <span class="nb">str</span><span class="p">(</span><span class="n">MData</span><span class="o">.</span><span class="n">datetime</span><span class="o">.</span><span class="n">now</span><span class="p">()))</span>
+ <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">records</span><span class="p">)</span> <span class="o">></span> <span class="mi">0</span><span class="p">:</span>
+ <span class="n">rec_count</span> <span class="o">=</span> <span class="n">insert_buoy_records</span><span class="p">(</span><span class="n">db_conn</span><span class="p">,</span> <span class="n">records</span><span class="p">)</span>
+ <span class="n">recs_added</span> <span class="o">+=</span> <span class="n">rec_count</span>
+ <span class="nb">print</span><span class="p">(</span><span class="n">recs_added</span><span class="p">,</span><span class="s1">' BUOY records added to the database'</span><span class="p">)</span>
+ <span class="nb">print</span><span class="p">(</span><span class="s1">'Time stamp: '</span><span class="p">,</span> <span class="nb">str</span><span class="p">(</span><span class="n">MData</span><span class="o">.</span><span class="n">datetime</span><span class="o">.</span><span class="n">now</span><span class="p">()))</span>
+ <span class="k">return</span> <span class="n">recs_added</span></div>
+
+
+<div class="viewcode-block" id="construct_rscd_mdb"><a class="viewcode-back" href="../MatchUpDatabase.html#MatchUpDatabase.construct_rscd_mdb">[docs]</a><span class="k">def</span> <span class="nf">construct_rscd_mdb</span><span class="p">(</span><span class="n">db_path</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
+ <span class="n">db_name</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
+ <span class="n">rscdpath</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
+ <span class="n">rscddataset</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
+ <span class="n">months</span><span class="p">:</span> <span class="nb">list</span><span class="p">,</span>
+ <span class="n">buoypath</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
+ <span class="n">buoydataset</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
+ <span class="n">buoydatafmt</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
+ <span class="n">bfilt</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
+ <span class="n">chunkSize</span><span class="o">=</span><span class="mi">500</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> """</span>
+ <span class="c1"># === Construct Match-up Database =======================================</span>
+ <span class="n">db_file</span> <span class="o">=</span> <span class="n">db_path</span><span class="o">+</span><span class="s1">'/'</span><span class="o">+</span><span class="n">db_name</span><span class="o">+</span><span class="s1">'.db'</span>
+ <span class="n">db_conn</span> <span class="o">=</span> <span class="n">create_connection</span><span class="p">(</span><span class="n">db_file</span><span class="p">)</span>
+
+ <span class="n">create_rscd_table</span><span class="p">(</span><span class="n">db_conn</span><span class="p">)</span>
+ <span class="n">create_buoy_table</span><span class="p">(</span><span class="n">db_conn</span><span class="p">)</span>
+
+ <span class="n">cur</span> <span class="o">=</span> <span class="n">db_conn</span><span class="o">.</span><span class="n">cursor</span><span class="p">()</span>
+ <span class="k">try</span><span class="p">:</span>
+ <span class="n">cur</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s2">"DELETE FROM buoy_files;"</span><span class="p">,)</span>
+ <span class="n">cur</span><span class="o">.</span><span class="n">rowcount</span>
+ <span class="k">except</span><span class="p">:</span>
+ <span class="nb">print</span><span class="p">(</span><span class="s1">'No table buoy_files, nothing deleted.'</span><span class="p">)</span>
+ <span class="k">try</span><span class="p">:</span>
+ <span class="n">cur</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s2">"DELETE FROM rscd_files;"</span><span class="p">,)</span>
+ <span class="n">cur</span><span class="o">.</span><span class="n">rowcount</span>
+ <span class="k">except</span><span class="p">:</span>
+ <span class="nb">print</span><span class="p">(</span><span class="s1">'No table rscd_files, nothing deleted.'</span><span class="p">)</span>
+ <span class="n">db_conn</span><span class="o">.</span><span class="n">commit</span><span class="p">()</span>
+
+ <span class="n">res</span> <span class="o">=</span><span class="n">cur</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s2">"SELECT name FROM sqlite_master WHERE type='table';"</span><span class="p">)</span>
+ <span class="nb">print</span><span class="p">(</span><span class="s1">'DB Tables: '</span><span class="p">,</span><span class="n">res</span><span class="o">.</span><span class="n">fetchall</span><span class="p">())</span>
+
+ <span class="c1"># === Populate Database =================================================</span>
+ <span class="c1"># Model Data Records</span>
+ <span class="k">if</span> <span class="n">months</span> <span class="o">==</span> <span class="p">[]:</span>
+ <span class="n">months</span> <span class="o">=</span> <span class="nb">list</span><span class="p">(</span><span class="nb">range</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span><span class="mi">13</span><span class="p">))</span>
+ <span class="k">for</span> <span class="n">month</span> <span class="ow">in</span> <span class="n">months</span><span class="p">:</span>
+ <span class="n">fpath</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">rscdpath</span><span class="p">,</span><span class="nb">str</span><span class="p">(</span><span class="n">month</span><span class="p">)</span><span class="o">.</span><span class="n">zfill</span><span class="p">(</span><span class="mi">2</span><span class="p">))</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">'</span><span class="se">\\</span><span class="s1">'</span><span class="p">,</span> <span class="s1">'/'</span><span class="p">)</span>
+ <span class="n">rscd_rec_cnt</span> <span class="o">=</span> <span class="n">load_rscd_archive</span><span class="p">(</span><span class="n">db_conn</span><span class="p">,</span>
+ <span class="n">fpath</span><span class="p">,</span> <span class="n">rscddataset</span><span class="p">,</span>
+ <span class="n">chunkSize</span><span class="p">)</span>
+ <span class="c1"># In situ Data Records</span>
+ <span class="n">buoy_rec_cnt</span> <span class="o">=</span> <span class="n">load_buoy_archive</span><span class="p">(</span><span class="n">db_conn</span><span class="p">,</span>
+ <span class="n">buoypath</span><span class="p">,</span> <span class="n">buoydataset</span><span class="p">,</span> <span class="n">buoydatafmt</span><span class="p">,</span>
+ <span class="n">bfilt</span><span class="p">,</span> <span class="n">chunkSize</span><span class="p">)</span>
+
+ <span class="n">db_conn</span><span class="o">.</span><span class="n">commit</span><span class="p">()</span>
+
+ <span class="c1"># === Close Database ====================================================</span>
+ <span class="n">db_conn</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
+
+ <span class="k">return</span> <span class="n">rscd_rec_cnt</span><span class="p">,</span> <span class="n">buoy_rec_cnt</span></div>
+
+</pre></div>
+
+ <div class="clearer"></div>
+ </div>
+ </div>
+ </div>
+ <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+ <div class="sphinxsidebarwrapper">
+<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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
+ <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="nav-item nav-item-0"><a href="../index.html">WaveVal documentation</a> »</li>
+ <li class="nav-item nav-item-1"><a href="index.html" >Module code</a> »</li>
+ <li class="nav-item nav-item-this"><a href="">MatchUpDatabase</a></li>
+ </ul>
+ </div>
+ <div class="footer" role="contentinfo">
+ © Copyright 2022.
+ Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 4.3.0.
+ </div>
+ </body>
+</html>
\ No newline at end of file
diff --git a/docs/_build/html/_modules/ModelData.html b/docs/_build/html/_modules/ModelData.html
new file mode 100644
index 0000000000000000000000000000000000000000..4771da46b531a0e6ecf99afcc496142fa00d471f
--- /dev/null
+++ b/docs/_build/html/_modules/ModelData.html
@@ -0,0 +1,362 @@
+
+
+<!doctype html>
+
+<html lang="en">
+ <head>
+ <meta charset="utf-8" />
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+ <title>ModelData — WaveVal documentation</title>
+ <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
+ <link rel="stylesheet" type="text/css" href="../_static/bizstyle.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 src="../_static/bizstyle.js"></script>
+ <link rel="author" title="About these documents" href="../about.html" />
+ <link rel="index" title="Index" href="../genindex.html" />
+ <link rel="search" title="Search" href="../search.html" />
+ <meta name="viewport" content="width=device-width,initial-scale=1.0" />
+ <!--[if lt IE 9]>
+ <script src="_static/css3-mediaqueries.js"></script>
+ <![endif]-->
+ </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="nav-item nav-item-0"><a href="../index.html">WaveVal documentation</a> »</li>
+ <li class="nav-item nav-item-1"><a href="index.html" accesskey="U">Module code</a> »</li>
+ <li class="nav-item nav-item-this"><a href="">ModelData</a></li>
+ </ul>
+ </div>
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body" role="main">
+
+ <h1>Source code for ModelData</h1><div class="highlight"><pre>
+<span></span><span class="c1"># -*- coding: utf-8 -*-</span>
+<span class="sd">"""</span>
+<span class="sd">Class structures and functions for loading numerical model output data in </span>
+<span class="sd">netCDF formats.</span>
+
+<span class="sd">:Dependencies [External]: os, numpy, datetime</span>
+<span class="sd">:Dependencies [Internal]: waveval.DataFormats. waveval.TimeFunc, waveval.Geometry</span>
+
+<span class="sd">"""</span>
+<span class="c1"># ----------------------------------------------------------------------------</span>
+<span class="c1"># IMPORTS</span>
+<span class="c1"># ----------------------------------------------------------------------------</span>
+<span class="c1"># Standard Python Dependencies</span>
+<span class="kn">import</span> <span class="nn">os</span>
+<span class="kn">from</span> <span class="nn">datetime</span> <span class="kn">import</span> <span class="n">datetime</span>
+<span class="c1"># Non-Standard Python Dependencies</span>
+<span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
+<span class="c1"># Local Module Dependencies</span>
+<span class="kn">from</span> <span class="nn">waveval.DataFormats</span> <span class="kn">import</span> <span class="n">ncdata</span><span class="p">,</span> <span class="n">netcdfGeneric</span>
+<span class="kn">from</span> <span class="nn">waveval.TimeFuncs</span> <span class="kn">import</span> <span class="n">num2date</span><span class="p">,</span> <span class="n">date2num</span>
+<span class="kn">from</span> <span class="nn">waveval.TimeFuncs</span> <span class="kn">import</span> <span class="n">stdTimeUnits</span>
+<span class="kn">from</span> <span class="nn">waveval.Geometry</span> <span class="kn">import</span> <span class="n">spatialCoverage</span>
+<span class="c1"># Other Dependencies</span>
+
+<span class="c1"># ----------------------------------------------------------------------------</span>
+<span class="c1"># GLOBAL VARIABLES</span>
+<span class="c1"># ----------------------------------------------------------------------------</span>
+
+
+<span class="c1"># ----------------------------------------------------------------------------</span>
+<span class="c1"># CLASS DEFINITIONS</span>
+<span class="c1"># ----------------------------------------------------------------------------</span>
+<span class="c1"># ============ ResourceCode WW3 Model Output Files ======================</span>
+<div class="viewcode-block" id="ww3"><a class="viewcode-back" href="../ModelData.html#ModelData.ww3">[docs]</a><span class="k">class</span> <span class="nc">ww3</span><span class="p">(</span><span class="n">netcdfGeneric</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Class structure for reading the ResourceCode WW3 model output netCDF files.</span>
+<span class="sd"> """</span>
+ <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">fileName</span><span class="p">):</span>
+
+ <span class="n">netcdfGeneric</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">fileName</span><span class="p">)</span>
+
+ <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">file</span><span class="p">[</span><span class="s1">'name'</span><span class="p">]</span> <span class="o">!=</span> <span class="s1">''</span><span class="p">:</span>
+ <span class="k">if</span> <span class="s1">'station_name'</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">file</span><span class="p">[</span><span class="s1">'vars'</span><span class="p">]:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">platform</span> <span class="o">=</span> \
+ <span class="s2">""</span><span class="o">.</span><span class="n">join</span><span class="p">([</span><span class="n">s</span><span class="o">.</span><span class="n">decode</span><span class="p">(</span><span class="s1">'utf-8'</span><span class="p">)</span>
+ <span class="k">for</span> <span class="n">s</span> <span class="ow">in</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">getVar</span><span class="p">(</span><span class="s1">'station_name'</span><span class="p">)[</span><span class="mi">0</span><span class="p">])])</span>
+ <span class="k">if</span> <span class="s1">'start_date'</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">file</span><span class="p">[</span><span class="s1">'attribs'</span><span class="p">]:</span>
+ <span class="n">tstr</span> <span class="o">=</span> <span class="n">ncdata</span><span class="p">(</span><span class="n">fileName</span><span class="p">)</span><span class="o">.</span><span class="n">start_date</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">time_start</span> <span class="o">=</span> <span class="n">tstr</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">'T'</span><span class="p">,</span> <span class="s1">' '</span><span class="p">)</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">'Z'</span><span class="p">,</span> <span class="s1">''</span><span class="p">)</span>
+ <span class="k">if</span> <span class="s1">'stop_date'</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">file</span><span class="p">[</span><span class="s1">'attribs'</span><span class="p">]:</span>
+ <span class="n">tstr</span> <span class="o">=</span> <span class="n">ncdata</span><span class="p">(</span><span class="n">fileName</span><span class="p">)</span><span class="o">.</span><span class="n">stop_date</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">time_end</span> <span class="o">=</span> <span class="n">tstr</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">'T'</span><span class="p">,</span> <span class="s1">' '</span><span class="p">)</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">'Z'</span><span class="p">,</span> <span class="s1">''</span><span class="p">)</span>
+ <span class="k">if</span> <span class="s1">'latitude'</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">file</span><span class="p">[</span><span class="s1">'vars'</span><span class="p">]:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">lat_min</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">nanmin</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">getVar</span><span class="p">(</span><span class="s1">'latitude'</span><span class="p">))</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">lat_max</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">nanmax</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">getVar</span><span class="p">(</span><span class="s1">'latitude'</span><span class="p">))</span>
+ <span class="n">lat</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">nanmean</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">getVar</span><span class="p">(</span><span class="s1">'latitude'</span><span class="p">))</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">lat</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">lat</span><span class="o">*</span><span class="mf">100000.0</span><span class="p">)</span><span class="o">/</span><span class="mf">100000.0</span>
+ <span class="k">if</span> <span class="s1">'longitude'</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">file</span><span class="p">[</span><span class="s1">'vars'</span><span class="p">]:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">lon_min</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">nanmin</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">getVar</span><span class="p">(</span><span class="s1">'longitude'</span><span class="p">))</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">lon_max</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">nanmax</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">getVar</span><span class="p">(</span><span class="s1">'longitude'</span><span class="p">))</span>
+ <span class="n">lon</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">nanmean</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">getVar</span><span class="p">(</span><span class="s1">'longitude'</span><span class="p">))</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">lon</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">lon</span><span class="o">*</span><span class="mf">100000.0</span><span class="p">)</span><span class="o">/</span><span class="mf">100000.0</span>
+ <span class="k">if</span> <span class="s1">'time'</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">file</span><span class="p">[</span><span class="s1">'vars'</span><span class="p">]:</span>
+ <span class="n">t</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">getVar</span><span class="p">(</span><span class="s1">'time'</span><span class="p">)</span>
+ <span class="n">p</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">mean</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">diff</span><span class="p">(</span><span class="n">t</span><span class="p">))</span><span class="o">*</span><span class="mf">24.0</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">sample_period</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">p</span><span class="o">*</span><span class="mf">3600.0</span><span class="p">)</span><span class="o">/</span><span class="mf">3600.0</span>
+
+<div class="viewcode-block" id="ww3.getMetaData"><a class="viewcode-back" href="../ModelData.html#ModelData.ww3.getMetaData">[docs]</a> <span class="k">def</span> <span class="nf">getMetaData</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="n">path</span><span class="p">,</span> <span class="n">file</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">file</span><span class="p">[</span><span class="s1">'name'</span><span class="p">])</span>
+ <span class="n">dtFmt</span> <span class="o">=</span> <span class="s1">'%Y-%m-</span><span class="si">%d</span><span class="s1"> %H:%M:%S'</span>
+ <span class="n">year</span> <span class="o">=</span> <span class="n">datetime</span><span class="o">.</span><span class="n">strptime</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">time_start</span><span class="p">,</span> <span class="n">dtFmt</span><span class="p">)</span><span class="o">.</span><span class="n">year</span>
+ <span class="n">month</span> <span class="o">=</span> <span class="n">datetime</span><span class="o">.</span><span class="n">strptime</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">time_start</span><span class="p">,</span> <span class="n">dtFmt</span><span class="p">)</span><span class="o">.</span><span class="n">month</span>
+ <span class="n">meta</span> <span class="o">=</span> <span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">platform</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">file</span><span class="p">,</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">lat</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">lon</span><span class="p">,</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">time_start</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">time_end</span><span class="p">,</span>
+ <span class="n">year</span><span class="p">,</span> <span class="n">month</span><span class="p">,</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">sample_period</span><span class="p">]</span>
+ <span class="k">return</span> <span class="n">meta</span></div>
+
+<div class="viewcode-block" id="ww3.getVar"><a class="viewcode-back" href="../ModelData.html#ModelData.ww3.getVar">[docs]</a> <span class="k">def</span> <span class="nf">getVar</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">varName</span><span class="p">):</span>
+ <span class="k">if</span> <span class="n">varName</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">file</span><span class="p">[</span><span class="s1">'vars'</span><span class="p">]:</span>
+ <span class="k">with</span> <span class="n">ncdata</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">file</span><span class="p">[</span><span class="s1">'name'</span><span class="p">],</span> <span class="s1">'r'</span><span class="p">,</span> <span class="nb">format</span><span class="o">=</span><span class="s1">'NETCDF4'</span><span class="p">)</span> <span class="k">as</span> <span class="n">nc</span><span class="p">:</span>
+ <span class="k">if</span> <span class="n">varName</span> <span class="o">==</span> <span class="s1">'time'</span><span class="p">:</span>
+ <span class="n">timeUnits</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">getVarAttr</span><span class="p">(</span><span class="s1">'time'</span><span class="p">,</span> <span class="s1">'units'</span><span class="p">)</span>
+ <span class="k">if</span> <span class="n">np</span><span class="o">.</span><span class="n">ma</span><span class="o">.</span><span class="n">isMaskedArray</span><span class="p">(</span><span class="n">nc</span><span class="o">.</span><span class="n">variables</span><span class="p">[</span><span class="n">varName</span><span class="p">][:]):</span>
+ <span class="n">time</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">ma</span><span class="o">.</span><span class="n">getdata</span><span class="p">(</span><span class="n">nc</span><span class="o">.</span><span class="n">variables</span><span class="p">[</span><span class="n">varName</span><span class="p">][:])</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">time</span> <span class="o">=</span> <span class="n">nc</span><span class="o">.</span><span class="n">variables</span><span class="p">[</span><span class="n">varName</span><span class="p">][:]</span>
+ <span class="n">var</span> <span class="o">=</span> <span class="n">date2num</span><span class="p">(</span><span class="n">num2date</span><span class="p">(</span><span class="n">time</span><span class="p">,</span> <span class="n">timeUnits</span><span class="p">),</span> <span class="n">stdTimeUnits</span><span class="p">)</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="k">if</span> <span class="n">np</span><span class="o">.</span><span class="n">ma</span><span class="o">.</span><span class="n">isMaskedArray</span><span class="p">(</span><span class="n">nc</span><span class="o">.</span><span class="n">variables</span><span class="p">[</span><span class="n">varName</span><span class="p">][:]):</span>
+ <span class="n">var</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">ma</span><span class="o">.</span><span class="n">getdata</span><span class="p">(</span><span class="n">nc</span><span class="o">.</span><span class="n">variables</span><span class="p">[</span><span class="n">varName</span><span class="p">][:])</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">var</span> <span class="o">=</span> <span class="n">nc</span><span class="o">.</span><span class="n">variables</span><span class="p">[</span><span class="n">varName</span><span class="p">][:]</span>
+ <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">hasAttr</span><span class="p">(</span><span class="n">varName</span><span class="p">,</span><span class="s1">'_FillValue'</span><span class="p">):</span>
+ <span class="n">fv</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">getVarAttr</span><span class="p">(</span><span class="n">varName</span><span class="p">,</span><span class="s1">'_FillValue'</span><span class="p">)</span>
+ <span class="n">var</span><span class="p">[</span><span class="n">var</span><span class="o">==</span><span class="n">fv</span><span class="p">]</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">NaN</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="nb">print</span><span class="p">(</span><span class="s1">'WARNING: Variable '</span><span class="o">+</span><span class="n">varName</span><span class="o">+</span><span class="s1">' does not exist.'</span><span class="p">)</span>
+ <span class="nb">print</span><span class="p">(</span><span class="s1">'Available variables:'</span><span class="p">)</span>
+ <span class="nb">print</span><span class="p">(</span><span class="nb">list</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">file</span><span class="p">[</span><span class="s1">'vars'</span><span class="p">]))</span>
+ <span class="n">var</span> <span class="o">=</span> <span class="kc">None</span>
+ <span class="k">return</span> <span class="n">var</span></div></div>
+
+
+<div class="viewcode-block" id="ww3Mesh"><a class="viewcode-back" href="../ModelData.html#ModelData.ww3Mesh">[docs]</a><span class="k">class</span> <span class="nc">ww3Mesh</span><span class="p">:</span>
+ <span class="sd">"""</span>
+<span class="sd"> Class structure for extracting the model mesh data from the a </span>
+<span class="sd"> ResourceCode WW3 model output netCDF files that contains the </span>
+<span class="sd"> mesh definition.</span>
+<span class="sd"> """</span>
+ <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">meshFile</span><span class="p">):</span>
+ <span class="k">try</span><span class="p">:</span>
+ <span class="n">mesh</span> <span class="o">=</span> <span class="n">ww3</span><span class="p">(</span><span class="n">meshFile</span><span class="p">)</span>
+ <span class="n">lon</span> <span class="o">=</span> <span class="n">mesh</span><span class="o">.</span><span class="n">getVar</span><span class="p">(</span><span class="s1">'longitude'</span><span class="p">)</span>
+ <span class="n">lat</span> <span class="o">=</span> <span class="n">mesh</span><span class="o">.</span><span class="n">getVar</span><span class="p">(</span><span class="s1">'latitude'</span><span class="p">)</span>
+ <span class="n">elems</span> <span class="o">=</span> <span class="n">mesh</span><span class="o">.</span><span class="n">getVar</span><span class="p">(</span><span class="s1">'tri'</span><span class="p">)</span>
+ <span class="n">bathy</span> <span class="o">=</span> <span class="n">mesh</span><span class="o">.</span><span class="n">getVar</span><span class="p">(</span><span class="s1">'dpt'</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">domain</span> <span class="o">=</span> <span class="n">spatialCoverage</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">nanmin</span><span class="p">(</span><span class="n">lat</span><span class="p">),</span> <span class="n">np</span><span class="o">.</span><span class="n">nanmax</span><span class="p">(</span><span class="n">lat</span><span class="p">),</span>
+ <span class="n">np</span><span class="o">.</span><span class="n">nanmin</span><span class="p">(</span><span class="n">lon</span><span class="p">),</span> <span class="n">np</span><span class="o">.</span><span class="n">nanmax</span><span class="p">(</span><span class="n">lon</span><span class="p">))</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">X</span> <span class="o">=</span> <span class="n">lon</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">Y</span> <span class="o">=</span> <span class="n">lat</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">elems</span> <span class="o">=</span> <span class="n">elems</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">bathy</span> <span class="o">=</span> <span class="n">bathy</span>
+ <span class="k">except</span><span class="p">:</span>
+ <span class="nb">print</span><span class="p">(</span><span class="s1">'WARNING: An error occurred while extracting mesh.'</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">domain</span> <span class="o">=</span> <span class="kc">None</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">X</span> <span class="o">=</span> <span class="kc">None</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">Y</span> <span class="o">=</span> <span class="kc">None</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">elems</span> <span class="o">=</span> <span class="kc">None</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">bathy</span> <span class="o">=</span> <span class="kc">None</span></div>
+
+<span class="c1"># ============ Marine Scotland SSW Model Output Files ===================</span>
+<div class="viewcode-block" id="ssw_rs"><a class="viewcode-back" href="../ModelData.html#ModelData.ssw_rs">[docs]</a><span class="k">class</span> <span class="nc">ssw_rs</span><span class="p">(</span><span class="n">netcdfGeneric</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Class structure for reading the Marine Scotland SSW model output netCDF files.</span>
+<span class="sd"> """</span>
+ <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">fileName</span><span class="p">):</span>
+
+ <span class="n">netcdfGeneric</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">fileName</span><span class="p">)</span>
+
+ <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">file</span><span class="p">[</span><span class="s1">'name'</span><span class="p">]</span> <span class="o">!=</span> <span class="s1">''</span><span class="p">:</span>
+ <span class="c1"># set metadata platform</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">platform</span> <span class="o">=</span> <span class="kc">None</span>
+ <span class="c1"># set metadata start date</span>
+ <span class="n">t</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">getVar</span><span class="p">(</span><span class="s1">'time'</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span>
+ <span class="n">units</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">getVarAttr</span><span class="p">(</span><span class="s1">'time'</span><span class="p">,</span><span class="s1">'units'</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">time_start</span> <span class="o">=</span> <span class="n">num2date</span><span class="p">(</span><span class="n">t</span><span class="p">,</span><span class="n">units</span><span class="p">)</span><span class="o">.</span><span class="n">strftime</span><span class="p">()</span>
+ <span class="c1"># set metadata stop date</span>
+ <span class="n">t</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">getVar</span><span class="p">(</span><span class="s1">'time'</span><span class="p">)[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span>
+ <span class="n">units</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">getVarAttr</span><span class="p">(</span><span class="s1">'time'</span><span class="p">,</span><span class="s1">'units'</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">time_end</span> <span class="o">=</span> <span class="n">num2date</span><span class="p">(</span><span class="n">t</span><span class="p">,</span><span class="n">units</span><span class="p">)</span><span class="o">.</span><span class="n">strftime</span><span class="p">()</span>
+ <span class="k">if</span> <span class="s1">'lat'</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">file</span><span class="p">[</span><span class="s1">'vars'</span><span class="p">]:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">lat_min</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">nanmin</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">getVar</span><span class="p">(</span><span class="s1">'lat'</span><span class="p">))</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">lat_max</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">nanmax</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">getVar</span><span class="p">(</span><span class="s1">'lat'</span><span class="p">))</span>
+ <span class="n">lat</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">nanmean</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">getVar</span><span class="p">(</span><span class="s1">'lat'</span><span class="p">))</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">lat</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">lat</span><span class="o">*</span><span class="mf">100000.0</span><span class="p">)</span><span class="o">/</span><span class="mf">100000.0</span>
+ <span class="k">if</span> <span class="s1">'lon'</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">file</span><span class="p">[</span><span class="s1">'vars'</span><span class="p">]:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">lon_min</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">nanmin</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">getVar</span><span class="p">(</span><span class="s1">'lon'</span><span class="p">))</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">lon_max</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">nanmax</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">getVar</span><span class="p">(</span><span class="s1">'lon'</span><span class="p">))</span>
+ <span class="n">lon</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">nanmean</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">getVar</span><span class="p">(</span><span class="s1">'lon'</span><span class="p">))</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">lon</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">lon</span><span class="o">*</span><span class="mf">100000.0</span><span class="p">)</span><span class="o">/</span><span class="mf">100000.0</span>
+ <span class="k">if</span> <span class="s1">'time'</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">file</span><span class="p">[</span><span class="s1">'vars'</span><span class="p">]:</span>
+ <span class="n">t</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">getVar</span><span class="p">(</span><span class="s1">'time'</span><span class="p">)</span>
+ <span class="n">p</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">mean</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">diff</span><span class="p">(</span><span class="n">t</span><span class="p">))</span><span class="o">*</span><span class="mf">24.0</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">sample_period</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">p</span><span class="o">*</span><span class="mf">3600.0</span><span class="p">)</span><span class="o">/</span><span class="mf">3600.0</span>
+
+<div class="viewcode-block" id="ssw_rs.getMetaData"><a class="viewcode-back" href="../ModelData.html#ModelData.ssw_rs.getMetaData">[docs]</a> <span class="k">def</span> <span class="nf">getMetaData</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="n">path</span><span class="p">,</span> <span class="n">file</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">file</span><span class="p">[</span><span class="s1">'name'</span><span class="p">])</span>
+ <span class="n">dtFmt</span> <span class="o">=</span> <span class="s1">'%Y-%m-</span><span class="si">%d</span><span class="s1"> %H:%M:%S'</span>
+ <span class="n">year</span> <span class="o">=</span> <span class="n">datetime</span><span class="o">.</span><span class="n">strptime</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">time_start</span><span class="p">,</span> <span class="n">dtFmt</span><span class="p">)</span><span class="o">.</span><span class="n">year</span>
+ <span class="n">month</span> <span class="o">=</span> <span class="n">datetime</span><span class="o">.</span><span class="n">strptime</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">time_start</span><span class="p">,</span> <span class="n">dtFmt</span><span class="p">)</span><span class="o">.</span><span class="n">month</span>
+ <span class="n">meta</span> <span class="o">=</span> <span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">platform</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">file</span><span class="p">,</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">lat</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">lon</span><span class="p">,</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">time_start</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">time_end</span><span class="p">,</span>
+ <span class="n">year</span><span class="p">,</span> <span class="n">month</span><span class="p">,</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">sample_period</span><span class="p">]</span>
+ <span class="k">return</span> <span class="n">meta</span></div>
+
+<div class="viewcode-block" id="ssw_rs.getVar"><a class="viewcode-back" href="../ModelData.html#ModelData.ssw_rs.getVar">[docs]</a> <span class="k">def</span> <span class="nf">getVar</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">varName</span><span class="p">):</span>
+ <span class="k">if</span> <span class="n">varName</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">file</span><span class="p">[</span><span class="s1">'vars'</span><span class="p">]:</span>
+ <span class="k">with</span> <span class="n">ncdata</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">file</span><span class="p">[</span><span class="s1">'name'</span><span class="p">],</span> <span class="s1">'r'</span><span class="p">,</span> <span class="nb">format</span><span class="o">=</span><span class="s1">'NETCDF4'</span><span class="p">)</span> <span class="k">as</span> <span class="n">nc</span><span class="p">:</span>
+ <span class="k">if</span> <span class="n">varName</span> <span class="o">==</span> <span class="s1">'time'</span><span class="p">:</span>
+ <span class="n">timeUnits</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">getVarAttr</span><span class="p">(</span><span class="s1">'time'</span><span class="p">,</span> <span class="s1">'units'</span><span class="p">)</span>
+ <span class="k">if</span> <span class="n">np</span><span class="o">.</span><span class="n">ma</span><span class="o">.</span><span class="n">isMaskedArray</span><span class="p">(</span><span class="n">nc</span><span class="o">.</span><span class="n">variables</span><span class="p">[</span><span class="n">varName</span><span class="p">][:]):</span>
+ <span class="n">time</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">ma</span><span class="o">.</span><span class="n">getdata</span><span class="p">(</span><span class="n">nc</span><span class="o">.</span><span class="n">variables</span><span class="p">[</span><span class="n">varName</span><span class="p">][:])</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">time</span> <span class="o">=</span> <span class="n">nc</span><span class="o">.</span><span class="n">variables</span><span class="p">[</span><span class="n">varName</span><span class="p">][:]</span>
+ <span class="n">var</span> <span class="o">=</span> <span class="n">date2num</span><span class="p">(</span><span class="n">num2date</span><span class="p">(</span><span class="n">time</span><span class="p">,</span> <span class="n">timeUnits</span><span class="p">),</span> <span class="n">stdTimeUnits</span><span class="p">)</span>
+ <span class="k">elif</span> <span class="n">varName</span> <span class="ow">in</span> <span class="p">[</span><span class="s1">'lon'</span><span class="p">,</span><span class="s1">'lonc'</span><span class="p">]:</span>
+ <span class="k">if</span> <span class="n">np</span><span class="o">.</span><span class="n">ma</span><span class="o">.</span><span class="n">isMaskedArray</span><span class="p">(</span><span class="n">nc</span><span class="o">.</span><span class="n">variables</span><span class="p">[</span><span class="n">varName</span><span class="p">][:]):</span>
+ <span class="n">var</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">ma</span><span class="o">.</span><span class="n">getdata</span><span class="p">(</span><span class="n">nc</span><span class="o">.</span><span class="n">variables</span><span class="p">[</span><span class="n">varName</span><span class="p">][:])</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">var</span> <span class="o">=</span> <span class="n">nc</span><span class="o">.</span><span class="n">variables</span><span class="p">[</span><span class="n">varName</span><span class="p">][:]</span>
+ <span class="n">var</span><span class="p">[</span><span class="n">var</span> <span class="o">></span> <span class="mf">180.0</span><span class="p">]</span> <span class="o">=</span> <span class="n">var</span><span class="p">[</span><span class="n">var</span> <span class="o">></span> <span class="mf">180.0</span><span class="p">]</span> <span class="o">-</span><span class="mf">360.0</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="k">if</span> <span class="n">np</span><span class="o">.</span><span class="n">ma</span><span class="o">.</span><span class="n">isMaskedArray</span><span class="p">(</span><span class="n">nc</span><span class="o">.</span><span class="n">variables</span><span class="p">[</span><span class="n">varName</span><span class="p">][:]):</span>
+ <span class="n">var</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">ma</span><span class="o">.</span><span class="n">getdata</span><span class="p">(</span><span class="n">nc</span><span class="o">.</span><span class="n">variables</span><span class="p">[</span><span class="n">varName</span><span class="p">][:])</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">var</span> <span class="o">=</span> <span class="n">nc</span><span class="o">.</span><span class="n">variables</span><span class="p">[</span><span class="n">varName</span><span class="p">][:]</span>
+ <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">hasAttr</span><span class="p">(</span><span class="n">varName</span><span class="p">,</span><span class="s1">'_FillValue'</span><span class="p">):</span>
+ <span class="n">fv</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">getVarAttr</span><span class="p">(</span><span class="n">varName</span><span class="p">,</span><span class="s1">'_FillValue'</span><span class="p">)</span>
+ <span class="n">var</span><span class="p">[</span><span class="n">var</span><span class="o">==</span><span class="n">fv</span><span class="p">]</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">NaN</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="nb">print</span><span class="p">(</span><span class="s1">'WARNING: Variable '</span><span class="o">+</span><span class="n">varName</span><span class="o">+</span><span class="s1">' does not exist.'</span><span class="p">)</span>
+ <span class="nb">print</span><span class="p">(</span><span class="s1">'Available variables:'</span><span class="p">)</span>
+ <span class="nb">print</span><span class="p">(</span><span class="nb">list</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">file</span><span class="p">[</span><span class="s1">'vars'</span><span class="p">]))</span>
+ <span class="n">var</span> <span class="o">=</span> <span class="kc">None</span>
+ <span class="k">return</span> <span class="n">var</span></div></div>
+
+
+<div class="viewcode-block" id="sswMesh"><a class="viewcode-back" href="../ModelData.html#ModelData.sswMesh">[docs]</a><span class="k">class</span> <span class="nc">sswMesh</span><span class="p">:</span>
+ <span class="sd">"""</span>
+<span class="sd"> Class structure for extracting the model mesh data from the a </span>
+<span class="sd"> Marine Scotland SSW model output netCDF files that contains the </span>
+<span class="sd"> mesh definition.</span>
+<span class="sd"> """</span>
+ <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">sswFile</span><span class="p">):</span>
+
+ <span class="k">try</span><span class="p">:</span>
+ <span class="n">ssw</span> <span class="o">=</span> <span class="n">ssw_rs</span><span class="p">(</span><span class="n">sswFile</span><span class="p">)</span>
+ <span class="n">lon</span> <span class="o">=</span> <span class="n">ssw</span><span class="o">.</span><span class="n">getVar</span><span class="p">(</span><span class="s1">'lon'</span><span class="p">)</span>
+ <span class="n">lat</span> <span class="o">=</span> <span class="n">ssw</span><span class="o">.</span><span class="n">getVar</span><span class="p">(</span><span class="s1">'lat'</span><span class="p">)</span>
+ <span class="n">elems</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">transpose</span><span class="p">(</span><span class="n">ssw</span><span class="o">.</span><span class="n">getVar</span><span class="p">(</span><span class="s1">'nv'</span><span class="p">))</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">domain</span> <span class="o">=</span> <span class="n">spatialCoverage</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">nanmin</span><span class="p">(</span><span class="n">lat</span><span class="p">),</span> <span class="n">np</span><span class="o">.</span><span class="n">nanmax</span><span class="p">(</span><span class="n">lat</span><span class="p">),</span>
+ <span class="n">np</span><span class="o">.</span><span class="n">nanmin</span><span class="p">(</span><span class="n">lon</span><span class="p">),</span> <span class="n">np</span><span class="o">.</span><span class="n">nanmax</span><span class="p">(</span><span class="n">lon</span><span class="p">))</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">X</span> <span class="o">=</span> <span class="n">lon</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">Y</span> <span class="o">=</span> <span class="n">lat</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">elems</span> <span class="o">=</span> <span class="n">elems</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">Xc</span> <span class="o">=</span> <span class="n">ssw</span><span class="o">.</span><span class="n">getVar</span><span class="p">(</span><span class="s1">'lonc'</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">Yc</span> <span class="o">=</span> <span class="n">ssw</span><span class="o">.</span><span class="n">getVar</span><span class="p">(</span><span class="s1">'latc'</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">bathy</span> <span class="o">=</span> <span class="n">ssw</span><span class="o">.</span><span class="n">getVar</span><span class="p">(</span><span class="s1">'h'</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">bathyc</span> <span class="o">=</span> <span class="n">ssw</span><span class="o">.</span><span class="n">getVar</span><span class="p">(</span><span class="s1">'h_center'</span><span class="p">)</span>
+ <span class="k">except</span><span class="p">:</span>
+ <span class="nb">print</span><span class="p">(</span><span class="s1">'WARNING: An error occurred while extracting mesh.'</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">domain</span> <span class="o">=</span> <span class="kc">None</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">X</span> <span class="o">=</span> <span class="kc">None</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">Y</span> <span class="o">=</span> <span class="kc">None</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">elems</span> <span class="o">=</span> <span class="kc">None</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">Xc</span> <span class="o">=</span> <span class="kc">None</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">Yc</span> <span class="o">=</span> <span class="kc">None</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">bathy</span> <span class="o">=</span> <span class="kc">None</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">bathyc</span> <span class="o">=</span> <span class="kc">None</span></div>
+
+
+<span class="c1"># ----------------------------------------------------------------------------</span>
+<span class="c1"># FUNCTION DEFINITIONS</span>
+<span class="c1"># ----------------------------------------------------------------------------</span>
+<div class="viewcode-block" id="mesh2sms2dm"><a class="viewcode-back" href="../ModelData.html#ModelData.mesh2sms2dm">[docs]</a><span class="k">def</span> <span class="nf">mesh2sms2dm</span><span class="p">(</span><span class="n">outpath</span><span class="p">,</span><span class="n">outfile</span><span class="p">,</span><span class="n">mesh</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Convert mesh data to SMS2DM mesh format.</span>
+<span class="sd"> """</span>
+ <span class="n">f</span> <span class="o">=</span> <span class="nb">open</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">outpath</span><span class="p">,</span><span class="n">outfile</span><span class="p">),</span><span class="s1">'w'</span><span class="p">)</span>
+ <span class="n">f</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s1">'MESH2D</span><span class="se">\n</span><span class="s1">'</span><span class="p">)</span>
+ <span class="n">elems</span> <span class="o">=</span> <span class="n">mesh</span><span class="o">.</span><span class="n">getVar</span><span class="p">(</span><span class="s1">'tri'</span><span class="p">)</span>
+ <span class="n">X</span> <span class="o">=</span> <span class="n">mesh</span><span class="o">.</span><span class="n">getVar</span><span class="p">(</span><span class="s1">'longitude'</span><span class="p">)</span>
+ <span class="n">Y</span> <span class="o">=</span> <span class="n">mesh</span><span class="o">.</span><span class="n">getVar</span><span class="p">(</span><span class="s1">'latitude'</span><span class="p">)</span>
+ <span class="n">bathy</span> <span class="o">=</span> <span class="n">mesh</span><span class="o">.</span><span class="n">getVar</span><span class="p">(</span><span class="s1">'bathy'</span><span class="p">)</span>
+ <span class="n">nelems</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="n">elems</span><span class="p">)</span>
+ <span class="k">for</span> <span class="n">el</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">nelems</span><span class="p">):</span>
+ <span class="n">s</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'E3T'</span><span class="p">,</span><span class="nb">str</span><span class="p">(</span><span class="n">el</span><span class="o">+</span><span class="mi">1</span><span class="p">),</span>
+ <span class="nb">str</span><span class="p">(</span><span class="n">elems</span><span class="p">[</span><span class="n">el</span><span class="p">,</span><span class="mi">0</span><span class="p">]),</span>
+ <span class="nb">str</span><span class="p">(</span><span class="n">elems</span><span class="p">[</span><span class="n">el</span><span class="p">,</span><span class="mi">1</span><span class="p">]),</span>
+ <span class="nb">str</span><span class="p">(</span><span class="n">elems</span><span class="p">[</span><span class="n">el</span><span class="p">,</span><span class="mi">2</span><span class="p">]),</span><span class="s1">'</span><span class="se">\n</span><span class="s1">'</span><span class="p">]</span>
+ <span class="n">aline</span> <span class="o">=</span> <span class="s1">' '</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">s</span><span class="p">)</span>
+ <span class="n">f</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">aline</span><span class="p">)</span>
+ <span class="n">nnodes</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="n">X</span><span class="p">)</span>
+ <span class="k">for</span> <span class="n">nd</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">nnodes</span><span class="p">):</span>
+ <span class="n">s</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'ND'</span><span class="p">,</span><span class="nb">str</span><span class="p">(</span><span class="n">nd</span><span class="o">+</span><span class="mi">1</span><span class="p">),</span><span class="nb">str</span><span class="p">(</span><span class="n">X</span><span class="p">[</span><span class="n">nd</span><span class="p">]),</span><span class="nb">str</span><span class="p">(</span><span class="n">Y</span><span class="p">[</span><span class="n">nd</span><span class="p">]),</span><span class="nb">str</span><span class="p">(</span><span class="n">bathy</span><span class="p">[</span><span class="n">nd</span><span class="p">]),</span><span class="s1">'</span><span class="se">\n</span><span class="s1">'</span><span class="p">]</span>
+ <span class="n">aline</span> <span class="o">=</span> <span class="s1">' '</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">s</span><span class="p">)</span>
+ <span class="n">f</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">aline</span><span class="p">)</span>
+ <span class="n">f</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
+ <span class="k">return</span></div>
+
+</pre></div>
+
+ <div class="clearer"></div>
+ </div>
+ </div>
+ </div>
+ <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+ <div class="sphinxsidebarwrapper">
+<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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
+ <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="nav-item nav-item-0"><a href="../index.html">WaveVal documentation</a> »</li>
+ <li class="nav-item nav-item-1"><a href="index.html" >Module code</a> »</li>
+ <li class="nav-item nav-item-this"><a href="">ModelData</a></li>
+ </ul>
+ </div>
+ <div class="footer" role="contentinfo">
+ © Copyright 2022.
+ Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 4.3.0.
+ </div>
+ </body>
+</html>
\ No newline at end of file
diff --git a/docs/_build/html/_modules/ObsData.html b/docs/_build/html/_modules/ObsData.html
new file mode 100644
index 0000000000000000000000000000000000000000..dfbd942cb800d747131d64f9a110cd61425a67cb
--- /dev/null
+++ b/docs/_build/html/_modules/ObsData.html
@@ -0,0 +1,446 @@
+
+
+<!doctype html>
+
+<html lang="en">
+ <head>
+ <meta charset="utf-8" />
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+ <title>ObsData — WaveVal documentation</title>
+ <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
+ <link rel="stylesheet" type="text/css" href="../_static/bizstyle.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 src="../_static/bizstyle.js"></script>
+ <link rel="author" title="About these documents" href="../about.html" />
+ <link rel="index" title="Index" href="../genindex.html" />
+ <link rel="search" title="Search" href="../search.html" />
+ <meta name="viewport" content="width=device-width,initial-scale=1.0" />
+ <!--[if lt IE 9]>
+ <script src="_static/css3-mediaqueries.js"></script>
+ <![endif]-->
+ </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="nav-item nav-item-0"><a href="../index.html">WaveVal documentation</a> »</li>
+ <li class="nav-item nav-item-1"><a href="index.html" accesskey="U">Module code</a> »</li>
+ <li class="nav-item nav-item-this"><a href="">ObsData</a></li>
+ </ul>
+ </div>
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body" role="main">
+
+ <h1>Source code for ObsData</h1><div class="highlight"><pre>
+<span></span><span class="c1"># -*- coding: utf-8 -*-</span>
+<span class="sd">"""</span>
+<span class="sd">Class structures and functions for loading observation data stored in </span>
+<span class="sd">netCDF formats.</span>
+
+<span class="sd">:Dependencies [External]: os, numpy, datetime</span>
+<span class="sd">:Dependencies [Internal]: waveval.DataFormats. waveval.TimeFunc, waveval.Geometry </span>
+
+<span class="sd">"""</span>
+<span class="c1"># ----------------------------------------------------------------------------</span>
+<span class="c1"># IMPORTS</span>
+<span class="c1"># ----------------------------------------------------------------------------</span>
+<span class="c1"># Standard Python Dependencies</span>
+<span class="kn">import</span> <span class="nn">os</span>
+<span class="c1"># Non-Standard Python Dependencies</span>
+<span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
+<span class="c1"># Local Module Dependencies</span>
+<span class="kn">from</span> <span class="nn">waveval.DataFormats</span> <span class="kn">import</span> <span class="n">ncdata</span><span class="p">,</span> <span class="n">netcdfGeneric</span>
+<span class="kn">from</span> <span class="nn">waveval.TimeFuncs</span> <span class="kn">import</span> <span class="n">num2date</span><span class="p">,</span> <span class="n">date2num</span>
+<span class="kn">from</span> <span class="nn">waveval.TimeFuncs</span> <span class="kn">import</span> <span class="n">stdTimeUnits</span>
+<span class="kn">from</span> <span class="nn">waveval.Geometry</span> <span class="kn">import</span> <span class="n">spatialCoverage</span>
+<span class="c1"># Other Dependencies</span>
+
+<span class="c1"># ----------------------------------------------------------------------------</span>
+<span class="c1"># GLOBAL VARIABLES</span>
+<span class="c1"># ----------------------------------------------------------------------------</span>
+
+
+<span class="c1"># ----------------------------------------------------------------------------</span>
+<span class="c1"># CLASS DEFINITIONS</span>
+<span class="c1"># ----------------------------------------------------------------------------</span>
+<span class="c1"># ==================== OceanSites Moored Buoy Data ======================</span>
+<div class="viewcode-block" id="wavebuoy"><a class="viewcode-back" href="../ObsData.html#ObsData.wavebuoy">[docs]</a><span class="k">class</span> <span class="nc">wavebuoy</span><span class="p">(</span><span class="n">netcdfGeneric</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Class structure for reading the CMEMS formatted wavebuoy netCDF files.</span>
+<span class="sd"> """</span>
+ <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">fileName</span><span class="p">):</span>
+
+ <span class="n">netcdfGeneric</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">fileName</span><span class="p">)</span>
+
+ <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">file</span><span class="p">[</span><span class="s1">'name'</span><span class="p">]</span> <span class="o">!=</span> <span class="s1">''</span><span class="p">:</span>
+ <span class="k">if</span> <span class="s1">'platform_code'</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">file</span><span class="p">[</span><span class="s1">'attribs'</span><span class="p">]:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">platform</span> <span class="o">=</span> <span class="n">ncdata</span><span class="p">(</span><span class="n">fileName</span><span class="p">)</span><span class="o">.</span><span class="n">platform_code</span>
+ <span class="k">if</span> <span class="s1">'time_coverage_start'</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">file</span><span class="p">[</span><span class="s1">'attribs'</span><span class="p">]:</span>
+ <span class="n">tstr</span> <span class="o">=</span> <span class="n">ncdata</span><span class="p">(</span><span class="n">fileName</span><span class="p">)</span><span class="o">.</span><span class="n">time_coverage_start</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">time_start</span> <span class="o">=</span> <span class="n">tstr</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">'T'</span><span class="p">,</span> <span class="s1">' '</span><span class="p">)</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">'Z'</span><span class="p">,</span> <span class="s1">''</span><span class="p">)</span>
+ <span class="k">if</span> <span class="s1">'time_coverage_end'</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">file</span><span class="p">[</span><span class="s1">'attribs'</span><span class="p">]:</span>
+ <span class="n">tstr</span> <span class="o">=</span> <span class="n">ncdata</span><span class="p">(</span><span class="n">fileName</span><span class="p">)</span><span class="o">.</span><span class="n">time_coverage_end</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">time_end</span> <span class="o">=</span> <span class="n">tstr</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">'T'</span><span class="p">,</span> <span class="s1">' '</span><span class="p">)</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">'Z'</span><span class="p">,</span> <span class="s1">''</span><span class="p">)</span>
+ <span class="k">if</span> <span class="s1">'LATITUDE'</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">file</span><span class="p">[</span><span class="s1">'vars'</span><span class="p">]:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">lat_min</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">nanmin</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">getVar</span><span class="p">(</span><span class="s1">'LATITUDE'</span><span class="p">))</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">lat_max</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">nanmax</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">getVar</span><span class="p">(</span><span class="s1">'LATITUDE'</span><span class="p">))</span>
+ <span class="n">lat</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">nanmedian</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">getVar</span><span class="p">(</span><span class="s1">'LATITUDE'</span><span class="p">))</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">lat</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">lat</span><span class="o">*</span><span class="mf">100000.0</span><span class="p">)</span><span class="o">/</span><span class="mf">100000.0</span>
+ <span class="k">if</span> <span class="s1">'LONGITUDE'</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">file</span><span class="p">[</span><span class="s1">'vars'</span><span class="p">]:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">lon_min</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">nanmin</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">getVar</span><span class="p">(</span><span class="s1">'LONGITUDE'</span><span class="p">))</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">lon_max</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">nanmax</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">getVar</span><span class="p">(</span><span class="s1">'LONGITUDE'</span><span class="p">))</span>
+ <span class="n">lon</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">nanmedian</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">getVar</span><span class="p">(</span><span class="s1">'LONGITUDE'</span><span class="p">))</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">lon</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">lon</span><span class="o">*</span><span class="mf">100000.0</span><span class="p">)</span><span class="o">/</span><span class="mf">100000.0</span>
+ <span class="k">if</span> <span class="s1">'TIME'</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">file</span><span class="p">[</span><span class="s1">'vars'</span><span class="p">]:</span>
+ <span class="n">t</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">getVar</span><span class="p">(</span><span class="s1">'TIME'</span><span class="p">)</span>
+ <span class="n">p</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">median</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">diff</span><span class="p">(</span><span class="n">t</span><span class="p">))</span><span class="o">*</span><span class="mf">24.0</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">sample_period</span> <span class="o">=</span> <span class="nb">round</span><span class="p">(</span><span class="n">p</span><span class="o">*</span><span class="mf">3600.0</span><span class="p">)</span><span class="o">/</span><span class="mf">3600.0</span>
+
+<div class="viewcode-block" id="wavebuoy.getMetaData"><a class="viewcode-back" href="../ObsData.html#ObsData.wavebuoy.getMetaData">[docs]</a> <span class="k">def</span> <span class="nf">getMetaData</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="n">path</span><span class="p">,</span> <span class="n">file</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">file</span><span class="p">[</span><span class="s1">'name'</span><span class="p">])</span>
+ <span class="n">meta</span> <span class="o">=</span> <span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">platform</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">file</span><span class="p">,</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">lat</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">lon</span><span class="p">,</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">time_start</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">time_end</span><span class="p">,</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">sample_period</span><span class="p">]</span>
+ <span class="k">return</span> <span class="n">meta</span></div>
+
+<div class="viewcode-block" id="wavebuoy.getVar"><a class="viewcode-back" href="../ObsData.html#ObsData.wavebuoy.getVar">[docs]</a> <span class="k">def</span> <span class="nf">getVar</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">varName</span><span class="p">):</span>
+ <span class="k">if</span> <span class="n">varName</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">file</span><span class="p">[</span><span class="s1">'vars'</span><span class="p">]:</span>
+ <span class="k">with</span> <span class="n">ncdata</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">file</span><span class="p">[</span><span class="s1">'name'</span><span class="p">],</span> <span class="s1">'r'</span><span class="p">,</span> <span class="nb">format</span><span class="o">=</span><span class="s1">'NETCDF4'</span><span class="p">)</span> <span class="k">as</span> <span class="n">nc</span><span class="p">:</span>
+ <span class="k">if</span> <span class="n">varName</span> <span class="o">==</span> <span class="s1">'TIME'</span><span class="p">:</span>
+ <span class="n">timeUnits</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">getVarAttr</span><span class="p">(</span><span class="s1">'TIME'</span><span class="p">,</span> <span class="s1">'units'</span><span class="p">)</span>
+ <span class="n">time</span><span class="p">,</span> <span class="n">mask</span> <span class="o">=</span> <span class="n">get_nc_var</span><span class="p">(</span><span class="n">nc</span><span class="p">,</span> <span class="s1">'TIME'</span><span class="p">)</span>
+ <span class="n">var</span> <span class="o">=</span> <span class="n">date2num</span><span class="p">(</span><span class="n">num2date</span><span class="p">(</span><span class="n">time</span><span class="p">,</span> <span class="n">timeUnits</span><span class="p">),</span> <span class="n">stdTimeUnits</span><span class="p">)</span>
+ <span class="n">var</span><span class="p">[</span><span class="n">mask</span><span class="p">]</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">nan</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">var</span><span class="p">,</span> <span class="n">mask</span> <span class="o">=</span> <span class="n">get_nc_var</span><span class="p">(</span><span class="n">nc</span><span class="p">,</span> <span class="n">varName</span><span class="p">)</span>
+ <span class="k">if</span> <span class="n">mask</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
+ <span class="n">var</span><span class="p">[</span><span class="n">mask</span><span class="p">]</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">nan</span>
+ <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">hasAttr</span><span class="p">(</span><span class="n">varName</span><span class="p">,</span><span class="s1">'_FillValue'</span><span class="p">):</span>
+ <span class="n">fv</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">getVarAttr</span><span class="p">(</span><span class="n">varName</span><span class="p">,</span><span class="s1">'_FillValue'</span><span class="p">)</span>
+ <span class="n">var</span><span class="p">[</span><span class="n">var</span><span class="o">==</span><span class="n">fv</span><span class="p">]</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">NaN</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="nb">print</span><span class="p">(</span><span class="s1">'WARNING: Variable '</span><span class="o">+</span><span class="n">varName</span><span class="o">+</span><span class="s1">' does not exist.'</span><span class="p">)</span>
+ <span class="nb">print</span><span class="p">(</span><span class="s1">'Available variables:'</span><span class="p">)</span>
+ <span class="nb">print</span><span class="p">(</span><span class="nb">list</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">file</span><span class="p">[</span><span class="s1">'vars'</span><span class="p">]))</span>
+ <span class="n">var</span> <span class="o">=</span> <span class="kc">None</span>
+ <span class="k">return</span> <span class="n">var</span></div>
+
+<div class="viewcode-block" id="wavebuoy.getQCVar"><a class="viewcode-back" href="../ObsData.html#ObsData.wavebuoy.getQCVar">[docs]</a> <span class="k">def</span> <span class="nf">getQCVar</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">varName</span><span class="p">):</span>
+ <span class="k">if</span> <span class="n">varName</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">file</span><span class="p">[</span><span class="s1">'vars'</span><span class="p">]:</span>
+ <span class="k">if</span> <span class="n">varName</span> <span class="o">==</span> <span class="s1">'TIME'</span><span class="p">:</span>
+ <span class="n">timeUnits</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">getVarAttr</span><span class="p">(</span><span class="s1">'TIME'</span><span class="p">,</span> <span class="s1">'units'</span><span class="p">)</span>
+ <span class="k">with</span> <span class="n">ncdata</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">file</span><span class="p">[</span><span class="s1">'name'</span><span class="p">],</span> <span class="s1">'r'</span><span class="p">,</span> <span class="nb">format</span><span class="o">=</span><span class="s1">'NETCDF4'</span><span class="p">)</span> <span class="k">as</span> <span class="n">nc</span><span class="p">:</span>
+ <span class="n">times</span><span class="p">,</span> <span class="n">t_mask</span> <span class="o">=</span> <span class="n">get_nc_var</span><span class="p">(</span><span class="n">nc</span><span class="p">,</span> <span class="s1">'TIME'</span><span class="p">)</span>
+ <span class="n">tqc</span><span class="p">,</span> <span class="n">tqc_mask</span> <span class="o">=</span> <span class="n">get_nc_var</span><span class="p">(</span><span class="n">nc</span><span class="p">,</span> <span class="s1">'TIME_QC'</span><span class="p">)</span>
+ <span class="n">var</span> <span class="o">=</span> <span class="n">date2num</span><span class="p">(</span><span class="n">num2date</span><span class="p">(</span><span class="n">times</span><span class="p">,</span> <span class="n">timeUnits</span><span class="p">),</span> <span class="n">stdTimeUnits</span><span class="p">)</span>
+ <span class="n">t_unique</span><span class="p">,</span> <span class="n">indx</span><span class="p">,</span> <span class="n">cnts</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">unique</span><span class="p">(</span><span class="n">times</span><span class="p">,</span>
+ <span class="n">return_index</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
+ <span class="n">return_counts</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
+ <span class="n">umask</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">ones</span><span class="p">(</span><span class="n">tqc</span><span class="o">.</span><span class="n">shape</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="nb">bool</span><span class="p">)</span>
+ <span class="n">umask</span><span class="p">[</span><span class="n">np</span><span class="o">.</span><span class="n">sort</span><span class="p">(</span><span class="n">indx</span><span class="p">[</span><span class="n">cnts</span> <span class="o">==</span> <span class="mi">1</span><span class="p">])]</span> <span class="o">=</span> <span class="kc">False</span>
+ <span class="n">tmask</span> <span class="o">=</span> <span class="n">tqc_mask</span>
+ <span class="n">mask</span> <span class="o">=</span> <span class="n">tmask</span> <span class="o">|</span> <span class="n">umask</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="k">with</span> <span class="n">ncdata</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">file</span><span class="p">[</span><span class="s1">'name'</span><span class="p">],</span> <span class="s1">'r'</span><span class="p">,</span> <span class="nb">format</span><span class="o">=</span><span class="s1">'NETCDF4'</span><span class="p">)</span> <span class="k">as</span> <span class="n">nc</span><span class="p">:</span>
+ <span class="n">var</span><span class="p">,</span> <span class="n">v_mask</span> <span class="o">=</span> <span class="n">get_nc_var</span><span class="p">(</span><span class="n">nc</span><span class="p">,</span> <span class="n">varName</span><span class="p">)</span>
+ <span class="n">vqc</span><span class="p">,</span> <span class="n">vqc_mask</span> <span class="o">=</span> <span class="n">get_nc_var</span><span class="p">(</span><span class="n">nc</span><span class="p">,</span> <span class="n">varName</span><span class="o">+</span><span class="s1">'_QC'</span><span class="p">)</span>
+ <span class="n">vqc</span><span class="p">,</span> <span class="n">vqc_mask</span> <span class="o">=</span> <span class="n">get_nc_var</span><span class="p">(</span><span class="n">nc</span><span class="p">,</span> <span class="n">varName</span><span class="o">+</span><span class="s1">'_QC'</span><span class="p">)</span>
+ <span class="n">var</span><span class="p">[</span><span class="n">v_mask</span><span class="p">]</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">nan</span>
+ <span class="n">var</span><span class="p">[</span><span class="n">vqc</span> <span class="o">!=</span> <span class="mi">1</span><span class="p">]</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">nan</span>
+ <span class="n">mask</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">zeros</span><span class="p">(</span><span class="n">vqc</span><span class="o">.</span><span class="n">shape</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="nb">bool</span><span class="p">)</span>
+ <span class="n">mask</span><span class="p">[</span><span class="n">np</span><span class="o">.</span><span class="n">isnan</span><span class="p">(</span><span class="n">var</span><span class="p">)]</span> <span class="o">=</span> <span class="kc">True</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="nb">print</span><span class="p">(</span><span class="s1">'WARNING: Variable '</span><span class="o">+</span><span class="n">varName</span><span class="o">+</span><span class="s1">' does not exist.'</span><span class="p">)</span>
+ <span class="nb">print</span><span class="p">(</span><span class="s1">'Available variables:'</span><span class="p">)</span>
+ <span class="nb">print</span><span class="p">(</span><span class="nb">list</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">file</span><span class="p">[</span><span class="s1">'vars'</span><span class="p">]))</span>
+ <span class="n">var</span> <span class="o">=</span> <span class="n">mask</span> <span class="o">=</span> <span class="kc">None</span>
+ <span class="k">return</span> <span class="n">var</span><span class="p">,</span> <span class="n">mask</span></div>
+
+<div class="viewcode-block" id="wavebuoy.getQCTimeseries"><a class="viewcode-back" href="../ObsData.html#ObsData.wavebuoy.getQCTimeseries">[docs]</a> <span class="k">def</span> <span class="nf">getQCTimeseries</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">varName</span><span class="p">,</span> <span class="n">varIndex</span><span class="p">):</span>
+ <span class="n">t</span><span class="p">,</span> <span class="n">tmsk</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">getQCVar</span><span class="p">(</span><span class="s1">'TIME'</span><span class="p">)</span>
+ <span class="n">v</span><span class="p">,</span> <span class="n">vmsk</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">getQCVar</span><span class="p">(</span><span class="n">varName</span><span class="p">)</span>
+ <span class="n">msk</span> <span class="o">=</span> <span class="n">tmsk</span> <span class="o">|</span> <span class="n">vmsk</span><span class="p">[:,</span> <span class="n">varIndex</span><span class="p">]</span>
+ <span class="n">times</span> <span class="o">=</span> <span class="n">t</span><span class="p">[</span><span class="o">~</span><span class="n">msk</span><span class="p">]</span><span class="o">.</span><span class="n">copy</span><span class="p">()</span>
+ <span class="n">values</span> <span class="o">=</span> <span class="n">v</span><span class="p">[:,</span> <span class="n">varIndex</span><span class="p">]</span><span class="o">.</span><span class="n">copy</span><span class="p">()</span>
+ <span class="n">values</span> <span class="o">=</span> <span class="n">values</span><span class="p">[</span><span class="o">~</span><span class="n">msk</span><span class="p">]</span>
+ <span class="k">return</span> <span class="n">times</span><span class="p">,</span> <span class="n">values</span></div>
+
+<div class="viewcode-block" id="wavebuoy.gapFillTimeseries"><a class="viewcode-back" href="../ObsData.html#ObsData.wavebuoy.gapFillTimeseries">[docs]</a> <span class="k">def</span> <span class="nf">gapFillTimeseries</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">times</span><span class="p">,</span> <span class="n">values</span><span class="p">):</span>
+ <span class="k">return</span> <span class="n">times</span><span class="p">,</span> <span class="n">values</span></div></div>
+
+<span class="c1"># ==================== EMEC Moored Buoy Data SeaDataNet ======================</span>
+<div class="viewcode-block" id="emecwb"><a class="viewcode-back" href="../ObsData.html#ObsData.emecwb">[docs]</a><span class="k">class</span> <span class="nc">emecwb</span><span class="p">(</span><span class="n">netcdfGeneric</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Class structure for reading the EMEC formatted wavebuoy netCDF files.</span>
+<span class="sd"> """</span>
+ <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">fileName</span><span class="p">):</span>
+
+ <span class="n">netcdfGeneric</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">fileName</span><span class="p">)</span>
+
+ <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">file</span><span class="p">[</span><span class="s1">'name'</span><span class="p">]</span> <span class="o">!=</span> <span class="s1">''</span><span class="p">:</span>
+ <span class="k">if</span> <span class="s1">'SDN_STATION'</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">file</span><span class="p">[</span><span class="s1">'vars'</span><span class="p">]:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">platform</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">getVar</span><span class="p">(</span><span class="s1">'SDN_STATION'</span><span class="p">))</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">platform</span> <span class="o">=</span> <span class="s1">'unknown'</span>
+ <span class="k">if</span> <span class="s1">'LATITUDE'</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">file</span><span class="p">[</span><span class="s1">'vars'</span><span class="p">]:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">lat_min</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">nanmin</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">getVar</span><span class="p">(</span><span class="s1">'LATITUDE'</span><span class="p">))</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">lat_max</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">nanmax</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">getVar</span><span class="p">(</span><span class="s1">'LATITUDE'</span><span class="p">))</span>
+ <span class="n">lat</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">nanmedian</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">getVar</span><span class="p">(</span><span class="s1">'LATITUDE'</span><span class="p">))</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">lat</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">lat</span><span class="o">*</span><span class="mf">100000.0</span><span class="p">)</span><span class="o">/</span><span class="mf">100000.0</span>
+ <span class="k">if</span> <span class="s1">'LONGITUDE'</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">file</span><span class="p">[</span><span class="s1">'vars'</span><span class="p">]:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">lon_min</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">nanmin</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">getVar</span><span class="p">(</span><span class="s1">'LONGITUDE'</span><span class="p">))</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">lon_max</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">nanmax</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">getVar</span><span class="p">(</span><span class="s1">'LONGITUDE'</span><span class="p">))</span>
+ <span class="n">lon</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">nanmedian</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">getVar</span><span class="p">(</span><span class="s1">'LONGITUDE'</span><span class="p">))</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">lon</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">lon</span><span class="o">*</span><span class="mf">100000.0</span><span class="p">)</span><span class="o">/</span><span class="mf">100000.0</span>
+ <span class="k">if</span> <span class="s1">'TIME'</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">file</span><span class="p">[</span><span class="s1">'vars'</span><span class="p">]:</span>
+ <span class="n">t</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">getVar</span><span class="p">(</span><span class="s1">'TIME'</span><span class="p">)</span><span class="o">.</span><span class="n">squeeze</span><span class="p">()</span>
+ <span class="n">p</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">median</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">diff</span><span class="p">(</span><span class="n">t</span><span class="p">))</span><span class="o">*</span><span class="mf">24.0</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">sample_period</span> <span class="o">=</span> <span class="nb">round</span><span class="p">(</span><span class="n">p</span><span class="o">*</span><span class="mf">3600.0</span><span class="p">)</span><span class="o">/</span><span class="mf">3600.0</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">time_start</span> <span class="o">=</span> <span class="n">num2date</span><span class="p">(</span><span class="n">t</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="n">stdTimeUnits</span><span class="p">)</span><span class="o">.</span><span class="n">strftime</span><span class="p">()</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">time_end</span> <span class="o">=</span> <span class="n">num2date</span><span class="p">(</span><span class="n">t</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">],</span> <span class="n">stdTimeUnits</span><span class="p">)</span><span class="o">.</span><span class="n">strftime</span><span class="p">()</span>
+
+<div class="viewcode-block" id="emecwb.getMetaData"><a class="viewcode-back" href="../ObsData.html#ObsData.emecwb.getMetaData">[docs]</a> <span class="k">def</span> <span class="nf">getMetaData</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="n">path</span><span class="p">,</span> <span class="n">file</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">file</span><span class="p">[</span><span class="s1">'name'</span><span class="p">])</span>
+ <span class="n">meta</span> <span class="o">=</span> <span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">platform</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">file</span><span class="p">,</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">lat</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">lon</span><span class="p">,</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">time_start</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">time_end</span><span class="p">,</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">sample_period</span><span class="p">]</span>
+ <span class="k">return</span> <span class="n">meta</span></div>
+
+<div class="viewcode-block" id="emecwb.getVar"><a class="viewcode-back" href="../ObsData.html#ObsData.emecwb.getVar">[docs]</a> <span class="k">def</span> <span class="nf">getVar</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">varName</span><span class="p">):</span>
+ <span class="k">if</span> <span class="n">varName</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">file</span><span class="p">[</span><span class="s1">'vars'</span><span class="p">]:</span>
+ <span class="k">with</span> <span class="n">ncdata</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">file</span><span class="p">[</span><span class="s1">'name'</span><span class="p">],</span> <span class="s1">'r'</span><span class="p">,</span> <span class="nb">format</span><span class="o">=</span><span class="s1">'NETCDF4'</span><span class="p">)</span> <span class="k">as</span> <span class="n">nc</span><span class="p">:</span>
+ <span class="k">if</span> <span class="n">varName</span> <span class="o">==</span> <span class="s1">'TIME'</span><span class="p">:</span>
+ <span class="n">timeUnits</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">getVarAttr</span><span class="p">(</span><span class="s1">'TIME'</span><span class="p">,</span> <span class="s1">'units'</span><span class="p">)</span>
+ <span class="n">time</span><span class="p">,</span> <span class="n">mask</span> <span class="o">=</span> <span class="n">get_nc_var</span><span class="p">(</span><span class="n">nc</span><span class="p">,</span> <span class="s1">'TIME'</span><span class="p">)</span>
+ <span class="n">var</span> <span class="o">=</span> <span class="n">date2num</span><span class="p">(</span><span class="n">num2date</span><span class="p">(</span><span class="n">time</span><span class="p">,</span> <span class="n">timeUnits</span><span class="p">),</span> <span class="n">stdTimeUnits</span><span class="p">)</span>
+ <span class="n">var</span><span class="p">[</span><span class="n">mask</span><span class="p">]</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">nan</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">var</span><span class="p">,</span> <span class="n">mask</span> <span class="o">=</span> <span class="n">get_nc_var</span><span class="p">(</span><span class="n">nc</span><span class="p">,</span> <span class="n">varName</span><span class="p">)</span>
+ <span class="k">if</span> <span class="n">mask</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
+ <span class="n">var</span><span class="p">[</span><span class="n">mask</span><span class="p">]</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">nan</span>
+ <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">hasAttr</span><span class="p">(</span><span class="n">varName</span><span class="p">,</span><span class="s1">'_FillValue'</span><span class="p">):</span>
+ <span class="n">fv</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">getVarAttr</span><span class="p">(</span><span class="n">varName</span><span class="p">,</span><span class="s1">'_FillValue'</span><span class="p">)</span>
+ <span class="n">var</span><span class="p">[</span><span class="n">var</span><span class="o">==</span><span class="n">fv</span><span class="p">]</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">NaN</span>
+ <span class="k">if</span> <span class="n">var</span><span class="o">.</span><span class="n">dtype</span> <span class="o">==</span> <span class="s1">'|S1'</span><span class="p">:</span>
+ <span class="n">var</span> <span class="o">=</span> <span class="p">(</span><span class="sa">b</span><span class="s1">''</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="nb">list</span><span class="p">(</span><span class="n">var</span><span class="p">)))</span><span class="o">.</span><span class="n">decode</span><span class="p">(</span><span class="s1">'utf-8'</span><span class="p">)</span>
+ <span class="n">var</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">squeeze</span><span class="p">(</span><span class="n">var</span><span class="p">)</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="nb">print</span><span class="p">(</span><span class="s1">'WARNING: Variable '</span><span class="o">+</span><span class="n">varName</span><span class="o">+</span><span class="s1">' does not exist.'</span><span class="p">)</span>
+ <span class="nb">print</span><span class="p">(</span><span class="s1">'Available variables:'</span><span class="p">)</span>
+ <span class="nb">print</span><span class="p">(</span><span class="nb">list</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">file</span><span class="p">[</span><span class="s1">'vars'</span><span class="p">]))</span>
+ <span class="n">var</span> <span class="o">=</span> <span class="kc">None</span>
+ <span class="k">return</span> <span class="n">var</span></div>
+
+<div class="viewcode-block" id="emecwb.getQCVar"><a class="viewcode-back" href="../ObsData.html#ObsData.emecwb.getQCVar">[docs]</a> <span class="k">def</span> <span class="nf">getQCVar</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">varName</span><span class="p">):</span>
+ <span class="k">if</span> <span class="n">varName</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">file</span><span class="p">[</span><span class="s1">'vars'</span><span class="p">]:</span>
+ <span class="k">if</span> <span class="n">varName</span> <span class="o">==</span> <span class="s1">'TIME'</span><span class="p">:</span>
+ <span class="n">timeUnits</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">getVarAttr</span><span class="p">(</span><span class="s1">'TIME'</span><span class="p">,</span> <span class="s1">'units'</span><span class="p">)</span>
+ <span class="k">with</span> <span class="n">ncdata</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">file</span><span class="p">[</span><span class="s1">'name'</span><span class="p">],</span> <span class="s1">'r'</span><span class="p">,</span> <span class="nb">format</span><span class="o">=</span><span class="s1">'NETCDF4'</span><span class="p">)</span> <span class="k">as</span> <span class="n">nc</span><span class="p">:</span>
+ <span class="n">times</span><span class="p">,</span> <span class="n">t_mask</span> <span class="o">=</span> <span class="n">get_nc_var</span><span class="p">(</span><span class="n">nc</span><span class="p">,</span> <span class="s1">'TIME'</span><span class="p">)</span>
+ <span class="n">tqc</span><span class="p">,</span> <span class="n">tqc_mask</span> <span class="o">=</span> <span class="n">get_nc_var</span><span class="p">(</span><span class="n">nc</span><span class="p">,</span> <span class="s1">'TIME_SEADATANET_QC'</span><span class="p">)</span>
+ <span class="n">var</span> <span class="o">=</span> <span class="n">date2num</span><span class="p">(</span><span class="n">num2date</span><span class="p">(</span><span class="n">times</span><span class="p">,</span> <span class="n">timeUnits</span><span class="p">),</span> <span class="n">stdTimeUnits</span><span class="p">)</span>
+ <span class="n">t_unique</span><span class="p">,</span> <span class="n">indx</span><span class="p">,</span> <span class="n">cnts</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">unique</span><span class="p">(</span><span class="n">times</span><span class="p">,</span>
+ <span class="n">return_index</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
+ <span class="n">return_counts</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
+ <span class="n">umask</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">ones</span><span class="p">(</span><span class="n">tqc</span><span class="o">.</span><span class="n">shape</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="nb">bool</span><span class="p">)</span>
+ <span class="n">umask</span><span class="p">[</span><span class="n">np</span><span class="o">.</span><span class="n">sort</span><span class="p">(</span><span class="n">indx</span><span class="p">[</span><span class="n">cnts</span> <span class="o">==</span> <span class="mi">1</span><span class="p">])]</span> <span class="o">=</span> <span class="kc">False</span>
+ <span class="n">tmask</span> <span class="o">=</span> <span class="n">tqc_mask</span>
+ <span class="n">mask</span> <span class="o">=</span> <span class="n">tmask</span> <span class="o">|</span> <span class="n">umask</span>
+ <span class="n">var</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">squeeze</span><span class="p">(</span><span class="n">var</span><span class="p">)</span>
+ <span class="n">mask</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">squeeze</span><span class="p">(</span><span class="n">mask</span><span class="p">)</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="k">with</span> <span class="n">ncdata</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">file</span><span class="p">[</span><span class="s1">'name'</span><span class="p">],</span> <span class="s1">'r'</span><span class="p">,</span> <span class="nb">format</span><span class="o">=</span><span class="s1">'NETCDF4'</span><span class="p">)</span> <span class="k">as</span> <span class="n">nc</span><span class="p">:</span>
+ <span class="n">var</span><span class="p">,</span> <span class="n">v_mask</span> <span class="o">=</span> <span class="n">get_nc_var</span><span class="p">(</span><span class="n">nc</span><span class="p">,</span> <span class="n">varName</span><span class="p">)</span>
+ <span class="n">vqc</span><span class="p">,</span> <span class="n">vqc_mask</span> <span class="o">=</span> <span class="n">get_nc_var</span><span class="p">(</span><span class="n">nc</span><span class="p">,</span> <span class="n">varName</span><span class="o">+</span><span class="s1">'_SEADATANET_QC'</span><span class="p">)</span>
+ <span class="c1">#vqc, vqc_mask = get_nc_var(nc, varName+'_SEADATANET_QC')</span>
+ <span class="n">var</span><span class="p">[</span><span class="n">v_mask</span><span class="p">]</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">nan</span>
+ <span class="n">var</span><span class="p">[</span><span class="n">vqc</span> <span class="o">></span> <span class="mi">49</span><span class="p">]</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">nan</span>
+ <span class="n">mask</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">zeros</span><span class="p">(</span><span class="n">vqc</span><span class="o">.</span><span class="n">shape</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="nb">bool</span><span class="p">)</span>
+ <span class="n">mask</span><span class="p">[</span><span class="n">np</span><span class="o">.</span><span class="n">isnan</span><span class="p">(</span><span class="n">var</span><span class="p">)]</span> <span class="o">=</span> <span class="kc">True</span>
+ <span class="n">var</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">squeeze</span><span class="p">(</span><span class="n">var</span><span class="p">)</span>
+ <span class="n">mask</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">squeeze</span><span class="p">(</span><span class="n">mask</span><span class="p">)</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="nb">print</span><span class="p">(</span><span class="s1">'WARNING: Variable '</span><span class="o">+</span><span class="n">varName</span><span class="o">+</span><span class="s1">' does not exist.'</span><span class="p">)</span>
+ <span class="nb">print</span><span class="p">(</span><span class="s1">'Available variables:'</span><span class="p">)</span>
+ <span class="nb">print</span><span class="p">(</span><span class="nb">list</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">file</span><span class="p">[</span><span class="s1">'vars'</span><span class="p">]))</span>
+ <span class="n">var</span> <span class="o">=</span> <span class="n">mask</span> <span class="o">=</span> <span class="kc">None</span>
+ <span class="k">return</span> <span class="n">var</span><span class="p">,</span> <span class="n">mask</span></div>
+
+<div class="viewcode-block" id="emecwb.getQCTimeseries"><a class="viewcode-back" href="../ObsData.html#ObsData.emecwb.getQCTimeseries">[docs]</a> <span class="k">def</span> <span class="nf">getQCTimeseries</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">varName</span><span class="p">,</span> <span class="n">varIndex</span><span class="p">):</span>
+ <span class="n">t</span><span class="p">,</span> <span class="n">tmsk</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">getQCVar</span><span class="p">(</span><span class="s1">'TIME'</span><span class="p">)</span>
+ <span class="n">v</span><span class="p">,</span> <span class="n">vmsk</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">getQCVar</span><span class="p">(</span><span class="n">varName</span><span class="p">)</span>
+ <span class="n">msk</span> <span class="o">=</span> <span class="n">tmsk</span> <span class="o">|</span> <span class="n">vmsk</span>
+ <span class="n">times</span> <span class="o">=</span> <span class="n">t</span><span class="p">[</span><span class="o">~</span><span class="n">msk</span><span class="p">]</span><span class="o">.</span><span class="n">copy</span><span class="p">()</span>
+ <span class="n">values</span> <span class="o">=</span> <span class="n">v</span><span class="o">.</span><span class="n">copy</span><span class="p">()</span>
+ <span class="n">values</span> <span class="o">=</span> <span class="n">values</span><span class="p">[</span><span class="o">~</span><span class="n">msk</span><span class="p">]</span>
+ <span class="k">return</span> <span class="n">times</span><span class="p">,</span> <span class="n">values</span></div>
+
+<div class="viewcode-block" id="emecwb.gapFillTimeseries"><a class="viewcode-back" href="../ObsData.html#ObsData.emecwb.gapFillTimeseries">[docs]</a> <span class="k">def</span> <span class="nf">gapFillTimeseries</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">times</span><span class="p">,</span> <span class="n">values</span><span class="p">):</span>
+ <span class="k">return</span> <span class="n">times</span><span class="p">,</span> <span class="n">values</span></div></div>
+
+
+<span class="c1"># ====================== OceanSites Drifter Data ======================</span>
+<div class="viewcode-block" id="drifter"><a class="viewcode-back" href="../ObsData.html#ObsData.drifter">[docs]</a><span class="k">class</span> <span class="nc">drifter</span><span class="p">(</span><span class="n">netcdfGeneric</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Class structure for reading the CMEMS formatted drifter netCDF files.</span>
+<span class="sd"> """</span>
+ <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">fileName</span><span class="p">):</span>
+
+ <span class="n">netcdfGeneric</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">fileName</span><span class="p">)</span>
+
+ <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">file</span><span class="p">[</span><span class="s1">'name'</span><span class="p">]</span> <span class="o">!=</span> <span class="s1">''</span><span class="p">:</span>
+ <span class="k">if</span> <span class="s1">'platform_code'</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">file</span><span class="p">[</span><span class="s1">'attribs'</span><span class="p">]:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">platform</span> <span class="o">=</span> <span class="n">ncdata</span><span class="p">(</span><span class="n">fileName</span><span class="p">)</span><span class="o">.</span><span class="n">platform_code</span>
+ <span class="k">if</span> <span class="s1">'time_coverage_start'</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">file</span><span class="p">[</span><span class="s1">'attribs'</span><span class="p">]:</span>
+ <span class="n">tstr</span> <span class="o">=</span> <span class="n">ncdata</span><span class="p">(</span><span class="n">fileName</span><span class="p">)</span><span class="o">.</span><span class="n">time_coverage_start</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">time_start</span> <span class="o">=</span> <span class="n">tstr</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">'T'</span><span class="p">,</span> <span class="s1">' '</span><span class="p">)</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">'Z'</span><span class="p">,</span> <span class="s1">''</span><span class="p">)</span>
+ <span class="k">if</span> <span class="s1">'time_coverage_end'</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">file</span><span class="p">[</span><span class="s1">'attribs'</span><span class="p">]:</span>
+ <span class="n">tstr</span> <span class="o">=</span> <span class="n">ncdata</span><span class="p">(</span><span class="n">fileName</span><span class="p">)</span><span class="o">.</span><span class="n">time_coverage_end</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">time_end</span> <span class="o">=</span> <span class="n">tstr</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">'T'</span><span class="p">,</span> <span class="s1">' '</span><span class="p">)</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">'Z'</span><span class="p">,</span> <span class="s1">''</span><span class="p">)</span>
+ <span class="k">if</span> <span class="s1">'LATITUDE'</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">file</span><span class="p">[</span><span class="s1">'vars'</span><span class="p">]:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">lat_min</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">nanmin</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">getVar</span><span class="p">(</span><span class="s1">'LATITUDE'</span><span class="p">))</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">lat_max</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">nanmax</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">getVar</span><span class="p">(</span><span class="s1">'LATITUDE'</span><span class="p">))</span>
+ <span class="n">lat</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">nanmedian</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">getVar</span><span class="p">(</span><span class="s1">'LATITUDE'</span><span class="p">))</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">lat</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">lat</span><span class="o">*</span><span class="mf">100000.0</span><span class="p">)</span><span class="o">/</span><span class="mf">100000.0</span>
+ <span class="k">if</span> <span class="s1">'LONGITUDE'</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">file</span><span class="p">[</span><span class="s1">'vars'</span><span class="p">]:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">lon_min</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">nanmin</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">getVar</span><span class="p">(</span><span class="s1">'LONGITUDE'</span><span class="p">))</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">lon_max</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">nanmax</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">getVar</span><span class="p">(</span><span class="s1">'LONGITUDE'</span><span class="p">))</span>
+ <span class="n">lon</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">nanmedian</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">getVar</span><span class="p">(</span><span class="s1">'LONGITUDE'</span><span class="p">))</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">lon</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">lon</span><span class="o">*</span><span class="mf">100000.0</span><span class="p">)</span><span class="o">/</span><span class="mf">100000.0</span>
+ <span class="k">if</span> <span class="s1">'TIME'</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">file</span><span class="p">[</span><span class="s1">'vars'</span><span class="p">]:</span>
+ <span class="n">t</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">getVar</span><span class="p">(</span><span class="s1">'TIME'</span><span class="p">)</span>
+ <span class="n">p</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">median</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">diff</span><span class="p">(</span><span class="n">t</span><span class="p">))</span><span class="o">*</span><span class="mf">24.0</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">sample_period</span> <span class="o">=</span> <span class="nb">round</span><span class="p">(</span><span class="n">p</span><span class="o">*</span><span class="mf">3600.0</span><span class="p">)</span><span class="o">/</span><span class="mf">3600.0</span>
+
+<div class="viewcode-block" id="drifter.getMetaData"><a class="viewcode-back" href="../ObsData.html#ObsData.drifter.getMetaData">[docs]</a> <span class="k">def</span> <span class="nf">getMetaData</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="n">path</span><span class="p">,</span> <span class="n">file</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">file</span><span class="p">[</span><span class="s1">'name'</span><span class="p">])</span>
+ <span class="n">meta</span> <span class="o">=</span> <span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">platform</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">file</span><span class="p">,</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">lat</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">lon</span><span class="p">,</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">time_start</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">time_end</span><span class="p">,</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">sample_period</span><span class="p">]</span>
+ <span class="k">return</span> <span class="n">meta</span></div>
+
+<div class="viewcode-block" id="drifter.getVar"><a class="viewcode-back" href="../ObsData.html#ObsData.drifter.getVar">[docs]</a> <span class="k">def</span> <span class="nf">getVar</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">varName</span><span class="p">):</span>
+ <span class="k">if</span> <span class="n">varName</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">file</span><span class="p">[</span><span class="s1">'vars'</span><span class="p">]:</span>
+ <span class="k">with</span> <span class="n">ncdata</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">file</span><span class="p">[</span><span class="s1">'name'</span><span class="p">],</span> <span class="s1">'r'</span><span class="p">,</span> <span class="nb">format</span><span class="o">=</span><span class="s1">'NETCDF4'</span><span class="p">)</span> <span class="k">as</span> <span class="n">nc</span><span class="p">:</span>
+ <span class="k">if</span> <span class="n">varName</span> <span class="o">==</span> <span class="s1">'TIME'</span><span class="p">:</span>
+ <span class="n">timeUnits</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">getVarAttr</span><span class="p">(</span><span class="s1">'TIME'</span><span class="p">,</span> <span class="s1">'units'</span><span class="p">)</span>
+ <span class="k">if</span> <span class="n">np</span><span class="o">.</span><span class="n">ma</span><span class="o">.</span><span class="n">isMaskedArray</span><span class="p">(</span><span class="n">nc</span><span class="o">.</span><span class="n">variables</span><span class="p">[</span><span class="n">varName</span><span class="p">][:]):</span>
+ <span class="n">time</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">ma</span><span class="o">.</span><span class="n">getdata</span><span class="p">(</span><span class="n">nc</span><span class="o">.</span><span class="n">variables</span><span class="p">[</span><span class="n">varName</span><span class="p">][:])</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">time</span> <span class="o">=</span> <span class="n">nc</span><span class="o">.</span><span class="n">variables</span><span class="p">[</span><span class="n">varName</span><span class="p">][:]</span>
+ <span class="n">var</span> <span class="o">=</span> <span class="n">date2num</span><span class="p">(</span><span class="n">num2date</span><span class="p">(</span><span class="n">time</span><span class="p">,</span> <span class="n">timeUnits</span><span class="p">),</span> <span class="n">stdTimeUnits</span><span class="p">)</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="k">if</span> <span class="n">np</span><span class="o">.</span><span class="n">ma</span><span class="o">.</span><span class="n">isMaskedArray</span><span class="p">(</span><span class="n">nc</span><span class="o">.</span><span class="n">variables</span><span class="p">[</span><span class="n">varName</span><span class="p">][:]):</span>
+ <span class="n">var</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">ma</span><span class="o">.</span><span class="n">getdata</span><span class="p">(</span><span class="n">nc</span><span class="o">.</span><span class="n">variables</span><span class="p">[</span><span class="n">varName</span><span class="p">][:])</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">var</span> <span class="o">=</span> <span class="n">nc</span><span class="o">.</span><span class="n">variables</span><span class="p">[</span><span class="n">varName</span><span class="p">][:]</span>
+ <span class="n">var</span> <span class="o">=</span> <span class="n">nc</span><span class="o">.</span><span class="n">variables</span><span class="p">[</span><span class="n">varName</span><span class="p">][:]</span>
+ <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">hasAttr</span><span class="p">(</span><span class="n">varName</span><span class="p">,</span><span class="s1">'_FillValue'</span><span class="p">):</span>
+ <span class="n">fv</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">getVarAttr</span><span class="p">(</span><span class="n">varName</span><span class="p">,</span><span class="s1">'_FillValue'</span><span class="p">)</span>
+ <span class="n">var</span><span class="p">[</span><span class="n">var</span><span class="o">==</span><span class="n">fv</span><span class="p">]</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">NaN</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="nb">print</span><span class="p">(</span><span class="s1">'WARNING: Variable '</span><span class="o">+</span><span class="n">varName</span><span class="o">+</span><span class="s1">' does not exist.'</span><span class="p">)</span>
+ <span class="nb">print</span><span class="p">(</span><span class="s1">'Available variables:'</span><span class="p">)</span>
+ <span class="nb">print</span><span class="p">(</span><span class="nb">list</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">file</span><span class="p">[</span><span class="s1">'vars'</span><span class="p">]))</span>
+ <span class="n">var</span> <span class="o">=</span> <span class="kc">None</span>
+ <span class="k">return</span> <span class="n">var</span></div>
+
+<div class="viewcode-block" id="drifter.getTrackCoverage"><a class="viewcode-back" href="../ObsData.html#ObsData.drifter.getTrackCoverage">[docs]</a> <span class="k">def</span> <span class="nf">getTrackCoverage</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="n">coverage</span> <span class="o">=</span> <span class="n">spatialCoverage</span><span class="p">()</span>
+ <span class="k">if</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">hasVar</span><span class="p">(</span><span class="s1">'LATITUDE'</span><span class="p">)</span> <span class="o">&</span> <span class="bp">self</span><span class="o">.</span><span class="n">hasVar</span><span class="p">(</span><span class="s1">'LONGITUDE'</span><span class="p">)):</span>
+ <span class="n">coverage</span><span class="o">.</span><span class="n">lat_range</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">nanmin</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">getVar</span><span class="p">(</span><span class="s1">'LATITUDE'</span><span class="p">))</span>
+ <span class="n">coverage</span><span class="o">.</span><span class="n">lat_range</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">nanmax</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">getVar</span><span class="p">(</span><span class="s1">'LATITUDE'</span><span class="p">))</span>
+ <span class="n">coverage</span><span class="o">.</span><span class="n">lon_range</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">nanmin</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">getVar</span><span class="p">(</span><span class="s1">'LONGITUDE'</span><span class="p">))</span>
+ <span class="n">coverage</span><span class="o">.</span><span class="n">lon_range</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">nanmax</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">getVar</span><span class="p">(</span><span class="s1">'LONGITUDE'</span><span class="p">))</span>
+ <span class="k">return</span> <span class="n">coverage</span></div>
+
+<div class="viewcode-block" id="drifter.crossesDomain"><a class="viewcode-back" href="../ObsData.html#ObsData.drifter.crossesDomain">[docs]</a> <span class="k">def</span> <span class="nf">crossesDomain</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">domain</span><span class="p">:</span> <span class="n">spatialCoverage</span><span class="p">):</span>
+ <span class="c1"># this belongs in a separate match module...</span>
+ <span class="n">crosses</span> <span class="o">=</span> <span class="kc">False</span>
+ <span class="k">return</span> <span class="n">crosses</span></div></div>
+
+
+<span class="c1"># ----------------------------------------------------------------------------</span>
+<span class="c1"># FUNCTION DEFINITIONS</span>
+<span class="c1"># ----------------------------------------------------------------------------</span>
+<div class="viewcode-block" id="is_masked"><a class="viewcode-back" href="../ObsData.html#ObsData.is_masked">[docs]</a><span class="k">def</span> <span class="nf">is_masked</span><span class="p">(</span><span class="n">data</span><span class="p">):</span>
+ <span class="n">masked</span> <span class="o">=</span> <span class="nb">type</span><span class="p">(</span><span class="n">data</span><span class="p">)</span> <span class="o">==</span> <span class="n">np</span><span class="o">.</span><span class="n">ma</span><span class="o">.</span><span class="n">core</span><span class="o">.</span><span class="n">MaskedArray</span>
+ <span class="k">return</span> <span class="n">masked</span></div>
+
+
+<div class="viewcode-block" id="get_nc_var"><a class="viewcode-back" href="../ObsData.html#ObsData.get_nc_var">[docs]</a><span class="k">def</span> <span class="nf">get_nc_var</span><span class="p">(</span><span class="n">ncHnd</span><span class="p">,</span> <span class="n">varName</span><span class="p">):</span>
+ <span class="k">try</span><span class="p">:</span>
+ <span class="k">if</span> <span class="p">(</span><span class="n">ncHnd</span><span class="p">[</span><span class="n">varName</span><span class="p">]</span><span class="o">.</span><span class="n">valid_min</span> <span class="o">==</span> <span class="s1">' '</span><span class="p">)</span> <span class="ow">or</span> <span class="p">(</span><span class="n">ncHnd</span><span class="p">[</span><span class="n">varName</span><span class="p">]</span><span class="o">.</span><span class="n">valid_max</span> <span class="o">==</span> <span class="s1">' '</span><span class="p">):</span>
+ <span class="n">ncHnd</span><span class="o">.</span><span class="n">set_auto_mask</span><span class="p">(</span><span class="kc">False</span><span class="p">)</span>
+ <span class="k">except</span><span class="p">:</span>
+ <span class="n">ncHnd</span><span class="o">.</span><span class="n">set_auto_mask</span><span class="p">(</span><span class="kc">True</span><span class="p">)</span>
+ <span class="n">var</span> <span class="o">=</span> <span class="n">ncHnd</span><span class="o">.</span><span class="n">variables</span><span class="p">[</span><span class="n">varName</span><span class="p">][:]</span><span class="o">.</span><span class="n">copy</span><span class="p">()</span>
+ <span class="k">if</span> <span class="n">is_masked</span><span class="p">(</span><span class="n">var</span><span class="p">):</span>
+ <span class="n">data</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">ma</span><span class="o">.</span><span class="n">getdata</span><span class="p">(</span><span class="n">var</span><span class="p">)</span>
+ <span class="n">mask</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">ma</span><span class="o">.</span><span class="n">getmask</span><span class="p">(</span><span class="n">var</span><span class="p">)</span>
+ <span class="k">if</span> <span class="n">mask</span><span class="o">.</span><span class="n">size</span> <span class="o">==</span> <span class="mi">1</span><span class="p">:</span>
+ <span class="n">mskval</span> <span class="o">=</span> <span class="n">mask</span>
+ <span class="n">mask</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">zeros</span><span class="p">(</span><span class="n">data</span><span class="o">.</span><span class="n">shape</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="s1">'bool'</span><span class="p">)</span>
+ <span class="n">mask</span><span class="p">[:]</span> <span class="o">=</span> <span class="n">mskval</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">data</span> <span class="o">=</span> <span class="n">var</span>
+ <span class="n">mask</span> <span class="o">=</span> <span class="kc">None</span>
+ <span class="k">return</span> <span class="n">data</span><span class="p">,</span> <span class="n">mask</span></div>
+
+</pre></div>
+
+ <div class="clearer"></div>
+ </div>
+ </div>
+ </div>
+ <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+ <div class="sphinxsidebarwrapper">
+<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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
+ <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="nav-item nav-item-0"><a href="../index.html">WaveVal documentation</a> »</li>
+ <li class="nav-item nav-item-1"><a href="index.html" >Module code</a> »</li>
+ <li class="nav-item nav-item-this"><a href="">ObsData</a></li>
+ </ul>
+ </div>
+ <div class="footer" role="contentinfo">
+ © Copyright 2022.
+ Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 4.3.0.
+ </div>
+ </body>
+</html>
\ No newline at end of file
diff --git a/docs/_build/html/_modules/TimeFuncs.html b/docs/_build/html/_modules/TimeFuncs.html
new file mode 100644
index 0000000000000000000000000000000000000000..98f11fb467ab241d3fa647369626401619ddde8a
--- /dev/null
+++ b/docs/_build/html/_modules/TimeFuncs.html
@@ -0,0 +1,200 @@
+
+
+<!doctype html>
+
+<html lang="en">
+ <head>
+ <meta charset="utf-8" />
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+ <title>TimeFuncs — WaveVal documentation</title>
+ <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
+ <link rel="stylesheet" type="text/css" href="../_static/bizstyle.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 src="../_static/bizstyle.js"></script>
+ <link rel="author" title="About these documents" href="../about.html" />
+ <link rel="index" title="Index" href="../genindex.html" />
+ <link rel="search" title="Search" href="../search.html" />
+ <meta name="viewport" content="width=device-width,initial-scale=1.0" />
+ <!--[if lt IE 9]>
+ <script src="_static/css3-mediaqueries.js"></script>
+ <![endif]-->
+ </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="nav-item nav-item-0"><a href="../index.html">WaveVal documentation</a> »</li>
+ <li class="nav-item nav-item-1"><a href="index.html" accesskey="U">Module code</a> »</li>
+ <li class="nav-item nav-item-this"><a href="">TimeFuncs</a></li>
+ </ul>
+ </div>
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body" role="main">
+
+ <h1>Source code for TimeFuncs</h1><div class="highlight"><pre>
+<span></span><span class="c1"># -*- coding: utf-8 -*-</span>
+<span class="sd">"""</span>
+<span class="sd">Internal date/time manipulation functions.</span>
+
+<span class="sd">These functions are used to standardise the time stamping between data types.</span>
+
+<span class="sd">:Dependencies [External]: datetime, netCDF4</span>
+<span class="sd">:Dependencies [Internal]: </span>
+
+<span class="sd">"""</span>
+
+<span class="c1"># ----------------------------------------------------------------------------</span>
+<span class="c1"># IMPORTS</span>
+<span class="c1"># ----------------------------------------------------------------------------</span>
+<span class="c1"># Standard Python Dependencies</span>
+<span class="kn">from</span> <span class="nn">datetime</span> <span class="kn">import</span> <span class="n">datetime</span>
+<span class="c1"># Non-Standard Python Dependencies</span>
+<span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
+<span class="kn">from</span> <span class="nn">netCDF4</span> <span class="kn">import</span> <span class="n">num2date</span><span class="p">,</span> <span class="n">date2num</span>
+<span class="c1"># Local Module Dependencies</span>
+<span class="c1"># Other Dependencies</span>
+
+<span class="c1"># ----------------------------------------------------------------------------</span>
+<span class="c1"># GLOBAL VARIABLES</span>
+<span class="c1"># ----------------------------------------------------------------------------</span>
+<span class="n">stdTimeUnits</span> <span class="o">=</span> <span class="s1">'days since 0001-01-01 00:00:00'</span>
+<span class="n">stdTimeFmt</span> <span class="o">=</span> <span class="s2">"%Y-%m-</span><span class="si">%d</span><span class="s2"> %H:%M:%S"</span>
+<span class="n">stdCalendar</span> <span class="o">=</span> <span class="s1">'gregorian'</span>
+
+<span class="c1"># ----------------------------------------------------------------------------</span>
+<span class="c1"># CLASS DEFINITIONS</span>
+<span class="c1"># ----------------------------------------------------------------------------</span>
+<div class="viewcode-block" id="temporalCoverage"><a class="viewcode-back" href="../TimeFuncs.html#TimeFuncs.temporalCoverage">[docs]</a><span class="k">class</span> <span class="nc">temporalCoverage</span><span class="p">:</span>
+
+ <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">timeStart</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">timeEnd</span><span class="p">:</span> <span class="nb">str</span><span class="p">):</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">timeRangeStr</span> <span class="o">=</span> <span class="p">[</span><span class="n">timeStart</span><span class="p">,</span> <span class="n">timeEnd</span><span class="p">]</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">timeRangeNum</span> <span class="o">=</span> <span class="p">[</span><span class="n">dateNumFromStr</span><span class="p">(</span><span class="n">timeStart</span><span class="p">),</span>
+ <span class="n">dateNumFromStr</span><span class="p">(</span><span class="n">timeEnd</span><span class="p">)]</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">units</span> <span class="o">=</span> <span class="n">stdTimeUnits</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">format</span> <span class="o">=</span> <span class="n">stdTimeFmt</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">calendar</span> <span class="o">=</span> <span class="n">stdCalendar</span>
+
+<div class="viewcode-block" id="temporalCoverage.timeOverlap"><a class="viewcode-back" href="../TimeFuncs.html#TimeFuncs.temporalCoverage.timeOverlap">[docs]</a> <span class="k">def</span> <span class="nf">timeOverlap</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">tRec</span><span class="p">):</span>
+ <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">tRec</span><span class="p">)</span> <span class="o">></span> <span class="mi">0</span><span class="p">:</span>
+ <span class="n">t0</span> <span class="o">=</span> <span class="n">tRec</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
+ <span class="n">t1</span> <span class="o">=</span> <span class="n">tRec</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span>
+ <span class="n">case01</span> <span class="o">=</span> <span class="p">(</span><span class="n">t0</span> <span class="o">>=</span> <span class="nb">min</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">timeRangeNum</span><span class="p">))</span> <span class="o">&</span> \
+ <span class="p">(</span><span class="n">t1</span> <span class="o"><=</span> <span class="nb">max</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">timeRangeNum</span><span class="p">))</span>
+ <span class="n">case02</span> <span class="o">=</span> <span class="p">(</span><span class="n">t0</span> <span class="o"><</span> <span class="nb">min</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">timeRangeNum</span><span class="p">))</span> <span class="o">&</span> \
+ <span class="p">(</span><span class="n">t1</span> <span class="o">>=</span> <span class="nb">min</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">timeRangeNum</span><span class="p">))</span>
+ <span class="n">case03</span> <span class="o">=</span> <span class="p">(</span><span class="n">t0</span> <span class="o"><</span> <span class="nb">max</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">timeRangeNum</span><span class="p">))</span> <span class="o">&</span> \
+ <span class="p">(</span><span class="n">t1</span> <span class="o">>=</span> <span class="nb">max</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">timeRangeNum</span><span class="p">))</span>
+ <span class="n">case04</span> <span class="o">=</span> <span class="p">(</span><span class="n">t0</span> <span class="o"><</span> <span class="nb">min</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">timeRangeNum</span><span class="p">))</span> <span class="o">&</span> \
+ <span class="p">(</span><span class="n">t1</span> <span class="o">></span> <span class="nb">max</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">timeRangeNum</span><span class="p">))</span>
+ <span class="n">overlaps</span> <span class="o">=</span> <span class="n">case01</span> <span class="ow">or</span> <span class="n">case02</span> <span class="ow">or</span> <span class="n">case03</span> <span class="ow">or</span> <span class="n">case04</span>
+ <span class="k">if</span> <span class="n">overlaps</span><span class="p">:</span>
+ <span class="n">tindx0</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">where</span><span class="p">(</span><span class="n">tRec</span> <span class="o">>=</span> <span class="bp">self</span><span class="o">.</span><span class="n">timeRangeNum</span><span class="p">[</span><span class="mi">0</span><span class="p">])[</span><span class="mi">0</span><span class="p">][</span><span class="mi">0</span><span class="p">]</span>
+ <span class="n">tindx1</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">where</span><span class="p">(</span><span class="n">tRec</span> <span class="o"><=</span> <span class="bp">self</span><span class="o">.</span><span class="n">timeRangeNum</span><span class="p">[</span><span class="mi">1</span><span class="p">])[</span><span class="mi">0</span><span class="p">][</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span>
+ <span class="n">indices</span> <span class="o">=</span> <span class="p">[</span><span class="n">tindx0</span><span class="p">,</span> <span class="n">tindx1</span><span class="p">]</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">indices</span> <span class="o">=</span> <span class="p">[</span><span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">]</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">overlaps</span> <span class="o">=</span> <span class="kc">False</span>
+ <span class="n">indices</span> <span class="o">=</span> <span class="p">[</span><span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">]</span>
+ <span class="k">return</span> <span class="n">overlaps</span><span class="p">,</span> <span class="n">indices</span></div></div>
+
+
+<span class="c1"># ----------------------------------------------------------------------------</span>
+<span class="c1"># FUNCTION DEFINITIONS</span>
+<span class="c1"># ----------------------------------------------------------------------------</span>
+<div class="viewcode-block" id="dateStr"><a class="viewcode-back" href="../TimeFuncs.html#TimeFuncs.dateStr">[docs]</a><span class="k">def</span> <span class="nf">dateStr</span><span class="p">(</span><span class="n">dateNum</span><span class="p">):</span>
+ <span class="k">if</span> <span class="n">dateNum</span><span class="o">.</span><span class="n">size</span> <span class="o">==</span> <span class="mi">1</span><span class="p">:</span>
+ <span class="n">date</span> <span class="o">=</span> <span class="n">num2date</span><span class="p">(</span><span class="n">dateNum</span><span class="p">,</span> <span class="n">stdTimeUnits</span><span class="p">)</span><span class="o">.</span><span class="n">strftime</span><span class="p">()</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">date</span> <span class="o">=</span> <span class="p">[</span><span class="n">num2date</span><span class="p">(</span><span class="n">d</span><span class="p">,</span> <span class="n">stdTimeUnits</span><span class="p">)</span><span class="o">.</span><span class="n">strftime</span><span class="p">()</span> <span class="k">for</span> <span class="n">d</span> <span class="ow">in</span> <span class="n">dateNum</span><span class="p">]</span>
+ <span class="k">return</span> <span class="n">date</span></div>
+
+
+<div class="viewcode-block" id="dateNumFromStr"><a class="viewcode-back" href="../TimeFuncs.html#TimeFuncs.dateNumFromStr">[docs]</a><span class="k">def</span> <span class="nf">dateNumFromStr</span><span class="p">(</span><span class="n">dateStr</span><span class="p">):</span>
+ <span class="n">dt</span> <span class="o">=</span> <span class="n">datetime</span><span class="o">.</span><span class="n">strptime</span><span class="p">(</span><span class="n">dateStr</span><span class="p">,</span> <span class="n">stdTimeFmt</span><span class="p">)</span>
+ <span class="n">dateNum</span> <span class="o">=</span> <span class="n">date2num</span><span class="p">(</span><span class="n">dt</span><span class="p">,</span> <span class="n">stdTimeUnits</span><span class="p">,</span> <span class="n">stdCalendar</span><span class="p">)</span>
+ <span class="k">return</span> <span class="n">dateNum</span></div>
+
+
+<div class="viewcode-block" id="matlab2std"><a class="viewcode-back" href="../TimeFuncs.html#TimeFuncs.matlab2std">[docs]</a><span class="k">def</span> <span class="nf">matlab2std</span><span class="p">(</span><span class="n">dateNum</span><span class="p">,</span> <span class="n">isLeapYear</span><span class="p">:</span> <span class="nb">bool</span><span class="p">):</span>
+ <span class="c1"># need check to ensure dateNum is in days</span>
+ <span class="k">if</span> <span class="n">isLeapYear</span><span class="p">:</span>
+ <span class="n">dn</span> <span class="o">=</span> <span class="n">dateNum</span> <span class="o">-</span> <span class="mf">366.0</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">dn</span> <span class="o">=</span> <span class="n">dateNum</span> <span class="o">-</span> <span class="mf">365.0</span>
+ <span class="k">return</span> <span class="n">dn</span></div>
+
+
+<div class="viewcode-block" id="std2matlab"><a class="viewcode-back" href="../TimeFuncs.html#TimeFuncs.std2matlab">[docs]</a><span class="k">def</span> <span class="nf">std2matlab</span><span class="p">(</span><span class="n">dateNum</span><span class="p">,</span> <span class="n">isLeapYear</span><span class="p">:</span> <span class="nb">bool</span><span class="p">):</span>
+ <span class="c1"># need check to ensure dateNum is in days</span>
+ <span class="k">if</span> <span class="n">isLeapYear</span><span class="p">:</span>
+ <span class="n">dn</span> <span class="o">=</span> <span class="n">dateNum</span> <span class="o">+</span> <span class="mf">366.0</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">dn</span> <span class="o">=</span> <span class="n">dateNum</span> <span class="o">+</span> <span class="mf">365.0</span>
+ <span class="k">return</span> <span class="n">dn</span></div>
+
+
+<div class="viewcode-block" id="isLeapYear"><a class="viewcode-back" href="../TimeFuncs.html#TimeFuncs.isLeapYear">[docs]</a><span class="k">def</span> <span class="nf">isLeapYear</span><span class="p">(</span><span class="n">year</span><span class="p">):</span>
+ <span class="k">if</span> <span class="n">year</span> <span class="o">%</span> <span class="mi">400</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
+ <span class="k">return</span> <span class="kc">True</span>
+ <span class="k">if</span> <span class="n">year</span> <span class="o">%</span> <span class="mi">100</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
+ <span class="k">return</span> <span class="kc">False</span>
+ <span class="k">if</span> <span class="n">year</span> <span class="o">%</span> <span class="mi">4</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
+ <span class="k">return</span> <span class="kc">True</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="k">return</span> <span class="kc">False</span></div>
+
+</pre></div>
+
+ <div class="clearer"></div>
+ </div>
+ </div>
+ </div>
+ <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+ <div class="sphinxsidebarwrapper">
+<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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
+ <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="nav-item nav-item-0"><a href="../index.html">WaveVal documentation</a> »</li>
+ <li class="nav-item nav-item-1"><a href="index.html" >Module code</a> »</li>
+ <li class="nav-item nav-item-this"><a href="">TimeFuncs</a></li>
+ </ul>
+ </div>
+ <div class="footer" role="contentinfo">
+ © Copyright 2022.
+ Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 4.3.0.
+ </div>
+ </body>
+</html>
\ No newline at end of file
diff --git a/docs/_build/html/_modules/Validation.html b/docs/_build/html/_modules/Validation.html
new file mode 100644
index 0000000000000000000000000000000000000000..3ecc495b85a86b5568c5f4a155260ac6bf1f92e8
--- /dev/null
+++ b/docs/_build/html/_modules/Validation.html
@@ -0,0 +1,930 @@
+
+
+<!doctype html>
+
+<html lang="en">
+ <head>
+ <meta charset="utf-8" />
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+ <title>Validation — WaveVal documentation</title>
+ <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
+ <link rel="stylesheet" type="text/css" href="../_static/bizstyle.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 src="../_static/bizstyle.js"></script>
+ <link rel="author" title="About these documents" href="../about.html" />
+ <link rel="index" title="Index" href="../genindex.html" />
+ <link rel="search" title="Search" href="../search.html" />
+ <meta name="viewport" content="width=device-width,initial-scale=1.0" />
+ <!--[if lt IE 9]>
+ <script src="_static/css3-mediaqueries.js"></script>
+ <![endif]-->
+ </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="nav-item nav-item-0"><a href="../index.html">WaveVal documentation</a> »</li>
+ <li class="nav-item nav-item-1"><a href="index.html" accesskey="U">Module code</a> »</li>
+ <li class="nav-item nav-item-this"><a href="">Validation</a></li>
+ </ul>
+ </div>
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body" role="main">
+
+ <h1>Source code for Validation</h1><div class="highlight"><pre>
+<span></span><span class="c1"># -*- coding: utf-8 -*-</span>
+<span class="sd">"""</span>
+<span class="sd">This module contains the functions for calculating parameter based validation statistics for </span>
+<span class="sd">a set of matchup records. </span>
+
+<span class="sd">:Dependencies [External]: os, scipy, numpy, copy</span>
+<span class="sd">:Dependencies [Internal]: waveval.ModelData, waveval.ObsData, waveval.MatchUpDatabase, waveval.Geometry</span>
+
+<span class="sd">"""</span>
+<span class="c1"># ----------------------------------------------------------------------------</span>
+<span class="c1"># IMPORTS</span>
+<span class="c1"># ----------------------------------------------------------------------------</span>
+<span class="c1"># Standard Python Dependencies</span>
+<span class="kn">import</span> <span class="nn">os</span>
+<span class="kn">import</span> <span class="nn">scipy.io</span> <span class="k">as</span> <span class="nn">sio</span>
+<span class="kn">import</span> <span class="nn">copy</span>
+<span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
+<span class="kn">from</span> <span class="nn">scipy.interpolate</span> <span class="kn">import</span> <span class="n">interp1d</span>
+<span class="c1"># Non-Standard Python Dependencies</span>
+<span class="c1"># Local Module Dependencies</span>
+<span class="kn">from</span> <span class="nn">waveval</span> <span class="kn">import</span> <span class="n">ModelData</span> <span class="k">as</span> <span class="n">MData</span>
+<span class="kn">from</span> <span class="nn">waveval</span> <span class="kn">import</span> <span class="n">ObsData</span> <span class="k">as</span> <span class="n">OData</span>
+<span class="kn">from</span> <span class="nn">waveval</span> <span class="kn">import</span> <span class="n">MatchUpDatabase</span> <span class="k">as</span> <span class="n">MDB</span>
+<span class="kn">from</span> <span class="nn">waveval.Geometry</span> <span class="kn">import</span> <span class="n">pol2cmplx</span>
+<span class="kn">from</span> <span class="nn">waveval.Graphics</span> <span class="kn">import</span> <span class="n">plot_time_series</span><span class="p">,</span> <span class="n">plot_correlation</span><span class="p">,</span> <span class="n">plot_close</span>
+<span class="c1"># Other Dependencies</span>
+
+<span class="c1"># ----------------------------------------------------------------------------</span>
+<span class="c1"># GLOBAL VARIABLES</span>
+<span class="c1"># ----------------------------------------------------------------------------</span>
+
+
+<span class="c1"># ----------------------------------------------------------------------------</span>
+<span class="c1"># CLASS DEFINITIONS</span>
+<span class="c1"># ----------------------------------------------------------------------------</span>
+
+
+<span class="c1"># ----------------------------------------------------------------------------</span>
+<span class="c1"># FUNCTION DEFINITIONS</span>
+<span class="c1"># ----------------------------------------------------------------------------</span>
+<span class="c1"># ======================== Data Selection =================================</span>
+<div class="viewcode-block" id="getVarName"><a class="viewcode-back" href="../Validation.html#Validation.getVarName">[docs]</a><span class="k">def</span> <span class="nf">getVarName</span><span class="p">(</span><span class="n">record</span><span class="p">,</span> <span class="n">Options</span><span class="p">:</span> <span class="nb">list</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Get variable names based on processsing options list</span>
+<span class="sd"> """</span>
+ <span class="n">hasVar</span> <span class="o">=</span> <span class="p">[</span><span class="kc">False</span><span class="p">]</span><span class="o">*</span><span class="nb">len</span><span class="p">(</span><span class="n">Options</span><span class="p">)</span>
+ <span class="k">for</span> <span class="n">indx</span><span class="p">,</span> <span class="n">vn</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">Options</span><span class="p">):</span>
+ <span class="n">hasVar</span><span class="p">[</span><span class="n">indx</span><span class="p">]</span> <span class="o">=</span> <span class="n">record</span><span class="o">.</span><span class="n">hasVar</span><span class="p">(</span><span class="n">vn</span><span class="p">)</span>
+ <span class="n">varIndx</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">where</span><span class="p">(</span><span class="n">hasVar</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span>
+ <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">varIndx</span><span class="p">)</span> <span class="o">!=</span> <span class="mi">0</span><span class="p">:</span>
+ <span class="n">varName</span> <span class="o">=</span> <span class="n">Options</span><span class="p">[</span><span class="n">varIndx</span><span class="p">[</span><span class="mi">0</span><span class="p">]]</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">varName</span> <span class="o">=</span> <span class="s1">''</span>
+ <span class="k">return</span> <span class="n">varName</span></div>
+
+
+<div class="viewcode-block" id="getSurfaceIndx"><a class="viewcode-back" href="../Validation.html#Validation.getSurfaceIndx">[docs]</a><span class="k">def</span> <span class="nf">getSurfaceIndx</span><span class="p">(</span><span class="n">record</span><span class="p">,</span> <span class="n">dataFmt</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Get index of surface layer in depth data</span>
+<span class="sd"> """</span>
+ <span class="k">if</span> <span class="n">dataFmt</span> <span class="o">==</span> <span class="s1">'InSituTAC'</span><span class="p">:</span>
+ <span class="n">depth</span> <span class="o">=</span> <span class="n">record</span><span class="o">.</span><span class="n">getVar</span><span class="p">(</span><span class="s1">'DEPH'</span><span class="p">)</span>
+ <span class="k">elif</span> <span class="n">dataFmt</span> <span class="o">==</span> <span class="s1">'SeaDataNet'</span><span class="p">:</span>
+ <span class="n">depth</span> <span class="o">=</span> <span class="n">record</span><span class="o">.</span><span class="n">getVar</span><span class="p">(</span><span class="s1">'DEPTH'</span><span class="p">)</span>
+ <span class="n">dims</span> <span class="o">=</span> <span class="n">depth</span><span class="o">.</span><span class="n">shape</span>
+ <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">dims</span><span class="p">)</span> <span class="o"><=</span> <span class="mi">1</span><span class="p">:</span>
+ <span class="n">surfIndx</span> <span class="o">=</span> <span class="p">[</span><span class="mi">0</span><span class="p">]</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">surfIndx</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">where</span><span class="p">(</span><span class="n">depth</span><span class="p">[</span><span class="mi">0</span><span class="p">,</span> <span class="p">:]</span> <span class="o">==</span> <span class="mf">0.0</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span>
+ <span class="k">return</span> <span class="n">surfIndx</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span></div>
+
+
+<span class="c1"># ========================== Statistics ===================================</span>
+<div class="viewcode-block" id="corr_coef"><a class="viewcode-back" href="../Validation.html#Validation.corr_coef">[docs]</a><span class="k">def</span> <span class="nf">corr_coef</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">obs</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Validation Metric: Correlation Coefficient</span>
+<span class="sd"> </span>
+<span class="sd"> :param model: model data time series</span>
+<span class="sd"> :param obs: observation time series mapped onto model time stamps</span>
+<span class="sd"> </span>
+<span class="sd"> :return: R</span>
+<span class="sd"> """</span>
+ <span class="n">m</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">squeeze</span><span class="p">(</span><span class="n">model</span><span class="p">)</span>
+ <span class="n">o</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">squeeze</span><span class="p">(</span><span class="n">obs</span><span class="p">)</span>
+ <span class="n">num</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">nansum</span><span class="p">((</span><span class="n">m</span><span class="o">-</span><span class="n">np</span><span class="o">.</span><span class="n">nanmean</span><span class="p">(</span><span class="n">m</span><span class="p">))</span><span class="o">*</span><span class="p">(</span><span class="n">o</span><span class="o">-</span><span class="n">np</span><span class="o">.</span><span class="n">nanmean</span><span class="p">(</span><span class="n">o</span><span class="p">)))</span>
+ <span class="n">msqr</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">nansum</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">square</span><span class="p">(</span><span class="n">m</span><span class="o">-</span><span class="n">np</span><span class="o">.</span><span class="n">nanmean</span><span class="p">(</span><span class="n">m</span><span class="p">)))</span>
+ <span class="n">osqr</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">nansum</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">square</span><span class="p">(</span><span class="n">o</span><span class="o">-</span><span class="n">np</span><span class="o">.</span><span class="n">nanmean</span><span class="p">(</span><span class="n">o</span><span class="p">)))</span>
+ <span class="n">denom</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">sqrt</span><span class="p">(</span><span class="n">msqr</span><span class="o">*</span><span class="n">osqr</span><span class="p">)</span>
+ <span class="n">R</span> <span class="o">=</span> <span class="n">num</span><span class="o">/</span><span class="n">denom</span>
+ <span class="k">return</span> <span class="n">R</span></div>
+
+
+<div class="viewcode-block" id="bias"><a class="viewcode-back" href="../Validation.html#Validation.bias">[docs]</a><span class="k">def</span> <span class="nf">bias</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">obs</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Validation Metric: Bias</span>
+<span class="sd"> </span>
+<span class="sd"> :param model: model data time series</span>
+<span class="sd"> :param obs: observation time series mapped onto model time stamps</span>
+<span class="sd"> </span>
+<span class="sd"> :return: b</span>
+<span class="sd"> """</span>
+ <span class="n">m</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">squeeze</span><span class="p">(</span><span class="n">model</span><span class="p">)</span>
+ <span class="n">o</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">squeeze</span><span class="p">(</span><span class="n">obs</span><span class="p">)</span>
+ <span class="n">b</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">nanmean</span><span class="p">(</span><span class="n">m</span><span class="p">)</span><span class="o">-</span><span class="n">np</span><span class="o">.</span><span class="n">nanmean</span><span class="p">(</span><span class="n">o</span><span class="p">)</span>
+ <span class="k">return</span> <span class="n">b</span></div>
+
+
+<div class="viewcode-block" id="mean_bias"><a class="viewcode-back" href="../Validation.html#Validation.mean_bias">[docs]</a><span class="k">def</span> <span class="nf">mean_bias</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">obs</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Validation Metric: Mean Bias</span>
+<span class="sd"> </span>
+<span class="sd"> :param model: model data time series</span>
+<span class="sd"> :param obs: observation time series mapped onto model time stamps</span>
+<span class="sd"> </span>
+<span class="sd"> :return: mb</span>
+<span class="sd"> """</span>
+ <span class="n">m</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">squeeze</span><span class="p">(</span><span class="n">model</span><span class="p">)</span>
+ <span class="n">o</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">squeeze</span><span class="p">(</span><span class="n">obs</span><span class="p">)</span>
+ <span class="n">mb</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">nanmean</span><span class="p">(</span><span class="n">m</span><span class="o">-</span><span class="n">o</span><span class="p">)</span>
+ <span class="k">return</span> <span class="n">mb</span></div>
+
+
+<div class="viewcode-block" id="mean_absolute_error"><a class="viewcode-back" href="../Validation.html#Validation.mean_absolute_error">[docs]</a><span class="k">def</span> <span class="nf">mean_absolute_error</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">obs</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Validation Metric: Mean absolute error</span>
+<span class="sd"> </span>
+<span class="sd"> :param model: model data time series</span>
+<span class="sd"> :param obs: observation time series mapped onto model time stamps</span>
+<span class="sd"> </span>
+<span class="sd"> :return: mae</span>
+<span class="sd"> """</span>
+ <span class="n">m</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">squeeze</span><span class="p">(</span><span class="n">model</span><span class="p">)</span>
+ <span class="n">o</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">squeeze</span><span class="p">(</span><span class="n">obs</span><span class="p">)</span>
+ <span class="n">mae</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">nanmean</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">abs</span><span class="p">(</span><span class="n">m</span><span class="o">-</span><span class="n">o</span><span class="p">))</span>
+ <span class="k">return</span> <span class="n">mae</span></div>
+
+
+<div class="viewcode-block" id="norm_ma_error"><a class="viewcode-back" href="../Validation.html#Validation.norm_ma_error">[docs]</a><span class="k">def</span> <span class="nf">norm_ma_error</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">obs</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Validation Metric: Normalised mean absolute error</span>
+<span class="sd"> </span>
+<span class="sd"> :param model: model data time series</span>
+<span class="sd"> :param obs: observation time series mapped onto model time stamps</span>
+<span class="sd"> </span>
+<span class="sd"> :return: nmae</span>
+<span class="sd"> """</span>
+ <span class="n">m</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">squeeze</span><span class="p">(</span><span class="n">model</span><span class="p">)</span>
+ <span class="n">o</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">squeeze</span><span class="p">(</span><span class="n">obs</span><span class="p">)</span>
+ <span class="n">nmae</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">nansum</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">abs</span><span class="p">(</span><span class="n">m</span><span class="o">-</span><span class="n">o</span><span class="p">))</span><span class="o">/</span><span class="n">np</span><span class="o">.</span><span class="n">nansum</span><span class="p">(</span><span class="n">o</span><span class="p">)</span>
+ <span class="n">nmae</span> <span class="o">=</span> <span class="n">nmae</span> <span class="o">*</span> <span class="mf">100.0</span>
+ <span class="k">return</span> <span class="n">nmae</span></div>
+
+
+<div class="viewcode-block" id="norm_mean_bias"><a class="viewcode-back" href="../Validation.html#Validation.norm_mean_bias">[docs]</a><span class="k">def</span> <span class="nf">norm_mean_bias</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">obs</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Validation Metric: Normalised mean bias</span>
+<span class="sd"> </span>
+<span class="sd"> :param model: model data time series</span>
+<span class="sd"> :param obs: observation time series mapped onto model time stamps</span>
+<span class="sd"> </span>
+<span class="sd"> :return: nmb</span>
+<span class="sd"> """</span>
+ <span class="c1"># Returns value as percentage</span>
+ <span class="n">m</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">squeeze</span><span class="p">(</span><span class="n">model</span><span class="p">)</span>
+ <span class="n">o</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">squeeze</span><span class="p">(</span><span class="n">obs</span><span class="p">)</span>
+ <span class="n">nmb</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">nansum</span><span class="p">(</span><span class="n">m</span><span class="o">-</span><span class="n">o</span><span class="p">)</span><span class="o">/</span><span class="n">np</span><span class="o">.</span><span class="n">nansum</span><span class="p">(</span><span class="n">o</span><span class="p">)</span>
+ <span class="n">nmb</span> <span class="o">=</span> <span class="n">nmb</span> <span class="o">*</span> <span class="mf">100.0</span>
+ <span class="k">return</span> <span class="n">nmb</span></div>
+
+
+<div class="viewcode-block" id="rms_error"><a class="viewcode-back" href="../Validation.html#Validation.rms_error">[docs]</a><span class="k">def</span> <span class="nf">rms_error</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">obs</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Validation Metric: Root-mean-square error</span>
+<span class="sd"> </span>
+<span class="sd"> :param model: model data time series</span>
+<span class="sd"> :param obs: observation time series mapped onto model time stamps</span>
+<span class="sd"> </span>
+<span class="sd"> :return: rmse</span>
+<span class="sd"> """</span>
+ <span class="n">m</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">squeeze</span><span class="p">(</span><span class="n">model</span><span class="p">)</span>
+ <span class="n">o</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">squeeze</span><span class="p">(</span><span class="n">obs</span><span class="p">)</span>
+ <span class="n">N</span> <span class="o">=</span> <span class="nb">min</span><span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">model</span> <span class="o">!=</span> <span class="n">np</span><span class="o">.</span><span class="n">nan</span><span class="p">),</span> <span class="nb">len</span><span class="p">(</span><span class="n">obs</span> <span class="o">!=</span> <span class="n">np</span><span class="o">.</span><span class="n">nan</span><span class="p">))</span>
+ <span class="n">rmse</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">sqrt</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">nansum</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">square</span><span class="p">(</span><span class="n">m</span><span class="o">-</span><span class="n">o</span><span class="p">))</span><span class="o">/</span><span class="n">N</span><span class="p">)</span>
+ <span class="k">return</span> <span class="n">rmse</span></div>
+
+
+<div class="viewcode-block" id="norm_rmse"><a class="viewcode-back" href="../Validation.html#Validation.norm_rmse">[docs]</a><span class="k">def</span> <span class="nf">norm_rmse</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">obs</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Validation Metric: Normalised root-mean-square error</span>
+<span class="sd"> </span>
+<span class="sd"> :param model: model data time series</span>
+<span class="sd"> :param obs: observation time series mapped onto model time stamps</span>
+<span class="sd"> </span>
+<span class="sd"> :return: nrmse</span>
+<span class="sd"> """</span>
+ <span class="c1"># Returns value as percentage</span>
+ <span class="n">o</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">squeeze</span><span class="p">(</span><span class="n">obs</span><span class="p">)</span>
+ <span class="n">nrmse</span> <span class="o">=</span> <span class="n">rms_error</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">obs</span><span class="p">)</span> <span class="o">/</span> <span class="n">np</span><span class="o">.</span><span class="n">sqrt</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">nanmean</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">square</span><span class="p">(</span><span class="n">o</span><span class="p">)))</span>
+ <span class="n">nrmse</span> <span class="o">=</span> <span class="n">nrmse</span> <span class="o">*</span> <span class="mf">100.0</span>
+ <span class="k">return</span> <span class="n">nrmse</span></div>
+
+
+<div class="viewcode-block" id="scatter_index"><a class="viewcode-back" href="../Validation.html#Validation.scatter_index">[docs]</a><span class="k">def</span> <span class="nf">scatter_index</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">obs</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Validation Metric: Scatter index</span>
+<span class="sd"> </span>
+<span class="sd"> :param model: model data time series</span>
+<span class="sd"> :param obs: observation time series mapped onto model time stamps</span>
+<span class="sd"> </span>
+<span class="sd"> :return: si</span>
+<span class="sd"> """</span>
+ <span class="c1"># Returns value as percentage</span>
+ <span class="n">m</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">squeeze</span><span class="p">(</span><span class="n">model</span><span class="p">)</span>
+ <span class="n">o</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">squeeze</span><span class="p">(</span><span class="n">obs</span><span class="p">)</span>
+ <span class="n">num</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">nansum</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">square</span><span class="p">((</span><span class="n">m</span><span class="o">-</span><span class="n">np</span><span class="o">.</span><span class="n">nanmean</span><span class="p">(</span><span class="n">m</span><span class="p">))</span><span class="o">-</span><span class="p">(</span><span class="n">o</span><span class="o">-</span><span class="n">np</span><span class="o">.</span><span class="n">nanmean</span><span class="p">(</span><span class="n">o</span><span class="p">))))</span>
+ <span class="n">denom</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">nansum</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">square</span><span class="p">(</span><span class="n">o</span><span class="p">))</span>
+ <span class="n">si</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">sqrt</span><span class="p">(</span><span class="n">num</span><span class="o">/</span><span class="n">denom</span><span class="p">)</span>
+ <span class="n">si</span> <span class="o">=</span> <span class="n">si</span> <span class="o">*</span> <span class="mf">100.0</span>
+ <span class="k">return</span> <span class="n">si</span></div>
+
+
+<div class="viewcode-block" id="reliability_index"><a class="viewcode-back" href="../Validation.html#Validation.reliability_index">[docs]</a><span class="k">def</span> <span class="nf">reliability_index</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">obs</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Validation Metric: Reliability index</span>
+<span class="sd"> </span>
+<span class="sd"> :param model: model data time series</span>
+<span class="sd"> :param obs: observation time series mapped onto model time stamps</span>
+<span class="sd"> </span>
+<span class="sd"> :return: ri</span>
+<span class="sd"> """</span>
+ <span class="n">m</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">squeeze</span><span class="p">(</span><span class="n">model</span><span class="p">)</span>
+ <span class="n">o</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">squeeze</span><span class="p">(</span><span class="n">obs</span><span class="p">)</span>
+ <span class="n">N</span> <span class="o">=</span> <span class="nb">min</span><span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">model</span> <span class="o">!=</span> <span class="n">np</span><span class="o">.</span><span class="n">nan</span><span class="p">),</span> <span class="nb">len</span><span class="p">(</span><span class="n">obs</span> <span class="o">!=</span> <span class="n">np</span><span class="o">.</span><span class="n">nan</span><span class="p">))</span>
+ <span class="n">ri</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">exp</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">sqrt</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">nansum</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">square</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">log</span><span class="p">(</span><span class="n">o</span><span class="o">/</span><span class="n">m</span><span class="p">)))</span><span class="o">/</span><span class="n">N</span><span class="p">))</span>
+ <span class="k">return</span> <span class="n">ri</span></div>
+
+
+<div class="viewcode-block" id="skill_score"><a class="viewcode-back" href="../Validation.html#Validation.skill_score">[docs]</a><span class="k">def</span> <span class="nf">skill_score</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">obs</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Validation Metric: Skill score</span>
+<span class="sd"> </span>
+<span class="sd"> :param model: model data time series</span>
+<span class="sd"> :param obs: observation time series mapped onto model time stamps</span>
+<span class="sd"> </span>
+<span class="sd"> :return: ss</span>
+<span class="sd"> """</span>
+ <span class="n">m</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">squeeze</span><span class="p">(</span><span class="n">model</span><span class="p">)</span>
+ <span class="n">o</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">squeeze</span><span class="p">(</span><span class="n">obs</span><span class="p">)</span>
+ <span class="n">num</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">nansum</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">square</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">abs</span><span class="p">(</span><span class="n">m</span><span class="o">-</span><span class="n">o</span><span class="p">)))</span>
+ <span class="n">mean_o</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">nanmean</span><span class="p">(</span><span class="n">o</span><span class="p">)</span>
+ <span class="n">denom</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">nansum</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">square</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">abs</span><span class="p">(</span><span class="n">m</span><span class="o">-</span><span class="n">mean_o</span><span class="p">)</span><span class="o">+</span><span class="n">np</span><span class="o">.</span><span class="n">abs</span><span class="p">(</span><span class="n">o</span><span class="o">-</span><span class="n">mean_o</span><span class="p">)))</span>
+ <span class="n">ss</span> <span class="o">=</span> <span class="mf">1.0</span> <span class="o">-</span> <span class="n">np</span><span class="o">.</span><span class="n">sqrt</span><span class="p">(</span><span class="n">num</span><span class="o">/</span><span class="n">denom</span><span class="p">)</span>
+ <span class="k">return</span> <span class="n">ss</span></div>
+
+
+<div class="viewcode-block" id="model_efficiency"><a class="viewcode-back" href="../Validation.html#Validation.model_efficiency">[docs]</a><span class="k">def</span> <span class="nf">model_efficiency</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">obs</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Validation Metric: Model efficiency</span>
+<span class="sd"> </span>
+<span class="sd"> :param model: model data time series</span>
+<span class="sd"> :param obs: observation time series mapped onto model time stamps</span>
+<span class="sd"> </span>
+<span class="sd"> :return: mef</span>
+<span class="sd"> """</span>
+ <span class="n">m</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">squeeze</span><span class="p">(</span><span class="n">model</span><span class="p">)</span>
+ <span class="n">o</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">squeeze</span><span class="p">(</span><span class="n">obs</span><span class="p">)</span>
+ <span class="n">mean_m</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">nanmean</span><span class="p">(</span><span class="n">m</span><span class="p">)</span>
+ <span class="n">mean_o</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">nanmean</span><span class="p">(</span><span class="n">o</span><span class="p">)</span>
+ <span class="n">denom</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">nansum</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">square</span><span class="p">(</span><span class="n">o</span><span class="o">-</span><span class="n">mean_o</span><span class="p">))</span>
+ <span class="n">num</span> <span class="o">=</span> <span class="n">denom</span><span class="o">-</span><span class="n">np</span><span class="o">.</span><span class="n">nansum</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">square</span><span class="p">(</span><span class="n">m</span><span class="o">-</span><span class="n">mean_m</span><span class="p">))</span>
+ <span class="n">mef</span> <span class="o">=</span> <span class="n">num</span><span class="o">/</span><span class="n">denom</span>
+ <span class="k">return</span> <span class="n">mef</span></div>
+
+
+<span class="c1"># ====================== Circular Statistics ===============================</span>
+<div class="viewcode-block" id="circ_mod_pi"><a class="viewcode-back" href="../Validation.html#Validation.circ_mod_pi">[docs]</a><span class="k">def</span> <span class="nf">circ_mod_pi</span><span class="p">(</span><span class="n">theta</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Fix angular range in radians to -\\pi <= \\theta <= \\pi</span>
+<span class="sd"> """</span>
+ <span class="c1"># This function requires theta in radians</span>
+ <span class="k">if</span> <span class="n">theta</span><span class="o">.</span><span class="n">size</span> <span class="o">></span> <span class="mi">1</span><span class="p">:</span>
+ <span class="n">indx</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">where</span><span class="p">(</span><span class="n">theta</span> <span class="o"><</span> <span class="o">-</span><span class="n">np</span><span class="o">.</span><span class="n">pi</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span>
+ <span class="n">theta</span><span class="p">[</span><span class="n">indx</span><span class="p">]</span> <span class="o">=</span> <span class="n">theta</span><span class="p">[</span><span class="n">indx</span><span class="p">]</span><span class="o">+</span><span class="mf">2.0</span><span class="o">*</span><span class="n">np</span><span class="o">.</span><span class="n">pi</span>
+ <span class="n">indx</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">where</span><span class="p">(</span><span class="n">theta</span> <span class="o">></span> <span class="n">np</span><span class="o">.</span><span class="n">pi</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span>
+ <span class="n">theta</span><span class="p">[</span><span class="n">indx</span><span class="p">]</span> <span class="o">=</span> <span class="n">theta</span><span class="p">[</span><span class="n">indx</span><span class="p">]</span><span class="o">-</span><span class="mf">2.0</span><span class="o">*</span><span class="n">np</span><span class="o">.</span><span class="n">pi</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="k">if</span> <span class="n">theta</span> <span class="o"><</span> <span class="o">-</span><span class="n">np</span><span class="o">.</span><span class="n">pi</span><span class="p">:</span>
+ <span class="n">theta</span> <span class="o">+=</span> <span class="mf">2.0</span><span class="o">*</span><span class="n">np</span><span class="o">.</span><span class="n">pi</span>
+ <span class="k">elif</span> <span class="n">theta</span> <span class="o">></span> <span class="n">np</span><span class="o">.</span><span class="n">pi</span><span class="p">:</span>
+ <span class="n">theta</span> <span class="o">-=</span> <span class="mf">2.0</span><span class="o">*</span><span class="n">np</span><span class="o">.</span><span class="n">pi</span>
+ <span class="k">return</span> <span class="n">theta</span></div>
+
+
+<div class="viewcode-block" id="circ_corr"><a class="viewcode-back" href="../Validation.html#Validation.circ_corr">[docs]</a><span class="k">def</span> <span class="nf">circ_corr</span><span class="p">(</span><span class="n">theta1</span><span class="p">,</span> <span class="n">theta2</span><span class="p">,</span> <span class="n">degrees</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Validation Metric (Circular): Correlation Coefficient</span>
+<span class="sd"> """</span>
+ <span class="k">if</span> <span class="n">degrees</span><span class="p">:</span>
+ <span class="n">theta1r</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">radians</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">squeeze</span><span class="p">(</span><span class="n">theta1</span><span class="p">),</span> <span class="n">dtype</span><span class="o">=</span><span class="s1">'double'</span><span class="p">)</span>
+ <span class="n">theta2r</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">radians</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">squeeze</span><span class="p">(</span><span class="n">theta2</span><span class="p">),</span> <span class="n">dtype</span><span class="o">=</span><span class="s1">'double'</span><span class="p">)</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">theta1r</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">double</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">squeeze</span><span class="p">(</span><span class="n">theta1</span><span class="p">))</span>
+ <span class="n">theta2r</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">double</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">squeeze</span><span class="p">(</span><span class="n">theta2</span><span class="p">))</span>
+ <span class="n">cmplx1</span> <span class="o">=</span> <span class="n">pol2cmplx</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">ones_like</span><span class="p">(</span><span class="n">theta1r</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="n">np</span><span class="o">.</span><span class="n">double</span><span class="p">),</span> <span class="n">theta1r</span><span class="p">)</span>
+ <span class="n">cmplx2</span> <span class="o">=</span> <span class="n">pol2cmplx</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">ones_like</span><span class="p">(</span><span class="n">theta2r</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="n">np</span><span class="o">.</span><span class="n">double</span><span class="p">),</span> <span class="n">theta2r</span><span class="p">)</span>
+ <span class="n">c_corr</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">abs</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">cov</span><span class="p">(</span><span class="n">cmplx1</span><span class="p">,</span><span class="n">cmplx2</span><span class="p">)[</span><span class="mi">0</span><span class="p">,</span><span class="mi">1</span><span class="p">])</span><span class="o">/</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">std</span><span class="p">(</span><span class="n">cmplx1</span><span class="p">)</span><span class="o">*</span><span class="n">np</span><span class="o">.</span><span class="n">std</span><span class="p">(</span><span class="n">cmplx2</span><span class="p">))</span>
+ <span class="k">return</span> <span class="n">c_corr</span></div>
+
+
+<div class="viewcode-block" id="circ_mean_bias"><a class="viewcode-back" href="../Validation.html#Validation.circ_mean_bias">[docs]</a><span class="k">def</span> <span class="nf">circ_mean_bias</span><span class="p">(</span><span class="n">theta1</span><span class="p">,</span> <span class="n">theta2</span><span class="p">,</span> <span class="n">degrees</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Validation Metric (Circular): Mean Bias</span>
+<span class="sd"> """</span>
+ <span class="n">theta1</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">double</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">squeeze</span><span class="p">(</span><span class="n">theta1</span><span class="p">))</span>
+ <span class="n">theta2</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">double</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">squeeze</span><span class="p">(</span><span class="n">theta2</span><span class="p">))</span>
+ <span class="k">if</span> <span class="n">degrees</span><span class="p">:</span>
+ <span class="n">dtheta</span> <span class="o">=</span> <span class="n">circ_mod_pi</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">radians</span><span class="p">(</span><span class="n">theta1</span> <span class="o">-</span> <span class="n">theta2</span><span class="p">))</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">dtheta</span> <span class="o">=</span> <span class="n">circ_mod_pi</span><span class="p">(</span><span class="n">theta1</span> <span class="o">-</span> <span class="n">theta2</span><span class="p">)</span>
+ <span class="n">circ_mb</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">nanmean</span><span class="p">(</span><span class="n">dtheta</span><span class="p">)</span>
+ <span class="k">if</span> <span class="n">degrees</span><span class="p">:</span>
+ <span class="n">circ_mb</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">degrees</span><span class="p">(</span><span class="n">circ_mb</span><span class="p">)</span>
+ <span class="k">return</span> <span class="n">circ_mb</span></div>
+
+
+<div class="viewcode-block" id="circ_norm_mean_bias"><a class="viewcode-back" href="../Validation.html#Validation.circ_norm_mean_bias">[docs]</a><span class="k">def</span> <span class="nf">circ_norm_mean_bias</span><span class="p">(</span><span class="n">theta1</span><span class="p">,</span> <span class="n">theta2</span><span class="p">,</span> <span class="n">degrees</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Validation Metric (Circular): Normalised mean Bias</span>
+<span class="sd"> """</span>
+ <span class="c1"># Returns value as percentage</span>
+ <span class="n">theta1</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">double</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">squeeze</span><span class="p">(</span><span class="n">theta1</span><span class="p">))</span>
+ <span class="n">theta2</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">double</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">squeeze</span><span class="p">(</span><span class="n">theta2</span><span class="p">))</span>
+ <span class="k">if</span> <span class="n">degrees</span><span class="p">:</span>
+ <span class="n">circ_nmb</span> <span class="o">=</span> <span class="n">circ_mean_bias</span><span class="p">(</span><span class="n">theta1</span><span class="p">,</span> <span class="n">theta2</span><span class="p">,</span> <span class="n">degrees</span><span class="p">)</span><span class="o">/</span><span class="n">np</span><span class="o">.</span><span class="n">double</span><span class="p">(</span><span class="mf">180.0</span><span class="p">)</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">circ_nmb</span> <span class="o">=</span> <span class="n">circ_mean_bias</span><span class="p">(</span><span class="n">theta1</span><span class="p">,</span> <span class="n">theta2</span><span class="p">,</span> <span class="n">degrees</span><span class="p">)</span><span class="o">/</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">pi</span><span class="p">)</span>
+ <span class="n">circ_nmb</span> <span class="o">=</span> <span class="n">circ_nmb</span> <span class="o">*</span> <span class="mf">100.0</span>
+ <span class="k">return</span> <span class="n">circ_nmb</span></div>
+
+
+<div class="viewcode-block" id="circ_mean_abs_error"><a class="viewcode-back" href="../Validation.html#Validation.circ_mean_abs_error">[docs]</a><span class="k">def</span> <span class="nf">circ_mean_abs_error</span><span class="p">(</span><span class="n">theta1</span><span class="p">,</span> <span class="n">theta2</span><span class="p">,</span> <span class="n">degrees</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Validation Metric (Circular): Mean absolute error</span>
+<span class="sd"> """</span>
+ <span class="n">theta1</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">double</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">squeeze</span><span class="p">(</span><span class="n">theta1</span><span class="p">))</span>
+ <span class="n">theta2</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">double</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">squeeze</span><span class="p">(</span><span class="n">theta2</span><span class="p">))</span>
+ <span class="k">if</span> <span class="n">degrees</span><span class="p">:</span>
+ <span class="n">dtheta</span> <span class="o">=</span> <span class="n">circ_mod_pi</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">radians</span><span class="p">(</span><span class="n">theta1</span> <span class="o">-</span> <span class="n">theta2</span><span class="p">))</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">dtheta</span> <span class="o">=</span> <span class="n">circ_mod_pi</span><span class="p">(</span><span class="n">theta1</span> <span class="o">-</span> <span class="n">theta2</span><span class="p">)</span>
+ <span class="n">circ_mae</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">nanmean</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">abs</span><span class="p">(</span><span class="n">dtheta</span><span class="p">))</span>
+ <span class="k">if</span> <span class="n">degrees</span><span class="p">:</span>
+ <span class="n">circ_mae</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">degrees</span><span class="p">(</span><span class="n">circ_mae</span><span class="p">)</span>
+ <span class="k">return</span> <span class="n">circ_mae</span></div>
+
+
+<div class="viewcode-block" id="circ_norm_ma_error"><a class="viewcode-back" href="../Validation.html#Validation.circ_norm_ma_error">[docs]</a><span class="k">def</span> <span class="nf">circ_norm_ma_error</span><span class="p">(</span><span class="n">theta1</span><span class="p">,</span> <span class="n">theta2</span><span class="p">,</span> <span class="n">degrees</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Validation Metric (Circular): Normalised mean absolute error</span>
+<span class="sd"> """</span>
+ <span class="c1"># Returns value as percentage</span>
+ <span class="n">theta1</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">double</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">squeeze</span><span class="p">(</span><span class="n">theta1</span><span class="p">))</span>
+ <span class="n">theta2</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">double</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">squeeze</span><span class="p">(</span><span class="n">theta2</span><span class="p">))</span>
+ <span class="k">if</span> <span class="n">degrees</span><span class="p">:</span>
+ <span class="n">circ_nmae</span> <span class="o">=</span> <span class="n">circ_mean_abs_error</span><span class="p">(</span><span class="n">theta1</span><span class="p">,</span> <span class="n">theta2</span><span class="p">,</span> <span class="n">degrees</span><span class="p">)</span><span class="o">/</span><span class="n">np</span><span class="o">.</span><span class="n">double</span><span class="p">(</span><span class="mf">180.0</span><span class="p">)</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">circ_nmae</span> <span class="o">=</span> <span class="n">circ_mean_abs_error</span><span class="p">(</span><span class="n">theta1</span><span class="p">,</span> <span class="n">theta2</span><span class="p">,</span> <span class="n">degrees</span><span class="p">)</span><span class="o">/</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">pi</span><span class="p">)</span>
+ <span class="n">circ_nmae</span> <span class="o">=</span> <span class="n">circ_nmae</span> <span class="o">*</span> <span class="mf">100.0</span>
+ <span class="k">return</span> <span class="n">circ_nmae</span></div>
+
+
+<div class="viewcode-block" id="circ_rms_error"><a class="viewcode-back" href="../Validation.html#Validation.circ_rms_error">[docs]</a><span class="k">def</span> <span class="nf">circ_rms_error</span><span class="p">(</span><span class="n">theta1</span><span class="p">,</span> <span class="n">theta2</span><span class="p">,</span> <span class="n">degrees</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Validation Metric (Circular): Root-mean-square error</span>
+<span class="sd"> """</span>
+ <span class="n">theta1</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">squeeze</span><span class="p">(</span><span class="n">theta1</span><span class="p">)</span>
+ <span class="n">theta2</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">squeeze</span><span class="p">(</span><span class="n">theta2</span><span class="p">)</span>
+ <span class="k">if</span> <span class="n">degrees</span><span class="p">:</span>
+ <span class="n">dtheta</span> <span class="o">=</span> <span class="n">circ_mod_pi</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">radians</span><span class="p">(</span><span class="n">theta1</span> <span class="o">-</span> <span class="n">theta2</span><span class="p">))</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">dtheta</span> <span class="o">=</span> <span class="n">circ_mod_pi</span><span class="p">(</span><span class="n">theta1</span> <span class="o">-</span> <span class="n">theta2</span><span class="p">)</span>
+ <span class="n">circ_rmse</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">sqrt</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">nanmean</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">square</span><span class="p">(</span><span class="n">dtheta</span><span class="p">)))</span>
+ <span class="k">if</span> <span class="n">degrees</span><span class="p">:</span>
+ <span class="n">circ_rmse</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">degrees</span><span class="p">(</span><span class="n">circ_rmse</span><span class="p">)</span>
+ <span class="k">return</span> <span class="n">circ_rmse</span></div>
+
+
+<div class="viewcode-block" id="circ_norm_rmse"><a class="viewcode-back" href="../Validation.html#Validation.circ_norm_rmse">[docs]</a><span class="k">def</span> <span class="nf">circ_norm_rmse</span><span class="p">(</span><span class="n">theta1</span><span class="p">,</span> <span class="n">theta2</span><span class="p">,</span> <span class="n">degrees</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Validation Metric (Circular): Normalised root-mean-square error</span>
+<span class="sd"> """</span>
+ <span class="c1"># Returns value as percentage</span>
+ <span class="n">theta1</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">squeeze</span><span class="p">(</span><span class="n">theta1</span><span class="p">)</span>
+ <span class="n">theta2</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">squeeze</span><span class="p">(</span><span class="n">theta2</span><span class="p">)</span>
+ <span class="k">if</span> <span class="n">degrees</span><span class="p">:</span>
+ <span class="n">dtheta</span> <span class="o">=</span> <span class="n">circ_mod_pi</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">radians</span><span class="p">(</span><span class="n">theta1</span> <span class="o">-</span> <span class="n">theta2</span><span class="p">))</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">dtheta</span> <span class="o">=</span> <span class="n">circ_mod_pi</span><span class="p">(</span><span class="n">theta1</span> <span class="o">-</span> <span class="n">theta2</span><span class="p">)</span>
+ <span class="n">num</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">sqrt</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">nanmean</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">square</span><span class="p">(</span><span class="n">dtheta</span><span class="p">)))</span>
+ <span class="n">denom</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">pi</span>
+ <span class="n">circ_nrmse</span> <span class="o">=</span> <span class="p">(</span><span class="n">num</span> <span class="o">/</span> <span class="n">denom</span><span class="p">)</span> <span class="o">*</span> <span class="mf">100.0</span>
+ <span class="k">return</span> <span class="n">circ_nrmse</span></div>
+
+
+<div class="viewcode-block" id="circ_scatter_index"><a class="viewcode-back" href="../Validation.html#Validation.circ_scatter_index">[docs]</a><span class="k">def</span> <span class="nf">circ_scatter_index</span><span class="p">(</span><span class="n">theta1</span><span class="p">,</span> <span class="n">theta2</span><span class="p">,</span> <span class="n">degrees</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Validation Metric (Circular): Scatter index</span>
+<span class="sd"> """</span>
+ <span class="c1"># Returns value as percentage</span>
+ <span class="n">theta1</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">double</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">squeeze</span><span class="p">(</span><span class="n">theta1</span><span class="p">))</span>
+ <span class="n">theta2</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">double</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">squeeze</span><span class="p">(</span><span class="n">theta2</span><span class="p">))</span>
+ <span class="k">if</span> <span class="n">degrees</span><span class="p">:</span>
+ <span class="n">theta1</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">radians</span><span class="p">(</span><span class="n">theta1</span><span class="p">)</span>
+ <span class="n">theta2</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">radians</span><span class="p">(</span><span class="n">theta2</span><span class="p">)</span>
+ <span class="n">theta1</span> <span class="o">=</span> <span class="n">circ_mod_pi</span><span class="p">(</span><span class="n">theta1</span><span class="p">)</span>
+ <span class="n">theta2</span> <span class="o">=</span> <span class="n">circ_mod_pi</span><span class="p">(</span><span class="n">theta2</span><span class="p">)</span>
+ <span class="n">mtheta1</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">nanmean</span><span class="p">(</span><span class="n">theta1</span><span class="p">)</span>
+ <span class="n">mtheta2</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">nanmean</span><span class="p">(</span><span class="n">theta2</span><span class="p">)</span>
+ <span class="n">dtheta1</span> <span class="o">=</span> <span class="n">circ_mod_pi</span><span class="p">(</span><span class="n">theta1</span><span class="o">-</span><span class="n">mtheta1</span><span class="p">)</span>
+ <span class="n">dtheta2</span> <span class="o">=</span> <span class="n">circ_mod_pi</span><span class="p">(</span><span class="n">theta2</span><span class="o">-</span><span class="n">mtheta2</span><span class="p">)</span>
+ <span class="n">num</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">nanmean</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">square</span><span class="p">(</span><span class="n">circ_mod_pi</span><span class="p">(</span><span class="n">dtheta1</span><span class="o">-</span><span class="n">dtheta2</span><span class="p">)))</span>
+ <span class="n">denom</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">square</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">pi</span><span class="p">)</span>
+ <span class="n">circ_si</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">sqrt</span><span class="p">(</span><span class="n">num</span><span class="o">/</span><span class="n">denom</span><span class="p">)</span> <span class="o">*</span> <span class="mf">100.0</span>
+ <span class="k">return</span> <span class="n">circ_si</span></div>
+
+
+<span class="c1"># =========================== Data Extraction =============================</span>
+<div class="viewcode-block" id="extract_model"><a class="viewcode-back" href="../Validation.html#Validation.extract_model">[docs]</a><span class="k">def</span> <span class="nf">extract_model</span><span class="p">(</span><span class="n">rscdfile</span><span class="p">,</span> <span class="n">mVarName</span><span class="p">:</span> <span class="nb">str</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Extract model output for a specified variable</span>
+<span class="sd"> """</span>
+ <span class="n">rscd</span> <span class="o">=</span> <span class="n">MData</span><span class="o">.</span><span class="n">ww3</span><span class="p">(</span><span class="n">rscdfile</span><span class="p">)</span>
+ <span class="n">wmtw</span> <span class="o">=</span> <span class="n">MDB</span><span class="o">.</span><span class="n">temporalCoverage</span><span class="p">(</span><span class="n">rscd</span><span class="o">.</span><span class="n">time_start</span><span class="p">,</span> <span class="n">rscd</span><span class="o">.</span><span class="n">time_end</span><span class="p">)</span>
+ <span class="n">rscd_t</span> <span class="o">=</span> <span class="n">rscd</span><span class="o">.</span><span class="n">getVar</span><span class="p">(</span><span class="s1">'time'</span><span class="p">)</span>
+ <span class="k">if</span> <span class="p">(</span><span class="n">mVarName</span> <span class="o">==</span> <span class="s1">'fp'</span><span class="p">)</span> <span class="ow">or</span> <span class="p">(</span><span class="n">mVarName</span> <span class="o">==</span> <span class="s1">'f02'</span><span class="p">):</span>
+ <span class="n">rscd_var</span> <span class="o">=</span> <span class="mf">1.0</span><span class="o">/</span><span class="n">rscd</span><span class="o">.</span><span class="n">getVar</span><span class="p">(</span><span class="n">mVarName</span><span class="p">)</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">rscd_var</span> <span class="o">=</span> <span class="n">rscd</span><span class="o">.</span><span class="n">getVar</span><span class="p">(</span><span class="n">mVarName</span><span class="p">)</span>
+ <span class="c1"># if mVarName == 'dir':</span>
+ <span class="c1"># theta = rscd_var.copy()*np.pi/180.0</span>
+ <span class="k">return</span> <span class="n">rscd</span><span class="p">,</span> <span class="n">rscd_t</span><span class="p">,</span> <span class="n">rscd_var</span><span class="p">,</span> <span class="n">wmtw</span></div>
+
+
+<div class="viewcode-block" id="extract_obs"><a class="viewcode-back" href="../Validation.html#Validation.extract_obs">[docs]</a><span class="k">def</span> <span class="nf">extract_obs</span><span class="p">(</span><span class="n">buoyfile</span><span class="p">,</span> <span class="n">buoyDataFmt</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">varOptions</span><span class="p">:</span> <span class="nb">list</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Extract *in situ* buoy data for a specified data foramt and variable</span>
+<span class="sd"> """</span>
+ <span class="k">if</span> <span class="n">buoyDataFmt</span> <span class="o">==</span> <span class="s1">'InSituTAC'</span><span class="p">:</span>
+ <span class="n">buoy</span> <span class="o">=</span> <span class="n">OData</span><span class="o">.</span><span class="n">wavebuoy</span><span class="p">(</span><span class="n">buoyfile</span><span class="p">)</span>
+ <span class="n">bVarName</span> <span class="o">=</span> <span class="n">getVarName</span><span class="p">(</span><span class="n">buoy</span><span class="p">,</span> <span class="n">varOptions</span><span class="p">)</span>
+ <span class="k">elif</span> <span class="n">buoyDataFmt</span> <span class="o">==</span> <span class="s1">'SeaDataNet'</span><span class="p">:</span>
+ <span class="n">buoy</span> <span class="o">=</span> <span class="n">OData</span><span class="o">.</span><span class="n">emecwb</span><span class="p">(</span><span class="n">buoyfile</span><span class="p">)</span>
+ <span class="n">bVarName</span> <span class="o">=</span> <span class="n">getVarName</span><span class="p">(</span><span class="n">buoy</span><span class="p">,</span> <span class="n">varOptions</span><span class="p">)</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="nb">print</span><span class="p">(</span><span class="s1">'Unknown file format: '</span><span class="o">+</span><span class="n">buoyDataFmt</span><span class="p">)</span>
+ <span class="n">bVarName</span> <span class="o">=</span> <span class="s1">''</span>
+ <span class="k">if</span> <span class="n">bVarName</span> <span class="o">!=</span> <span class="s1">''</span><span class="p">:</span>
+ <span class="n">varIndx</span> <span class="o">=</span> <span class="n">getSurfaceIndx</span><span class="p">(</span><span class="n">buoy</span><span class="p">,</span> <span class="n">buoyDataFmt</span><span class="p">)</span>
+ <span class="n">buoy_t</span><span class="p">,</span> <span class="n">buoy_var</span> <span class="o">=</span> <span class="n">buoy</span><span class="o">.</span><span class="n">getQCTimeseries</span><span class="p">(</span><span class="n">bVarName</span><span class="p">,</span> <span class="n">varIndx</span><span class="p">)</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">varIndx</span> <span class="o">=</span> <span class="kc">None</span>
+ <span class="n">buoy_t</span> <span class="o">=</span> <span class="p">[]</span>
+ <span class="n">buoy_var</span> <span class="o">=</span> <span class="p">[]</span>
+ <span class="k">return</span> <span class="n">bVarName</span><span class="p">,</span> <span class="n">buoy</span><span class="p">,</span> <span class="n">buoy_t</span><span class="p">,</span> <span class="n">buoy_var</span></div>
+
+
+<span class="c1"># ========================== Data Interpolators ===========================</span>
+<div class="viewcode-block" id="time_interpolate_obs"><a class="viewcode-back" href="../Validation.html#Validation.time_interpolate_obs">[docs]</a><span class="k">def</span> <span class="nf">time_interpolate_obs</span><span class="p">(</span><span class="n">t_obs</span><span class="p">,</span> <span class="n">t_var</span><span class="p">,</span> <span class="n">t_model</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Interpolation of observation data onto the model output timestamps</span>
+<span class="sd"> """</span>
+ <span class="n">intrp_var</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">empty_like</span><span class="p">(</span><span class="n">t_model</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="s1">'float'</span><span class="p">)</span>
+ <span class="n">intrp_var</span><span class="p">[:]</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">nan</span>
+ <span class="k">for</span> <span class="n">i_ref</span><span class="p">,</span> <span class="n">t_ref</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">t_model</span><span class="p">):</span>
+ <span class="n">idx</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">sort</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">argsort</span><span class="p">(</span><span class="nb">abs</span><span class="p">(</span><span class="n">t_obs</span><span class="o">-</span><span class="n">t_ref</span><span class="p">))[</span><span class="mi">0</span><span class="p">:</span><span class="mi">2</span><span class="p">])</span>
+ <span class="n">o_diff</span> <span class="o">=</span> <span class="nb">abs</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">diff</span><span class="p">(</span><span class="n">t_obs</span><span class="p">[</span><span class="n">idx</span><span class="p">]))</span><span class="o">*</span><span class="mf">24.0</span>
+ <span class="n">m_diff</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">min</span><span class="p">(</span><span class="nb">abs</span><span class="p">(</span><span class="n">t_obs</span><span class="p">[</span><span class="n">idx</span><span class="p">]</span><span class="o">-</span><span class="n">t_ref</span><span class="p">))</span><span class="o">*</span><span class="mf">24.0</span>
+ <span class="k">if</span> <span class="p">(</span><span class="n">o_diff</span> <span class="o"><</span> <span class="mf">1.5</span><span class="p">)</span> <span class="ow">and</span> <span class="p">(</span><span class="n">m_diff</span> <span class="o"><</span> <span class="mf">1.0</span><span class="p">):</span>
+ <span class="k">if</span> <span class="n">t_ref</span> <span class="o"><</span> <span class="n">t_obs</span><span class="p">[</span><span class="n">idx</span><span class="p">[</span><span class="mi">0</span><span class="p">]]:</span>
+ <span class="n">intrp_var</span><span class="p">[</span><span class="n">i_ref</span><span class="p">]</span> <span class="o">=</span> <span class="n">t_var</span><span class="p">[</span><span class="n">idx</span><span class="p">[</span><span class="mi">0</span><span class="p">]]</span>
+ <span class="k">elif</span> <span class="n">t_ref</span> <span class="o">></span> <span class="n">t_obs</span><span class="p">[</span><span class="n">idx</span><span class="p">[</span><span class="mi">1</span><span class="p">]]:</span>
+ <span class="n">intrp_var</span><span class="p">[</span><span class="n">i_ref</span><span class="p">]</span> <span class="o">=</span> <span class="n">t_var</span><span class="p">[</span><span class="n">idx</span><span class="p">[</span><span class="mi">1</span><span class="p">]]</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">fnc</span> <span class="o">=</span> <span class="n">interp1d</span><span class="p">(</span><span class="n">t_obs</span><span class="p">[</span><span class="n">idx</span><span class="p">],</span> <span class="n">t_var</span><span class="p">[</span><span class="n">idx</span><span class="p">],</span>
+ <span class="n">kind</span><span class="o">=</span><span class="s1">'nearest'</span><span class="p">,</span> <span class="n">bounds_error</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
+ <span class="n">intrp_var</span><span class="p">[</span><span class="n">i_ref</span><span class="p">]</span> <span class="o">=</span> <span class="n">fnc</span><span class="p">(</span><span class="n">t_ref</span><span class="p">)</span>
+ <span class="k">return</span> <span class="n">intrp_var</span></div>
+
+
+<span class="c1"># ============================ Analysis Tools =============================</span>
+<div class="viewcode-block" id="initialize_results"><a class="viewcode-back" href="../Validation.html#Validation.initialize_results">[docs]</a><span class="k">def</span> <span class="nf">initialize_results</span><span class="p">():</span>
+ <span class="sd">"""</span>
+<span class="sd"> Initialise a dictionary for collecting validation results</span>
+<span class="sd"> """</span>
+ <span class="n">results</span> <span class="o">=</span> <span class="p">{}</span>
+ <span class="n">results</span><span class="o">.</span><span class="n">update</span><span class="p">({</span><span class="s1">'MODEL'</span><span class="p">:</span> <span class="p">[]})</span>
+ <span class="n">results</span><span class="o">.</span><span class="n">update</span><span class="p">({</span><span class="s1">'OBSERVATION'</span><span class="p">:</span> <span class="p">[]})</span>
+ <span class="n">results</span><span class="o">.</span><span class="n">update</span><span class="p">({</span><span class="s1">'YEAR'</span><span class="p">:</span> <span class="p">[]})</span>
+ <span class="n">results</span><span class="o">.</span><span class="n">update</span><span class="p">({</span><span class="s1">'MONTH'</span><span class="p">:</span> <span class="p">[]})</span>
+ <span class="n">results</span><span class="o">.</span><span class="n">update</span><span class="p">({</span><span class="s1">'PARAM'</span><span class="p">:</span> <span class="p">[]})</span>
+ <span class="n">results</span><span class="o">.</span><span class="n">update</span><span class="p">({</span><span class="s1">'R'</span><span class="p">:</span> <span class="p">[]})</span>
+ <span class="n">results</span><span class="o">.</span><span class="n">update</span><span class="p">({</span><span class="s1">'MB'</span><span class="p">:</span> <span class="p">[]})</span>
+ <span class="n">results</span><span class="o">.</span><span class="n">update</span><span class="p">({</span><span class="s1">'NMB'</span><span class="p">:</span> <span class="p">[]})</span>
+ <span class="n">results</span><span class="o">.</span><span class="n">update</span><span class="p">({</span><span class="s1">'MAE'</span><span class="p">:</span> <span class="p">[]})</span>
+ <span class="n">results</span><span class="o">.</span><span class="n">update</span><span class="p">({</span><span class="s1">'NMAE'</span><span class="p">:</span> <span class="p">[]})</span>
+ <span class="n">results</span><span class="o">.</span><span class="n">update</span><span class="p">({</span><span class="s1">'RMSE'</span><span class="p">:</span> <span class="p">[]})</span>
+ <span class="n">results</span><span class="o">.</span><span class="n">update</span><span class="p">({</span><span class="s1">'NRMSE'</span><span class="p">:</span> <span class="p">[]})</span>
+ <span class="n">results</span><span class="o">.</span><span class="n">update</span><span class="p">({</span><span class="s1">'SI'</span><span class="p">:</span> <span class="p">[]})</span>
+ <span class="n">results</span><span class="o">.</span><span class="n">update</span><span class="p">({</span><span class="s1">'NSMPL'</span><span class="p">:</span> <span class="p">[]})</span>
+ <span class="k">return</span> <span class="n">results</span></div>
+
+
+<div class="viewcode-block" id="calculate_circular_metrics"><a class="viewcode-back" href="../Validation.html#Validation.calculate_circular_metrics">[docs]</a><span class="k">def</span> <span class="nf">calculate_circular_metrics</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">obs</span><span class="p">,</span> <span class="n">nsampl</span><span class="p">,</span> <span class="n">degrees</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Calculate circlar validation metrics for a pair of modelled and observation time series</span>
+<span class="sd"> """</span>
+ <span class="n">R</span> <span class="o">=</span> <span class="n">circ_corr</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">obs</span><span class="p">,</span> <span class="n">degrees</span><span class="p">)</span>
+ <span class="n">mb</span> <span class="o">=</span> <span class="n">circ_mean_bias</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">obs</span><span class="p">,</span> <span class="n">degrees</span><span class="p">)</span>
+ <span class="n">nmb</span> <span class="o">=</span> <span class="n">circ_norm_mean_bias</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">obs</span><span class="p">,</span> <span class="n">degrees</span><span class="p">)</span>
+ <span class="n">mae</span> <span class="o">=</span> <span class="n">circ_mean_abs_error</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">obs</span><span class="p">,</span> <span class="n">degrees</span><span class="p">)</span>
+ <span class="n">nmae</span> <span class="o">=</span> <span class="n">circ_norm_ma_error</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">obs</span><span class="p">,</span> <span class="n">degrees</span><span class="p">)</span>
+ <span class="n">rmse</span> <span class="o">=</span> <span class="n">circ_rms_error</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">obs</span><span class="p">,</span> <span class="n">degrees</span><span class="p">)</span>
+ <span class="n">nrmse</span> <span class="o">=</span> <span class="n">circ_norm_rmse</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">obs</span><span class="p">,</span> <span class="n">degrees</span><span class="p">)</span>
+ <span class="n">si</span> <span class="o">=</span> <span class="n">circ_scatter_index</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">obs</span><span class="p">,</span> <span class="n">degrees</span><span class="p">)</span>
+
+ <span class="n">metrics</span> <span class="o">=</span> <span class="p">{}</span>
+ <span class="n">metrics</span><span class="p">[</span><span class="s1">'R'</span><span class="p">]</span> <span class="o">=</span> <span class="n">R</span>
+ <span class="n">metrics</span><span class="p">[</span><span class="s1">'MB'</span><span class="p">]</span> <span class="o">=</span> <span class="n">mb</span>
+ <span class="n">metrics</span><span class="p">[</span><span class="s1">'NMB'</span><span class="p">]</span> <span class="o">=</span> <span class="n">nmb</span>
+ <span class="n">metrics</span><span class="p">[</span><span class="s1">'MAE'</span><span class="p">]</span> <span class="o">=</span> <span class="n">mae</span>
+ <span class="n">metrics</span><span class="p">[</span><span class="s1">'NMAE'</span><span class="p">]</span> <span class="o">=</span> <span class="n">nmae</span>
+ <span class="n">metrics</span><span class="p">[</span><span class="s1">'RMSE'</span><span class="p">]</span> <span class="o">=</span> <span class="n">rmse</span>
+ <span class="n">metrics</span><span class="p">[</span><span class="s1">'NRMSE'</span><span class="p">]</span> <span class="o">=</span> <span class="n">nrmse</span>
+ <span class="n">metrics</span><span class="p">[</span><span class="s1">'SI'</span><span class="p">]</span> <span class="o">=</span> <span class="n">si</span>
+ <span class="n">metrics</span><span class="p">[</span><span class="s1">'NSMPL'</span><span class="p">]</span> <span class="o">=</span> <span class="n">nsampl</span>
+ <span class="k">return</span> <span class="n">metrics</span></div>
+
+
+<div class="viewcode-block" id="calculate_metrics"><a class="viewcode-back" href="../Validation.html#Validation.calculate_metrics">[docs]</a><span class="k">def</span> <span class="nf">calculate_metrics</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">obs</span><span class="p">,</span> <span class="n">nsampl</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Calculate standard validation metrics for a pair of modelled and observation time series</span>
+<span class="sd"> """</span>
+ <span class="n">R</span> <span class="o">=</span> <span class="n">corr_coef</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">obs</span><span class="p">)</span>
+ <span class="n">mb</span> <span class="o">=</span> <span class="n">mean_bias</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">obs</span><span class="p">)</span>
+ <span class="n">nmb</span> <span class="o">=</span> <span class="n">norm_mean_bias</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">obs</span><span class="p">)</span>
+ <span class="n">mae</span> <span class="o">=</span> <span class="n">mean_absolute_error</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">obs</span><span class="p">)</span>
+ <span class="n">nmae</span> <span class="o">=</span> <span class="n">norm_ma_error</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">obs</span><span class="p">)</span>
+ <span class="n">rmse</span> <span class="o">=</span> <span class="n">rms_error</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">obs</span><span class="p">)</span>
+ <span class="n">nrmse</span> <span class="o">=</span> <span class="n">norm_rmse</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">obs</span><span class="p">)</span>
+ <span class="n">si</span> <span class="o">=</span> <span class="n">scatter_index</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">obs</span><span class="p">)</span>
+
+ <span class="n">metrics</span> <span class="o">=</span> <span class="p">{}</span>
+ <span class="n">metrics</span><span class="p">[</span><span class="s1">'R'</span><span class="p">]</span> <span class="o">=</span> <span class="n">R</span>
+ <span class="n">metrics</span><span class="p">[</span><span class="s1">'MB'</span><span class="p">]</span> <span class="o">=</span> <span class="n">mb</span>
+ <span class="n">metrics</span><span class="p">[</span><span class="s1">'NMB'</span><span class="p">]</span> <span class="o">=</span> <span class="n">nmb</span>
+ <span class="n">metrics</span><span class="p">[</span><span class="s1">'MAE'</span><span class="p">]</span> <span class="o">=</span> <span class="n">mae</span>
+ <span class="n">metrics</span><span class="p">[</span><span class="s1">'NMAE'</span><span class="p">]</span> <span class="o">=</span> <span class="n">nmae</span>
+ <span class="n">metrics</span><span class="p">[</span><span class="s1">'RMSE'</span><span class="p">]</span> <span class="o">=</span> <span class="n">rmse</span>
+ <span class="n">metrics</span><span class="p">[</span><span class="s1">'NRMSE'</span><span class="p">]</span> <span class="o">=</span> <span class="n">nrmse</span>
+ <span class="n">metrics</span><span class="p">[</span><span class="s1">'SI'</span><span class="p">]</span> <span class="o">=</span> <span class="n">si</span>
+ <span class="n">metrics</span><span class="p">[</span><span class="s1">'NSMPL'</span><span class="p">]</span> <span class="o">=</span> <span class="n">nsampl</span>
+ <span class="k">return</span> <span class="n">metrics</span></div>
+
+
+<div class="viewcode-block" id="results_record"><a class="viewcode-back" href="../Validation.html#Validation.results_record">[docs]</a><span class="k">def</span> <span class="nf">results_record</span><span class="p">(</span><span class="n">modelFileName</span><span class="p">,</span> <span class="n">obsFileName</span><span class="p">,</span> <span class="n">obsVarName</span><span class="p">,</span>
+ <span class="n">year</span><span class="p">,</span> <span class="n">month</span><span class="p">,</span> <span class="n">metrics</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Create results recod from calculated validation metrics</span>
+<span class="sd"> """</span>
+ <span class="n">results</span> <span class="o">=</span> <span class="p">{}</span>
+ <span class="n">results</span><span class="p">[</span><span class="s1">'MODEL'</span><span class="p">]</span> <span class="o">=</span> <span class="n">modelFileName</span>
+ <span class="n">results</span><span class="p">[</span><span class="s1">'BUOY'</span><span class="p">]</span> <span class="o">=</span> <span class="n">obsFileName</span>
+ <span class="n">results</span><span class="p">[</span><span class="s1">'YEAR'</span><span class="p">]</span> <span class="o">=</span> <span class="n">year</span>
+ <span class="n">results</span><span class="p">[</span><span class="s1">'MONTH'</span><span class="p">]</span> <span class="o">=</span> <span class="n">month</span>
+ <span class="n">results</span><span class="p">[</span><span class="s1">'PARAM'</span><span class="p">]</span> <span class="o">=</span> <span class="n">obsVarName</span>
+ <span class="k">for</span> <span class="n">key</span> <span class="ow">in</span> <span class="n">metrics</span><span class="o">.</span><span class="n">keys</span><span class="p">():</span>
+ <span class="n">results</span><span class="p">[</span><span class="n">key</span><span class="p">]</span> <span class="o">=</span> <span class="n">metrics</span><span class="p">[</span><span class="n">key</span><span class="p">]</span>
+ <span class="k">return</span> <span class="n">results</span></div>
+
+
+<div class="viewcode-block" id="store_valid_results"><a class="viewcode-back" href="../Validation.html#Validation.store_valid_results">[docs]</a><span class="k">def</span> <span class="nf">store_valid_results</span><span class="p">(</span><span class="n">store</span><span class="p">,</span> <span class="n">results</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Store validation results record in the results dictionary</span>
+<span class="sd"> """</span>
+ <span class="n">store</span><span class="p">[</span><span class="s1">'MODEL'</span><span class="p">]</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">results</span><span class="p">[</span><span class="s1">'MODEL'</span><span class="p">])</span>
+ <span class="n">store</span><span class="p">[</span><span class="s1">'OBSERVATION'</span><span class="p">]</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">results</span><span class="p">[</span><span class="s1">'BUOY'</span><span class="p">])</span>
+ <span class="n">store</span><span class="p">[</span><span class="s1">'YEAR'</span><span class="p">]</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">results</span><span class="p">[</span><span class="s1">'YEAR'</span><span class="p">])</span>
+ <span class="n">store</span><span class="p">[</span><span class="s1">'MONTH'</span><span class="p">]</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">results</span><span class="p">[</span><span class="s1">'MONTH'</span><span class="p">])</span>
+ <span class="n">store</span><span class="p">[</span><span class="s1">'PARAM'</span><span class="p">]</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">results</span><span class="p">[</span><span class="s1">'PARAM'</span><span class="p">])</span>
+ <span class="n">store</span><span class="p">[</span><span class="s1">'R'</span><span class="p">]</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">results</span><span class="p">[</span><span class="s1">'R'</span><span class="p">])</span>
+ <span class="n">store</span><span class="p">[</span><span class="s1">'MB'</span><span class="p">]</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">results</span><span class="p">[</span><span class="s1">'MB'</span><span class="p">])</span>
+ <span class="n">store</span><span class="p">[</span><span class="s1">'NMB'</span><span class="p">]</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">results</span><span class="p">[</span><span class="s1">'NMB'</span><span class="p">])</span>
+ <span class="n">store</span><span class="p">[</span><span class="s1">'MAE'</span><span class="p">]</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">results</span><span class="p">[</span><span class="s1">'MAE'</span><span class="p">])</span>
+ <span class="n">store</span><span class="p">[</span><span class="s1">'NMAE'</span><span class="p">]</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">results</span><span class="p">[</span><span class="s1">'NMAE'</span><span class="p">])</span>
+ <span class="n">store</span><span class="p">[</span><span class="s1">'RMSE'</span><span class="p">]</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">results</span><span class="p">[</span><span class="s1">'RMSE'</span><span class="p">])</span>
+ <span class="n">store</span><span class="p">[</span><span class="s1">'NRMSE'</span><span class="p">]</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">results</span><span class="p">[</span><span class="s1">'NRMSE'</span><span class="p">])</span>
+ <span class="n">store</span><span class="p">[</span><span class="s1">'SI'</span><span class="p">]</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">results</span><span class="p">[</span><span class="s1">'SI'</span><span class="p">])</span>
+ <span class="n">store</span><span class="p">[</span><span class="s1">'NSMPL'</span><span class="p">]</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">results</span><span class="p">[</span><span class="s1">'NSMPL'</span><span class="p">])</span>
+ <span class="k">return</span></div>
+
+
+<div class="viewcode-block" id="display_tabulated_results"><a class="viewcode-back" href="../Validation.html#Validation.display_tabulated_results">[docs]</a><span class="k">def</span> <span class="nf">display_tabulated_results</span><span class="p">(</span><span class="n">store</span><span class="p">,</span> <span class="n">mVarName</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Display validation results as a table on the standard output</span>
+<span class="sd"> """</span>
+ <span class="nb">print</span><span class="p">(</span><span class="s1">'Validation Statistics for'</span><span class="p">,</span> <span class="n">mVarName</span><span class="p">,</span> <span class="s1">'</span><span class="se">\n</span><span class="s1">'</span><span class="p">)</span>
+ <span class="n">fmtstr</span> <span class="o">=</span> <span class="s2">"</span><span class="si">{:<60}{:<25}{:^7}{:^7}{:^7}{:^9.3}{:^9.4}{:^9.4}{:^9.4}{:^9.4}{:^9.4}{:^9.4}{:^9.4}{:^9}</span><span class="s2">"</span>
+ <span class="k">for</span> <span class="n">row</span> <span class="ow">in</span> <span class="nb">zip</span><span class="p">(</span><span class="o">*</span><span class="p">([</span><span class="n">key</span><span class="p">]</span> <span class="o">+</span> <span class="p">(</span><span class="n">value</span><span class="p">)</span> <span class="k">for</span> <span class="n">key</span><span class="p">,</span> <span class="n">value</span> <span class="ow">in</span> <span class="n">store</span><span class="o">.</span><span class="n">items</span><span class="p">())):</span>
+ <span class="nb">print</span><span class="p">(</span><span class="n">fmtstr</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="o">*</span><span class="n">row</span><span class="p">))</span>
+ <span class="k">return</span></div>
+
+
+<div class="viewcode-block" id="save_tabulated_results"><a class="viewcode-back" href="../Validation.html#Validation.save_tabulated_results">[docs]</a><span class="k">def</span> <span class="nf">save_tabulated_results</span><span class="p">(</span><span class="n">store</span><span class="p">,</span> <span class="n">platform</span><span class="p">,</span> <span class="n">mVarName</span><span class="p">,</span> <span class="n">outpath</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Save tabulated validation results as an ASCII file</span>
+<span class="sd"> """</span>
+ <span class="n">outtxtname</span> <span class="o">=</span> <span class="n">platform</span><span class="o">+</span><span class="s1">'_VALIDATION_STATS_'</span><span class="o">+</span><span class="n">mVarName</span><span class="o">+</span><span class="s1">'.txt'</span>
+ <span class="n">outtxtfile</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">outpath</span><span class="p">,</span><span class="n">outtxtname</span><span class="p">)</span>
+ <span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="n">outtxtfile</span><span class="p">,</span><span class="s1">'w'</span><span class="p">)</span> <span class="k">as</span> <span class="n">ofile</span><span class="p">:</span>
+ <span class="n">ofile</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s1">'Validation Statistics for '</span><span class="o">+</span><span class="n">mVarName</span><span class="o">+</span><span class="s1">'</span><span class="se">\n</span><span class="s1">'</span><span class="p">)</span>
+ <span class="n">fmtstr</span> <span class="o">=</span> <span class="s2">"</span><span class="si">{:<60}{:<25}{:^7}{:^7}{:^7}{:^9.3}{:^9.4}{:^9.4}{:^9.4}{:^9.4}{:^9.4}{:^9.4}{:^9.4}{:^9}</span><span class="s2">"</span>
+ <span class="k">for</span> <span class="n">row</span> <span class="ow">in</span> <span class="nb">zip</span><span class="p">(</span><span class="o">*</span><span class="p">([</span><span class="n">key</span><span class="p">]</span> <span class="o">+</span> <span class="p">(</span><span class="n">value</span><span class="p">)</span> <span class="k">for</span> <span class="n">key</span><span class="p">,</span> <span class="n">value</span> <span class="ow">in</span> <span class="n">store</span><span class="o">.</span><span class="n">items</span><span class="p">())):</span>
+ <span class="n">ofile</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">fmtstr</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="o">*</span><span class="n">row</span><span class="p">)</span><span class="o">+</span><span class="s1">'</span><span class="se">\n</span><span class="s1">'</span><span class="p">)</span>
+ <span class="n">outmatname</span> <span class="o">=</span> <span class="n">platform</span><span class="o">+</span><span class="s1">'_VALIDATION_STATS_'</span><span class="o">+</span><span class="n">mVarName</span><span class="o">+</span><span class="s1">'.mat'</span>
+ <span class="n">outmatfile</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">outpath</span><span class="p">,</span><span class="n">outmatname</span><span class="p">)</span>
+ <span class="n">saveFlg</span> <span class="o">=</span> <span class="n">sio</span><span class="o">.</span><span class="n">savemat</span><span class="p">(</span><span class="n">outmatfile</span><span class="p">,</span><span class="n">store</span><span class="p">)</span>
+ <span class="k">return</span> <span class="n">saveFlg</span></div>
+
+<div class="viewcode-block" id="save_cleaned_ts_data"><a class="viewcode-back" href="../Validation.html#Validation.save_cleaned_ts_data">[docs]</a><span class="k">def</span> <span class="nf">save_cleaned_ts_data</span><span class="p">(</span><span class="n">t</span><span class="p">,</span> <span class="n">rscd</span><span class="p">,</span> <span class="n">buoy</span><span class="p">,</span> <span class="n">platform</span><span class="p">,</span> <span class="n">mVarName</span><span class="p">,</span> <span class="n">outpath</span><span class="p">,</span> <span class="n">year</span><span class="p">,</span> <span class="n">month</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Save cleaned matched model and buoy timeseries as a matlab \\*.mat binary file</span>
+<span class="sd"> """</span>
+ <span class="n">yrMnthStr</span> <span class="o">=</span> <span class="s1">'_'</span><span class="o">+</span><span class="nb">str</span><span class="p">(</span><span class="n">year</span><span class="p">)</span><span class="o">+</span><span class="s1">'_'</span><span class="o">+</span><span class="nb">str</span><span class="p">(</span><span class="n">month</span><span class="p">)</span><span class="o">.</span><span class="n">zfill</span><span class="p">(</span><span class="mi">2</span><span class="p">)</span>
+ <span class="n">outdatname</span> <span class="o">=</span> <span class="n">platform</span><span class="o">+</span><span class="s1">'_VALIDATION_TS_'</span><span class="o">+</span><span class="n">mVarName</span><span class="o">+</span><span class="n">yrMnthStr</span><span class="o">+</span><span class="s1">'.mat'</span>
+ <span class="n">data</span> <span class="o">=</span> <span class="p">{}</span>
+ <span class="n">data</span><span class="p">[</span><span class="s1">'platform'</span><span class="p">]</span> <span class="o">=</span> <span class="n">platform</span>
+ <span class="n">data</span><span class="p">[</span><span class="s1">'var'</span><span class="p">]</span> <span class="o">=</span> <span class="n">mVarName</span>
+ <span class="n">data</span><span class="p">[</span><span class="s1">'year'</span><span class="p">]</span> <span class="o">=</span> <span class="n">year</span>
+ <span class="n">data</span><span class="p">[</span><span class="s1">'month'</span><span class="p">]</span> <span class="o">=</span> <span class="n">month</span>
+ <span class="n">data</span><span class="p">[</span><span class="s1">'time'</span><span class="p">]</span> <span class="o">=</span> <span class="n">t</span>
+ <span class="n">data</span><span class="p">[</span><span class="s1">'rscd'</span><span class="p">]</span> <span class="o">=</span> <span class="n">rscd</span>
+ <span class="n">data</span><span class="p">[</span><span class="s1">'buoy'</span><span class="p">]</span> <span class="o">=</span> <span class="n">buoy</span>
+ <span class="n">outdatfile</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">outpath</span><span class="p">,</span> <span class="n">outdatname</span><span class="p">)</span>
+ <span class="n">saveFlg</span> <span class="o">=</span> <span class="n">sio</span><span class="o">.</span><span class="n">savemat</span><span class="p">(</span><span class="n">outdatfile</span><span class="p">,</span> <span class="n">data</span><span class="p">)</span>
+ <span class="k">return</span> <span class="n">saveFlg</span></div>
+
+<div class="viewcode-block" id="load_binary_results"><a class="viewcode-back" href="../Validation.html#Validation.load_binary_results">[docs]</a><span class="k">def</span> <span class="nf">load_binary_results</span><span class="p">(</span><span class="n">platform</span><span class="p">,</span> <span class="n">mVarName</span><span class="p">,</span> <span class="n">datapath</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> load binary results from a matlab file</span>
+<span class="sd"> """</span>
+ <span class="n">matname</span> <span class="o">=</span> <span class="n">platform</span><span class="o">+</span><span class="s1">'_VALIDATION_STATS_'</span><span class="o">+</span><span class="n">mVarName</span><span class="o">+</span><span class="s1">'.mat'</span>
+ <span class="n">matfile</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">datapath</span><span class="p">,</span><span class="n">matname</span><span class="p">)</span>
+ <span class="n">data</span> <span class="o">=</span> <span class="n">sio</span><span class="o">.</span><span class="n">loadmat</span><span class="p">(</span><span class="n">matfile</span><span class="p">)</span>
+ <span class="n">store</span> <span class="o">=</span> <span class="n">initialize_results</span><span class="p">()</span>
+ <span class="k">for</span> <span class="n">key</span> <span class="ow">in</span> <span class="n">data</span><span class="o">.</span><span class="n">keys</span><span class="p">():</span>
+ <span class="k">if</span> <span class="n">key</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">!=</span> <span class="s1">'_'</span><span class="p">:</span>
+ <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">data</span><span class="p">[</span><span class="n">key</span><span class="p">]</span><span class="o">.</span><span class="n">shape</span><span class="p">)</span> <span class="o">==</span> <span class="mi">1</span><span class="p">:</span>
+ <span class="n">store</span><span class="p">[</span><span class="n">key</span><span class="p">]</span> <span class="o">=</span> <span class="n">data</span><span class="p">[</span><span class="n">key</span><span class="p">]</span><span class="o">.</span><span class="n">tolist</span><span class="p">()</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">store</span><span class="p">[</span><span class="n">key</span><span class="p">]</span> <span class="o">=</span> <span class="n">data</span><span class="p">[</span><span class="n">key</span><span class="p">][</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">tolist</span><span class="p">()</span>
+ <span class="k">return</span> <span class="n">store</span></div>
+
+<div class="viewcode-block" id="process_record"><a class="viewcode-back" href="../Validation.html#Validation.process_record">[docs]</a><span class="k">def</span> <span class="nf">process_record</span><span class="p">(</span><span class="n">rec</span><span class="p">,</span>
+ <span class="n">buoyFmt</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">platform</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
+ <span class="n">mVarName</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">varOptions</span><span class="p">:</span> <span class="nb">list</span><span class="p">,</span>
+ <span class="n">pVarName</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">results_dir</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
+ <span class="n">angularData</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">plot_results</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Process a matched model/buoy data record</span>
+<span class="sd"> """</span>
+ <span class="n">rscdpath</span> <span class="o">=</span> <span class="n">copy</span><span class="o">.</span><span class="n">copy</span><span class="p">(</span><span class="n">rec</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span>
+ <span class="n">rscdfname</span> <span class="o">=</span> <span class="n">copy</span><span class="o">.</span><span class="n">copy</span><span class="p">(</span><span class="n">rec</span><span class="p">[</span><span class="mi">1</span><span class="p">])</span>
+ <span class="n">rscdfile</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">rscdpath</span><span class="p">,</span> <span class="n">rscdfname</span><span class="p">)</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">'</span><span class="se">\\</span><span class="s1">'</span><span class="p">,</span> <span class="s1">'/'</span><span class="p">)</span>
+ <span class="n">rscd</span><span class="p">,</span> <span class="n">rscd_t</span><span class="p">,</span> <span class="n">rscd_var</span><span class="p">,</span> <span class="n">wmtw</span> <span class="o">=</span> <span class="n">extract_model</span><span class="p">(</span><span class="n">rscdfile</span><span class="p">,</span> <span class="n">mVarName</span><span class="p">)</span>
+ <span class="c1">#minNSampl = len(rscd_t)//2</span>
+ <span class="n">minNSampl</span> <span class="o">=</span> <span class="mi">200</span>
+ <span class="nb">print</span><span class="p">(</span><span class="n">rscdfname</span><span class="p">)</span>
+
+ <span class="n">buoypath</span> <span class="o">=</span> <span class="n">copy</span><span class="o">.</span><span class="n">copy</span><span class="p">(</span><span class="n">rec</span><span class="p">[</span><span class="mi">2</span><span class="p">])</span>
+ <span class="n">buoyfname</span> <span class="o">=</span> <span class="n">copy</span><span class="o">.</span><span class="n">copy</span><span class="p">(</span><span class="n">rec</span><span class="p">[</span><span class="mi">3</span><span class="p">])</span>
+ <span class="n">buoyfile</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">buoypath</span><span class="p">,</span> <span class="n">buoyfname</span><span class="p">)</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">'</span><span class="se">\\</span><span class="s1">'</span><span class="p">,</span> <span class="s1">'/'</span><span class="p">)</span>
+ <span class="n">bVarName</span><span class="p">,</span> <span class="n">buoy</span><span class="p">,</span> <span class="n">buoy_t</span><span class="p">,</span> <span class="n">buoy_var</span> <span class="o">=</span> <span class="n">extract_obs</span><span class="p">(</span><span class="n">buoyfile</span><span class="p">,</span> <span class="n">buoyFmt</span><span class="p">,</span> <span class="n">varOptions</span><span class="p">)</span>
+ <span class="nb">print</span><span class="p">(</span><span class="s1">'Buoy file = '</span><span class="p">,</span> <span class="n">buoyfname</span><span class="p">)</span>
+ <span class="nb">print</span><span class="p">(</span><span class="s1">'Buoy sampling period = '</span><span class="p">,</span> <span class="n">buoy</span><span class="o">.</span><span class="n">sample_period</span><span class="p">)</span>
+
+ <span class="n">year</span> <span class="o">=</span> <span class="n">copy</span><span class="o">.</span><span class="n">copy</span><span class="p">(</span><span class="n">rec</span><span class="p">[</span><span class="mi">4</span><span class="p">])</span>
+ <span class="n">month</span> <span class="o">=</span> <span class="n">copy</span><span class="o">.</span><span class="n">copy</span><span class="p">(</span><span class="n">rec</span><span class="p">[</span><span class="mi">5</span><span class="p">])</span>
+
+ <span class="n">valid_results</span> <span class="o">=</span> <span class="kc">None</span>
+
+ <span class="k">if</span> <span class="n">bVarName</span> <span class="o">!=</span> <span class="s1">''</span><span class="p">:</span>
+ <span class="nb">print</span><span class="p">(</span><span class="s1">'Variable name = '</span><span class="p">,</span> <span class="n">bVarName</span><span class="p">)</span>
+ <span class="n">overlaps</span><span class="p">,</span> <span class="n">tindx</span> <span class="o">=</span> <span class="n">wmtw</span><span class="o">.</span><span class="n">timeOverlap</span><span class="p">(</span><span class="n">buoy_t</span><span class="p">)</span>
+ <span class="k">if</span> <span class="p">(</span><span class="n">tindx</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">)</span> <span class="o">&</span> <span class="p">(</span><span class="n">tindx</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">):</span>
+ <span class="n">ngood</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">where</span><span class="p">(</span><span class="n">buoy_var</span><span class="p">[</span><span class="n">tindx</span><span class="p">[</span><span class="mi">0</span><span class="p">]:(</span><span class="n">tindx</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span><span class="o">+</span><span class="mi">1</span><span class="p">)]</span> <span class="o">!=</span> <span class="n">np</span><span class="o">.</span><span class="n">nan</span><span class="p">)[</span><span class="mi">0</span><span class="p">])</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">ngood</span> <span class="o">=</span> <span class="mi">0</span>
+ <span class="k">if</span> <span class="n">overlaps</span> <span class="o">&</span> <span class="p">(</span><span class="n">ngood</span> <span class="o">>=</span> <span class="n">minNSampl</span><span class="p">):</span>
+ <span class="n">t0</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">where</span><span class="p">(</span><span class="n">buoy_t</span> <span class="o">>=</span> <span class="n">rscd_t</span><span class="p">[</span><span class="mi">0</span><span class="p">])[</span><span class="mi">0</span><span class="p">][</span><span class="mi">0</span><span class="p">]</span>
+ <span class="n">t1</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">where</span><span class="p">(</span><span class="n">buoy_t</span> <span class="o"><=</span> <span class="n">rscd_t</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">])[</span><span class="mi">0</span><span class="p">][</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span>
+ <span class="nb">print</span><span class="p">(</span><span class="s1">'Number of good data points = '</span><span class="p">,</span> <span class="n">ngood</span><span class="p">)</span>
+ <span class="nb">print</span><span class="p">(</span><span class="s1">'Points in RSCD time series = '</span><span class="p">,</span> <span class="nb">len</span><span class="p">(</span><span class="n">rscd_t</span><span class="p">))</span>
+ <span class="nb">print</span><span class="p">(</span><span class="s1">'Points in Buoy time series = '</span><span class="p">,</span> <span class="nb">len</span><span class="p">(</span><span class="n">buoy_t</span><span class="p">[</span><span class="n">t0</span><span class="p">:(</span><span class="n">t1</span><span class="o">+</span><span class="mi">1</span><span class="p">)]))</span>
+ <span class="nb">print</span><span class="p">(</span><span class="s1">'Start times (model, in situ): '</span><span class="p">,</span> <span class="n">rscd_t</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="n">buoy_t</span><span class="p">[</span><span class="n">t0</span><span class="p">])</span>
+ <span class="nb">print</span><span class="p">(</span><span class="s1">'End times (model, in situ): '</span><span class="p">,</span> <span class="n">rscd_t</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">],</span> <span class="n">buoy_t</span><span class="p">[</span><span class="n">t1</span><span class="p">])</span>
+ <span class="n">model</span> <span class="o">=</span> <span class="p">[]</span>
+ <span class="n">obs</span> <span class="o">=</span> <span class="p">[]</span>
+ <span class="n">sample_period</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">median</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">diff</span><span class="p">(</span><span class="n">buoy_t</span><span class="p">[</span><span class="n">t0</span><span class="p">:(</span><span class="n">t1</span><span class="o">+</span><span class="mi">1</span><span class="p">)]))</span><span class="o">*</span><span class="mf">24.0</span>
+ <span class="c1">#if buoy.sample_period != 1.0:</span>
+ <span class="k">if</span> <span class="n">sample_period</span> <span class="o">!=</span> <span class="mf">1.0</span><span class="p">:</span>
+ <span class="c1"># Get common indices</span>
+ <span class="n">max_dt</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">max</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">diff</span><span class="p">(</span><span class="n">buoy_t</span><span class="p">[</span><span class="n">t0</span><span class="p">:(</span><span class="n">t1</span><span class="o">+</span><span class="mi">1</span><span class="p">)]))</span>
+ <span class="nb">print</span><span class="p">(</span><span class="s1">'Maximum dt in obs ='</span><span class="p">,</span> <span class="n">max_dt</span><span class="o">*</span><span class="mf">24.</span><span class="p">,</span> <span class="s1">'hours'</span><span class="p">)</span>
+ <span class="c1"># Interpolate obs onto model times</span>
+ <span class="n">t_mod</span> <span class="o">=</span> <span class="n">rscd_t</span><span class="o">.</span><span class="n">copy</span><span class="p">()</span>
+ <span class="n">v_mod</span> <span class="o">=</span> <span class="n">rscd_var</span><span class="o">.</span><span class="n">copy</span><span class="p">()</span>
+ <span class="n">t_obs</span> <span class="o">=</span> <span class="n">buoy_t</span><span class="p">[</span><span class="n">t0</span><span class="p">:(</span><span class="n">t1</span><span class="o">+</span><span class="mi">1</span><span class="p">)]</span><span class="o">.</span><span class="n">copy</span><span class="p">()</span>
+ <span class="n">v_obs</span> <span class="o">=</span> <span class="n">buoy_var</span><span class="p">[</span><span class="n">t0</span><span class="p">:(</span><span class="n">t1</span><span class="o">+</span><span class="mi">1</span><span class="p">)]</span><span class="o">.</span><span class="n">copy</span><span class="p">()</span>
+ <span class="n">v_obs</span> <span class="o">=</span> <span class="n">time_interpolate_obs</span><span class="p">(</span><span class="n">t_obs</span><span class="p">,</span> <span class="n">v_obs</span><span class="p">,</span> <span class="n">t_mod</span><span class="p">)</span>
+ <span class="c1"># Plot time series</span>
+ <span class="k">if</span> <span class="n">plot_results</span><span class="p">:</span>
+ <span class="n">fig</span> <span class="o">=</span> <span class="n">plot_time_series</span><span class="p">(</span><span class="n">t_mod</span><span class="p">,</span> <span class="n">v_mod</span><span class="p">,</span> <span class="n">t_mod</span><span class="p">,</span> <span class="n">v_obs</span><span class="p">,</span>
+ <span class="n">bVarName</span><span class="p">,</span> <span class="n">buoy</span><span class="o">.</span><span class="n">platform</span><span class="p">,</span>
+ <span class="n">pVarName</span><span class="p">,</span> <span class="n">rscdfname</span><span class="p">,</span>
+ <span class="n">year</span><span class="p">,</span> <span class="n">month</span><span class="p">,</span>
+ <span class="p">[</span><span class="n">rscd_t</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="n">rscd_t</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]])</span>
+ <span class="n">plotname</span> <span class="o">=</span> <span class="s1">''</span><span class="o">.</span><span class="n">join</span><span class="p">(</span>
+ <span class="p">(</span><span class="s1">'RSCD_'</span><span class="p">,</span> <span class="n">buoy</span><span class="o">.</span><span class="n">platform</span><span class="p">,</span> <span class="s1">'_'</span><span class="p">,</span>
+ <span class="n">pVarName</span><span class="p">,</span><span class="s1">'_'</span><span class="p">,</span>
+ <span class="nb">str</span><span class="p">(</span><span class="n">year</span><span class="p">),</span><span class="s1">'_'</span><span class="p">,</span>
+ <span class="nb">str</span><span class="p">(</span><span class="n">month</span><span class="p">)</span><span class="o">.</span><span class="n">zfill</span><span class="p">(</span><span class="mi">2</span><span class="p">),</span>
+ <span class="s1">'_TS.png'</span><span class="p">))</span>
+ <span class="n">plotfile</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">results_dir</span><span class="p">,</span><span class="n">plotname</span><span class="p">)</span>
+ <span class="n">fig</span><span class="o">.</span><span class="n">savefig</span><span class="p">(</span><span class="n">plotfile</span><span class="p">)</span>
+ <span class="n">plot_close</span><span class="p">(</span><span class="n">fig</span><span class="p">)</span>
+ <span class="c1"># Select common points between timeseries</span>
+ <span class="n">nans</span><span class="p">,</span> <span class="n">x</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">isnan</span><span class="p">(</span><span class="n">v_obs</span><span class="p">),</span> <span class="k">lambda</span> <span class="n">z</span><span class="p">:</span> <span class="n">z</span><span class="o">.</span><span class="n">nonzero</span><span class="p">()[</span><span class="mi">0</span><span class="p">]</span>
+ <span class="n">indices</span> <span class="o">=</span> <span class="n">x</span><span class="p">(</span><span class="o">~</span><span class="n">nans</span><span class="p">)</span>
+ <span class="c1"># Calculate validation metrics</span>
+ <span class="n">model</span> <span class="o">=</span> <span class="n">v_mod</span><span class="p">[</span><span class="n">indices</span><span class="p">]</span><span class="o">.</span><span class="n">copy</span><span class="p">()</span>
+ <span class="n">obs</span> <span class="o">=</span> <span class="n">v_obs</span><span class="p">[</span><span class="n">indices</span><span class="p">]</span><span class="o">.</span><span class="n">copy</span><span class="p">()</span>
+ <span class="n">nsampl</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="n">indices</span><span class="p">)</span>
+ <span class="n">save_cleaned_ts_data</span><span class="p">(</span><span class="n">t_mod</span><span class="p">,</span> <span class="n">v_mod</span><span class="p">,</span> <span class="n">v_obs</span><span class="p">,</span> <span class="n">platform</span><span class="p">,</span> <span class="n">mVarName</span><span class="p">,</span> <span class="n">results_dir</span><span class="p">,</span> <span class="n">year</span><span class="p">,</span> <span class="n">month</span> <span class="p">)</span>
+ <span class="k">elif</span> <span class="n">buoy</span><span class="o">.</span><span class="n">sample_period</span> <span class="o">==</span> <span class="mf">1.0</span><span class="p">:</span>
+ <span class="c1"># Get common indices</span>
+ <span class="n">both</span> <span class="o">=</span> <span class="nb">set</span><span class="p">(</span><span class="nb">list</span><span class="p">(</span><span class="n">rscd_t</span><span class="p">))</span><span class="o">.</span><span class="n">intersection</span><span class="p">(</span><span class="nb">list</span><span class="p">(</span><span class="n">buoy_t</span><span class="p">))</span>
+ <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">both</span><span class="p">)</span> <span class="o">></span> <span class="mi">0</span><span class="p">:</span>
+ <span class="c1"># Interpolate obs onto model times</span>
+ <span class="n">t_mod</span> <span class="o">=</span> <span class="n">rscd_t</span><span class="o">.</span><span class="n">copy</span><span class="p">()</span>
+ <span class="n">v_mod</span> <span class="o">=</span> <span class="n">rscd_var</span><span class="o">.</span><span class="n">copy</span><span class="p">()</span>
+ <span class="n">t_obs</span> <span class="o">=</span> <span class="n">buoy_t</span><span class="p">[</span><span class="n">t0</span><span class="p">:(</span><span class="n">t1</span><span class="o">+</span><span class="mi">1</span><span class="p">)]</span><span class="o">.</span><span class="n">copy</span><span class="p">()</span>
+ <span class="n">v_obs</span> <span class="o">=</span> <span class="n">buoy_var</span><span class="p">[</span><span class="n">t0</span><span class="p">:(</span><span class="n">t1</span><span class="o">+</span><span class="mi">1</span><span class="p">)]</span><span class="o">.</span><span class="n">copy</span><span class="p">()</span>
+ <span class="c1"># Plot time series</span>
+ <span class="k">if</span> <span class="n">plot_results</span><span class="p">:</span>
+ <span class="n">fig</span> <span class="o">=</span> <span class="n">plot_time_series</span><span class="p">(</span><span class="n">t_mod</span><span class="p">,</span> <span class="n">v_mod</span><span class="p">,</span> <span class="n">t_obs</span><span class="p">,</span> <span class="n">v_obs</span><span class="p">,</span>
+ <span class="n">bVarName</span><span class="p">,</span> <span class="n">buoy</span><span class="o">.</span><span class="n">platform</span><span class="p">,</span>
+ <span class="n">pVarName</span><span class="p">,</span> <span class="n">rscdfname</span><span class="p">,</span>
+ <span class="n">year</span><span class="p">,</span> <span class="n">month</span><span class="p">,</span>
+ <span class="p">[</span><span class="n">rscd_t</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="n">rscd_t</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]])</span>
+ <span class="n">plotname</span> <span class="o">=</span> <span class="s1">''</span><span class="o">.</span><span class="n">join</span><span class="p">(</span>
+ <span class="p">(</span><span class="s1">'RSCD_'</span><span class="p">,</span> <span class="n">buoy</span><span class="o">.</span><span class="n">platform</span><span class="p">,</span> <span class="s1">'_'</span><span class="p">,</span>
+ <span class="n">pVarName</span><span class="p">,</span><span class="s1">'_'</span><span class="p">,</span>
+ <span class="nb">str</span><span class="p">(</span><span class="n">year</span><span class="p">),</span><span class="s1">'_'</span><span class="p">,</span>
+ <span class="nb">str</span><span class="p">(</span><span class="n">month</span><span class="p">)</span><span class="o">.</span><span class="n">zfill</span><span class="p">(</span><span class="mi">2</span><span class="p">),</span>
+ <span class="s1">'_TS.png'</span><span class="p">))</span>
+ <span class="n">plotfile</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">results_dir</span><span class="p">,</span><span class="n">plotname</span><span class="p">)</span>
+ <span class="n">fig</span><span class="o">.</span><span class="n">savefig</span><span class="p">(</span><span class="n">plotfile</span><span class="p">)</span>
+ <span class="n">plot_close</span><span class="p">(</span><span class="n">fig</span><span class="p">)</span>
+ <span class="c1"># Get common data indices</span>
+ <span class="n">nans</span><span class="p">,</span> <span class="n">x</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">isnan</span><span class="p">(</span><span class="n">v_obs</span><span class="p">),</span> <span class="k">lambda</span> <span class="n">z</span><span class="p">:</span> <span class="n">z</span><span class="o">.</span><span class="n">nonzero</span><span class="p">()[</span><span class="mi">0</span><span class="p">]</span>
+ <span class="n">indices</span> <span class="o">=</span> <span class="n">x</span><span class="p">(</span><span class="o">~</span><span class="n">nans</span><span class="p">)</span>
+ <span class="c1"># Select common points between timeseries</span>
+ <span class="n">model</span> <span class="o">=</span> <span class="n">v_mod</span><span class="p">[</span><span class="n">indices</span><span class="p">]</span><span class="o">.</span><span class="n">copy</span><span class="p">()</span>
+ <span class="n">obs</span> <span class="o">=</span> <span class="n">v_obs</span><span class="p">[</span><span class="n">indices</span><span class="p">]</span><span class="o">.</span><span class="n">copy</span><span class="p">()</span>
+ <span class="n">nsampl</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="n">both</span><span class="p">)</span>
+ <span class="n">save_cleaned_ts_data</span><span class="p">(</span><span class="n">t_mod</span><span class="p">,</span> <span class="n">v_mod</span><span class="p">,</span> <span class="n">v_obs</span><span class="p">,</span> <span class="n">platform</span><span class="p">,</span> <span class="n">mVarName</span><span class="p">,</span> <span class="n">results_dir</span><span class="p">,</span> <span class="n">year</span><span class="p">,</span> <span class="n">month</span> <span class="p">)</span>
+ <span class="c1"># Calculate validation metrics</span>
+ <span class="k">if</span> <span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">model</span><span class="p">)</span> <span class="o">></span> <span class="n">minNSampl</span><span class="p">)</span> <span class="o">&</span> <span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">obs</span><span class="p">)</span> <span class="o">></span> <span class="n">minNSampl</span><span class="p">):</span>
+ <span class="k">if</span> <span class="n">angularData</span><span class="p">:</span>
+ <span class="n">metrics</span> <span class="o">=</span> <span class="n">calculate_circular_metrics</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">obs</span><span class="p">,</span> <span class="n">nsampl</span><span class="p">)</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">metrics</span> <span class="o">=</span> <span class="n">calculate_metrics</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">obs</span><span class="p">,</span> <span class="n">nsampl</span><span class="p">)</span>
+ <span class="n">valid_results</span> <span class="o">=</span> <span class="n">results_record</span><span class="p">(</span><span class="n">rscdfname</span><span class="p">,</span> <span class="n">buoyfname</span><span class="p">,</span>
+ <span class="n">bVarName</span><span class="p">,</span>
+ <span class="n">year</span><span class="p">,</span> <span class="n">month</span><span class="p">,</span> <span class="n">metrics</span><span class="p">)</span>
+ <span class="c1"># Plot correlation</span>
+ <span class="k">if</span> <span class="n">plot_results</span><span class="p">:</span>
+ <span class="n">fig</span> <span class="o">=</span> <span class="n">plot_correlation</span><span class="p">(</span><span class="n">obs</span><span class="p">,</span> <span class="n">model</span><span class="p">,</span> <span class="n">bVarName</span><span class="p">,</span>
+ <span class="n">buoy</span><span class="o">.</span><span class="n">platform</span><span class="p">,</span>
+ <span class="n">pVarName</span><span class="p">,</span> <span class="n">rscdfname</span><span class="p">,</span>
+ <span class="n">year</span><span class="p">,</span> <span class="n">month</span><span class="p">,</span>
+ <span class="n">metrics</span><span class="p">)</span>
+ <span class="n">plotname</span> <span class="o">=</span> <span class="s1">''</span><span class="o">.</span><span class="n">join</span><span class="p">(</span>
+ <span class="p">(</span><span class="s1">'RSCD_'</span><span class="p">,</span> <span class="n">buoy</span><span class="o">.</span><span class="n">platform</span><span class="p">,</span> <span class="s1">'_'</span><span class="p">,</span>
+ <span class="n">pVarName</span><span class="p">,</span><span class="s1">'_'</span><span class="p">,</span>
+ <span class="nb">str</span><span class="p">(</span><span class="n">year</span><span class="p">),</span><span class="s1">'_'</span><span class="p">,</span>
+ <span class="nb">str</span><span class="p">(</span><span class="n">month</span><span class="p">)</span><span class="o">.</span><span class="n">zfill</span><span class="p">(</span><span class="mi">2</span><span class="p">),</span>
+ <span class="s1">'_CORR.png'</span><span class="p">))</span>
+ <span class="n">plotfile</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">results_dir</span><span class="p">,</span><span class="n">plotname</span><span class="p">)</span>
+ <span class="n">fig</span><span class="o">.</span><span class="n">savefig</span><span class="p">(</span><span class="n">plotfile</span><span class="p">)</span>
+ <span class="n">plot_close</span><span class="p">(</span><span class="n">fig</span><span class="p">)</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="nb">print</span><span class="p">(</span><span class="s1">'No common indices found for metrics calculations.'</span><span class="p">)</span>
+ <span class="nb">print</span><span class="p">()</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="nb">print</span><span class="p">(</span><span class="s1">'Insuffient valid data for statistics. (# Good = '</span><span class="p">,</span>
+ <span class="n">ngood</span><span class="p">,</span> <span class="s1">')'</span><span class="p">)</span>
+ <span class="nb">print</span><span class="p">()</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="nb">print</span><span class="p">(</span><span class="s1">'No variable match with '</span><span class="p">,</span> <span class="n">varOptions</span><span class="p">)</span>
+ <span class="nb">print</span><span class="p">(</span><span class="s1">'Buoy variables: '</span><span class="p">,</span> <span class="n">buoy</span><span class="o">.</span><span class="n">file</span><span class="p">[</span><span class="s1">'vars'</span><span class="p">])</span>
+ <span class="nb">print</span><span class="p">()</span>
+ <span class="k">return</span> <span class="n">valid_results</span></div>
+
+
+<div class="viewcode-block" id="validate_records"><a class="viewcode-back" href="../Validation.html#Validation.validate_records">[docs]</a><span class="k">def</span> <span class="nf">validate_records</span><span class="p">(</span><span class="n">records</span><span class="p">,</span> <span class="n">dataFmt</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">platform</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
+ <span class="n">mVarName</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">varOptions</span><span class="p">:</span> <span class="nb">list</span><span class="p">,</span>
+ <span class="n">pVarName</span><span class="p">,</span>
+ <span class="n">results_dir</span><span class="p">,</span>
+ <span class="n">plot_results</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Process a set of matched model/buoy data records</span>
+<span class="sd"> """</span>
+ <span class="c1"># Create results dictionary</span>
+ <span class="n">results_store</span> <span class="o">=</span> <span class="n">initialize_results</span><span class="p">()</span>
+
+ <span class="k">if</span> <span class="n">mVarName</span> <span class="o">==</span> <span class="s1">'dir'</span><span class="p">:</span>
+ <span class="n">angularData</span><span class="o">=</span><span class="kc">True</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">angularData</span><span class="o">=</span><span class="kc">False</span>
+
+ <span class="n">n_valid_results</span> <span class="o">=</span> <span class="mi">0</span>
+ <span class="k">for</span> <span class="n">rec</span> <span class="ow">in</span> <span class="n">records</span><span class="p">:</span>
+ <span class="n">result</span> <span class="o">=</span> <span class="n">process_record</span><span class="p">(</span><span class="n">rec</span><span class="p">,</span> <span class="n">dataFmt</span><span class="p">,</span> <span class="n">platform</span><span class="p">,</span>
+ <span class="n">mVarName</span><span class="p">,</span> <span class="n">varOptions</span><span class="p">,</span>
+ <span class="n">pVarName</span><span class="p">,</span> <span class="n">results_dir</span><span class="p">,</span>
+ <span class="n">angularData</span><span class="p">,</span> <span class="n">plot_results</span><span class="p">)</span>
+ <span class="k">if</span> <span class="n">result</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
+ <span class="n">store_valid_results</span><span class="p">(</span><span class="n">results_store</span><span class="p">,</span> <span class="n">result</span><span class="p">)</span>
+ <span class="n">n_valid_results</span> <span class="o">+=</span> <span class="mi">1</span>
+ <span class="k">return</span> <span class="n">n_valid_results</span><span class="p">,</span> <span class="n">results_store</span></div>
+
+</pre></div>
+
+ <div class="clearer"></div>
+ </div>
+ </div>
+ </div>
+ <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+ <div class="sphinxsidebarwrapper">
+<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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
+ <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="nav-item nav-item-0"><a href="../index.html">WaveVal documentation</a> »</li>
+ <li class="nav-item nav-item-1"><a href="index.html" >Module code</a> »</li>
+ <li class="nav-item nav-item-this"><a href="">Validation</a></li>
+ </ul>
+ </div>
+ <div class="footer" role="contentinfo">
+ © Copyright 2022.
+ Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 4.3.0.
+ </div>
+ </body>
+</html>
\ No newline at end of file
diff --git a/docs/_build/html/_modules/WaveSpectra.html b/docs/_build/html/_modules/WaveSpectra.html
new file mode 100644
index 0000000000000000000000000000000000000000..2de8641837998ae3b985caeb495f83906e0ed253
--- /dev/null
+++ b/docs/_build/html/_modules/WaveSpectra.html
@@ -0,0 +1,371 @@
+
+
+<!doctype html>
+
+<html lang="en">
+ <head>
+ <meta charset="utf-8" />
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+ <title>WaveSpectra — WaveVal documentation</title>
+ <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
+ <link rel="stylesheet" type="text/css" href="../_static/bizstyle.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 src="../_static/bizstyle.js"></script>
+ <link rel="author" title="About these documents" href="../about.html" />
+ <link rel="index" title="Index" href="../genindex.html" />
+ <link rel="search" title="Search" href="../search.html" />
+ <meta name="viewport" content="width=device-width,initial-scale=1.0" />
+ <!--[if lt IE 9]>
+ <script src="_static/css3-mediaqueries.js"></script>
+ <![endif]-->
+ </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="nav-item nav-item-0"><a href="../index.html">WaveVal documentation</a> »</li>
+ <li class="nav-item nav-item-1"><a href="index.html" accesskey="U">Module code</a> »</li>
+ <li class="nav-item nav-item-this"><a href="">WaveSpectra</a></li>
+ </ul>
+ </div>
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body" role="main">
+
+ <h1>Source code for WaveSpectra</h1><div class="highlight"><pre>
+<span></span><span class="c1"># -*- coding: utf-8 -*-</span>
+<span class="sd">"""</span>
+<span class="sd">This module contains functions for calculating intergated wave parameters and </span>
+<span class="sd">reconstructing 2-D wave spectra from spectral parameters.</span>
+
+<span class="sd">:Dependencies [External]: numpy</span>
+<span class="sd">:Dependencies [Internal]: </span>
+
+<span class="sd">"""</span>
+<span class="c1"># ----------------------------------------------------------------------------</span>
+<span class="c1"># IMPORTS</span>
+<span class="c1"># ----------------------------------------------------------------------------</span>
+<span class="c1"># Standard Python Dependencies</span>
+<span class="c1"># Non-Standard Python Dependencies</span>
+<span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
+<span class="c1"># Local Module Dependencies</span>
+<span class="c1"># Other Dependencies</span>
+
+
+<span class="c1"># ----------------------------------------------------------------------------</span>
+<span class="c1"># GLOBAL VARIABLES</span>
+<span class="c1"># ----------------------------------------------------------------------------</span>
+<span class="n">grav</span> <span class="o">=</span> <span class="mf">9.81</span> <span class="c1"># Mean gravitional acceleration at Earths surface m / s^2</span>
+
+<span class="c1"># ----------------------------------------------------------------------------</span>
+<span class="c1"># CLASS DEFINITIONS</span>
+<span class="c1"># ----------------------------------------------------------------------------</span>
+
+
+<span class="c1"># ----------------------------------------------------------------------------</span>
+<span class="c1"># FUNCTION DEFINITIONS</span>
+<span class="c1"># ----------------------------------------------------------------------------</span>
+
+<span class="c1"># ============== 2-D Spectra Functions ==================</span>
+<div class="viewcode-block" id="significant_wave_height"><a class="viewcode-back" href="../WaveSpectra.html#WaveSpectra.significant_wave_height">[docs]</a><span class="k">def</span> <span class="nf">significant_wave_height</span><span class="p">(</span><span class="n">moments</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Integrated Wave Parameter: Significant wave height</span>
+<span class="sd"> </span>
+<span class="sd"> :param moments: Spectral moments calculated from the wave energy spectrum using :func:`WaveVal.WaveSpectra.spectralMoment()`.</span>
+<span class="sd"> </span>
+<span class="sd"> :return: Hm0.</span>
+<span class="sd"> """</span>
+ <span class="n">Hm0</span> <span class="o">=</span> <span class="mf">4.0</span> <span class="o">*</span> <span class="n">np</span><span class="o">.</span><span class="n">sqrt</span><span class="p">(</span><span class="n">moments</span><span class="p">[</span><span class="s1">'m0'</span><span class="p">])</span>
+ <span class="k">return</span> <span class="n">Hm0</span></div>
+
+<div class="viewcode-block" id="mean_wave_period"><a class="viewcode-back" href="../WaveSpectra.html#WaveSpectra.mean_wave_period">[docs]</a><span class="k">def</span> <span class="nf">mean_wave_period</span><span class="p">(</span><span class="n">moments</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Integrated Wave Parameter: Mean wave period</span>
+<span class="sd"> </span>
+<span class="sd"> :param moments: Spectral moments calculated from the wave energy spectrum using :func:`WaveVal.WaveSpectra.spectralMoment()`.</span>
+
+<span class="sd"> :return: Tm01.</span>
+<span class="sd"> """</span>
+ <span class="n">Tm01</span> <span class="o">=</span> <span class="p">(</span><span class="n">moments</span><span class="p">[</span><span class="s1">'m1'</span><span class="p">]</span><span class="o">/</span><span class="n">moments</span><span class="p">[</span><span class="s1">'m0'</span><span class="p">])</span>
+ <span class="k">return</span> <span class="n">Tm01</span></div>
+
+<div class="viewcode-block" id="zero_crossing_period"><a class="viewcode-back" href="../WaveSpectra.html#WaveSpectra.zero_crossing_period">[docs]</a><span class="k">def</span> <span class="nf">zero_crossing_period</span><span class="p">(</span><span class="n">moments</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Integrated Wave Parameter: Zero crossing period</span>
+<span class="sd"> </span>
+<span class="sd"> :param moments: Spectral moments calculated from the wave energy spectrum using :func:`WaveVal.WaveSpectra.spectralMoment()`.</span>
+<span class="sd"> </span>
+<span class="sd"> :return: Tm02.</span>
+<span class="sd"> """</span>
+ <span class="n">Tm02</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">sqrt</span><span class="p">(</span><span class="n">moments</span><span class="p">[</span><span class="s1">'m0'</span><span class="p">]</span><span class="o">/</span><span class="n">moments</span><span class="p">[</span><span class="s1">'m2'</span><span class="p">])</span>
+ <span class="k">return</span> <span class="n">Tm02</span></div>
+
+<div class="viewcode-block" id="wave_energy_period"><a class="viewcode-back" href="../WaveSpectra.html#WaveSpectra.wave_energy_period">[docs]</a><span class="k">def</span> <span class="nf">wave_energy_period</span><span class="p">(</span><span class="n">moments</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Integrated Wave Parameter: Wave energy period</span>
+<span class="sd"> </span>
+<span class="sd"> :param moments: Spectral moments calculated from the wave energy spectrum using :func:`WaveVal.WaveSpectra.spectralMoment()`.</span>
+<span class="sd"> :returns: Tm10.</span>
+<span class="sd"> """</span>
+ <span class="n">Tm10</span> <span class="o">=</span> <span class="p">(</span><span class="n">moments</span><span class="p">[</span><span class="s1">'m0'</span><span class="p">]</span><span class="o">/</span><span class="n">moments</span><span class="p">[</span><span class="s1">'m1'</span><span class="p">])</span>
+ <span class="k">return</span> <span class="n">Tm10</span></div>
+
+<div class="viewcode-block" id="spectral_period"><a class="viewcode-back" href="../WaveSpectra.html#WaveSpectra.spectral_period">[docs]</a><span class="k">def</span> <span class="nf">spectral_period</span><span class="p">(</span><span class="n">moments</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Integrated Wave Parameter: Peak spectral period</span>
+<span class="sd"> </span>
+<span class="sd"> :param moments: Spectral moments calculated from the wave energy spectrum using :func:`WaveVal.WaveSpectra.spectralMoment()`.</span>
+<span class="sd"> </span>
+<span class="sd"> :returns: Tm02.</span>
+<span class="sd"> """</span>
+ <span class="n">Tdw2</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">sqrt</span><span class="p">(</span><span class="n">moments</span><span class="p">[</span><span class="s1">'m-1'</span><span class="p">]</span><span class="o">/</span><span class="n">moments</span><span class="p">[</span><span class="s1">'m1'</span><span class="p">])</span>
+ <span class="k">return</span> <span class="n">Tdw2</span></div>
+
+<div class="viewcode-block" id="wave_steepness"><a class="viewcode-back" href="../WaveSpectra.html#WaveSpectra.wave_steepness">[docs]</a><span class="k">def</span> <span class="nf">wave_steepness</span><span class="p">(</span><span class="n">moments</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Integrated Wave Parameter: Wave steepness</span>
+<span class="sd"> </span>
+<span class="sd"> :param moments: Spectral moments calculated from the wave energy spectrum using :func:`WaveVal.WaveSpectra.spectralMoment()`.</span>
+<span class="sd"> </span>
+<span class="sd"> :returns: Tdw2.</span>
+<span class="sd"> """</span>
+ <span class="n">Hm0</span> <span class="o">=</span> <span class="n">significant_wave_height</span><span class="p">(</span><span class="n">moments</span><span class="p">)</span>
+ <span class="n">Tm01</span> <span class="o">=</span> <span class="n">mean_wave_period</span><span class="p">(</span><span class="n">moments</span><span class="p">)</span>
+ <span class="n">xi</span> <span class="o">=</span> <span class="p">(</span><span class="mf">2.0</span> <span class="o">*</span> <span class="n">np</span><span class="o">.</span><span class="n">pi</span> <span class="o">/</span> <span class="n">grav</span><span class="p">)</span> <span class="o">*</span> <span class="n">np</span><span class="o">.</span><span class="n">sqrt</span><span class="p">(</span> <span class="n">Hm0</span> <span class="o">/</span> <span class="n">np</span><span class="o">.</span><span class="n">square</span><span class="p">(</span><span class="n">Tm01</span><span class="p">)</span> <span class="p">)</span>
+ <span class="k">return</span> <span class="n">xi</span></div>
+
+<div class="viewcode-block" id="spectral_width"><a class="viewcode-back" href="../WaveSpectra.html#WaveSpectra.spectral_width">[docs]</a><span class="k">def</span> <span class="nf">spectral_width</span><span class="p">(</span><span class="n">moments</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Integrated Wave Parameter: Spectral width</span>
+<span class="sd"> </span>
+<span class="sd"> :param moments: Spectral moments calculated from the wave energy spectrum using :func:`WaveVal.WaveSpectra.spectralMoment()`.</span>
+<span class="sd"> </span>
+<span class="sd"> :returns: eps.</span>
+<span class="sd"> """</span>
+ <span class="n">num</span> <span class="o">=</span> <span class="n">moments</span><span class="p">[</span><span class="s1">'m0'</span><span class="p">]</span><span class="o">*</span><span class="n">moments</span><span class="p">[</span><span class="s1">'m4'</span><span class="p">]</span> <span class="o">-</span> <span class="n">np</span><span class="o">.</span><span class="n">square</span><span class="p">(</span><span class="n">moments</span><span class="p">[</span><span class="s1">'m2'</span><span class="p">])</span>
+ <span class="n">den</span> <span class="o">=</span> <span class="n">moments</span><span class="p">[</span><span class="s1">'m0'</span><span class="p">]</span><span class="o">*</span><span class="n">moments</span><span class="p">[</span><span class="s1">'m4'</span><span class="p">]</span>
+ <span class="n">eps</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">sqrt</span><span class="p">(</span><span class="n">num</span> <span class="o">/</span> <span class="n">den</span><span class="p">)</span>
+ <span class="k">return</span> <span class="n">eps</span></div>
+
+<div class="viewcode-block" id="spectral_narrowness"><a class="viewcode-back" href="../WaveSpectra.html#WaveSpectra.spectral_narrowness">[docs]</a><span class="k">def</span> <span class="nf">spectral_narrowness</span><span class="p">(</span><span class="n">moments</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Integrated Wave Parameter: Spectral narrowness</span>
+<span class="sd"> </span>
+<span class="sd"> :param moments: Spectral moments calculated from the wave energy spectrum using :func:`WaveVal.WaveSpectra.spectralMoment()`.</span>
+<span class="sd"> </span>
+<span class="sd"> :returns: nu.</span>
+<span class="sd"> """</span>
+ <span class="n">num</span> <span class="o">=</span> <span class="n">moments</span><span class="p">[</span><span class="s1">'m0'</span><span class="p">]</span><span class="o">*</span><span class="n">moments</span><span class="p">[</span><span class="s1">'m2'</span><span class="p">]</span> <span class="o">-</span> <span class="n">np</span><span class="o">.</span><span class="n">square</span><span class="p">(</span><span class="n">moments</span><span class="p">[</span><span class="s1">'m1'</span><span class="p">])</span>
+ <span class="n">den</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">square</span><span class="p">(</span><span class="n">moments</span><span class="p">[</span><span class="s1">'m1'</span><span class="p">])</span>
+ <span class="n">nu</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">sqrt</span><span class="p">(</span><span class="n">num</span> <span class="o">/</span> <span class="n">den</span><span class="p">)</span>
+ <span class="k">return</span> <span class="n">nu</span></div>
+
+
+<div class="viewcode-block" id="spectralMoment"><a class="viewcode-back" href="../WaveSpectra.html#WaveSpectra.spectralMoment">[docs]</a><span class="k">def</span> <span class="nf">spectralMoment</span><span class="p">(</span><span class="n">f</span><span class="p">,</span><span class="n">df</span><span class="p">,</span><span class="n">S</span><span class="p">,</span><span class="n">moment</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> :param f: frequency bin centre values</span>
+<span class="sd"> :param df: frequency bin widths</span>
+<span class="sd"> :param S: spectral energy density in frquency bins</span>
+<span class="sd"> :param moment: interger representing moment to be calculated</span>
+<span class="sd"> </span>
+<span class="sd"> :return: specMom</span>
+<span class="sd"> """</span>
+ <span class="k">if</span> <span class="n">S</span><span class="o">.</span><span class="n">ndim</span> <span class="o">></span> <span class="mi">1</span><span class="p">:</span>
+ <span class="n">specMom</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">sum</span><span class="p">(</span><span class="nb">pow</span><span class="p">(</span><span class="n">f</span><span class="p">,</span><span class="n">moment</span><span class="p">)</span><span class="o">*</span><span class="n">S</span><span class="o">*</span><span class="n">df</span><span class="p">,</span><span class="mi">1</span><span class="p">)</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">specMom</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">sum</span><span class="p">(</span><span class="nb">pow</span><span class="p">(</span><span class="n">f</span><span class="p">,</span><span class="n">moment</span><span class="p">)</span><span class="o">*</span><span class="n">S</span><span class="o">*</span><span class="n">df</span><span class="p">)</span>
+ <span class="k">return</span> <span class="n">specMom</span></div>
+
+<div class="viewcode-block" id="getSpectralMoments"><a class="viewcode-back" href="../WaveSpectra.html#WaveSpectra.getSpectralMoments">[docs]</a><span class="k">def</span> <span class="nf">getSpectralMoments</span><span class="p">(</span><span class="n">f</span><span class="p">,</span><span class="n">df</span><span class="p">,</span><span class="n">S</span><span class="p">):</span>
+ <span class="n">moments</span> <span class="o">=</span> <span class="p">{}</span>
+ <span class="n">moms</span> <span class="o">=</span> <span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">,</span><span class="mi">0</span><span class="p">,</span><span class="mi">1</span><span class="p">,</span><span class="mi">2</span><span class="p">,</span><span class="mi">4</span><span class="p">]</span>
+ <span class="k">for</span> <span class="n">mom</span> <span class="ow">in</span> <span class="n">moms</span><span class="p">:</span>
+ <span class="n">momStr</span> <span class="o">=</span> <span class="s1">'m'</span><span class="o">+</span><span class="nb">str</span><span class="p">(</span><span class="n">mom</span><span class="p">)</span>
+ <span class="n">moments</span><span class="p">[</span><span class="n">momStr</span><span class="p">]</span> <span class="o">=</span> <span class="n">spectralMoment</span><span class="p">(</span><span class="n">f</span><span class="p">,</span><span class="n">df</span><span class="p">,</span><span class="n">S</span><span class="p">,</span><span class="n">mom</span><span class="p">)</span>
+ <span class="k">return</span> <span class="n">moments</span></div>
+
+<div class="viewcode-block" id="getSpectralParameters"><a class="viewcode-back" href="../WaveSpectra.html#WaveSpectra.getSpectralParameters">[docs]</a><span class="k">def</span> <span class="nf">getSpectralParameters</span><span class="p">(</span><span class="n">moments</span><span class="p">):</span>
+ <span class="n">spec_params</span> <span class="o">=</span> <span class="p">{}</span>
+ <span class="n">spec_params</span><span class="p">[</span><span class="s1">'Hm0'</span><span class="p">]</span> <span class="o">=</span> <span class="n">significant_wave_height</span><span class="p">(</span><span class="n">moments</span><span class="p">)</span>
+ <span class="n">spec_params</span><span class="p">[</span><span class="s1">'Tm01'</span><span class="p">]</span> <span class="o">=</span> <span class="n">mean_wave_period</span><span class="p">(</span><span class="n">moments</span><span class="p">)</span>
+ <span class="n">spec_params</span><span class="p">[</span><span class="s1">'Tm02'</span><span class="p">]</span> <span class="o">=</span> <span class="n">zero_crossing_period</span><span class="p">(</span><span class="n">moments</span><span class="p">)</span>
+ <span class="n">spec_params</span><span class="p">[</span><span class="s1">'Tm10'</span><span class="p">]</span> <span class="o">=</span> <span class="n">wave_energy_period</span><span class="p">(</span><span class="n">moments</span><span class="p">)</span>
+ <span class="n">spec_params</span><span class="p">[</span><span class="s1">'Tdw2'</span><span class="p">]</span> <span class="o">=</span> <span class="n">spectral_period</span><span class="p">(</span><span class="n">moments</span><span class="p">)</span>
+ <span class="n">spec_params</span><span class="p">[</span><span class="s1">'wave_steepness'</span><span class="p">]</span> <span class="o">=</span> <span class="n">wave_steepness</span><span class="p">(</span><span class="n">moments</span><span class="p">)</span>
+ <span class="n">spec_params</span><span class="p">[</span><span class="s1">'spectral_width'</span><span class="p">]</span> <span class="o">=</span> <span class="n">spectral_width</span><span class="p">(</span><span class="n">moments</span><span class="p">)</span>
+ <span class="n">spec_params</span><span class="p">[</span><span class="s1">'spectral_narrowness'</span><span class="p">]</span> <span class="o">=</span> <span class="n">spectral_narrowness</span><span class="p">(</span><span class="n">moments</span><span class="p">)</span>
+ <span class="k">return</span> <span class="n">spec_params</span></div>
+
+
+<span class="c1"># ============== 2-D Spectra Functions ==================</span>
+<div class="viewcode-block" id="wavehgtvar"><a class="viewcode-back" href="../WaveSpectra.html#WaveSpectra.wavehgtvar">[docs]</a><span class="k">def</span> <span class="nf">wavehgtvar</span><span class="p">(</span><span class="n">freq</span><span class="p">,</span> <span class="n">df</span><span class="p">,</span> <span class="n">dt</span><span class="p">,</span> <span class="n">spec2D</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Convert 2-D wave spectrum into wave height variance map in (f,theta) space.</span>
+<span class="sd"> """</span>
+ <span class="n">nfreq</span> <span class="o">=</span> <span class="n">spec2D</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
+ <span class="n">ntheta</span> <span class="o">=</span> <span class="n">spec2D</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span>
+ <span class="n">f_arry</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">outer</span><span class="p">(</span><span class="n">freq</span><span class="p">,</span><span class="n">np</span><span class="o">.</span><span class="n">ones</span><span class="p">(</span><span class="n">ntheta</span><span class="p">,))</span>
+ <span class="n">df_arry</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">outer</span><span class="p">(</span><span class="n">df</span><span class="p">,</span><span class="n">np</span><span class="o">.</span><span class="n">ones</span><span class="p">(</span><span class="n">ntheta</span><span class="p">,))</span>
+ <span class="n">dt_arry</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">outer</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">ones</span><span class="p">(</span><span class="n">nfreq</span><span class="p">,),</span><span class="n">np</span><span class="o">.</span><span class="n">radians</span><span class="p">(</span><span class="n">dt</span><span class="p">))</span>
+ <span class="n">whv</span> <span class="o">=</span> <span class="n">spec2D</span><span class="o">*</span><span class="n">f_arry</span><span class="o">*</span><span class="n">df_arry</span><span class="o">*</span><span class="n">dt_arry</span>
+ <span class="k">return</span> <span class="n">whv</span></div>
+
+<div class="viewcode-block" id="dsfuncnorm"><a class="viewcode-back" href="../WaveSpectra.html#WaveSpectra.dsfuncnorm">[docs]</a><span class="k">def</span> <span class="nf">dsfuncnorm</span><span class="p">(</span><span class="n">freq</span><span class="p">,</span> <span class="n">df</span><span class="p">,</span> <span class="n">th1</span><span class="p">,</span> <span class="n">sth1</span><span class="p">,</span> <span class="n">ntheta</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Normalised 2-D directional spreading function</span>
+<span class="sd"> </span>
+<span class="sd"> Based on description given on NOAA `NDBC <https://www.ndbc.noaa.gov/measdes.shtml>`_ web site.</span>
+<span class="sd"> """</span>
+ <span class="n">nfreq</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="n">freq</span><span class="p">)</span> <span class="c1"># number of frequency bins</span>
+ <span class="n">dth</span> <span class="o">=</span> <span class="mf">360.0</span> <span class="o">/</span> <span class="n">ntheta</span> <span class="c1"># theta bin width</span>
+
+ <span class="c1"># Convert direction convention from meteorological to mathematical</span>
+ <span class="n">theta1</span> <span class="o">=</span> <span class="mf">270.0</span> <span class="o">-</span> <span class="n">th1</span>
+
+ <span class="n">dsFnc</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">empty</span><span class="p">((</span><span class="n">nfreq</span><span class="p">,</span> <span class="n">ntheta</span><span class="p">),</span> <span class="n">dtype</span><span class="o">=</span><span class="nb">float</span><span class="p">)</span>
+ <span class="c1"># Apply weighting define in Earle et al, 1999 to avoid -ve energy</span>
+ <span class="k">for</span> <span class="n">ith</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">ntheta</span><span class="p">):</span>
+ <span class="n">theta</span> <span class="o">=</span> <span class="n">ith</span> <span class="o">*</span> <span class="n">dth</span>
+ <span class="n">dsFnc</span><span class="p">[:,</span><span class="n">ith</span><span class="p">]</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">exp</span><span class="p">(</span><span class="o">-</span><span class="mf">0.5</span><span class="o">*</span><span class="n">np</span><span class="o">.</span><span class="n">square</span><span class="p">((</span><span class="n">np</span><span class="o">.</span><span class="n">radians</span><span class="p">(</span><span class="n">theta</span><span class="p">)</span><span class="o">-</span><span class="n">np</span><span class="o">.</span><span class="n">radians</span><span class="p">(</span><span class="n">theta1</span><span class="p">)</span><span class="o">+</span><span class="mf">2.0</span><span class="o">*</span><span class="n">np</span><span class="o">.</span><span class="n">pi</span><span class="p">)</span><span class="o">/</span><span class="n">np</span><span class="o">.</span><span class="n">radians</span><span class="p">(</span><span class="n">sth1</span><span class="p">)))</span><span class="o">/</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">sqrt</span><span class="p">(</span><span class="mf">2.0</span><span class="o">*</span><span class="n">np</span><span class="o">.</span><span class="n">pi</span><span class="p">)</span><span class="o">*</span><span class="n">np</span><span class="o">.</span><span class="n">radians</span><span class="p">(</span><span class="n">sth1</span><span class="p">))</span>
+ <span class="n">dsFnc</span><span class="p">[:,</span><span class="n">ith</span><span class="p">]</span> <span class="o">+=</span> <span class="n">np</span><span class="o">.</span><span class="n">exp</span><span class="p">(</span><span class="o">-</span><span class="mf">0.5</span><span class="o">*</span><span class="n">np</span><span class="o">.</span><span class="n">square</span><span class="p">((</span><span class="n">np</span><span class="o">.</span><span class="n">radians</span><span class="p">(</span><span class="n">theta</span><span class="p">)</span><span class="o">-</span><span class="n">np</span><span class="o">.</span><span class="n">radians</span><span class="p">(</span><span class="n">theta1</span><span class="p">))</span><span class="o">/</span><span class="n">np</span><span class="o">.</span><span class="n">radians</span><span class="p">(</span><span class="n">sth1</span><span class="p">)))</span><span class="o">/</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">sqrt</span><span class="p">(</span><span class="mf">2.0</span><span class="o">*</span><span class="n">np</span><span class="o">.</span><span class="n">pi</span><span class="p">)</span><span class="o">*</span><span class="n">np</span><span class="o">.</span><span class="n">radians</span><span class="p">(</span><span class="n">sth1</span><span class="p">))</span>
+ <span class="n">dsFnc</span><span class="p">[:,</span><span class="n">ith</span><span class="p">]</span> <span class="o">+=</span> <span class="n">np</span><span class="o">.</span><span class="n">exp</span><span class="p">(</span><span class="o">-</span><span class="mf">0.5</span><span class="o">*</span><span class="n">np</span><span class="o">.</span><span class="n">square</span><span class="p">((</span><span class="n">np</span><span class="o">.</span><span class="n">radians</span><span class="p">(</span><span class="n">theta</span><span class="p">)</span><span class="o">-</span><span class="n">np</span><span class="o">.</span><span class="n">radians</span><span class="p">(</span><span class="n">theta1</span><span class="p">)</span><span class="o">-</span><span class="mf">2.0</span><span class="o">*</span><span class="n">np</span><span class="o">.</span><span class="n">pi</span><span class="p">)</span><span class="o">/</span><span class="n">np</span><span class="o">.</span><span class="n">radians</span><span class="p">(</span><span class="n">sth1</span><span class="p">)))</span><span class="o">/</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">sqrt</span><span class="p">(</span><span class="mf">2.0</span><span class="o">*</span><span class="n">np</span><span class="o">.</span><span class="n">pi</span><span class="p">)</span><span class="o">*</span><span class="n">np</span><span class="o">.</span><span class="n">radians</span><span class="p">(</span><span class="n">sth1</span><span class="p">))</span>
+ <span class="c1"># Normalise across theta</span>
+ <span class="k">for</span> <span class="n">ifrq</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">nfreq</span><span class="p">):</span>
+ <span class="n">dsFnc</span><span class="p">[</span><span class="n">ifrq</span><span class="p">,:]</span> <span class="o">=</span> <span class="n">dsFnc</span><span class="p">[</span><span class="n">ifrq</span><span class="p">,:]</span> <span class="o">/</span> <span class="n">np</span><span class="o">.</span><span class="n">nansum</span><span class="p">(</span><span class="n">dsFnc</span><span class="p">[</span><span class="n">ifrq</span><span class="p">,:])</span>
+
+ <span class="k">return</span> <span class="n">dsFnc</span></div>
+
+
+<div class="viewcode-block" id="spec2dnorm"><a class="viewcode-back" href="../WaveSpectra.html#WaveSpectra.spec2dnorm">[docs]</a><span class="k">def</span> <span class="nf">spec2dnorm</span><span class="p">(</span><span class="n">freq</span><span class="p">,</span> <span class="n">sf</span><span class="p">,</span> <span class="n">df</span><span class="p">,</span> <span class="n">th1</span><span class="p">,</span> <span class="n">sth1</span><span class="p">,</span> <span class="n">ntheta</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Generate normlaised 2-D directional spectrum from standard parameters retrieve </span>
+<span class="sd"> from a wavebuoy.</span>
+<span class="sd"> """</span>
+ <span class="c1"># construct 2-D directional spreading function</span>
+ <span class="n">dsFnc</span> <span class="o">=</span> <span class="n">dsfuncnorm</span><span class="p">(</span><span class="n">freq</span><span class="p">,</span> <span class="n">df</span><span class="p">,</span> <span class="n">th1</span><span class="p">,</span> <span class="n">sth1</span><span class="p">,</span> <span class="n">ntheta</span><span class="p">)</span>
+ <span class="c1"># construct 2-D directional spectrum </span>
+ <span class="n">sp</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">outer</span><span class="p">(</span><span class="n">sf</span><span class="p">,</span><span class="n">np</span><span class="o">.</span><span class="n">ones</span><span class="p">(</span><span class="n">ntheta</span><span class="p">,))</span>
+ <span class="n">sp2d</span> <span class="o">=</span> <span class="n">sp</span> <span class="o">*</span> <span class="n">dsFnc</span>
+ <span class="k">return</span> <span class="n">sp2d</span><span class="p">,</span> <span class="n">dsFnc</span></div>
+
+
+<div class="viewcode-block" id="dsfunc"><a class="viewcode-back" href="../WaveSpectra.html#WaveSpectra.dsfunc">[docs]</a><span class="k">def</span> <span class="nf">dsfunc</span><span class="p">(</span><span class="n">freq</span><span class="p">,</span> <span class="n">df</span><span class="p">,</span> <span class="n">th1</span><span class="p">,</span> <span class="n">th2</span><span class="p">,</span> <span class="n">sth1</span><span class="p">,</span> <span class="n">sth2</span><span class="p">,</span> <span class="n">ntheta</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Directional spreading function</span>
+
+<span class="sd"> Based on description of `MEDS </span>
+<span class="sd"> <https://forge.ifremer.fr/plugins/mediawiki/wiki/ww3/index.php/En:buoy_data:meds>`_ </span>
+<span class="sd"> buoy data format given on the IFREMER Wiki pages.</span>
+<span class="sd"> </span>
+<span class="sd"> :param freq:</span>
+<span class="sd"> :param df:</span>
+<span class="sd"> :param th1:</span>
+<span class="sd"> :param th2:</span>
+<span class="sd"> :param sth1:</span>
+<span class="sd"> :param sth2:</span>
+<span class="sd"> :param ntheta:</span>
+<span class="sd"> </span>
+<span class="sd"> :return: dsFnc</span>
+<span class="sd"> """</span>
+ <span class="n">nfreq</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="n">freq</span><span class="p">)</span> <span class="c1"># number of frequency bins</span>
+ <span class="n">dth</span> <span class="o">=</span> <span class="mf">360.0</span> <span class="o">/</span> <span class="n">ntheta</span> <span class="c1"># theta bin width</span>
+
+ <span class="n">W1</span> <span class="o">=</span> <span class="mf">2.0</span><span class="o">/</span><span class="mf">3.0</span>
+ <span class="n">W2</span> <span class="o">=</span> <span class="mf">1.0</span><span class="o">/</span><span class="mf">6.0</span>
+ <span class="k">if</span> <span class="n">th2</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
+ <span class="n">th2</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">zeros</span><span class="p">(</span><span class="n">th1</span><span class="o">.</span><span class="n">shape</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="nb">float</span><span class="p">)</span>
+ <span class="n">sth2</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">zeros</span><span class="p">(</span><span class="n">sth1</span><span class="o">.</span><span class="n">shape</span><span class="p">,</span> <span class="n">dtype</span> <span class="o">=</span> <span class="nb">float</span><span class="p">)</span>
+ <span class="n">W1</span> <span class="o">=</span> <span class="mf">1.0</span>
+ <span class="n">W2</span> <span class="o">=</span> <span class="mf">0.0</span>
+
+ <span class="c1"># Convert direction convention from meteorological to mathematical</span>
+ <span class="n">theta1</span> <span class="o">=</span> <span class="mf">270.0</span> <span class="o">-</span> <span class="n">th1</span>
+ <span class="n">theta2</span> <span class="o">=</span> <span class="mf">270.0</span> <span class="o">-</span> <span class="n">th2</span>
+
+ <span class="c1"># Set theta2 to give minimum angular separation with theta1</span>
+ <span class="n">th2mth1</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">abs</span><span class="p">(</span><span class="n">theta2</span><span class="o">-</span><span class="n">theta1</span><span class="p">)</span>
+ <span class="n">theta2</span><span class="p">[</span><span class="n">th2mth1</span> <span class="o">></span> <span class="mf">180.</span><span class="p">]</span> <span class="o">=</span> <span class="n">theta2</span><span class="p">[</span><span class="n">th2mth1</span> <span class="o">></span> <span class="mf">180.</span><span class="p">]</span> <span class="o">+</span> <span class="mf">180.</span>
+
+ <span class="n">R1</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">abs</span><span class="p">(</span><span class="mf">1.0</span> <span class="o">-</span> <span class="mf">0.5</span><span class="o">*</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">square</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">radians</span><span class="p">(</span><span class="n">sth1</span><span class="p">))))</span>
+ <span class="n">R2</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">abs</span><span class="p">(</span><span class="mf">1.0</span> <span class="o">-</span> <span class="mf">0.5</span><span class="o">*</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">square</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">radians</span><span class="p">(</span><span class="n">sth2</span><span class="p">))))</span>
+
+ <span class="n">dsFnc</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">empty</span><span class="p">((</span><span class="n">nfreq</span><span class="p">,</span> <span class="n">ntheta</span><span class="p">),</span> <span class="n">dtype</span><span class="o">=</span><span class="nb">float</span><span class="p">)</span>
+ <span class="c1"># Apply weighting define in Earle et al, 1999 to avoid -ve energy</span>
+ <span class="k">for</span> <span class="n">ith</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">ntheta</span><span class="p">):</span>
+ <span class="n">theta</span> <span class="o">=</span> <span class="n">ith</span> <span class="o">*</span> <span class="n">dth</span>
+ <span class="c1">#dsFnc[:,ith] = ( 0.5 + R1*np.cos(np.radians(theta-theta1))</span>
+ <span class="c1"># + R2*np.cos(2.0*np.radians(theta-theta2)) ) / np.pi</span>
+ <span class="c1">#dsFnc[:,ith] = (dsFnc[:,ith]+np.abs(dsFnc[:,ith]))/2.0</span>
+ <span class="n">dsFnc</span><span class="p">[:,</span><span class="n">ith</span><span class="p">]</span> <span class="o">=</span> <span class="p">(</span> <span class="mf">0.5</span> <span class="o">+</span> <span class="n">W1</span><span class="o">*</span><span class="n">R1</span><span class="o">*</span><span class="n">np</span><span class="o">.</span><span class="n">cos</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">radians</span><span class="p">(</span><span class="n">theta</span><span class="o">-</span><span class="n">theta1</span><span class="p">))</span>
+ <span class="o">+</span> <span class="n">W2</span><span class="o">*</span><span class="n">R2</span><span class="o">*</span><span class="n">np</span><span class="o">.</span><span class="n">cos</span><span class="p">(</span><span class="mf">2.0</span><span class="o">*</span><span class="n">np</span><span class="o">.</span><span class="n">radians</span><span class="p">(</span><span class="n">theta</span><span class="o">-</span><span class="n">theta2</span><span class="p">))</span> <span class="p">)</span> <span class="o">/</span> <span class="n">np</span><span class="o">.</span><span class="n">pi</span>
+ <span class="c1"># Normalise across theta</span>
+ <span class="k">for</span> <span class="n">ifrq</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">nfreq</span><span class="p">):</span>
+ <span class="n">dsFnc</span><span class="p">[</span><span class="n">ifrq</span><span class="p">,:]</span> <span class="o">=</span> <span class="n">dsFnc</span><span class="p">[</span><span class="n">ifrq</span><span class="p">,:]</span> <span class="o">/</span> <span class="n">np</span><span class="o">.</span><span class="n">nansum</span><span class="p">(</span><span class="n">dsFnc</span><span class="p">[</span><span class="n">ifrq</span><span class="p">,:])</span>
+
+ <span class="k">return</span> <span class="n">dsFnc</span></div>
+
+<div class="viewcode-block" id="spec2d"><a class="viewcode-back" href="../WaveSpectra.html#WaveSpectra.spec2d">[docs]</a><span class="k">def</span> <span class="nf">spec2d</span><span class="p">(</span><span class="n">freq</span><span class="p">,</span> <span class="n">sf</span><span class="p">,</span> <span class="n">df</span><span class="p">,</span> <span class="n">th1</span><span class="p">,</span> <span class="n">th2</span><span class="p">,</span> <span class="n">sth1</span><span class="p">,</span> <span class="n">sth2</span><span class="p">,</span> <span class="n">ntheta</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Generate 2-D directional spectrum from standard parameters retrieve from</span>
+<span class="sd"> a wavebuoy.</span>
+<span class="sd"> """</span>
+ <span class="c1"># construct 2-D directional spreading function</span>
+ <span class="n">dsFnc</span> <span class="o">=</span> <span class="n">dsfunc</span><span class="p">(</span><span class="n">freq</span><span class="p">,</span> <span class="n">df</span><span class="p">,</span> <span class="n">th1</span><span class="p">,</span> <span class="n">th2</span><span class="p">,</span> <span class="n">sth1</span><span class="p">,</span> <span class="n">sth2</span><span class="p">,</span> <span class="n">ntheta</span><span class="p">)</span>
+ <span class="c1"># construct 2-D directional spectrum </span>
+ <span class="n">sp</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">outer</span><span class="p">(</span><span class="n">sf</span><span class="p">,</span><span class="n">np</span><span class="o">.</span><span class="n">ones</span><span class="p">(</span><span class="n">ntheta</span><span class="p">,))</span>
+ <span class="n">sp2d</span> <span class="o">=</span> <span class="n">sp</span> <span class="o">*</span> <span class="n">dsFnc</span>
+ <span class="k">return</span> <span class="n">sp2d</span><span class="p">,</span> <span class="n">dsFnc</span></div>
+
+</pre></div>
+
+ <div class="clearer"></div>
+ </div>
+ </div>
+ </div>
+ <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+ <div class="sphinxsidebarwrapper">
+<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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
+ <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="nav-item nav-item-0"><a href="../index.html">WaveVal documentation</a> »</li>
+ <li class="nav-item nav-item-1"><a href="index.html" >Module code</a> »</li>
+ <li class="nav-item nav-item-this"><a href="">WaveSpectra</a></li>
+ </ul>
+ </div>
+ <div class="footer" role="contentinfo">
+ © Copyright 2022.
+ Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 4.3.0.
+ </div>
+ </body>
+</html>
\ No newline at end of file
diff --git a/docs/_build/html/_modules/WaveStats.html b/docs/_build/html/_modules/WaveStats.html
new file mode 100644
index 0000000000000000000000000000000000000000..a3be82d3ef62acced777547f1600972ea38185e8
--- /dev/null
+++ b/docs/_build/html/_modules/WaveStats.html
@@ -0,0 +1,277 @@
+
+
+<!doctype html>
+
+<html lang="en">
+ <head>
+ <meta charset="utf-8" />
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+ <title>WaveStats — WaveVal documentation</title>
+ <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
+ <link rel="stylesheet" type="text/css" href="../_static/bizstyle.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 src="../_static/bizstyle.js"></script>
+ <link rel="author" title="About these documents" href="../about.html" />
+ <link rel="index" title="Index" href="../genindex.html" />
+ <link rel="search" title="Search" href="../search.html" />
+ <meta name="viewport" content="width=device-width,initial-scale=1.0" />
+ <!--[if lt IE 9]>
+ <script src="_static/css3-mediaqueries.js"></script>
+ <![endif]-->
+ </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="nav-item nav-item-0"><a href="../index.html">WaveVal documentation</a> »</li>
+ <li class="nav-item nav-item-1"><a href="index.html" accesskey="U">Module code</a> »</li>
+ <li class="nav-item nav-item-this"><a href="">WaveStats</a></li>
+ </ul>
+ </div>
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body" role="main">
+
+ <h1>Source code for WaveStats</h1><div class="highlight"><pre>
+<span></span><span class="c1"># -*- coding: utf-8 -*-</span>
+<span class="sd">"""</span>
+<span class="sd">This module contains functions for post-processing the validation statistics.</span>
+
+<span class="sd">:Dependencies [External]: os, scipy, numpy</span>
+<span class="sd">:Dependencies [Internal]: </span>
+
+<span class="sd">"""</span>
+<span class="c1"># ----------------------------------------------------------------------------</span>
+<span class="c1"># IMPORTS</span>
+<span class="c1"># ----------------------------------------------------------------------------</span>
+<span class="c1"># Standard Python Dependencies</span>
+<span class="kn">import</span> <span class="nn">os</span>
+<span class="c1"># Non-Standard Python Dependencies</span>
+<span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
+<span class="kn">import</span> <span class="nn">scipy.io</span> <span class="k">as</span> <span class="nn">sio</span>
+<span class="c1"># Local Module Dependencies</span>
+<span class="c1"># Other Dependencies</span>
+
+<span class="c1"># ----------------------------------------------------------------------------</span>
+<span class="c1"># GLOBAL VARIABLES</span>
+<span class="c1"># ----------------------------------------------------------------------------</span>
+<span class="n">mStr</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'JAN'</span><span class="p">,</span><span class="s1">'FEB'</span><span class="p">,</span><span class="s1">'MAR'</span><span class="p">,</span><span class="s1">'APR'</span><span class="p">,</span><span class="s1">'MAY'</span><span class="p">,</span><span class="s1">'JUN'</span><span class="p">,</span><span class="s1">'JUL'</span><span class="p">,</span><span class="s1">'AUG'</span><span class="p">,</span><span class="s1">'SEP'</span><span class="p">,</span><span class="s1">'OCT'</span><span class="p">,</span><span class="s1">'NOV'</span><span class="p">,</span><span class="s1">'DEC'</span><span class="p">]</span>
+
+<span class="c1"># ----------------------------------------------------------------------------</span>
+<span class="c1"># CLASS DEFINITIONS</span>
+<span class="c1"># ----------------------------------------------------------------------------</span>
+
+
+<span class="c1"># ----------------------------------------------------------------------------</span>
+<span class="c1"># Function Definitions</span>
+<span class="c1"># ----------------------------------------------------------------------------</span>
+<span class="c1"># Global statistics</span>
+<div class="viewcode-block" id="get_metric_stats_global"><a class="viewcode-back" href="../WaveStats.html#WaveStats.get_metric_stats_global">[docs]</a><span class="k">def</span> <span class="nf">get_metric_stats_global</span><span class="p">(</span><span class="n">dpath</span><span class="p">,</span> <span class="n">files</span><span class="p">,</span> <span class="n">metric</span><span class="p">:</span><span class="nb">str</span><span class="p">):</span>
+ <span class="n">V_glbl</span> <span class="o">=</span> <span class="mf">0.0</span>
+ <span class="n">V2_glbl</span> <span class="o">=</span> <span class="mf">0.0</span>
+
+ <span class="n">n_glbl</span> <span class="o">=</span> <span class="mi">0</span>
+ <span class="k">for</span> <span class="n">f</span> <span class="ow">in</span> <span class="n">files</span><span class="p">:</span>
+ <span class="n">stat</span> <span class="o">=</span> <span class="n">sio</span><span class="o">.</span><span class="n">loadmat</span><span class="p">(</span><span class="n">dpath</span><span class="o">+</span><span class="s1">'/'</span><span class="o">+</span><span class="n">f</span><span class="p">)</span>
+ <span class="n">mstat</span> <span class="o">=</span> <span class="n">stat</span><span class="p">[</span><span class="n">metric</span><span class="p">][</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">copy</span><span class="p">()</span>
+ <span class="n">indx</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">where</span><span class="p">(</span><span class="n">mstat</span> <span class="o">></span> <span class="mf">500.0</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span>
+ <span class="k">if</span> <span class="n">np</span><span class="o">.</span><span class="n">size</span><span class="p">(</span><span class="n">indx</span><span class="p">)</span> <span class="o">></span> <span class="mi">0</span><span class="p">:</span>
+ <span class="n">mstat</span><span class="p">[</span><span class="n">indx</span><span class="p">]</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">nan</span>
+ <span class="n">n_glbl</span> <span class="o">+=</span> <span class="n">np</span><span class="o">.</span><span class="n">sum</span><span class="p">(</span><span class="o">~</span><span class="n">np</span><span class="o">.</span><span class="n">isnan</span><span class="p">(</span><span class="n">mstat</span><span class="p">))</span>
+ <span class="n">V_glbl</span> <span class="o">+=</span> <span class="n">np</span><span class="o">.</span><span class="n">nansum</span><span class="p">(</span><span class="n">mstat</span><span class="p">)</span>
+ <span class="n">V2_glbl</span> <span class="o">+=</span> <span class="n">np</span><span class="o">.</span><span class="n">nansum</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">square</span><span class="p">(</span><span class="n">mstat</span><span class="p">))</span>
+
+ <span class="n">V_glbl</span> <span class="o">=</span> <span class="n">V_glbl</span> <span class="o">/</span> <span class="n">n_glbl</span>
+ <span class="n">sigV_glbl</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">sqrt</span><span class="p">((</span><span class="n">V2_glbl</span><span class="o">/</span><span class="n">n_glbl</span><span class="p">)</span><span class="o">-</span><span class="n">np</span><span class="o">.</span><span class="n">square</span><span class="p">(</span><span class="n">V_glbl</span><span class="p">))</span>
+
+ <span class="nb">print</span><span class="p">(</span><span class="s1">'ALL '</span><span class="o">+</span><span class="nb">str</span><span class="p">(</span><span class="n">V_glbl</span><span class="p">)</span><span class="o">+</span><span class="s1">' +/- '</span><span class="o">+</span><span class="nb">str</span><span class="p">(</span><span class="n">sigV_glbl</span><span class="p">))</span>
+ <span class="nb">print</span><span class="p">(</span><span class="s1">''</span><span class="p">)</span>
+
+ <span class="k">return</span> <span class="n">V_glbl</span><span class="p">,</span> <span class="n">sigV_glbl</span></div>
+
+
+<div class="viewcode-block" id="get_parameter_stats_global"><a class="viewcode-back" href="../WaveStats.html#WaveStats.get_parameter_stats_global">[docs]</a><span class="k">def</span> <span class="nf">get_parameter_stats_global</span><span class="p">(</span><span class="n">dpath</span><span class="p">:</span><span class="nb">str</span><span class="p">,</span> <span class="n">param</span><span class="p">:</span><span class="nb">str</span><span class="p">,</span> <span class="n">metricStr</span><span class="p">:</span><span class="nb">list</span><span class="p">):</span>
+ <span class="n">files</span> <span class="o">=</span> <span class="p">[</span><span class="n">f</span> <span class="k">for</span> <span class="n">f</span> <span class="ow">in</span> <span class="n">os</span><span class="o">.</span><span class="n">listdir</span><span class="p">(</span><span class="n">dpath</span><span class="p">)</span> <span class="k">if</span> <span class="n">f</span><span class="o">.</span><span class="n">endswith</span><span class="p">(</span><span class="n">param</span><span class="o">+</span><span class="s1">'.mat'</span><span class="p">)]</span>
+ <span class="k">for</span> <span class="n">metric</span> <span class="ow">in</span> <span class="n">metricStr</span><span class="p">:</span>
+ <span class="nb">print</span><span class="p">(</span><span class="s1">'METRIC: '</span><span class="o">+</span><span class="n">metric</span><span class="p">)</span>
+ <span class="n">V_glbl</span><span class="p">,</span> <span class="n">sigV_glbl</span> <span class="o">=</span> <span class="n">get_metric_stats_global</span><span class="p">(</span><span class="n">dpath</span><span class="p">,</span> <span class="n">files</span><span class="p">,</span> <span class="n">metric</span><span class="p">)</span>
+ <span class="k">return</span> <span class="n">V_glbl</span><span class="p">,</span> <span class="n">sigV_glbl</span></div>
+
+
+<span class="c1"># Statistics by year</span>
+<div class="viewcode-block" id="get_metric_stats_by_year"><a class="viewcode-back" href="../WaveStats.html#WaveStats.get_metric_stats_by_year">[docs]</a><span class="k">def</span> <span class="nf">get_metric_stats_by_year</span><span class="p">(</span><span class="n">dpath</span><span class="p">,</span> <span class="n">files</span><span class="p">,</span> <span class="n">metric</span><span class="p">:</span><span class="nb">str</span><span class="p">,</span> <span class="n">yr</span><span class="p">:</span><span class="nb">int</span><span class="p">):</span>
+ <span class="n">V_year</span> <span class="o">=</span> <span class="mf">0.0</span>
+ <span class="n">V2_year</span> <span class="o">=</span> <span class="mf">0.0</span>
+
+ <span class="n">V_mnth</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">zeros</span><span class="p">((</span><span class="mi">12</span><span class="p">,),</span> <span class="n">dtype</span><span class="o">=</span><span class="nb">float</span><span class="p">)</span>
+ <span class="n">V2_mnth</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">zeros</span><span class="p">((</span><span class="mi">12</span><span class="p">,),</span> <span class="n">dtype</span><span class="o">=</span><span class="nb">float</span><span class="p">)</span>
+
+ <span class="n">n_year</span> <span class="o">=</span> <span class="mi">0</span>
+ <span class="n">n_mnth</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">zeros</span><span class="p">((</span><span class="mi">12</span><span class="p">,),</span> <span class="n">dtype</span><span class="o">=</span><span class="nb">int</span><span class="p">)</span>
+ <span class="k">for</span> <span class="n">f</span> <span class="ow">in</span> <span class="n">files</span><span class="p">:</span>
+ <span class="n">stat</span> <span class="o">=</span> <span class="n">sio</span><span class="o">.</span><span class="n">loadmat</span><span class="p">(</span><span class="n">dpath</span><span class="o">+</span><span class="s1">'/'</span><span class="o">+</span><span class="n">f</span><span class="p">)</span>
+ <span class="n">indx</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">where</span><span class="p">(</span><span class="n">stat</span><span class="p">[</span><span class="s1">'YEAR'</span><span class="p">]</span> <span class="o">==</span> <span class="nb">str</span><span class="p">(</span><span class="n">yr</span><span class="p">))[</span><span class="mi">0</span><span class="p">]</span>
+ <span class="n">nrecs</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="n">stat</span><span class="p">[</span><span class="n">metric</span><span class="p">][</span><span class="mi">0</span><span class="p">][</span><span class="n">indx</span><span class="p">])</span>
+ <span class="n">mstat</span> <span class="o">=</span> <span class="n">stat</span><span class="p">[</span><span class="n">metric</span><span class="p">][</span><span class="mi">0</span><span class="p">][</span><span class="n">indx</span><span class="p">]</span><span class="o">.</span><span class="n">copy</span><span class="p">()</span>
+ <span class="n">indx</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">where</span><span class="p">(</span><span class="n">mstat</span> <span class="o">></span> <span class="mf">500.0</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span>
+ <span class="k">if</span> <span class="n">np</span><span class="o">.</span><span class="n">size</span><span class="p">(</span><span class="n">indx</span><span class="p">)</span> <span class="o">></span> <span class="mi">0</span><span class="p">:</span>
+ <span class="n">mstat</span><span class="p">[</span><span class="n">indx</span><span class="p">]</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">nan</span>
+ <span class="n">n_year</span> <span class="o">+=</span> <span class="n">np</span><span class="o">.</span><span class="n">sum</span><span class="p">(</span><span class="o">~</span><span class="n">np</span><span class="o">.</span><span class="n">isnan</span><span class="p">(</span><span class="n">mstat</span><span class="p">))</span>
+ <span class="n">V_year</span> <span class="o">+=</span> <span class="n">np</span><span class="o">.</span><span class="n">nansum</span><span class="p">(</span><span class="n">mstat</span><span class="p">)</span>
+ <span class="n">V2_year</span> <span class="o">+=</span> <span class="n">np</span><span class="o">.</span><span class="n">nansum</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">square</span><span class="p">(</span><span class="n">mstat</span><span class="p">))</span>
+ <span class="k">for</span> <span class="n">irec</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">nrecs</span><span class="p">):</span>
+ <span class="k">if</span> <span class="n">stat</span><span class="p">[</span><span class="s1">'YEAR'</span><span class="p">][</span><span class="n">irec</span><span class="p">]</span> <span class="o">==</span> <span class="nb">str</span><span class="p">(</span><span class="n">yr</span><span class="p">):</span>
+ <span class="n">midx</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">stat</span><span class="p">[</span><span class="s1">'MONTH'</span><span class="p">][</span><span class="n">irec</span><span class="p">])</span><span class="o">-</span><span class="mi">1</span>
+ <span class="n">V_mnth</span><span class="p">[</span><span class="n">midx</span><span class="p">]</span> <span class="o">+=</span> <span class="n">stat</span><span class="p">[</span><span class="n">metric</span><span class="p">][</span><span class="mi">0</span><span class="p">][</span><span class="n">irec</span><span class="p">]</span>
+ <span class="n">V2_mnth</span><span class="p">[</span><span class="n">midx</span><span class="p">]</span> <span class="o">+=</span> <span class="n">np</span><span class="o">.</span><span class="n">square</span><span class="p">(</span><span class="n">stat</span><span class="p">[</span><span class="n">metric</span><span class="p">][</span><span class="mi">0</span><span class="p">][</span><span class="n">irec</span><span class="p">])</span>
+ <span class="n">n_mnth</span><span class="p">[</span><span class="n">midx</span><span class="p">]</span> <span class="o">+=</span> <span class="mi">1</span>
+
+ <span class="n">V_year</span> <span class="o">=</span> <span class="n">V_year</span> <span class="o">/</span> <span class="n">n_year</span>
+ <span class="n">sigV_year</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">sqrt</span><span class="p">((</span><span class="n">V2_year</span><span class="o">/</span><span class="n">n_year</span><span class="p">)</span><span class="o">-</span><span class="n">np</span><span class="o">.</span><span class="n">square</span><span class="p">(</span><span class="n">V_year</span><span class="p">))</span>
+ <span class="nb">print</span><span class="p">(</span><span class="s1">'ALL '</span><span class="o">+</span><span class="nb">str</span><span class="p">(</span><span class="n">V_year</span><span class="p">)</span><span class="o">+</span><span class="s1">' +/- '</span><span class="o">+</span><span class="nb">str</span><span class="p">(</span><span class="n">sigV_year</span><span class="p">))</span>
+ <span class="nb">print</span><span class="p">(</span><span class="s1">''</span><span class="p">)</span>
+
+ <span class="n">V_mnth</span> <span class="o">=</span> <span class="n">V_mnth</span> <span class="o">/</span> <span class="n">n_mnth</span>
+ <span class="n">sigV_mnth</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">sqrt</span><span class="p">((</span><span class="n">V2_mnth</span><span class="o">/</span><span class="n">n_mnth</span><span class="p">)</span><span class="o">-</span><span class="n">np</span><span class="o">.</span><span class="n">square</span><span class="p">(</span><span class="n">V_mnth</span><span class="p">))</span>
+ <span class="k">for</span> <span class="n">im</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="mi">12</span><span class="p">):</span>
+ <span class="nb">print</span><span class="p">(</span><span class="n">mStr</span><span class="p">[</span><span class="n">im</span><span class="p">]</span><span class="o">+</span><span class="s1">' '</span><span class="o">+</span><span class="nb">str</span><span class="p">(</span><span class="n">V_mnth</span><span class="p">[</span><span class="n">im</span><span class="p">])</span><span class="o">+</span><span class="s1">' +/- '</span><span class="o">+</span><span class="nb">str</span><span class="p">(</span><span class="n">sigV_mnth</span><span class="p">[</span><span class="n">im</span><span class="p">]))</span>
+ <span class="k">return</span> <span class="n">V_year</span><span class="p">,</span> <span class="n">sigV_year</span><span class="p">,</span> <span class="n">V_mnth</span><span class="p">,</span> <span class="n">sigV_mnth</span></div>
+
+
+<div class="viewcode-block" id="get_parameter_stats_by_year"><a class="viewcode-back" href="../WaveStats.html#WaveStats.get_parameter_stats_by_year">[docs]</a><span class="k">def</span> <span class="nf">get_parameter_stats_by_year</span><span class="p">(</span><span class="n">dpath</span><span class="p">:</span><span class="nb">str</span><span class="p">,</span> <span class="n">param</span><span class="p">:</span><span class="nb">str</span><span class="p">,</span> <span class="n">metricStr</span><span class="p">:</span><span class="nb">list</span><span class="p">,</span> <span class="n">year</span><span class="p">:</span><span class="nb">int</span><span class="p">):</span>
+ <span class="n">files</span> <span class="o">=</span> <span class="p">[</span><span class="n">f</span> <span class="k">for</span> <span class="n">f</span> <span class="ow">in</span> <span class="n">os</span><span class="o">.</span><span class="n">listdir</span><span class="p">(</span><span class="n">dpath</span><span class="p">)</span> <span class="k">if</span> <span class="n">f</span><span class="o">.</span><span class="n">endswith</span><span class="p">(</span><span class="n">param</span><span class="o">+</span><span class="s1">'.mat'</span><span class="p">)]</span>
+ <span class="k">for</span> <span class="n">metric</span> <span class="ow">in</span> <span class="n">metricStr</span><span class="p">:</span>
+ <span class="nb">print</span><span class="p">(</span><span class="s1">'METRIC: '</span><span class="o">+</span><span class="n">metric</span><span class="p">)</span>
+ <span class="n">V_year</span><span class="p">,</span> <span class="n">sigV_year</span><span class="p">,</span> <span class="n">V_mnth</span><span class="p">,</span> <span class="n">sigV_mnth</span> <span class="o">=</span> <span class="n">get_metric_stats_by_year</span><span class="p">(</span><span class="n">dpath</span><span class="p">,</span> <span class="n">files</span><span class="p">,</span> <span class="n">metric</span><span class="p">,</span> <span class="n">year</span><span class="p">)</span>
+ <span class="k">return</span> <span class="n">V_year</span><span class="p">,</span> <span class="n">sigV_year</span><span class="p">,</span> <span class="n">V_mnth</span><span class="p">,</span> <span class="n">sigV_mnth</span></div>
+
+
+<span class="c1"># Statistics by buoy</span>
+<div class="viewcode-block" id="get_metric_stats_by_buoy"><a class="viewcode-back" href="../WaveStats.html#WaveStats.get_metric_stats_by_buoy">[docs]</a><span class="k">def</span> <span class="nf">get_metric_stats_by_buoy</span><span class="p">(</span><span class="n">dpath</span><span class="p">,</span> <span class="n">files</span><span class="p">,</span> <span class="n">metric</span><span class="p">:</span><span class="nb">str</span><span class="p">):</span>
+ <span class="n">metricStats</span> <span class="o">=</span> <span class="p">{}</span>
+ <span class="n">metricStats</span><span class="o">.</span><span class="n">update</span><span class="p">({</span><span class="s1">'platform'</span><span class="p">:</span> <span class="p">[]})</span>
+ <span class="n">metricStats</span><span class="o">.</span><span class="n">update</span><span class="p">({</span><span class="s1">'nyears'</span><span class="p">:</span> <span class="p">[]})</span>
+ <span class="n">metricStats</span><span class="o">.</span><span class="n">update</span><span class="p">({</span><span class="s1">'nrecs'</span><span class="p">:</span> <span class="p">[]})</span>
+ <span class="n">metricStats</span><span class="o">.</span><span class="n">update</span><span class="p">({</span><span class="s1">'min'</span><span class="p">:</span> <span class="p">[]})</span>
+ <span class="n">metricStats</span><span class="o">.</span><span class="n">update</span><span class="p">({</span><span class="s1">'max'</span><span class="p">:</span> <span class="p">[]})</span>
+ <span class="n">metricStats</span><span class="o">.</span><span class="n">update</span><span class="p">({</span><span class="s1">'mean'</span><span class="p">:</span> <span class="p">[]})</span>
+ <span class="n">metricStats</span><span class="o">.</span><span class="n">update</span><span class="p">({</span><span class="s1">'stddev'</span><span class="p">:</span> <span class="p">[]})</span>
+ <span class="k">for</span> <span class="n">f</span> <span class="ow">in</span> <span class="n">files</span><span class="p">:</span>
+ <span class="c1"># Load data from binary file</span>
+ <span class="n">pltfrm</span> <span class="o">=</span> <span class="n">f</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">'_'</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span>
+ <span class="n">stat</span> <span class="o">=</span> <span class="n">sio</span><span class="o">.</span><span class="n">loadmat</span><span class="p">(</span><span class="n">dpath</span><span class="o">+</span><span class="s1">'/'</span><span class="o">+</span><span class="n">f</span><span class="p">)</span>
+ <span class="n">nyrs</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">unique</span><span class="p">([</span><span class="nb">int</span><span class="p">(</span><span class="n">n</span><span class="p">)</span> <span class="k">for</span> <span class="n">n</span> <span class="ow">in</span> <span class="n">stat</span><span class="p">[</span><span class="s1">'YEAR'</span><span class="p">]])</span><span class="o">.</span><span class="n">tolist</span><span class="p">())</span>
+ <span class="n">mstat</span> <span class="o">=</span> <span class="n">stat</span><span class="p">[</span><span class="n">metric</span><span class="p">][</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">copy</span><span class="p">()</span>
+ <span class="c1"># Filter out missing data values</span>
+ <span class="n">indx</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">where</span><span class="p">(</span><span class="n">mstat</span> <span class="o">></span> <span class="mf">500.0</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span>
+ <span class="k">if</span> <span class="n">np</span><span class="o">.</span><span class="n">size</span><span class="p">(</span><span class="n">indx</span><span class="p">)</span> <span class="o">></span> <span class="mi">0</span><span class="p">:</span>
+ <span class="n">mstat</span><span class="p">[</span><span class="n">indx</span><span class="p">]</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">nan</span>
+ <span class="c1"># Initialise variables</span>
+ <span class="n">minV</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">nanmin</span><span class="p">(</span><span class="n">mstat</span><span class="p">)</span>
+ <span class="n">maxV</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">nanmax</span><span class="p">(</span><span class="n">mstat</span><span class="p">)</span>
+ <span class="n">avgV</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">nanmean</span><span class="p">(</span><span class="n">mstat</span><span class="p">)</span>
+ <span class="n">sigV</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">nanstd</span><span class="p">(</span><span class="n">mstat</span><span class="p">,</span> <span class="n">ddof</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span>
+ <span class="c1"># Load validation statistics</span>
+ <span class="n">metricStats</span><span class="p">[</span><span class="s1">'platform'</span><span class="p">]</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">pltfrm</span><span class="p">)</span>
+ <span class="n">metricStats</span><span class="p">[</span><span class="s1">'nyears'</span><span class="p">]</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">nyrs</span><span class="p">)</span>
+ <span class="n">metricStats</span><span class="p">[</span><span class="s1">'nrecs'</span><span class="p">]</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">sum</span><span class="p">(</span><span class="o">~</span><span class="n">np</span><span class="o">.</span><span class="n">isnan</span><span class="p">(</span><span class="n">mstat</span><span class="p">)))</span>
+ <span class="n">metricStats</span><span class="p">[</span><span class="s1">'min'</span><span class="p">]</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">minV</span><span class="p">)</span>
+ <span class="n">metricStats</span><span class="p">[</span><span class="s1">'max'</span><span class="p">]</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">maxV</span><span class="p">)</span>
+ <span class="n">metricStats</span><span class="p">[</span><span class="s1">'mean'</span><span class="p">]</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">avgV</span><span class="p">)</span>
+ <span class="n">metricStats</span><span class="p">[</span><span class="s1">'stddev'</span><span class="p">]</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">sigV</span><span class="p">)</span>
+ <span class="k">del</span> <span class="n">pltfrm</span><span class="p">,</span> <span class="n">stat</span><span class="p">,</span> <span class="n">mstat</span><span class="p">,</span> <span class="n">indx</span><span class="p">,</span>
+ <span class="k">del</span> <span class="n">minV</span><span class="p">,</span> <span class="n">maxV</span><span class="p">,</span> <span class="n">avgV</span><span class="p">,</span> <span class="n">sigV</span>
+ <span class="k">return</span> <span class="n">metricStats</span></div>
+
+
+<div class="viewcode-block" id="get_parameter_stats_by_buoy"><a class="viewcode-back" href="../WaveStats.html#WaveStats.get_parameter_stats_by_buoy">[docs]</a><span class="k">def</span> <span class="nf">get_parameter_stats_by_buoy</span><span class="p">(</span><span class="n">dpath</span><span class="p">:</span><span class="nb">str</span><span class="p">,</span> <span class="n">param</span><span class="p">:</span><span class="nb">str</span><span class="p">,</span> <span class="n">metric</span><span class="p">:</span><span class="nb">str</span><span class="p">):</span>
+ <span class="n">files</span> <span class="o">=</span> <span class="p">[</span><span class="n">f</span> <span class="k">for</span> <span class="n">f</span> <span class="ow">in</span> <span class="n">os</span><span class="o">.</span><span class="n">listdir</span><span class="p">(</span><span class="n">dpath</span><span class="p">)</span> <span class="k">if</span> <span class="n">f</span><span class="o">.</span><span class="n">endswith</span><span class="p">(</span><span class="n">param</span><span class="o">+</span><span class="s1">'.mat'</span><span class="p">)]</span>
+ <span class="n">paramStats</span> <span class="o">=</span> <span class="n">get_metric_stats_by_buoy</span><span class="p">(</span><span class="n">dpath</span><span class="p">,</span> <span class="n">files</span><span class="p">,</span> <span class="n">metric</span><span class="p">)</span>
+ <span class="k">return</span> <span class="n">paramStats</span></div>
+
+
+<div class="viewcode-block" id="test_for_failure"><a class="viewcode-back" href="../WaveStats.html#WaveStats.test_for_failure">[docs]</a><span class="k">def</span> <span class="nf">test_for_failure</span><span class="p">(</span><span class="n">meanV</span><span class="p">,</span> <span class="n">metric</span><span class="p">:</span><span class="nb">str</span><span class="p">):</span>
+ <span class="n">v</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">abs</span><span class="p">(</span><span class="n">meanV</span><span class="p">)</span>
+ <span class="n">fail</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">zeros</span><span class="p">((</span><span class="nb">len</span><span class="p">(</span><span class="n">v</span><span class="p">),))</span>
+ <span class="k">if</span> <span class="n">metric</span> <span class="o">==</span> <span class="s1">'R'</span><span class="p">:</span>
+ <span class="n">fail</span><span class="p">[</span><span class="n">v</span> <span class="o"><</span> <span class="mf">0.7</span><span class="p">]</span> <span class="o">=</span> <span class="mi">1</span>
+ <span class="k">elif</span> <span class="n">metric</span> <span class="o">==</span> <span class="s1">'NMB'</span><span class="p">:</span>
+ <span class="n">fail</span><span class="p">[</span><span class="n">v</span> <span class="o">></span> <span class="mf">20.0</span><span class="p">]</span> <span class="o">=</span> <span class="mi">1</span>
+ <span class="k">elif</span> <span class="n">metric</span> <span class="o">==</span> <span class="s1">'NMAE'</span><span class="p">:</span>
+ <span class="n">fail</span><span class="p">[</span><span class="n">v</span> <span class="o">></span> <span class="mf">20.0</span><span class="p">]</span> <span class="o">=</span> <span class="mi">1</span>
+ <span class="k">elif</span> <span class="n">metric</span> <span class="o">==</span> <span class="s1">'NRMSE'</span><span class="p">:</span>
+ <span class="n">fail</span><span class="p">[</span><span class="n">v</span> <span class="o">></span> <span class="mf">20.0</span><span class="p">]</span> <span class="o">=</span> <span class="mi">1</span>
+ <span class="k">elif</span> <span class="n">metric</span> <span class="o">==</span> <span class="s1">'SI'</span><span class="p">:</span>
+ <span class="n">fail</span><span class="p">[</span><span class="n">v</span> <span class="o">></span> <span class="mf">30.0</span><span class="p">]</span> <span class="o">=</span> <span class="mi">1</span>
+ <span class="k">return</span> <span class="n">fail</span></div>
+
+
+<div class="viewcode-block" id="get_buoy_locations"><a class="viewcode-back" href="../WaveStats.html#WaveStats.get_buoy_locations">[docs]</a><span class="k">def</span> <span class="nf">get_buoy_locations</span><span class="p">(</span><span class="n">records</span><span class="p">):</span>
+ <span class="n">buoylocs</span> <span class="o">=</span> <span class="p">{}</span>
+ <span class="n">buoylocs</span><span class="o">.</span><span class="n">update</span><span class="p">({</span><span class="s1">'rscdfile'</span><span class="p">:</span> <span class="p">[]})</span>
+ <span class="n">buoylocs</span><span class="o">.</span><span class="n">update</span><span class="p">({</span><span class="s1">'buoyfile'</span><span class="p">:</span> <span class="p">[]})</span>
+ <span class="n">buoylocs</span><span class="o">.</span><span class="n">update</span><span class="p">({</span><span class="s1">'platform'</span><span class="p">:</span> <span class="p">[]})</span>
+ <span class="n">buoylocs</span><span class="o">.</span><span class="n">update</span><span class="p">({</span><span class="s1">'latitude'</span><span class="p">:</span> <span class="p">[]})</span>
+ <span class="n">buoylocs</span><span class="o">.</span><span class="n">update</span><span class="p">({</span><span class="s1">'longitude'</span><span class="p">:</span> <span class="p">[]})</span>
+ <span class="k">for</span> <span class="n">rec</span> <span class="ow">in</span> <span class="n">records</span><span class="p">:</span>
+ <span class="n">buoylocs</span><span class="p">[</span><span class="s1">'rscdfile'</span><span class="p">]</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">rec</span><span class="p">[</span><span class="mi">1</span><span class="p">])</span>
+ <span class="n">buoylocs</span><span class="p">[</span><span class="s1">'buoyfile'</span><span class="p">]</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">rec</span><span class="p">[</span><span class="mi">3</span><span class="p">])</span>
+ <span class="n">buoylocs</span><span class="p">[</span><span class="s1">'platform'</span><span class="p">]</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">rec</span><span class="p">[</span><span class="mi">8</span><span class="p">])</span>
+ <span class="n">buoylocs</span><span class="p">[</span><span class="s1">'latitude'</span><span class="p">]</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">rec</span><span class="p">[</span><span class="mi">9</span><span class="p">])</span>
+ <span class="n">buoylocs</span><span class="p">[</span><span class="s1">'longitude'</span><span class="p">]</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">rec</span><span class="p">[</span><span class="mi">10</span><span class="p">])</span>
+ <span class="k">return</span> <span class="n">buoylocs</span></div>
+
+
+</pre></div>
+
+ <div class="clearer"></div>
+ </div>
+ </div>
+ </div>
+ <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+ <div class="sphinxsidebarwrapper">
+<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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
+ <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="nav-item nav-item-0"><a href="../index.html">WaveVal documentation</a> »</li>
+ <li class="nav-item nav-item-1"><a href="index.html" >Module code</a> »</li>
+ <li class="nav-item nav-item-this"><a href="">WaveStats</a></li>
+ </ul>
+ </div>
+ <div class="footer" role="contentinfo">
+ © Copyright 2022.
+ Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 4.3.0.
+ </div>
+ </body>
+</html>
\ No newline at end of file
diff --git a/docs/_build/html/_modules/index.html b/docs/_build/html/_modules/index.html
new file mode 100644
index 0000000000000000000000000000000000000000..6229ca60dfbad80341f3e727a88444cf5aeb5537
--- /dev/null
+++ b/docs/_build/html/_modules/index.html
@@ -0,0 +1,96 @@
+
+
+<!doctype html>
+
+<html lang="en">
+ <head>
+ <meta charset="utf-8" />
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+ <title>Overview: module code — WaveVal documentation</title>
+ <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
+ <link rel="stylesheet" type="text/css" href="../_static/bizstyle.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 src="../_static/bizstyle.js"></script>
+ <link rel="author" title="About these documents" href="../about.html" />
+ <link rel="index" title="Index" href="../genindex.html" />
+ <link rel="search" title="Search" href="../search.html" />
+ <meta name="viewport" content="width=device-width,initial-scale=1.0" />
+ <!--[if lt IE 9]>
+ <script src="_static/css3-mediaqueries.js"></script>
+ <![endif]-->
+ </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="nav-item nav-item-0"><a href="../index.html">WaveVal documentation</a> »</li>
+ <li class="nav-item nav-item-this"><a href="">Overview: module code</a></li>
+ </ul>
+ </div>
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body" role="main">
+
+ <h1>All modules for which code is available</h1>
+<ul><li><a href="DataFormats.html">DataFormats</a></li>
+<li><a href="Geometry.html">Geometry</a></li>
+<li><a href="Graphics.html">Graphics</a></li>
+<li><a href="MatchUpDatabase.html">MatchUpDatabase</a></li>
+<li><a href="ModelData.html">ModelData</a></li>
+<li><a href="ObsData.html">ObsData</a></li>
+<li><a href="TimeFuncs.html">TimeFuncs</a></li>
+<li><a href="Validation.html">Validation</a></li>
+<li><a href="WaveSpectra.html">WaveSpectra</a></li>
+<li><a href="WaveStats.html">WaveStats</a></li>
+</ul>
+
+ <div class="clearer"></div>
+ </div>
+ </div>
+ </div>
+ <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+ <div class="sphinxsidebarwrapper">
+<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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
+ <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="nav-item nav-item-0"><a href="../index.html">WaveVal documentation</a> »</li>
+ <li class="nav-item nav-item-this"><a href="">Overview: module code</a></li>
+ </ul>
+ </div>
+ <div class="footer" role="contentinfo">
+ © Copyright 2022.
+ Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 4.3.0.
+ </div>
+ </body>
+</html>
\ No newline at end of file
diff --git a/docs/_build/html/_sources/DataFormats.rst.txt b/docs/_build/html/_sources/DataFormats.rst.txt
new file mode 100644
index 0000000000000000000000000000000000000000..30a15ba97085c6abe521de73fa5465cf7ee3506c
--- /dev/null
+++ b/docs/_build/html/_sources/DataFormats.rst.txt
@@ -0,0 +1,7 @@
+DataFormats
+===========
+
+.. automodule:: DataFormats
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/_build/html/_sources/Geometry.rst.txt b/docs/_build/html/_sources/Geometry.rst.txt
new file mode 100644
index 0000000000000000000000000000000000000000..e959c44d27a044c227b934fc0b7967aa487a7472
--- /dev/null
+++ b/docs/_build/html/_sources/Geometry.rst.txt
@@ -0,0 +1,7 @@
+Geometry
+========
+
+.. automodule:: Geometry
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/_build/html/_sources/Graphics.rst.txt b/docs/_build/html/_sources/Graphics.rst.txt
new file mode 100644
index 0000000000000000000000000000000000000000..d9414a064ddd08cfbf7f5c4c3aacf86782b23160
--- /dev/null
+++ b/docs/_build/html/_sources/Graphics.rst.txt
@@ -0,0 +1,7 @@
+Graphics
+========
+
+.. automodule:: Graphics
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/_build/html/_sources/MatchUpDatabase.rst.txt b/docs/_build/html/_sources/MatchUpDatabase.rst.txt
new file mode 100644
index 0000000000000000000000000000000000000000..27d9d7d8bc41cebe1d3f1fdda16fe898d31baf3f
--- /dev/null
+++ b/docs/_build/html/_sources/MatchUpDatabase.rst.txt
@@ -0,0 +1,7 @@
+MatchUpDatabase
+===============
+
+.. automodule:: MatchUpDatabase
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/_build/html/_sources/ModelData.rst.txt b/docs/_build/html/_sources/ModelData.rst.txt
new file mode 100644
index 0000000000000000000000000000000000000000..0ff8722e0533ed596f180e2ff95d121510603c58
--- /dev/null
+++ b/docs/_build/html/_sources/ModelData.rst.txt
@@ -0,0 +1,7 @@
+ModelData
+=========
+
+.. automodule:: ModelData
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/_build/html/_sources/ObsData.rst.txt b/docs/_build/html/_sources/ObsData.rst.txt
new file mode 100644
index 0000000000000000000000000000000000000000..46c0efa56491e46311a906bb212f15ff84914dd0
--- /dev/null
+++ b/docs/_build/html/_sources/ObsData.rst.txt
@@ -0,0 +1,7 @@
+ObsData
+=======
+
+.. automodule:: ObsData
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/_build/html/_sources/TimeFuncs.rst.txt b/docs/_build/html/_sources/TimeFuncs.rst.txt
new file mode 100644
index 0000000000000000000000000000000000000000..bf42e8fcd5a68f22f1c2adc49a393863684a4b62
--- /dev/null
+++ b/docs/_build/html/_sources/TimeFuncs.rst.txt
@@ -0,0 +1,7 @@
+TimeFuncs
+=========
+
+.. automodule:: TimeFuncs
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/_build/html/_sources/Validation.rst.txt b/docs/_build/html/_sources/Validation.rst.txt
new file mode 100644
index 0000000000000000000000000000000000000000..57ba1747c9c4a50e769c197ccfeefb6ba42f545b
--- /dev/null
+++ b/docs/_build/html/_sources/Validation.rst.txt
@@ -0,0 +1,7 @@
+Validation
+==========
+
+.. automodule:: Validation
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/_build/html/_sources/WaveSpectra.rst.txt b/docs/_build/html/_sources/WaveSpectra.rst.txt
new file mode 100644
index 0000000000000000000000000000000000000000..3d9bafc98ee5d126a34f47e0cbdf786b7e39084f
--- /dev/null
+++ b/docs/_build/html/_sources/WaveSpectra.rst.txt
@@ -0,0 +1,7 @@
+WaveSpectra
+===========
+
+.. automodule:: WaveSpectra
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/_build/html/_sources/WaveStats.rst.txt b/docs/_build/html/_sources/WaveStats.rst.txt
new file mode 100644
index 0000000000000000000000000000000000000000..a8e3cf410cb7650b589803eb9a2ca413480810fd
--- /dev/null
+++ b/docs/_build/html/_sources/WaveStats.rst.txt
@@ -0,0 +1,7 @@
+WaveStats
+=========
+
+.. automodule:: WaveStats
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/_build/html/_sources/about.rst.txt b/docs/_build/html/_sources/about.rst.txt
new file mode 100644
index 0000000000000000000000000000000000000000..f4c283ce3a873eb2faef8f362df8dbf365a060bd
--- /dev/null
+++ b/docs/_build/html/_sources/about.rst.txt
@@ -0,0 +1,44 @@
+.. _aboutwaveval:
+
+About WaveVal
+=============
+
+The general motivation for this package is the validation of numerical wave simulation models against observed *in situ*
+wavebuoy measurements. The focus is on standard integrated wave parameters that are generated from spectral moments.
+Data readers have been constructed for records archived in the netCDF4 format following published format conventions. A
+generic netCDF class is included to allow the development of readers for data archived using different data conventions.
+The validataion process has been modularised to allow the automated validation of a long-term hindcast model archive
+against a large set of buoy data across the model domain. Methods for matching the model data extracts to the a specific
+buoy record are include. The data matching requires suffcient information in the model extracts to link a given extract
+record to a specific buoy location.
+
+The WaveVal code is developed and maintained by the IES, School of Engineering, at The University of Edinburgh, UK.
+
+Licence
+#######
+
+© 2022. University of Edinburgh. All rights reserved. This software was produced for The University of Edinburgh under the
+OCEANERA-NET COFUND ResourceCode project (EC/GA #731200), funded by Scottish Enterprise. All rights in the software are
+reserved by the University of Edinburgh. The University of Edinburgh is granted, for itself and others acting on its behalf,
+a nonexclusive, paid-up, irrevocable worldwide licence in this material to reproduce, prepare derivative works, distribute
+copies to the public, perform publicly and display publicly, and to permit others to do so.
+
+This software is open source under the BSD-3 Licence. Redistribution and use in source and binary forms, with or without
+modification, is permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following
+ disclaimer.
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following
+ disclaimer in the documentation and/or other materials provided with the distribution.
+3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote
+ products derived from this software without specific prior written permission.
+
+**Disclaimer**
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
+INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
+ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
\ No newline at end of file
diff --git a/docs/_build/html/_sources/automate.rst.txt b/docs/_build/html/_sources/automate.rst.txt
new file mode 100644
index 0000000000000000000000000000000000000000..55c7b549a6291b6b636fcf6284d9a237258ed0a6
--- /dev/null
+++ b/docs/_build/html/_sources/automate.rst.txt
@@ -0,0 +1,274 @@
+.. _batch:
+
+Batch Processing - (IFREMER Datarmor HPC)
+=========================================
+
+The `ResourceCode`_ hindcast archive has been developed using the `IFREMER`_ `Datarmor`_ HPC services.
+The hindcast data set was validated using the `WaveVal`_ tools implemented on Datarmor. This page
+provides information on how to set up and run the `WaveVal`_ tools on Datarmor, and how to generate
+and run a set of PBS batch jobs to automate the validation process. To use the Datarmor HPC service
+the user requires an IFREMER intranet login account, and an extranet login to remotely access the
+services.
+
+Useful information on using the Datarmor services can be found at
+`<https://m.davidmkaplan.fr/cluster/cluster-use-instructions.html>`_.
+
+The methods described here should port to any HPC systems that supports the python anaconda environment and
+runs a PBS job submission service.
+
+
+.. _ResourceCode: https://resourcecode.ifremer.fr/
+.. _WaveVal: https://git.ecdf.ed.ac.uk/uoe-ies-open-tools/waveval
+.. _IFREMER: https://wwz-ifremer-fr.translate.goog/L-institut?_x_tr_sl=fr&_x_tr_tl=en&_x_tr_hl=en&_x_tr_pto=sc
+.. _Datarmor: https://wwz-ifremer-fr.translate.goog/Recherche/Infrastructures-de-recherche/Infrastructures-numeriques/Pole-de-Calcul-et-de-Donnees-pour-la-Mer?_x_tr_sl=fr&_x_tr_tl=en&_x_tr_hl=en&_x_tr_pto=sc
+
+Setup conda environment
+#######################
+
+Access to Datarmor is via login node. On this node the user enters a bash shell by default. The anaconda
+python interface is accessed by changing to a conda shell using:
+
+.. code-block:: bash
+
+ $ source /appli/anaconda/latest/etc/profile.d/conda.csh
+
+Then the local conda runtime configuration file ( ~/.condarc ) needs to be created containg the following lines:
+
+.. code-block:: bash
+ :caption: .condarc
+
+ envs_dirs:
+ - $DATAWORK/conda-env
+ - /appli/conda-env
+ - /appli/conda-env/2.7
+ - /appli/conda-env/3.6
+ pkgs_dirs:
+ - $DATAWORK/conda/pkgs
+
+This file needs to be in the root of the users home directory. It can be created using any suitable text
+editor (*e.g.* vi, nano, *etc.*).
+
+Once the ~/.condarc file exists, a conda enviroment can be created including the python packages required
+to run the validation tools. For the ResourceCode hindcast validation the conda environment ``buoyvalid`` was created
+using the command:
+
+.. code-block:: bash
+
+ $ conda create --name buoyvalid
+
+where the option --name is used to set the name of the conda enviroment created.
+
+To check that the conda environment was generated use the command:
+
+.. code-block:: bash
+
+ $ conda info --envs
+
+The required python packages can be added to the ``buoyvalid`` conda environment as follows:
+
+.. code-block:: bash
+
+ $ conda install --name buoyvalid numpy
+ $ conda install --name buoyvalid netCDF4
+ $ conda install --name buoyvalid astropy
+ $ conda install --name buoyvalid matplotlib
+ $ conda install --name buoyvalid cartopy
+ $ conda install --name buoyvalid spyder
+ $ conda config --add channels conda-forge
+ $ conda install --name buoyvalid cartopy_offlinedata
+
+To use the conda environment it needs to be activated using the command:
+
+.. code-block:: bash
+
+ $ conda activate buoyvalid
+
+Similarly, to close the conda environment use the command:
+
+.. code-block:: bash
+
+ $ conda deactivate
+
+Construct validation process scripts
+####################################
+
+.. _CMEMS: https://marine.copernicus.eu/
+.. _InSituTAC: http://www.marineinsitu.eu/dashboard/
+
+The processing script needs to be constructed in such a way that it can be called from a PBS batch
+job script and option parameters can be passed to control how what the process does. The script
+``datarmor_insitutac_validate.py`` was used to process the ResourceCode hindcast data set against the
+`CMEMS`_ `InsituTAC`_ wavebuoy data archive. The main function is called when this python script is run,
+and the optinal parameters are parsed prior to calling the validation process. This script is designed
+to process a single wavebuoy location, the information about the buoy is taken from a record in a CSV
+file that provides a full set of unique model/wavebuoy data matches for a specific year and month,
+*i.e.* each record in the CSV file corresponds to a unique wavebuoy.
+
+.. literalinclude:: ../examples/datarmor_insitutac_validate.py
+ :lines: 1-12
+ :caption: datarmor_insitutac_validate.py
+
+The header of the script sets the shebang line to idenfiy the program required to run the script, and
+imports the required modules and module functions.
+
+The first part of the main function parses the user input options used to control the process.
+There are three required parameters:
+
+ +---------------+-------------------------------------------------------------------------------------+
+ | Option | Description |
+ +===============+=====================================================================================+
+ | -p, -\-path | Path for validation results output |
+ +---------------+-------------------------------------------------------------------------------------+
+ | -f, -\-file | CSV file of dat match records, **this must be in the directory defined by -\-path** |
+ +---------------+-------------------------------------------------------------------------------------+
+ | -n, -\-recnum | Record number in the CSV file to process |
+ +---------------+-------------------------------------------------------------------------------------+
+
+
+and three optional parameters:
+
+ +--------------+----------------------------+---------+
+ | Option | Description | Default |
+ +==============+============================+=========+
+ | -\-minYear | Minimum year to process | 1994 |
+ +--------------+----------------------------+---------+
+ | -\-maxYear | Maximum year to process | 2019 |
+ +--------------+----------------------------+---------+
+ | -\-genPlots | Generate plots flag | False |
+ +--------------+----------------------------+---------+
+
+.. note::
+ The minimum year **must not be less than** the first year in the model hindcast archive, and the
+ maximum year **must not be greater than** the last year in the model hindcast archive.
+
+.. literalinclude:: ../examples/datarmor_insitutac_validate.py
+ :lines: 13-51
+
+Once the input parameters are parsed, the input record list CSV file is converted to a list of tuples
+for processing by the :ref:`Validation` module, the requested year range is set, and the wave data
+format defined.
+
+.. literalinclude:: ../examples/datarmor_insitutac_validate.py
+ :lines: 52-66
+
+Next the wave parameters to be processed are select using an index list based on the following values:
+
+ +--------+---------------------------------------+
+ | Index | Integrated Wave Parameter |
+ +========+=======================================+
+ | 0 | Hm0 - Significant wave height |
+ +--------+---------------------------------------+
+ | 1 | Tp - Peak wave period |
+ +--------+---------------------------------------+
+ | 2 | Tm02 - Mean zero-crossing wave period |
+ +--------+---------------------------------------+
+ | 3 | Dir - Peak wave direction |
+ +--------+---------------------------------------+
+ | 4 | Spr - Peak wave directional spreading |
+ +--------+---------------------------------------+
+
+Each integrated wave parameter is processed separately, so the selected parameters are processed in a loop.
+
+.. literalinclude:: ../examples/datarmor_insitutac_validate.py
+ :lines: 67-83
+
+The selected wave parameters then need to be mapped to the corresponding netCDF variable names within
+the model and wavebuoy data files. The model variable name is set in the variable ``mVarName`` and takes a single string value, the wavebuoy variable names are set in the list variable ``varOptions``. There are a range of similar wave parameters in the buoy data that could be used in place of the preferred variables, the list allows these to be used if the preferred is not available.
+
+.. note::
+ It is recommended that the user only take the preferred wavebuoy variables for validation purposes.
+ [VHM0, VTPK, VTM02, VPED, VPSP].
+
+ The WaveWatch III model ouputs peak and zero-crossing frequencies, these are converted to periods
+ during the record processing stage.
+
+.. literalinclude:: ../examples/datarmor_insitutac_validate.py
+ :lines: 84-100
+
+The final steps are to calculate the validation statistics by calling :py:func:`Validation.validate_records`. This returns
+a count of the number of validations returned (``n_valid``) and a dictionary structure (``valid_stats``) containing the
+validation results. If there is at least one validation result, then the results are saved to both an ASCII and a binary
+file for post-procesing. A separate record is produced for each integrated wave parameter for the current wavebuoy being
+processed.
+
+.. literalinclude:: ../examples/datarmor_insitutac_validate.py
+ :lines: 101-115
+
+The interface section allows the script to be run from the command line or to be called from within another script. This feature is used to automate the processing of a large number of wavebuoy locations using the methods described in the following section.
+
+.. literalinclude:: ../examples/datarmor_insitutac_validate.py
+ :lines: 116-120
+
+To run the script from the command line use:
+
+.. code-block:: bash
+
+ $ python3 datarmor_insitutac_validate.py -p path/to/output/directory -f records_file.csv -n record_nmber
+
+e.g.
+
+.. code-block:: bash
+
+ $ python3 datarmor_insitutac_validate.py -p ../data/VALIDATION/RSCD_v3 -f validation_site.csv -n 9
+
+will write the output to the absolute directory ``../data/VALIDATION/RSCD_v3``, the input file containing the list of
+unique model/observation matches is ``validation_sites.csv``, and record number 9 is to be processed (it must be
+remembered that python counts from 0 not 1, *i.e.* -n 0 processes the first record in the file, -n 9 processes the
+10 :superscript:`th` record in the file).
+
+.. note::
+ For this script to be callable from another function its permissions need to be set to executable,
+ *e.g.* apply ``chmod a+x datarmor_insitutac_validate.py`` to the script.
+
+Generate PBS job scripts and submit to queue
+############################################
+
+To run the ``datarmor_insitutac_validate.py`` processing script on a Datarmor processing node it needs to be submitted
+to the job queue using a qsub call. The ``datarmor_insitutac_validate.py`` needs to be run in an anaconda shell environment, so this needs to be set up in the script submitted by the qsub call. Within the script the compute node
+resources need to be requested (*i.e.* the amount of memory required and the time required to run the process). It should be noted that if insufficient resources or walltime are requested the job will end without completion, so it pays to over-estimate the resource requirements, to avoid needing to rerun a process.
+
+To automate the processing of a large number of wavebuoys, a separate PBS script is required. The approcach taken to
+facillitate this is to define a base PBD script that contains the common components, and can be modified to provide the specific information for each job.
+
+The following PBS job script (``base_insitutac.pbs``) was used as the basis for generating the individual job submissions:
+
+.. literalinclude:: ../examples/base_insitutac.pbs
+ :linenos:
+ :caption: base_insitutac.pbs
+
+Line 1 sets the shell environment, lines 3 and 4 request the compute node resources, line 6 changes to a conda shell,
+line 7 activates the conda environment ``buoyvalid`` (as described above), line 8 changes to the location of the python
+scripts on the users datawork space, and line 9 gives the common components of the call to run the
+``datarmor_insitutac_validate.py`` script. Line 9 is missing the required -n input option, so this will return an error
+if submitted as is. The following script used to generate the PBS jobs adds the required record number to the call.
+
+.. note::
+
+ The conda environment **buoyvalid** needs to be replaced with the environment you have set up.
+
+ You must replace **USER** must be with your user name, **pycode** with the location of your python scripts,
+ **VALIDATION/RSCD_v3** with the location you want the results to be output too, and **validation_sites.csv** with the
+ name of the CSV file used for input.
+
+ The output directory must exist, and the records CSV file must exist in the output directory.
+
+The script ``generate_validation_batch_jobs.py`` is used to generate and submit a PBS job for records in the CSV matched
+data records file. The default PBS script ``base_insitutac.pbs``, described above, is modified to match the record being
+processed. It is assumed that each record in the CSV file represents a unique wavebuoy, the data processing script called
+generates the set of separate year/month records required for processing a given buoy.
+
+The only line in ``base_insitutac.pbs`` that needs to be modified is the last line which calls python processing script;
+the record number to be processed is added as in input option to the call. A new PBS job script is generated with the record number appended, then submitted to the job queue using the ``qsub`` command.
+
+A subset of the records can be processed by setting the ``start_rec`` and ``num_recs`` values in this script before running it. The ``num_recs`` must not be greater than the number of records in the CSV file. This feature can be used to re-run processes that failed.
+
+.. literalinclude:: ../examples/generate_validation_batch_jobs.py
+ :linenos:
+ :caption: generate_validation_batch_jobs.py
+
+Post-process validation results
+###############################
+
+.. literalinclude:: ../examples/process_insitutac_stats.py
+ :linenos:
+ :caption: process_insitutac_stats.py
diff --git a/docs/_build/html/_sources/data_access.rst.txt b/docs/_build/html/_sources/data_access.rst.txt
new file mode 100644
index 0000000000000000000000000000000000000000..7d2aa556f0ea903804ea9a64c5c809b30a327c04
--- /dev/null
+++ b/docs/_build/html/_sources/data_access.rst.txt
@@ -0,0 +1,11 @@
+External data archives
+======================
+
+`CMEMS`_ - Copernicus Marine Service
+########################################
+
+CMEMS data can be obtained from http://www.marineinsitu.eu/dashboard/.
+You have to register before the data can be download,
+see http://www.marineinsitu.eu/access-data/ for details on registration.
+
+.. _CMEMS: https://marine.copernicus.eu/
\ No newline at end of file
diff --git a/docs/_build/html/_sources/examples.rst.txt b/docs/_build/html/_sources/examples.rst.txt
new file mode 100644
index 0000000000000000000000000000000000000000..fec353e123826b96697fe518659c4d335463d860
--- /dev/null
+++ b/docs/_build/html/_sources/examples.rst.txt
@@ -0,0 +1,45 @@
+Examples
+========
+
+Current example code is located on GitLab: `WaveVal examples`_.
+
+.. _WaveVal examples: https://git.ecdf.ed.ac.uk/uoe-ies-open-tools/WaveVal/tree/main/examples
+
+The example scripts demonstrate how the `WaveVal`_ tools can be used to process a set of `ResourceCode`_ hindcast model
+data extracts against `CMEMS InSituTAC`_ wavebuoy data. The data for these example cases are included in the ``./examples/data`` subdirectory. The model extract data are in ``./data/RSCD_HINDCAST/2017`` and the corresponding wavebuoy
+data are in the ``./data/INSITU_GLO_WAVE/MO`` subdirectory. For ``Example 1`` and ``Example 2`` the 1-D frequency spectra
+data store in the ``/FREQ_NC`` subdirectory within each month directories (*e.g.* ``./data/RSCD_HINDCAST/2017/01/FREQ_NC``
+contains the 1-D spectral data for January 2017).
+
+``Example 1`` shows how to create a matchup database for a set of model and wavebuoy records and how to convert the
+database records to a CSV file that can be used by the :ref:`Validation` module.
+
+``Example 2`` shows how to generate validation statistics for the records in a CSV input file. This example uses the output
+from Example 1, but the corresponding file is included in the ``./data/MATCHUPDB`` subdirectory.
+
+.. note::
+
+ The example scripts use absolute paths, so the examples must be run from within the ``./examples`` subdirectory.
+
+.. _WaveVal: https://git.ecdf.ed.ac.uk/uoe-ies-open-tools/rcode_tools
+.. _ResourceCode: https://resourcecode.ifremer.fr/
+.. _CMEMS InSituTAC: http://www.marineinsitu.eu/dashboard/
+
+Example 1: Create a matchup database
+####################################
+
+.. literalinclude:: ../examples/rscd_tools_example_01_matchupdb.py
+ :linenos:
+ :caption: rscd_tools_example_01_matchupdb.py
+
+Example 2: Calculate validation parameters
+##########################################
+
+.. literalinclude:: ../examples/rscd_tools_example_02_validate.py
+ :linenos:
+ :caption: rscd_tools_example_02_validate.py
+
+
+
+
+
diff --git a/docs/_build/html/_sources/formats.rst.txt b/docs/_build/html/_sources/formats.rst.txt
new file mode 100644
index 0000000000000000000000000000000000000000..658c443bf7cec5e15b64c5caec3ea870223ac1f6
--- /dev/null
+++ b/docs/_build/html/_sources/formats.rst.txt
@@ -0,0 +1,132 @@
+.. _formats:
+
+WaveVal internal data formats
+=============================
+
+The :ref:`Validation` module uses set predefined file and data formats for data input, passing, and output.
+The user input matched data records is in the form of a comma delimited CSV file, this is converted to a list
+of tuples for passing to the :ref:`Validation` process records function. Internally the validataion data are
+stored in a simple dictionary, and the data are returned in this format from the :ref:`Validation` process.
+The pre-processed time series data for a matched data pair are saved as a Matlab v4 binary file; beyond
+Matlab7.2 the data format converted to HDF5. The rationale for using a Matlab format was that Matlab is still
+widely used for data processing, but the formatted data can be easily imported into python using the
+`scipy.io.loadmat`_ function.
+
+.. _scipy.io.loadmat: https://docs.scipy.org/doc/scipy/reference/generated/scipy.io.loadmat.html
+
+Matched data records CSV format
+###############################
+
+The default input format for a set of model/observation data matches is a comma delimited CSV ASCII file.
+Each row in the CSV file represents a matched pair for a particular year and month; this year/month data
+fragmentation corresponds to the storage fragmentation used for archiving the ResourceCode hindcast data.
+
+The columns of each row contain:
+
+ #. Path to the directory containing the model extract data records
+ #. Model extract data file name
+ #. Path to the directory containing the observation data records
+ #. Observation data file name
+ #. Year to be processed
+ #. Month to be processed
+ #. Start date and time of observational data (space separated data and time)
+ #. End data and time of observational data (space separated data and time)
+ #. Platform name string
+ #. Platform latitude
+ #. Platform longitude
+
+To minimise issues with the use of different path separators across operating systems, it is recommended that
+the separator / be used for path strings.
+
+ *e.g.* E:/GitRepos/waveval/examples/data/RSCD_HINDCAST/2017/01/FREQ_NC
+
+File names should not include spaces or special characters as these are not currently accounted for in the readers.
+If the file names used in an archive include spaces and/or special characters the readers will need to be modified.
+
+The format for the observational data start and end date and time is yyyy-mm-dd HH:MM:SS.
+
+ *e.g.* 2005-07-04 12:35:00
+
+Matched data records internal format
+####################################
+
+Internally the :ref:`Validation` module uses a python list of tuples, where each tuple corresponds to a
+record in the original CSV file supplied by the user. In essence the elements in a tuple corresponds to the
+CSV record field at the same location, *e.g.* the tuple elements for a record are:
+
+ #. tuple[0] = Path to the directory containing the model extract data records
+ #. tuple[1] = Model extract data file name
+ #. tuple[2] = Path to the directory containing the observation data records
+ #. tuple[3] = Observation data file name
+ #. tuple[4] = Year to be processed
+ #. tuple[5] = Month to be processed
+ #. tuple[6] = Start date and time of observational data (space separated data and time)
+ #. tuple[7] = End data and time of observational data (space separated data and time)
+ #. tuple[8] = Platform name string
+
+Internal validation results data format
+#######################################
+
+Internally the validation results are collected in a python data dictionary with the following key fields:
+
+====================== =================================================
+Keys Description
+====================== =================================================
+results.MODEL Model data file name
+results.OBSERVATION Observation data file name
+results.YEAR Year being processed
+results.MONTH Month being processed
+results.PARAM Observation parameter name
+results.R Correlation value
+results.MB Mean bias value
+results.NMB Normalised mean bias value
+results.MAE Mean absolute error value
+results.NMAE Normalised mean absolute error value
+results.RMSE Root mean square error value
+resutls.NRMSE Normalised root mean square error value
+results.SI Scatter index value
+results.NSMPL Number of valid time series data samples used
+====================== =================================================
+
+This structure is initialised by the :py:func:`Validation.initialize_results` function, and
+results for a given matchup record are stored in the dictionary using the
+:py:func:`Validation.store_valid_results` function.
+
+Saved binary data format
+########################
+
+To support post processing of the validation resuts, the results are stored in a binary format. This is
+currently a Matlab v4 binary format. This is generated using the `scipy.io.savemat`_ function. This
+generates a simple binary data structure where each dictionary keys is saved as a variable using the key
+name. For post-processing exercises, the matlab formatted binary data can be loaded back into an internal
+results data dictionary using the :py:func:`Validation.load_binary_results` function.
+
+.. _scipy.io.savemat: https://docs.scipy.org/doc/scipy/reference/generated/scipy.io.savemat.html
+
+Saved tabulated ASCII data format
+#################################
+
+The results are store in a human-readable ASCII format as part of the :py:func:`Validation.save_tabulated_results`
+call. The header line gives the integrated wave parameter that the tabulated statistics are for, the next line
+gives the table column field names, then there is a formated row for each valid result.
+
+The columns and formats are as follows:
+
+============== ======== ====================================================
+Field Format Description
+============== ======== ====================================================
+MODEL {:<60} Upto 60 characters
+OBSERVATION {:<25} Upto 25 characters
+YEAR {:^7} Upto 7 digits centred
+MONTH {:^7} Upto 7 digits centred
+PARAM {:^7} Upto 7 characters centred
+R {:^9.3} Upto 9 digits centred with 3 decimal place precision
+MB {:^9.4} Upto 9 digits centred with 4 decimal place precision
+NMB {:^9.4} Upto 9 digits centred with 4 decimal place precision
+MAE {:^9.4} Upto 9 digits centred with 4 decimal place precision
+NMAE {:^9.4} Upto 9 digits centred with 4 decimal place precision
+RMSE {:^9.4} Upto 9 digits centred with 4 decimal place precision
+NRMSE {:^9.4} Upto 9 digits centred with 4 decimal place precision
+SI {:^9.4} Upto 9 digits centred with 4 decimal place precision
+NSMPL {:^9} Upto 9 digits centred
+============== ======== ====================================================
diff --git a/docs/_build/html/_sources/index.rst.txt b/docs/_build/html/_sources/index.rst.txt
new file mode 100644
index 0000000000000000000000000000000000000000..ac4d174580f16c3059f8f474066d952098809f73
--- /dev/null
+++ b/docs/_build/html/_sources/index.rst.txt
@@ -0,0 +1,141 @@
+WaveVal: Wave Model Validation
+==============================
+.. automodule:: waveval
+ :members:
+
+.. image:: waveval_example.png
+ :align: left
+ :height: 200px
+ :width: 200px
+ :alt: ResourceCode WaveVal Output.
+
+
+What is WaveVal?
+################
+
+The `WaveVal`_ software package was developed to support the validation of the `ResourceCode`_ waves hindcast database
+against the `CMEMS`_ `In Situ TAC`_ multi-year wavebuoy data archive. The waves hindcast database was generated
+using `WaveWatch III`_, and covers the European Shelf waters for the period from 1994 to 2020. The `ResourceCode`_
+web site is the front-end portal providing access to the hindcast data and a set of data analysis tools.
+
+The validation data generated by the WaveVal package are limited to the following subset of the integerated wave
+parameters:
+
+ +----------------------+----------------------------------------+
+ | Wave Parameter | Description |
+ +======================+========================================+
+ | :math:`H_{m0}` | Significant wave height |
+ +----------------------+----------------------------------------+
+ | :math:`T_p` | Peak wave period |
+ +----------------------+----------------------------------------+
+ | :math:`T_{m02}` | Mean zero-crossing period |
+ +----------------------+----------------------------------------+
+ | :math:`\theta_p` | Peak wave direction |
+ +----------------------+----------------------------------------+
+ | :math:`\theta_{sp}` | Peak wave directional spreading |
+ +----------------------+----------------------------------------+
+
+Validation metrics are provided in the form of monthly statistical measures of the differences between
+overlapping time series of the modelled and observed integrated wave parameters. The metrics used are:
+
+ +---------------+-------------------------------------+
+ | Metric | Description |
+ +===============+=====================================+
+ | :math:`R` | Pearson Correlation Coefficient |
+ +---------------+-------------------------------------+
+ | :math:`MB` | Mean Bias |
+ +---------------+-------------------------------------+
+ | :math:`NMB` | Normalised Mean Bias |
+ +---------------+-------------------------------------+
+ | :math:`MAE` | Mean Absolute Error |
+ +---------------+-------------------------------------+
+ | :math:`NMAE` | Normalised Mean Absolute Error |
+ +---------------+-------------------------------------+
+ | :math:`RMSE` | Root-Mean-Square Error |
+ +---------------+-------------------------------------+
+ | :math:`NRMSE` | Normalised Root-Mean-Square Error |
+ +---------------+-------------------------------------+
+ | :math:`SI` | Scatter Index |
+ +---------------+-------------------------------------+
+
+Separate functions are provided to calculate the above validation metrics for circular variables
+(*e.g.* wave direction).
+
+The validation process is described on the :ref:`workflow` information page, and examples of using
+the tools are given on the :ref:`examples` information page.
+
+Full source code is available from the `GitLab`_ repository held at The University of Edinburgh.
+
+While `WaveVal`_ is still under development, users should pull the newest code from the `GitLab`_
+repository regularly. If you have installed the package using the instructions below, you should not
+need to re-install after pulling new code.
+
+`WaveVal`_ is still under development and is intended to be a research tool, not production-level code.
+Please submit questions as `GitLab`_ issues if you encounter unexpected behaviour or need help using
+`WaveVal`_. As of the current release, basic functionality is complete and has been tested.
+
+.. _WaveVal: https://git.ecdf.ed.ac.uk/uoe-ies-open-tools/WaveVal
+.. _ResourceCode: https://resourcecode.ifremer.fr/
+.. _CMEMS: https://marine.copernicus.eu/
+.. _In Situ TAC: http://www.marineinsitu.eu/dashboard/
+.. _WaveWatch III: https://github.com/NOAA-EMC/WW3
+.. _GitLab: https://git.ecdf.ed.ac.uk/uoe-ies-open-tools/WaveVal
+
+
+Installation
+############
+
+First, pull down the current source code from `GitLab`_ either by downloading a zip file or using `git clone`.
+
+From the command line, while in the main WaveVal directory, use the following command to install WaveVal::
+
+ pip install -e .[waveval]
+
+The `-e` flag signals developer mode, meaning that if you update the code from `Gitlab`_, your installation will
+automatically take those changes into account without requiring re-installation.
+Some other essential packages used in `WaveVal`_ may be installed if they do not exist in your system or environment.
+
+If you encounter problems with the above install method, you may try to install dependencies manually before
+installing `WaveVal`_. First, ensure you have a recent version of Python (greater than 3.5).
+Then, install packages `numpy`_, `scipy`_, `matplotlib`_, `netCDF4`_, and `cartopy`_.
+
+.. _numpy: https://pypi.org/project/numpy/
+.. _scipy: https://pypi.org/project/scipy/
+.. _matplotlib: https://pypi.org/project/matplotlib/
+.. _netCDF4: https://pypi.org/project/netCDF4/
+.. _cartopy: https://pypi.org/project/Cartopy/
+
+
+Information Pages
+#################
+.. toctree::
+ :maxdepth: 2
+
+ about
+ quickstart
+ formats
+ examples
+ automate
+ data_access
+
+WaveVal Package Content
+#######################
+.. toctree::
+ :maxdepth: 2
+
+ Validation
+ MatchUpDatabase
+ WaveStats
+ WaveSpectra
+ ModelData
+ ObsData
+ DataFormats
+ TimeFuncs
+ Geometry
+ Graphics
+
+Indices and tables
+##################
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
\ No newline at end of file
diff --git a/docs/_build/html/_sources/quickstart.rst.txt b/docs/_build/html/_sources/quickstart.rst.txt
new file mode 100644
index 0000000000000000000000000000000000000000..25ab15cfc9cde8c508b7e56968b7b44e066e0432
--- /dev/null
+++ b/docs/_build/html/_sources/quickstart.rst.txt
@@ -0,0 +1,128 @@
+.. _workflow:
+
+Validation workflow
+===================
+
+The core functions for generating validation metric values for a set of extracted model data
+against a wavebuoy data archive are in the following modules:
+
+* :ref:`MatchUpDatabase` used to generate a searchable set of model/observation data matches.
+* :ref:`Validation` used to generate validation metrics for a set of matched data records.
+
+The steps involved are as follows:
+
+Step 1: Match up model and observation data records
+###################################################
+
+ The validation process requires timeseries of data extracted for a specific location
+ with in the model domain and a corresponding time record of wavebuoy data.
+ The ResourceCode hindcast data are computed on an hourly basis and the data are
+ stored in monthly records, sorted by year, month and data type (FREQ_NC, SPEC_NC).
+ The InSituTAC wavebuoy data are available as either monthly files or a continuous
+ single record file; these tools have been developed for use with the continuous
+ wavebuoy records to simplify the process of the validating the complete hindcast dataset.
+
+ The function for generating the matchup database is
+ :py:func:`MatchUpDatabase.construct_rscd_mdb`. This is used to generate an SQLite3
+ database of matched buoy/model extract data by location.
+
+ The validation process has been generalised to take matched data record information from a
+ CSV file, allowing manual generation of the data match records without the need for
+ generating an SQLite database. The SQLite matchup database can be converted to a CSV file
+ using the :py:func:`MatchUpDatabase.db_match_to_csv` function.
+
+Step 2: Extract matched data records from tabulated CSV file
+############################################################
+
+ The validation process takes as input a list of a matched data records in the form of a
+ tuple. The data in the CSV files is converted into the list of tuples using the function
+ :py:func:`MatchUpDatabase.csv2tuples`.
+
+Step 3: Identify unique platforms within the matched data records
+#################################################################
+
+ The records are processed by location, so the records for a particular platform need to be
+ identified. The unique platform names are extracted from the list of matched data records
+ using the function :py:func:`MatchUpDatabase.getPlatformList`.
+
+Step 4: Generate validation statistics for a platform
+#####################################################
+
+ The following substeps are carried out:
+
+ **(4.1) Extract the records relevant to the current platform.**
+ The records corresponding to a given platform are extracted using the function
+ :py:func:`MatchUpDatabase.getPlatformRecords`.
+
+ **(4.2) Provide a list of the wave parameters to be tested**
+ The wave parameter options available are: [Hm0, Tp, Tm02, Dir, Spr]
+
+ **(4.3) Process the set of extracted matchup records**
+ The records are processed via the :py:func:`Validation.validate_records` function.
+ This loops over each record in the supplied list and processes them separately.
+
+ A single record is processed by a call to the :py:func:`Validation.process_record`
+ function. The internal steps of the validation process for a given record are:
+
+ *(4.3.1) Extract model record timestamp, variable data and temporal coverage structure*
+
+ Call :py:func:`Validation.extract_model`
+
+ *(4.3.2) Extract observation record timestamp and variable data*
+
+ Call :py:func:`Validation.extract_obs`
+
+ *(4.3.3) Check the required buoy variable exists*
+
+ If the variable exists then continue process, otherwise exit record processing.
+
+ *(4.3.4) Check for temporal overlap between records*
+
+ If the time records overlap and there are at least 200 common samples then continue process,
+ otherwise exit record processing.
+
+ *(4.3.5) Interpolate the observation variable onto the model time stamps*
+
+ The observations must be mapped to the model time stamps to allow the differencing required
+ for metric statistics to be calculated. The interpolation method used is nearest neighbour with
+ the constraint that the difference between the observation time and the model time is less
+ than 1 hour. Missing observational data are filled with the ``numpy.NAN`` value.
+
+ The function used is :py:func:`Validation.time_interpolate_obs`.
+
+ The model and interpolated observation data are plotted as overlayed time series if requested,
+ and the model data and interpolated observational data are save as a binary file to allow rapid
+ reprocessing if required.
+
+ *(4.3.6) Check there are sufficient valid observational values in interpolated data*
+
+ If there are at least 200 valid observations in the interpolated data then continue process,
+ otherwise exit record processing.
+
+ *(4.3.7) Calculate validation metric statistics*
+
+ Determine the wave parameter type (standard or circular), then calculate the set of validation
+ metrics for the records and save the output in the results records structure.
+
+ * For standard parameters call :py:func:`Validation.calculate_metrics`
+ * For circular parameters call :py:func:`Validation.calculate_circular_metrics`
+
+ Generate and save a correlation plot if requested by calling :py:func:`Graphics.plot_correlation`.
+
+ *(4.3.8) Continue to next record*
+
+ Select next platform record and repeat steps (4.3.1) to (4.3.7)
+
+ **(4.4) Return the full set of validation results for the current platform.**
+
+ The results are returned in the form of a python data dictionary, where each element in a key field
+ corresponds to a specific matched data pair record.
+
+Step 5: Save the validation results for post-processing
+#######################################################
+
+ The results are written out as a table formatted ASCII file, and are save as binary file
+ for post-processing.
+
+ This done by calling :py:func:`Validation.save_tabulated_results`.
+
diff --git a/docs/_build/html/_static/background_b01.png b/docs/_build/html/_static/background_b01.png
new file mode 100644
index 0000000000000000000000000000000000000000..353f26dde0803aa172c23e21ef6ac068e1253bc8
Binary files /dev/null and b/docs/_build/html/_static/background_b01.png differ
diff --git a/docs/_build/html/_static/basic.css b/docs/_build/html/_static/basic.css
new file mode 100644
index 0000000000000000000000000000000000000000..7fbe7a181e69d677f9d60411fd916fea65d8a858
--- /dev/null
+++ b/docs/_build/html/_static/basic.css
@@ -0,0 +1,905 @@
+/*
+ * basic.css
+ * ~~~~~~~~~
+ *
+ * Sphinx stylesheet -- basic theme.
+ *
+ * :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS.
+ * :license: BSD, see LICENSE for details.
+ *
+ */
+
+/* -- main layout ----------------------------------------------------------- */
+
+div.clearer {
+ clear: both;
+}
+
+div.section::after {
+ display: block;
+ content: '';
+ clear: left;
+}
+
+/* -- relbar ---------------------------------------------------------------- */
+
+div.related {
+ width: 100%;
+ font-size: 90%;
+}
+
+div.related h3 {
+ display: none;
+}
+
+div.related ul {
+ margin: 0;
+ padding: 0 0 0 10px;
+ list-style: none;
+}
+
+div.related li {
+ display: inline;
+}
+
+div.related li.right {
+ float: right;
+ margin-right: 5px;
+}
+
+/* -- sidebar --------------------------------------------------------------- */
+
+div.sphinxsidebarwrapper {
+ padding: 10px 5px 0 10px;
+}
+
+div.sphinxsidebar {
+ float: left;
+ width: 210px;
+ margin-left: -100%;
+ font-size: 90%;
+ word-wrap: break-word;
+ overflow-wrap : break-word;
+}
+
+div.sphinxsidebar ul {
+ list-style: none;
+}
+
+div.sphinxsidebar ul ul,
+div.sphinxsidebar ul.want-points {
+ margin-left: 20px;
+ list-style: square;
+}
+
+div.sphinxsidebar ul ul {
+ margin-top: 0;
+ margin-bottom: 0;
+}
+
+div.sphinxsidebar form {
+ margin-top: 10px;
+}
+
+div.sphinxsidebar input {
+ border: 1px solid #98dbcc;
+ font-family: sans-serif;
+ font-size: 1em;
+}
+
+div.sphinxsidebar #searchbox form.search {
+ overflow: hidden;
+}
+
+div.sphinxsidebar #searchbox input[type="text"] {
+ float: left;
+ width: 80%;
+ padding: 0.25em;
+ box-sizing: border-box;
+}
+
+div.sphinxsidebar #searchbox input[type="submit"] {
+ float: left;
+ width: 20%;
+ border-left: none;
+ padding: 0.25em;
+ box-sizing: border-box;
+}
+
+
+img {
+ border: 0;
+ max-width: 100%;
+}
+
+/* -- search page ----------------------------------------------------------- */
+
+ul.search {
+ margin: 10px 0 0 20px;
+ padding: 0;
+}
+
+ul.search li {
+ padding: 5px 0 5px 20px;
+ background-image: url(file.png);
+ background-repeat: no-repeat;
+ background-position: 0 7px;
+}
+
+ul.search li a {
+ font-weight: bold;
+}
+
+ul.search li p.context {
+ color: #888;
+ margin: 2px 0 0 30px;
+ text-align: left;
+}
+
+ul.keywordmatches li.goodmatch a {
+ font-weight: bold;
+}
+
+/* -- index page ------------------------------------------------------------ */
+
+table.contentstable {
+ width: 90%;
+ margin-left: auto;
+ margin-right: auto;
+}
+
+table.contentstable p.biglink {
+ line-height: 150%;
+}
+
+a.biglink {
+ font-size: 1.3em;
+}
+
+span.linkdescr {
+ font-style: italic;
+ padding-top: 5px;
+ font-size: 90%;
+}
+
+/* -- general index --------------------------------------------------------- */
+
+table.indextable {
+ width: 100%;
+}
+
+table.indextable td {
+ text-align: left;
+ vertical-align: top;
+}
+
+table.indextable ul {
+ margin-top: 0;
+ margin-bottom: 0;
+ list-style-type: none;
+}
+
+table.indextable > tbody > tr > td > ul {
+ padding-left: 0em;
+}
+
+table.indextable tr.pcap {
+ height: 10px;
+}
+
+table.indextable tr.cap {
+ margin-top: 10px;
+ background-color: #f2f2f2;
+}
+
+img.toggler {
+ margin-right: 3px;
+ margin-top: 3px;
+ cursor: pointer;
+}
+
+div.modindex-jumpbox {
+ border-top: 1px solid #ddd;
+ border-bottom: 1px solid #ddd;
+ margin: 1em 0 1em 0;
+ padding: 0.4em;
+}
+
+div.genindex-jumpbox {
+ border-top: 1px solid #ddd;
+ border-bottom: 1px solid #ddd;
+ margin: 1em 0 1em 0;
+ padding: 0.4em;
+}
+
+/* -- domain module index --------------------------------------------------- */
+
+table.modindextable td {
+ padding: 2px;
+ border-collapse: collapse;
+}
+
+/* -- general body styles --------------------------------------------------- */
+
+div.body {
+ min-width: 450px;
+ max-width: 800px;
+}
+
+div.body p, div.body dd, div.body li, div.body blockquote {
+ -moz-hyphens: auto;
+ -ms-hyphens: auto;
+ -webkit-hyphens: auto;
+ hyphens: auto;
+}
+
+a.headerlink {
+ visibility: hidden;
+}
+
+a.brackets:before,
+span.brackets > a:before{
+ content: "[";
+}
+
+a.brackets:after,
+span.brackets > a:after {
+ content: "]";
+}
+
+h1:hover > a.headerlink,
+h2:hover > a.headerlink,
+h3:hover > a.headerlink,
+h4:hover > a.headerlink,
+h5:hover > a.headerlink,
+h6:hover > a.headerlink,
+dt:hover > a.headerlink,
+caption:hover > a.headerlink,
+p.caption:hover > a.headerlink,
+div.code-block-caption:hover > a.headerlink {
+ visibility: visible;
+}
+
+div.body p.caption {
+ text-align: inherit;
+}
+
+div.body td {
+ text-align: left;
+}
+
+.first {
+ margin-top: 0 !important;
+}
+
+p.rubric {
+ margin-top: 30px;
+ font-weight: bold;
+}
+
+img.align-left, figure.align-left, .figure.align-left, object.align-left {
+ clear: left;
+ float: left;
+ margin-right: 1em;
+}
+
+img.align-right, figure.align-right, .figure.align-right, object.align-right {
+ clear: right;
+ float: right;
+ margin-left: 1em;
+}
+
+img.align-center, figure.align-center, .figure.align-center, object.align-center {
+ display: block;
+ margin-left: auto;
+ margin-right: auto;
+}
+
+img.align-default, figure.align-default, .figure.align-default {
+ display: block;
+ margin-left: auto;
+ margin-right: auto;
+}
+
+.align-left {
+ text-align: left;
+}
+
+.align-center {
+ text-align: center;
+}
+
+.align-default {
+ text-align: center;
+}
+
+.align-right {
+ text-align: right;
+}
+
+/* -- sidebars -------------------------------------------------------------- */
+
+div.sidebar,
+aside.sidebar {
+ margin: 0 0 0.5em 1em;
+ border: 1px solid #ddb;
+ padding: 7px;
+ background-color: #ffe;
+ width: 40%;
+ float: right;
+ clear: right;
+ overflow-x: auto;
+}
+
+p.sidebar-title {
+ font-weight: bold;
+}
+
+div.admonition, div.topic, blockquote {
+ clear: left;
+}
+
+/* -- topics ---------------------------------------------------------------- */
+
+div.topic {
+ border: 1px solid #ccc;
+ padding: 7px;
+ margin: 10px 0 10px 0;
+}
+
+p.topic-title {
+ font-size: 1.1em;
+ font-weight: bold;
+ margin-top: 10px;
+}
+
+/* -- admonitions ----------------------------------------------------------- */
+
+div.admonition {
+ margin-top: 10px;
+ margin-bottom: 10px;
+ padding: 7px;
+}
+
+div.admonition dt {
+ font-weight: bold;
+}
+
+p.admonition-title {
+ margin: 0px 10px 5px 0px;
+ font-weight: bold;
+}
+
+div.body p.centered {
+ text-align: center;
+ margin-top: 25px;
+}
+
+/* -- content of sidebars/topics/admonitions -------------------------------- */
+
+div.sidebar > :last-child,
+aside.sidebar > :last-child,
+div.topic > :last-child,
+div.admonition > :last-child {
+ margin-bottom: 0;
+}
+
+div.sidebar::after,
+aside.sidebar::after,
+div.topic::after,
+div.admonition::after,
+blockquote::after {
+ display: block;
+ content: '';
+ clear: both;
+}
+
+/* -- tables ---------------------------------------------------------------- */
+
+table.docutils {
+ margin-top: 10px;
+ margin-bottom: 10px;
+ border: 0;
+ border-collapse: collapse;
+}
+
+table.align-center {
+ margin-left: auto;
+ margin-right: auto;
+}
+
+table.align-default {
+ margin-left: auto;
+ margin-right: auto;
+}
+
+table caption span.caption-number {
+ font-style: italic;
+}
+
+table caption span.caption-text {
+}
+
+table.docutils td, table.docutils th {
+ padding: 1px 8px 1px 5px;
+ border-top: 0;
+ border-left: 0;
+ border-right: 0;
+ border-bottom: 1px solid #aaa;
+}
+
+table.footnote td, table.footnote th {
+ border: 0 !important;
+}
+
+th {
+ text-align: left;
+ padding-right: 5px;
+}
+
+table.citation {
+ border-left: solid 1px gray;
+ margin-left: 1px;
+}
+
+table.citation td {
+ border-bottom: none;
+}
+
+th > :first-child,
+td > :first-child {
+ margin-top: 0px;
+}
+
+th > :last-child,
+td > :last-child {
+ margin-bottom: 0px;
+}
+
+/* -- figures --------------------------------------------------------------- */
+
+div.figure, figure {
+ margin: 0.5em;
+ padding: 0.5em;
+}
+
+div.figure p.caption, figcaption {
+ padding: 0.3em;
+}
+
+div.figure p.caption span.caption-number,
+figcaption span.caption-number {
+ font-style: italic;
+}
+
+div.figure p.caption span.caption-text,
+figcaption span.caption-text {
+}
+
+/* -- field list styles ----------------------------------------------------- */
+
+table.field-list td, table.field-list th {
+ border: 0 !important;
+}
+
+.field-list ul {
+ margin: 0;
+ padding-left: 1em;
+}
+
+.field-list p {
+ margin: 0;
+}
+
+.field-name {
+ -moz-hyphens: manual;
+ -ms-hyphens: manual;
+ -webkit-hyphens: manual;
+ hyphens: manual;
+}
+
+/* -- hlist styles ---------------------------------------------------------- */
+
+table.hlist {
+ margin: 1em 0;
+}
+
+table.hlist td {
+ vertical-align: top;
+}
+
+/* -- object description styles --------------------------------------------- */
+
+.sig {
+ font-family: 'Consolas', 'Menlo', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace;
+}
+
+.sig-name, code.descname {
+ background-color: transparent;
+ font-weight: bold;
+}
+
+.sig-name {
+ font-size: 1.1em;
+}
+
+code.descname {
+ font-size: 1.2em;
+}
+
+.sig-prename, code.descclassname {
+ background-color: transparent;
+}
+
+.optional {
+ font-size: 1.3em;
+}
+
+.sig-paren {
+ font-size: larger;
+}
+
+.sig-param.n {
+ font-style: italic;
+}
+
+/* C++ specific styling */
+
+.sig-inline.c-texpr,
+.sig-inline.cpp-texpr {
+ font-family: unset;
+}
+
+.sig.c .k, .sig.c .kt,
+.sig.cpp .k, .sig.cpp .kt {
+ color: #0033B3;
+}
+
+.sig.c .m,
+.sig.cpp .m {
+ color: #1750EB;
+}
+
+.sig.c .s, .sig.c .sc,
+.sig.cpp .s, .sig.cpp .sc {
+ color: #067D17;
+}
+
+
+/* -- other body styles ----------------------------------------------------- */
+
+ol.arabic {
+ list-style: decimal;
+}
+
+ol.loweralpha {
+ list-style: lower-alpha;
+}
+
+ol.upperalpha {
+ list-style: upper-alpha;
+}
+
+ol.lowerroman {
+ list-style: lower-roman;
+}
+
+ol.upperroman {
+ list-style: upper-roman;
+}
+
+:not(li) > ol > li:first-child > :first-child,
+:not(li) > ul > li:first-child > :first-child {
+ margin-top: 0px;
+}
+
+:not(li) > ol > li:last-child > :last-child,
+:not(li) > ul > li:last-child > :last-child {
+ margin-bottom: 0px;
+}
+
+ol.simple ol p,
+ol.simple ul p,
+ul.simple ol p,
+ul.simple ul p {
+ margin-top: 0;
+}
+
+ol.simple > li:not(:first-child) > p,
+ul.simple > li:not(:first-child) > p {
+ margin-top: 0;
+}
+
+ol.simple p,
+ul.simple p {
+ margin-bottom: 0;
+}
+
+dl.footnote > dt,
+dl.citation > dt {
+ float: left;
+ margin-right: 0.5em;
+}
+
+dl.footnote > dd,
+dl.citation > dd {
+ margin-bottom: 0em;
+}
+
+dl.footnote > dd:after,
+dl.citation > dd:after {
+ content: "";
+ clear: both;
+}
+
+dl.field-list {
+ display: grid;
+ grid-template-columns: fit-content(30%) auto;
+}
+
+dl.field-list > dt {
+ font-weight: bold;
+ word-break: break-word;
+ padding-left: 0.5em;
+ padding-right: 5px;
+}
+
+dl.field-list > dt:after {
+ content: ":";
+}
+
+dl.field-list > dd {
+ padding-left: 0.5em;
+ margin-top: 0em;
+ margin-left: 0em;
+ margin-bottom: 0em;
+}
+
+dl {
+ margin-bottom: 15px;
+}
+
+dd > :first-child {
+ margin-top: 0px;
+}
+
+dd ul, dd table {
+ margin-bottom: 10px;
+}
+
+dd {
+ margin-top: 3px;
+ margin-bottom: 10px;
+ margin-left: 30px;
+}
+
+dl > dd:last-child,
+dl > dd:last-child > :last-child {
+ margin-bottom: 0;
+}
+
+dt:target, span.highlighted {
+ background-color: #fbe54e;
+}
+
+rect.highlighted {
+ fill: #fbe54e;
+}
+
+dl.glossary dt {
+ font-weight: bold;
+ font-size: 1.1em;
+}
+
+.versionmodified {
+ font-style: italic;
+}
+
+.system-message {
+ background-color: #fda;
+ padding: 5px;
+ border: 3px solid red;
+}
+
+.footnote:target {
+ background-color: #ffa;
+}
+
+.line-block {
+ display: block;
+ margin-top: 1em;
+ margin-bottom: 1em;
+}
+
+.line-block .line-block {
+ margin-top: 0;
+ margin-bottom: 0;
+ margin-left: 1.5em;
+}
+
+.guilabel, .menuselection {
+ font-family: sans-serif;
+}
+
+.accelerator {
+ text-decoration: underline;
+}
+
+.classifier {
+ font-style: oblique;
+}
+
+.classifier:before {
+ font-style: normal;
+ margin: 0 0.5em;
+ content: ":";
+ display: inline-block;
+}
+
+abbr, acronym {
+ border-bottom: dotted 1px;
+ cursor: help;
+}
+
+/* -- code displays --------------------------------------------------------- */
+
+pre {
+ overflow: auto;
+ overflow-y: hidden; /* fixes display issues on Chrome browsers */
+}
+
+pre, div[class*="highlight-"] {
+ clear: both;
+}
+
+span.pre {
+ -moz-hyphens: none;
+ -ms-hyphens: none;
+ -webkit-hyphens: none;
+ hyphens: none;
+}
+
+div[class*="highlight-"] {
+ margin: 1em 0;
+}
+
+td.linenos pre {
+ border: 0;
+ background-color: transparent;
+ color: #aaa;
+}
+
+table.highlighttable {
+ display: block;
+}
+
+table.highlighttable tbody {
+ display: block;
+}
+
+table.highlighttable tr {
+ display: flex;
+}
+
+table.highlighttable td {
+ margin: 0;
+ padding: 0;
+}
+
+table.highlighttable td.linenos {
+ padding-right: 0.5em;
+}
+
+table.highlighttable td.code {
+ flex: 1;
+ overflow: hidden;
+}
+
+.highlight .hll {
+ display: block;
+}
+
+div.highlight pre,
+table.highlighttable pre {
+ margin: 0;
+}
+
+div.code-block-caption + div {
+ margin-top: 0;
+}
+
+div.code-block-caption {
+ margin-top: 1em;
+ padding: 2px 5px;
+ font-size: small;
+}
+
+div.code-block-caption code {
+ background-color: transparent;
+}
+
+table.highlighttable td.linenos,
+span.linenos,
+div.highlight span.gp { /* gp: Generic.Prompt */
+ user-select: none;
+ -webkit-user-select: text; /* Safari fallback only */
+ -webkit-user-select: none; /* Chrome/Safari */
+ -moz-user-select: none; /* Firefox */
+ -ms-user-select: none; /* IE10+ */
+}
+
+div.code-block-caption span.caption-number {
+ padding: 0.1em 0.3em;
+ font-style: italic;
+}
+
+div.code-block-caption span.caption-text {
+}
+
+div.literal-block-wrapper {
+ margin: 1em 0;
+}
+
+code.xref, a code {
+ background-color: transparent;
+ font-weight: bold;
+}
+
+h1 code, h2 code, h3 code, h4 code, h5 code, h6 code {
+ background-color: transparent;
+}
+
+.viewcode-link {
+ float: right;
+}
+
+.viewcode-back {
+ float: right;
+ font-family: sans-serif;
+}
+
+div.viewcode-block:target {
+ margin: -1px -10px;
+ padding: 0 10px;
+}
+
+/* -- math display ---------------------------------------------------------- */
+
+img.math {
+ vertical-align: middle;
+}
+
+div.body div.math p {
+ text-align: center;
+}
+
+span.eqno {
+ float: right;
+}
+
+span.eqno a.headerlink {
+ position: absolute;
+ z-index: 1;
+}
+
+div.math:hover a.headerlink {
+ visibility: visible;
+}
+
+/* -- printout stylesheet --------------------------------------------------- */
+
+@media print {
+ div.document,
+ div.documentwrapper,
+ div.bodywrapper {
+ margin: 0 !important;
+ width: 100%;
+ }
+
+ div.sphinxsidebar,
+ div.related,
+ div.footer,
+ #top-link {
+ display: none;
+ }
+}
\ No newline at end of file
diff --git a/docs/_build/html/_static/bizstyle.css b/docs/_build/html/_static/bizstyle.css
new file mode 100644
index 0000000000000000000000000000000000000000..def9cedc5dbfb46c1c8b8b95c40289ecea8869b4
--- /dev/null
+++ b/docs/_build/html/_static/bizstyle.css
@@ -0,0 +1,506 @@
+/*
+ * bizstyle.css_t
+ * ~~~~~~~~~~~~~~
+ *
+ * Sphinx stylesheet -- business style theme.
+ *
+ * :copyright: Copyright 2011-2014 by Sphinx team, see AUTHORS.
+ * :license: BSD, see LICENSE for details.
+ *
+ */
+
+@import url("basic.css");
+
+/* -- page layout ----------------------------------------------------------- */
+
+body {
+ font-family: 'Lucida Grande', 'Lucida Sans Unicode', 'Geneva',
+ 'Verdana', sans-serif;
+ font-size: 14px;
+ letter-spacing: -0.01em;
+ line-height: 150%;
+ text-align: center;
+ background-color: white;
+ background-image: url(background_b01.png);
+ color: black;
+ padding: 0;
+ border-right: 1px solid #336699;
+ border-left: 1px solid #336699;
+
+ margin: 0px 40px 0px 40px;
+}
+
+div.document {
+ background-color: white;
+ text-align: left;
+ background-repeat: repeat-x;
+
+ -moz-box-shadow: 2px 2px 5px #000;
+ -webkit-box-shadow: 2px 2px 5px #000;
+}
+
+div.documentwrapper {
+ float: left;
+ width: 100%;
+}
+
+div.bodywrapper {
+ margin: 0 0 0 240px;
+ border-left: 1px solid #ccc;
+}
+
+div.body {
+ margin: 0;
+ padding: 0.5em 20px 20px 20px;
+}
+div.bodywrapper {
+ margin: 0 0 0 calc(210px + 30px);
+}
+
+div.related {
+ font-size: 1em;
+
+ -moz-box-shadow: 2px 2px 5px #000;
+ -webkit-box-shadow: 2px 2px 5px #000;
+}
+
+div.related ul {
+ background-color: #336699;
+ height: 100%;
+ overflow: hidden;
+ border-top: 1px solid #ddd;
+ border-bottom: 1px solid #ddd;
+}
+
+div.related ul li {
+ color: white;
+ margin: 0;
+ padding: 0;
+ height: 2em;
+ float: left;
+}
+
+div.related ul li.right {
+ float: right;
+ margin-right: 5px;
+}
+
+div.related ul li a {
+ margin: 0;
+ padding: 0 5px 0 5px;
+ line-height: 1.75em;
+ color: #fff;
+}
+
+div.related ul li a:hover {
+ color: #fff;
+ text-decoration: underline;
+}
+
+div.sphinxsidebarwrapper {
+ padding: 0;
+}
+
+div.sphinxsidebar {
+ padding: 0.5em 12px 12px 12px;
+ width: 210px;
+ font-size: 1em;
+ text-align: left;
+}
+
+div.sphinxsidebar h3, div.sphinxsidebar h4 {
+ margin: 1em 0 0.5em 0;
+ font-size: 1em;
+ padding: 0.1em 0 0.1em 0.5em;
+ color: white;
+ border: 1px solid #336699;
+ background-color: #336699;
+}
+
+div.sphinxsidebar h3 a {
+ color: white;
+}
+
+div.sphinxsidebar ul {
+ padding-left: 1.5em;
+ margin-top: 7px;
+ padding: 0;
+ line-height: 130%;
+}
+
+div.sphinxsidebar ul ul {
+ margin-left: 20px;
+}
+
+div.sphinxsidebar input {
+ border: 1px solid #336699;
+}
+
+div.footer {
+ background-color: white;
+ color: #336699;
+ padding: 3px 8px 3px 0;
+ clear: both;
+ font-size: 0.8em;
+ text-align: right;
+ border-bottom: 1px solid #336699;
+
+ -moz-box-shadow: 2px 2px 5px #000;
+ -webkit-box-shadow: 2px 2px 5px #000;
+}
+
+div.footer a {
+ color: #336699;
+ text-decoration: underline;
+}
+
+/* -- body styles ----------------------------------------------------------- */
+
+p {
+ margin: 0.8em 0 0.5em 0;
+}
+
+a {
+ color: #336699;
+ text-decoration: none;
+}
+
+a:hover {
+ color: #336699;
+ text-decoration: underline;
+}
+
+div.body a {
+ text-decoration: underline;
+}
+
+h1, h2, h3 {
+ color: #336699;
+}
+
+h1 {
+ margin: 0;
+ padding: 0.7em 0 0.3em 0;
+ font-size: 1.5em;
+}
+
+h2 {
+ margin: 1.3em 0 0.2em 0;
+ font-size: 1.35em;
+ padding-bottom: .5em;
+ border-bottom: 1px solid #336699;
+}
+
+h3 {
+ margin: 1em 0 -0.3em 0;
+ font-size: 1.2em;
+ padding-bottom: .3em;
+ border-bottom: 1px solid #CCCCCC;
+}
+
+div.body h1 a, div.body h2 a, div.body h3 a,
+div.body h4 a, div.body h5 a, div.body h6 a {
+ color: black!important;
+}
+
+h1 a.anchor, h2 a.anchor, h3 a.anchor,
+h4 a.anchor, h5 a.anchor, h6 a.anchor {
+ display: none;
+ margin: 0 0 0 0.3em;
+ padding: 0 0.2em 0 0.2em;
+ color: #aaa!important;
+}
+
+h1:hover a.anchor, h2:hover a.anchor, h3:hover a.anchor, h4:hover a.anchor,
+h5:hover a.anchor, h6:hover a.anchor {
+ display: inline;
+}
+
+h1 a.anchor:hover, h2 a.anchor:hover, h3 a.anchor:hover, h4 a.anchor:hover,
+h5 a.anchor:hover, h6 a.anchor:hover {
+ color: #777;
+ background-color: #eee;
+}
+
+a.headerlink {
+ color: #c60f0f!important;
+ font-size: 1em;
+ margin-left: 6px;
+ padding: 0 4px 0 4px;
+ text-decoration: none!important;
+}
+
+a.headerlink:hover {
+ background-color: #ccc;
+ color: white!important;
+}
+
+cite, code, tt {
+ font-family: 'Consolas', 'Deja Vu Sans Mono',
+ 'Bitstream Vera Sans Mono', monospace;
+ font-size: 0.95em;
+ letter-spacing: 0.01em;
+}
+
+code {
+ background-color: #F2F2F2;
+ border-bottom: 1px solid #ddd;
+ color: #333;
+}
+
+code.descname, code.descclassname, code.xref {
+ border: 0;
+}
+
+hr {
+ border: 1px solid #abc;
+ margin: 2em;
+}
+
+a code {
+ border: 0;
+ color: #CA7900;
+}
+
+a code:hover {
+ color: #2491CF;
+}
+
+pre {
+ background-color: transparent !important;
+ font-family: 'Consolas', 'Deja Vu Sans Mono',
+ 'Bitstream Vera Sans Mono', monospace;
+ font-size: 0.95em;
+ letter-spacing: 0.015em;
+ line-height: 120%;
+ padding: 0.5em;
+ border-right: 5px solid #ccc;
+ border-left: 5px solid #ccc;
+}
+
+pre a {
+ color: inherit;
+ text-decoration: underline;
+}
+
+td.linenos pre {
+ padding: 0.5em 0;
+}
+
+div.quotebar {
+ background-color: #f8f8f8;
+ max-width: 250px;
+ float: right;
+ padding: 2px 7px;
+ border: 1px solid #ccc;
+}
+
+div.topic {
+ background-color: #f8f8f8;
+}
+
+table {
+ border-collapse: collapse;
+ margin: 0 -0.5em 0 -0.5em;
+}
+
+table td, table th {
+ padding: 0.2em 0.5em 0.2em 0.5em;
+}
+
+div.admonition {
+ font-size: 0.9em;
+ margin: 1em 0 1em 0;
+ border: 3px solid #cccccc;
+ background-color: #f7f7f7;
+ padding: 0;
+}
+
+div.admonition p {
+ margin: 0.5em 1em 0.5em 1em;
+ padding: 0;
+}
+
+div.admonition li p {
+ margin-left: 0;
+}
+
+div.admonition pre, div.warning pre {
+ margin: 0;
+}
+
+div.highlight {
+ margin: 0.4em 1em;
+}
+
+div.admonition p.admonition-title {
+ margin: 0;
+ padding: 0.1em 0 0.1em 0.5em;
+ color: white;
+ border-bottom: 3px solid #cccccc;
+ font-weight: bold;
+ background-color: #165e83;
+}
+
+div.danger { border: 3px solid #f0908d; background-color: #f0cfa0; }
+div.error { border: 3px solid #f0908d; background-color: #ede4cd; }
+div.warning { border: 3px solid #f8b862; background-color: #f0cfa0; }
+div.caution { border: 3px solid #f8b862; background-color: #ede4cd; }
+div.attention { border: 3px solid #f8b862; background-color: #f3f3f3; }
+div.important { border: 3px solid #f0cfa0; background-color: #ede4cd; }
+div.note { border: 3px solid #f0cfa0; background-color: #f3f3f3; }
+div.hint { border: 3px solid #bed2c3; background-color: #f3f3f3; }
+div.tip { border: 3px solid #bed2c3; background-color: #f3f3f3; }
+
+div.danger p.admonition-title, div.error p.admonition-title {
+ background-color: #b7282e;
+ border-bottom: 3px solid #f0908d;
+}
+
+div.caution p.admonition-title,
+div.warning p.admonition-title,
+div.attention p.admonition-title {
+ background-color: #f19072;
+ border-bottom: 3px solid #f8b862;
+}
+
+div.note p.admonition-title, div.important p.admonition-title {
+ background-color: #f8b862;
+ border-bottom: 3px solid #f0cfa0;
+}
+
+div.hint p.admonition-title, div.tip p.admonition-title {
+ background-color: #7ebea5;
+ border-bottom: 3px solid #bed2c3;
+}
+
+div.admonition ul, div.admonition ol,
+div.warning ul, div.warning ol {
+ margin: 0.1em 0.5em 0.5em 3em;
+ padding: 0;
+}
+
+div.versioninfo {
+ margin: 1em 0 0 0;
+ border: 1px solid #ccc;
+ background-color: #DDEAF0;
+ padding: 8px;
+ line-height: 1.3em;
+ font-size: 0.9em;
+}
+
+.viewcode-back {
+ font-family: 'Lucida Grande', 'Lucida Sans Unicode', 'Geneva',
+ 'Verdana', sans-serif;
+}
+
+div.viewcode-block:target {
+ background-color: #f4debf;
+ border-top: 1px solid #ac9;
+ border-bottom: 1px solid #ac9;
+}
+
+p.versionchanged span.versionmodified {
+ font-size: 0.9em;
+ margin-right: 0.2em;
+ padding: 0.1em;
+ background-color: #DCE6A0;
+}
+
+dl.field-list > dt {
+ color: white;
+ background-color: #82A0BE;
+}
+
+dl.field-list > dd {
+ background-color: #f7f7f7;
+}
+
+/* -- table styles ---------------------------------------------------------- */
+
+table.docutils {
+ margin: 1em 0;
+ padding: 0;
+ border: 1px solid white;
+ background-color: #f7f7f7;
+}
+
+table.docutils td, table.docutils th {
+ padding: 1px 8px 1px 5px;
+ border-top: 0;
+ border-left: 0;
+ border-right: 1px solid white;
+ border-bottom: 1px solid white;
+}
+
+table.docutils td p {
+ margin-top: 0;
+ margin-bottom: 0.3em;
+}
+
+table.field-list td, table.field-list th {
+ border: 0 !important;
+ word-break: break-word;
+}
+
+table.footnote td, table.footnote th {
+ border: 0 !important;
+}
+
+th {
+ color: white;
+ text-align: left;
+ padding-right: 5px;
+ background-color: #82A0BE;
+}
+
+div.literal-block-wrapper div.code-block-caption {
+ background-color: #EEE;
+ border-style: solid;
+ border-color: #CCC;
+ border-width: 1px 5px;
+}
+
+/* WIDE DESKTOP STYLE */
+@media only screen and (min-width: 1176px) {
+body {
+ margin: 0 40px 0 40px;
+}
+}
+
+/* TABLET STYLE */
+@media only screen and (min-width: 768px) and (max-width: 991px) {
+body {
+ margin: 0 40px 0 40px;
+}
+}
+
+/* MOBILE LAYOUT (PORTRAIT/320px) */
+@media only screen and (max-width: 767px) {
+body {
+ margin: 0;
+}
+div.bodywrapper {
+ margin: 0;
+ width: 100%;
+ border: none;
+}
+div.sphinxsidebar {
+ display: none;
+}
+}
+
+/* MOBILE LAYOUT (LANDSCAPE/480px) */
+@media only screen and (min-width: 480px) and (max-width: 767px) {
+body {
+ margin: 0 20px 0 20px;
+}
+}
+
+/* RETINA OVERRIDES */
+@media
+only screen and (-webkit-min-device-pixel-ratio: 2),
+only screen and (min-device-pixel-ratio: 2) {
+}
+
+/* -- end ------------------------------------------------------------------- */
\ No newline at end of file
diff --git a/docs/_build/html/_static/bizstyle.js b/docs/_build/html/_static/bizstyle.js
new file mode 100644
index 0000000000000000000000000000000000000000..3be6e68d610823ebe8f26855967f1bf2dd3852e8
--- /dev/null
+++ b/docs/_build/html/_static/bizstyle.js
@@ -0,0 +1,41 @@
+//
+// bizstyle.js
+// ~~~~~~~~~~~
+//
+// Sphinx javascript -- for bizstyle theme.
+//
+// This theme was created by referring to 'sphinxdoc'
+//
+// :copyright: Copyright 2012-2014 by Sphinx team, see AUTHORS.
+// :license: BSD, see LICENSE for details.
+//
+$(document).ready(function(){
+ if (navigator.userAgent.indexOf('iPhone') > 0 ||
+ navigator.userAgent.indexOf('Android') > 0) {
+ $("li.nav-item-0 a").text("Top");
+ }
+
+ $("div.related:first ul li:not(.right) a").slice(1).each(function(i, item){
+ if (item.text.length > 20) {
+ var tmpstr = item.text
+ $(item).attr("title", tmpstr);
+ $(item).text(tmpstr.substr(0, 17) + "...");
+ }
+ });
+ $("div.related:last ul li:not(.right) a").slice(1).each(function(i, item){
+ if (item.text.length > 20) {
+ var tmpstr = item.text
+ $(item).attr("title", tmpstr);
+ $(item).text(tmpstr.substr(0, 17) + "...");
+ }
+ });
+});
+
+$(window).resize(function(){
+ if ($(window).width() <= 776) {
+ $("li.nav-item-0 a").text("Top");
+ }
+ else {
+ $("li.nav-item-0 a").text("WaveVal documentation");
+ }
+});
\ No newline at end of file
diff --git a/docs/_build/html/_static/css3-mediaqueries.js b/docs/_build/html/_static/css3-mediaqueries.js
new file mode 100644
index 0000000000000000000000000000000000000000..59735f59dcb97f8d892a786ab94a33120254db9d
--- /dev/null
+++ b/docs/_build/html/_static/css3-mediaqueries.js
@@ -0,0 +1 @@
+if(typeof Object.create!=="function"){Object.create=function(e){function t(){}t.prototype=e;return new t}}var ua={toString:function(){return navigator.userAgent},test:function(e){return this.toString().toLowerCase().indexOf(e.toLowerCase())>-1}};ua.version=(ua.toString().toLowerCase().match(/[\s\S]+(?:rv|it|ra|ie)[\/: ]([\d.]+)/)||[])[1];ua.webkit=ua.test("webkit");ua.gecko=ua.test("gecko")&&!ua.webkit;ua.opera=ua.test("opera");ua.ie=ua.test("msie")&&!ua.opera;ua.ie6=ua.ie&&document.compatMode&&typeof document.documentElement.style.maxHeight==="undefined";ua.ie7=ua.ie&&document.documentElement&&typeof document.documentElement.style.maxHeight!=="undefined"&&typeof XDomainRequest==="undefined";ua.ie8=ua.ie&&typeof XDomainRequest!=="undefined";var domReady=function(){var e=[];var t=function(){if(!arguments.callee.done){arguments.callee.done=true;for(var t=0;t<e.length;t++){e[t]()}}};if(document.addEventListener){document.addEventListener("DOMContentLoaded",t,false)}if(ua.ie){(function(){try{document.documentElement.doScroll("left")}catch(e){setTimeout(arguments.callee,50);return}t()})();document.onreadystatechange=function(){if(document.readyState==="complete"){document.onreadystatechange=null;t()}}}if(ua.webkit&&document.readyState){(function(){if(document.readyState!=="loading"){t()}else{setTimeout(arguments.callee,10)}})()}window.onload=t;return function(t){if(typeof t==="function"){e[e.length]=t}return t}}();var cssHelper=function(){var e={BLOCKS:/[^\s{;][^{;]*\{(?:[^{}]*\{[^{}]*\}[^{}]*|[^{}]*)*\}/g,BLOCKS_INSIDE:/[^\s{][^{]*\{[^{}]*\}/g,DECLARATIONS:/[a-zA-Z\-]+[^;]*:[^;]+;/g,RELATIVE_URLS:/url\(['"]?([^\/\)'"][^:\)'"]+)['"]?\)/g,REDUNDANT_COMPONENTS:/(?:\/\*([^*\\\\]|\*(?!\/))+\*\/|@import[^;]+;)/g,REDUNDANT_WHITESPACE:/\s*(,|:|;|\{|\})\s*/g,WHITESPACE_IN_PARENTHESES:/\(\s*(\S*)\s*\)/g,MORE_WHITESPACE:/\s{2,}/g,FINAL_SEMICOLONS:/;\}/g,NOT_WHITESPACE:/\S+/g};var t,n=false;var r=[];var s=function(e){if(typeof e==="function"){r[r.length]=e}};var o=function(){for(var e=0;e<r.length;e++){r[e](t)}};var u={};var a=function(e,t){if(u[e]){var n=u[e].listeners;if(n){for(var r=0;r<n.length;r++){n[r](t)}}}};var f=function(e,t,n){if(ua.ie&&!window.XMLHttpRequest){window.XMLHttpRequest=function(){return new ActiveXObject("Microsoft.XMLHTTP")}}if(!XMLHttpRequest){return""}var r=new XMLHttpRequest;try{r.open("get",e,true);r.setRequestHeader("X_REQUESTED_WITH","XMLHttpRequest")}catch(i){n();return}var s=false;setTimeout(function(){s=true},5e3);document.documentElement.style.cursor="progress";r.onreadystatechange=function(){if(r.readyState===4&&!s){if(!r.status&&location.protocol==="file:"||r.status>=200&&r.status<300||r.status===304||navigator.userAgent.indexOf("Safari")>-1&&typeof r.status==="undefined"){t(r.responseText)}else{n()}document.documentElement.style.cursor="";r=null}};r.send("")};var l=function(t){t=t.replace(e.REDUNDANT_COMPONENTS,"");t=t.replace(e.REDUNDANT_WHITESPACE,"$1");t=t.replace(e.WHITESPACE_IN_PARENTHESES,"($1)");t=t.replace(e.MORE_WHITESPACE," ");t=t.replace(e.FINAL_SEMICOLONS,"}");return t};var c={stylesheet:function(t){var n={};var r=[],i=[],s=[],o=[];var u=t.cssHelperText;var a=t.getAttribute("media");if(a){var f=a.toLowerCase().split(",")}else{var f=["all"]}for(var l=0;l<f.length;l++){r[r.length]=c.mediaQuery(f[l],n)}var h=u.match(e.BLOCKS);if(h!==null){for(var l=0;l<h.length;l++){if(h[l].substring(0,7)==="@media "){var p=c.mediaQueryList(h[l],n);s=s.concat(p.getRules());i[i.length]=p}else{s[s.length]=o[o.length]=c.rule(h[l],n,null)}}}n.element=t;n.getCssText=function(){return u};n.getAttrMediaQueries=function(){return r};n.getMediaQueryLists=function(){return i};n.getRules=function(){return s};n.getRulesWithoutMQ=function(){return o};return n},mediaQueryList:function(t,n){var r={};var i=t.indexOf("{");var s=t.substring(0,i);t=t.substring(i+1,t.length-1);var o=[],u=[];var a=s.toLowerCase().substring(7).split(",");for(var f=0;f<a.length;f++){o[o.length]=c.mediaQuery(a[f],r)}var l=t.match(e.BLOCKS_INSIDE);if(l!==null){for(f=0;f<l.length;f++){u[u.length]=c.rule(l[f],n,r)}}r.type="mediaQueryList";r.getMediaQueries=function(){return o};r.getRules=function(){return u};r.getListText=function(){return s};r.getCssText=function(){return t};return r},mediaQuery:function(t,n){t=t||"";var r,i;if(n.type==="mediaQueryList"){r=n}else{i=n}var s=false,o;var u=[];var a=true;var f=t.match(e.NOT_WHITESPACE);for(var l=0;l<f.length;l++){var c=f[l];if(!o&&(c==="not"||c==="only")){if(c==="not"){s=true}}else if(!o){o=c}else if(c.charAt(0)==="("){var h=c.substring(1,c.length-1).split(":");u[u.length]={mediaFeature:h[0],value:h[1]||null}}}return{getQueryText:function(){return t},getAttrStyleSheet:function(){return i||null},getList:function(){return r||null},getValid:function(){return a},getNot:function(){return s},getMediaType:function(){return o},getExpressions:function(){return u}}},rule:function(e,t,n){var r={};var i=e.indexOf("{");var s=e.substring(0,i);var o=s.split(",");var u=[];var a=e.substring(i+1,e.length-1).split(";");for(var f=0;f<a.length;f++){u[u.length]=c.declaration(a[f],r)}r.getStylesheet=function(){return t||null};r.getMediaQueryList=function(){return n||null};r.getSelectors=function(){return o};r.getSelectorText=function(){return s};r.getDeclarations=function(){return u};r.getPropertyValue=function(e){for(var t=0;t<u.length;t++){if(u[t].getProperty()===e){return u[t].getValue()}}return null};return r},declaration:function(e,t){var n=e.indexOf(":");var r=e.substring(0,n);var i=e.substring(n+1);return{getRule:function(){return t||null},getProperty:function(){return r},getValue:function(){return i}}}};var h=function(e){if(typeof e.cssHelperText!=="string"){return}var n={stylesheet:null,mediaQueryLists:[],rules:[],selectors:{},declarations:[],properties:{}};var r=n.stylesheet=c.stylesheet(e);var s=n.mediaQueryLists=r.getMediaQueryLists();var o=n.rules=r.getRules();var u=n.selectors;var a=function(e){var t=e.getSelectors();for(var n=0;n<t.length;n++){var r=t[n];if(!u[r]){u[r]=[]}u[r][u[r].length]=e}};for(i=0;i<o.length;i++){a(o[i])}var f=n.declarations;for(i=0;i<o.length;i++){f=n.declarations=f.concat(o[i].getDeclarations())}var l=n.properties;for(i=0;i<f.length;i++){var h=f[i].getProperty();if(!l[h]){l[h]=[]}l[h][l[h].length]=f[i]}e.cssHelperParsed=n;t[t.length]=e;return n};var p=function(e,t){return;e.cssHelperText=l(t||e.innerHTML);return h(e)};var d=function(){n=true;t=[];var r=[];var i=function(){for(var e=0;e<r.length;e++){h(r[e])}var t=document.getElementsByTagName("style");for(e=0;e<t.length;e++){p(t[e])}n=false;o()};var s=document.getElementsByTagName("link");for(var u=0;u<s.length;u++){var a=s[u];if(a.getAttribute("rel").indexOf("style")>-1&&a.href&&a.href.length!==0&&!a.disabled){r[r.length]=a}}if(r.length>0){var c=0;var d=function(){c++;if(c===r.length){i()}};var v=function(t){var n=t.href;f(n,function(r){r=l(r).replace(e.RELATIVE_URLS,"url("+n.substring(0,n.lastIndexOf("/"))+"/$1)");t.cssHelperText=r;d()},d)};for(u=0;u<r.length;u++){v(r[u])}}else{i()}};var v={stylesheets:"array",mediaQueryLists:"array",rules:"array",selectors:"object",declarations:"array",properties:"object"};var m={stylesheets:null,mediaQueryLists:null,rules:null,selectors:null,declarations:null,properties:null};var g=function(e,t){if(m[e]!==null){if(v[e]==="array"){return m[e]=m[e].concat(t)}else{var n=m[e];for(var r in t){if(t.hasOwnProperty(r)){if(!n[r]){n[r]=t[r]}else{n[r]=n[r].concat(t[r])}}}return n}}};var y=function(e){m[e]=v[e]==="array"?[]:{};for(var n=0;n<t.length;n++){var r=e==="stylesheets"?"stylesheet":e;g(e,t[n].cssHelperParsed[r])}return m[e]};var b=function(e){if(typeof window.innerWidth!="undefined"){return window["inner"+e]}else if(typeof document.documentElement!=="undefined"&&typeof document.documentElement.clientWidth!=="undefined"&&document.documentElement.clientWidth!=0){return document.documentElement["client"+e]}};return{addStyle:function(e,t,n){var r=document.createElement("style");r.setAttribute("type","text/css");if(t&&t.length>0){r.setAttribute("media",t.join(","))}document.getElementsByTagName("head")[0].appendChild(r);if(r.styleSheet){r.styleSheet.cssText=e}else{r.appendChild(document.createTextNode(e))}r.addedWithCssHelper=true;if(typeof n==="undefined"||n===true){cssHelper.parsed(function(t){var n=p(r,e);for(var i in n){if(n.hasOwnProperty(i)){g(i,n[i])}}a("newStyleParsed",r)})}else{r.parsingDisallowed=true}return r},removeStyle:function(e){return e.parentNode.removeChild(e)},parsed:function(e){if(n){s(e)}else{if(typeof t!=="undefined"){if(typeof e==="function"){e(t)}}else{s(e);d()}}},stylesheets:function(e){cssHelper.parsed(function(t){e(m.stylesheets||y("stylesheets"))})},mediaQueryLists:function(e){cssHelper.parsed(function(t){e(m.mediaQueryLists||y("mediaQueryLists"))})},rules:function(e){cssHelper.parsed(function(t){e(m.rules||y("rules"))})},selectors:function(e){cssHelper.parsed(function(t){e(m.selectors||y("selectors"))})},declarations:function(e){cssHelper.parsed(function(t){e(m.declarations||y("declarations"))})},properties:function(e){cssHelper.parsed(function(t){e(m.properties||y("properties"))})},broadcast:a,addListener:function(e,t){if(typeof t==="function"){if(!u[e]){u[e]={listeners:[]}}u[e].listeners[u[e].listeners.length]=t}},removeListener:function(e,t){if(typeof t==="function"&&u[e]){var n=u[e].listeners;for(var r=0;r<n.length;r++){if(n[r]===t){n.splice(r,1);r-=1}}}},getViewportWidth:function(){return b("Width")},getViewportHeight:function(){return b("Height")}}}();domReady(function(){var t;var n={LENGTH_UNIT:/[0-9]+(em|ex|px|in|cm|mm|pt|pc)$/,RESOLUTION_UNIT:/[0-9]+(dpi|dpcm)$/,ASPECT_RATIO:/^[0-9]+\/[0-9]+$/,ABSOLUTE_VALUE:/^[0-9]*(\.[0-9]+)*$/};var r=[];var i=function(){var e="css3-mediaqueries-test";var t=document.createElement("div");t.id=e;var n=cssHelper.addStyle("@media all and (width) { #"+e+" { width: 1px !important; } }",[],false);document.body.appendChild(t);var r=t.offsetWidth===1;n.parentNode.removeChild(n);t.parentNode.removeChild(t);i=function(){return r};return r};var s=function(){t=document.createElement("div");t.style.cssText="position:absolute;top:-9999em;left:-9999em;"+"margin:0;border:none;padding:0;width:1em;font-size:1em;";document.body.appendChild(t);if(t.offsetWidth!==16){t.style.fontSize=16/t.offsetWidth+"em"}t.style.width=""};var o=function(e){t.style.width=e;var n=t.offsetWidth;t.style.width="";return n};var u=function(e,t){var r=e.length;var i=e.substring(0,4)==="min-";var s=!i&&e.substring(0,4)==="max-";if(t!==null){var u;var a;if(n.LENGTH_UNIT.exec(t)){u="length";a=o(t)}else if(n.RESOLUTION_UNIT.exec(t)){u="resolution";a=parseInt(t,10);var f=t.substring((a+"").length)}else if(n.ASPECT_RATIO.exec(t)){u="aspect-ratio";a=t.split("/")}else if(n.ABSOLUTE_VALUE){u="absolute";a=t}else{u="unknown"}}var l,c;if("device-width"===e.substring(r-12,r)){l=screen.width;if(t!==null){if(u==="length"){return i&&l>=a||s&&l<a||!i&&!s&&l===a}else{return false}}else{return l>0}}else if("device-height"===e.substring(r-13,r)){c=screen.height;if(t!==null){if(u==="length"){return i&&c>=a||s&&c<a||!i&&!s&&c===a}else{return false}}else{return c>0}}else if("width"===e.substring(r-5,r)){l=document.documentElement.clientWidth||document.body.clientWidth;if(t!==null){if(u==="length"){return i&&l>=a||s&&l<a||!i&&!s&&l===a}else{return false}}else{return l>0}}else if("height"===e.substring(r-6,r)){c=document.documentElement.clientHeight||document.body.clientHeight;if(t!==null){if(u==="length"){return i&&c>=a||s&&c<a||!i&&!s&&c===a}else{return false}}else{return c>0}}else if("device-aspect-ratio"===e.substring(r-19,r)){return u==="aspect-ratio"&&screen.width*a[1]===screen.height*a[0]}else if("color-index"===e.substring(r-11,r)){var h=Math.pow(2,screen.colorDepth);if(t!==null){if(u==="absolute"){return i&&h>=a||s&&h<a||!i&&!s&&h===a}else{return false}}else{return h>0}}else if("color"===e.substring(r-5,r)){var p=screen.colorDepth;if(t!==null){if(u==="absolute"){return i&&p>=a||s&&p<a||!i&&!s&&p===a}else{return false}}else{return p>0}}else if("resolution"===e.substring(r-10,r)){var d;if(f==="dpcm"){d=o("1cm")}else{d=o("1in")}if(t!==null){if(u==="resolution"){return i&&d>=a||s&&d<a||!i&&!s&&d===a}else{return false}}else{return d>0}}else{return false}};var a=function(e){var t=e.getValid();var n=e.getExpressions();var r=n.length;if(r>0){for(var i=0;i<r&&t;i++){t=u(n[i].mediaFeature,n[i].value)}var s=e.getNot();return t&&!s||s&&!t}return t};var f=function(e,t){var n=e.getMediaQueries();var i={};for(var s=0;s<n.length;s++){var o=n[s].getMediaType();if(n[s].getExpressions().length===0){continue}var u=true;if(o!=="all"&&t&&t.length>0){u=false;for(var f=0;f<t.length;f++){if(t[f]===o){u=true}}}if(u&&a(n[s])){i[o]=true}}var l=[],c=0;for(var h in i){if(i.hasOwnProperty(h)){if(c>0){l[c++]=","}l[c++]=h}}if(l.length>0){r[r.length]=cssHelper.addStyle("@media "+l.join("")+"{"+e.getCssText()+"}",t,false)}};var l=function(e,t){for(var n=0;n<e.length;n++){f(e[n],t)}};var c=function(e){var t=e.getAttrMediaQueries();var n=false;var i={};for(var s=0;s<t.length;s++){if(a(t[s])){i[t[s].getMediaType()]=t[s].getExpressions().length>0}}var o=[],u=[];for(var f in i){if(i.hasOwnProperty(f)){o[o.length]=f;if(i[f]){u[u.length]=f}if(f==="all"){n=true}}}if(u.length>0){r[r.length]=cssHelper.addStyle(e.getCssText(),u,false)}var c=e.getMediaQueryLists();if(n){l(c)}else{l(c,o)}};var h=function(e){for(var t=0;t<e.length;t++){c(e[t])}if(ua.ie){document.documentElement.style.display="block";setTimeout(function(){document.documentElement.style.display=""},0);setTimeout(function(){cssHelper.broadcast("cssMediaQueriesTested")},100)}else{cssHelper.broadcast("cssMediaQueriesTested")}};var p=function(){for(var e=0;e<r.length;e++){cssHelper.removeStyle(r[e])}r=[];cssHelper.stylesheets(h)};var d=0;var v=function(){var e=cssHelper.getViewportWidth();var t=cssHelper.getViewportHeight();if(ua.ie){var n=document.createElement("div");n.style.position="absolute";n.style.top="-9999em";n.style.overflow="scroll";document.body.appendChild(n);d=n.offsetWidth-n.clientWidth;document.body.removeChild(n)}var r;var s=function(){var n=cssHelper.getViewportWidth();var s=cssHelper.getViewportHeight();if(Math.abs(n-e)>d||Math.abs(s-t)>d){e=n;t=s;clearTimeout(r);r=setTimeout(function(){if(!i()){p()}else{cssHelper.broadcast("cssMediaQueriesTested")}},500)}};window.onresize=function(){var e=window.onresize||function(){};return function(){e();s()}}()};var m=document.documentElement;m.style.marginLeft="-32767px";setTimeout(function(){m.style.marginLeft=""},5e3);return function(){if(!i()){cssHelper.addListener("newStyleParsed",function(e){c(e.cssHelperParsed.stylesheet)});cssHelper.addListener("cssMediaQueriesTested",function(){if(ua.ie){m.style.width="1px"}setTimeout(function(){m.style.width="";m.style.marginLeft=""},0);cssHelper.removeListener("cssMediaQueriesTested",arguments.callee)});s();p()}else{m.style.marginLeft=""}v()}}());try{document.execCommand("BackgroundImageCache",false,true)}catch(e){}
diff --git a/docs/_build/html/_static/css3-mediaqueries_src.js b/docs/_build/html/_static/css3-mediaqueries_src.js
new file mode 100644
index 0000000000000000000000000000000000000000..78786202744b89fd21806c34d25f132a823c07ae
--- /dev/null
+++ b/docs/_build/html/_static/css3-mediaqueries_src.js
@@ -0,0 +1,1104 @@
+/*
+css3-mediaqueries.js - CSS Helper and CSS3 Media Queries Enabler
+
+author: Wouter van der Graaf <wouter at dynora nl>
+version: 1.0 (20110330)
+license: MIT
+website: http://code.google.com/p/css3-mediaqueries-js/
+
+W3C spec: http://www.w3.org/TR/css3-mediaqueries/
+
+Note: use of embedded <style> is not recommended when using media queries, because IE has no way of returning the raw literal css text from a <style> element.
+*/
+
+
+// true prototypal inheritance (http://javascript.crockford.com/prototypal.html)
+if (typeof Object.create !== 'function') {
+ Object.create = function (o) {
+ function F() {}
+ F.prototype = o;
+ return new F();
+ };
+}
+
+
+// user agent sniffing shortcuts
+var ua = {
+ toString: function () {
+ return navigator.userAgent;
+ },
+ test: function (s) {
+ return this.toString().toLowerCase().indexOf(s.toLowerCase()) > -1;
+ }
+};
+ua.version = (ua.toString().toLowerCase().match(/[\s\S]+(?:rv|it|ra|ie)[\/: ]([\d.]+)/) || [])[1];
+ua.webkit = ua.test('webkit');
+ua.gecko = ua.test('gecko') && !ua.webkit;
+ua.opera = ua.test('opera');
+ua.ie = ua.test('msie') && !ua.opera;
+ua.ie6 = ua.ie && document.compatMode && typeof document.documentElement.style.maxHeight === 'undefined';
+ua.ie7 = ua.ie && document.documentElement && typeof document.documentElement.style.maxHeight !== 'undefined' && typeof XDomainRequest === 'undefined';
+ua.ie8 = ua.ie && typeof XDomainRequest !== 'undefined';
+
+
+
+// initialize when DOM content is loaded
+var domReady = function () {
+ var fns = [];
+ var init = function () {
+ if (!arguments.callee.done) { // run init functions once
+ arguments.callee.done = true;
+ for (var i = 0; i < fns.length; i++) {
+ fns[i]();
+ }
+ }
+ };
+
+ // listeners for different browsers
+ if (document.addEventListener) {
+ document.addEventListener('DOMContentLoaded', init, false);
+ }
+ if (ua.ie) {
+ (function () {
+ try {
+ // throws errors until after ondocumentready
+ document.documentElement.doScroll('left');
+ }
+ catch (e) {
+ setTimeout(arguments.callee, 50);
+ return;
+ }
+ // no errors, fire
+ init();
+ })();
+ // trying to always fire before onload
+ document.onreadystatechange = function () {
+ if (document.readyState === 'complete') {
+ document.onreadystatechange = null;
+ init();
+ }
+ };
+ }
+ if (ua.webkit && document.readyState) {
+ (function () {
+ if (document.readyState !== 'loading') {
+ init();
+ }
+ else {
+ setTimeout(arguments.callee, 10);
+ }
+ })();
+ }
+ window.onload = init; // fallback
+
+ return function (fn) { // add fn to init functions
+ if (typeof fn === 'function') {
+ fns[fns.length] = fn;
+ }
+ return fn;
+ };
+}();
+
+
+
+// helper library for parsing css to objects
+var cssHelper = function () {
+
+ var regExp = {
+ BLOCKS: /[^\s{;][^{;]*\{(?:[^{}]*\{[^{}]*\}[^{}]*|[^{}]*)*\}/g,
+ BLOCKS_INSIDE: /[^\s{][^{]*\{[^{}]*\}/g,
+ DECLARATIONS: /[a-zA-Z\-]+[^;]*:[^;]+;/g,
+ RELATIVE_URLS: /url\(['"]?([^\/\)'"][^:\)'"]+)['"]?\)/g,
+ // strip whitespace and comments, @import is evil
+ REDUNDANT_COMPONENTS: /(?:\/\*([^*\\\\]|\*(?!\/))+\*\/|@import[^;]+;)/g,
+ REDUNDANT_WHITESPACE: /\s*(,|:|;|\{|\})\s*/g,
+ WHITESPACE_IN_PARENTHESES: /\(\s*(\S*)\s*\)/g,
+ MORE_WHITESPACE: /\s{2,}/g,
+ FINAL_SEMICOLONS: /;\}/g,
+ NOT_WHITESPACE: /\S+/g
+ };
+
+ var parsed, parsing = false;
+
+ var waiting = [];
+ var wait = function (fn) {
+ if (typeof fn === 'function') {
+ waiting[waiting.length] = fn;
+ }
+ };
+ var ready = function () {
+ for (var i = 0; i < waiting.length; i++) {
+ waiting[i](parsed);
+ }
+ };
+ var events = {};
+ var broadcast = function (n, v) {
+ if (events[n]) {
+ var listeners = events[n].listeners;
+ if (listeners) {
+ for (var i = 0; i < listeners.length; i++) {
+ listeners[i](v);
+ }
+ }
+ }
+ };
+
+ var requestText = function (url, fnSuccess, fnFailure) {
+ if (ua.ie && !window.XMLHttpRequest) {
+ window.XMLHttpRequest = function () {
+ return new ActiveXObject('Microsoft.XMLHTTP');
+ };
+ }
+ if (!XMLHttpRequest) {
+ return '';
+ }
+ var r = new XMLHttpRequest();
+ try {
+ r.open('get', url, true);
+ r.setRequestHeader('X_REQUESTED_WITH', 'XMLHttpRequest');
+ }
+ catch (e) {
+ fnFailure();
+ return;
+ }
+ var done = false;
+ setTimeout(function () {
+ done = true;
+ }, 5000);
+ document.documentElement.style.cursor = 'progress';
+ r.onreadystatechange = function () {
+ if (r.readyState === 4 && !done) {
+ if (!r.status && location.protocol === 'file:' ||
+ (r.status >= 200 && r.status < 300) ||
+ r.status === 304 ||
+ navigator.userAgent.indexOf('Safari') > -1 && typeof r.status === 'undefined') {
+ fnSuccess(r.responseText);
+ }
+ else {
+ fnFailure();
+ }
+ document.documentElement.style.cursor = '';
+ r = null; // avoid memory leaks
+ }
+ };
+ r.send('');
+ };
+
+ var sanitize = function (text) {
+ text = text.replace(regExp.REDUNDANT_COMPONENTS, '');
+ text = text.replace(regExp.REDUNDANT_WHITESPACE, '$1');
+ text = text.replace(regExp.WHITESPACE_IN_PARENTHESES, '($1)');
+ text = text.replace(regExp.MORE_WHITESPACE, ' ');
+ text = text.replace(regExp.FINAL_SEMICOLONS, '}'); // optional final semicolons
+ return text;
+ };
+
+ var objects = {
+ stylesheet: function (el) {
+ var o = {};
+ var amqs = [], mqls = [], rs = [], rsw = [];
+ var s = el.cssHelperText;
+
+ // add attribute media queries
+ var attr = el.getAttribute('media');
+ if (attr) {
+ var qts = attr.toLowerCase().split(',')
+ }
+ else {
+ var qts = ['all'] // imply 'all'
+ }
+ for (var i = 0; i < qts.length; i++) {
+ amqs[amqs.length] = objects.mediaQuery(qts[i], o);
+ }
+
+ // add media query lists and rules (top down order)
+ var blocks = s.match(regExp.BLOCKS); // @charset is not a block
+ if (blocks !== null) {
+ for (var i = 0; i < blocks.length; i++) {
+ if (blocks[i].substring(0, 7) === '@media ') { // media query (list)
+ var mql = objects.mediaQueryList(blocks[i], o);
+ rs = rs.concat(mql.getRules());
+ mqls[mqls.length] = mql;
+ }
+ else { // regular rule set, page context (@page) or font description (@font-face)
+ rs[rs.length] = rsw[rsw.length] = objects.rule(blocks[i], o, null);
+ }
+ }
+ }
+
+ o.element = el;
+ o.getCssText = function () {
+ return s;
+ };
+ o.getAttrMediaQueries = function () {
+ return amqs;
+ };
+ o.getMediaQueryLists = function () {
+ return mqls;
+ };
+ o.getRules = function () {
+ return rs;
+ };
+ o.getRulesWithoutMQ = function () {
+ return rsw;
+ };
+ return o;
+ },
+
+ mediaQueryList: function (s, stsh) {
+ var o = {};
+ var idx = s.indexOf('{');
+ var lt = s.substring(0, idx);
+ s = s.substring(idx + 1, s.length - 1);
+ var mqs = [], rs = [];
+
+ // add media queries
+ var qts = lt.toLowerCase().substring(7).split(',');
+ for (var i = 0; i < qts.length; i++) { // parse each media query
+ mqs[mqs.length] = objects.mediaQuery(qts[i], o);
+ }
+
+ // add rule sets
+ var rts = s.match(regExp.BLOCKS_INSIDE);
+ if (rts !== null) {
+ for (i = 0; i < rts.length; i++) {
+ rs[rs.length] = objects.rule(rts[i], stsh, o);
+ }
+ }
+
+ o.type = 'mediaQueryList';
+ o.getMediaQueries = function () {
+ return mqs;
+ };
+ o.getRules = function () {
+ return rs;
+ };
+ o.getListText = function () {
+ return lt;
+ };
+ o.getCssText = function () {
+ return s;
+ };
+ return o;
+ },
+
+ mediaQuery: function (s, listOrSheet) {
+ s = s || '';
+ var mql, stsh;
+ if (listOrSheet.type === 'mediaQueryList') {
+ mql = listOrSheet;
+ }
+ else {
+ stsh = listOrSheet;
+ }
+ var not = false, type;
+ var expr = [];
+ var valid = true;
+ var tokens = s.match(regExp.NOT_WHITESPACE);
+
+
+
+ for (var i = 0; i < tokens.length; i++) {
+ var token = tokens[i];
+ if (!type && (token === 'not' || token === 'only')) { // 'not' and 'only' keywords
+ // keyword 'only' does nothing, as if it was not present
+ if (token === 'not') {
+ not = true;
+ }
+ }
+ else if (!type) { // media type
+ type = token;
+ }
+ else if (token.charAt(0) === '(') { // media feature expression
+ var pair = token.substring(1, token.length - 1).split(':');
+ expr[expr.length] = {
+ mediaFeature: pair[0],
+ value: pair[1] || null
+ };
+ }
+ }
+
+ return {
+ getQueryText: function () {
+ return s;
+ },
+ getAttrStyleSheet: function () {
+ return stsh || null;
+ },
+ getList: function () {
+ return mql || null;
+ },
+ getValid: function () {
+ return valid;
+ },
+ getNot: function () {
+ return not;
+ },
+ getMediaType: function () {
+ return type;
+ },
+ getExpressions: function () {
+ return expr;
+ }
+ };
+ },
+
+ rule: function (s, stsh, mql) {
+ var o = {};
+ var idx = s.indexOf('{');
+ var st = s.substring(0, idx);
+ var ss = st.split(',');
+ var ds = [];
+ var dts = s.substring(idx + 1, s.length - 1).split(';');
+ for (var i = 0; i < dts.length; i++) {
+ ds[ds.length] = objects.declaration(dts[i], o);
+ }
+
+ o.getStylesheet = function () {
+ return stsh || null;
+ };
+ o.getMediaQueryList = function () {
+ return mql || null;
+ };
+ o.getSelectors = function () {
+ return ss;
+ };
+ o.getSelectorText = function () {
+ return st;
+ };
+ o.getDeclarations = function () {
+ return ds;
+ };
+ o.getPropertyValue = function (n) {
+ for (var i = 0; i < ds.length; i++) {
+ if (ds[i].getProperty() === n) {
+ return ds[i].getValue();
+ }
+ }
+ return null;
+ };
+ return o;
+ },
+
+ declaration: function (s, r) {
+ var idx = s.indexOf(':');
+ var p = s.substring(0, idx);
+ var v = s.substring(idx + 1);
+ return {
+ getRule: function () {
+ return r || null;
+ },
+ getProperty: function () {
+ return p;
+ },
+ getValue: function () {
+ return v;
+ }
+ };
+ }
+ };
+
+ var parseText = function (el) {
+ if (typeof el.cssHelperText !== 'string') {
+ return;
+ }
+ var o = {
+ stylesheet: null,
+ mediaQueryLists: [],
+ rules: [],
+ selectors: {},
+ declarations: [],
+ properties: {}
+ };
+
+ // build stylesheet object
+ var stsh = o.stylesheet = objects.stylesheet(el);
+
+ // collect media query lists
+ var mqls = o.mediaQueryLists = stsh.getMediaQueryLists();
+
+ // collect all rules
+ var ors = o.rules = stsh.getRules();
+
+ // collect all selectors
+ var oss = o.selectors;
+ var collectSelectors = function (r) {
+ var ss = r.getSelectors();
+ for (var i = 0; i < ss.length; i++) {
+ var n = ss[i];
+ if (!oss[n]) {
+ oss[n] = [];
+ }
+ oss[n][oss[n].length] = r;
+ }
+ };
+ for (var i = 0; i < ors.length; i++) {
+ collectSelectors(ors[i]);
+ }
+
+ // collect all declarations
+ var ods = o.declarations;
+ for (i = 0; i < ors.length; i++) {
+ ods = o.declarations = ods.concat(ors[i].getDeclarations());
+ }
+
+ // collect all properties
+ var ops = o.properties;
+ for (i = 0; i < ods.length; i++) {
+ var n = ods[i].getProperty();
+ if (!ops[n]) {
+ ops[n] = [];
+ }
+ ops[n][ops[n].length] = ods[i];
+ }
+
+ el.cssHelperParsed = o;
+ parsed[parsed.length] = el;
+ return o;
+ };
+
+ var parseEmbedded = function (el, s) {
+ return;
+ // This function doesn't work because of a bug in IE, where innerHTML gives us parsed css instead of raw literal.
+ el.cssHelperText = sanitize(s || el.innerHTML);
+ return parseText(el);
+ };
+
+ var parse = function () {
+ parsing = true;
+ parsed = [];
+ var linked = [];
+ var finish = function () {
+ for (var i = 0; i < linked.length; i++) {
+ parseText(linked[i]);
+ }
+ var styles = document.getElementsByTagName('style');
+ for (i = 0; i < styles.length; i++) {
+ parseEmbedded(styles[i]);
+ }
+ parsing = false;
+ ready();
+ };
+ var links = document.getElementsByTagName('link');
+ for (var i = 0; i < links.length; i++) {
+ var link = links[i];
+ if (link.getAttribute('rel').indexOf('style') > -1 && link.href && link.href.length !== 0 && !link.disabled) {
+ linked[linked.length] = link;
+ }
+ }
+ if (linked.length > 0) {
+ var c = 0;
+ var checkForFinish = function () {
+ c++;
+ if (c === linked.length) { // parse in right order, so after last link is read
+ finish();
+ }
+ };
+ var processLink = function (link) {
+ var href = link.href;
+ requestText(href, function (text) {
+ // fix url's
+ text = sanitize(text).replace(regExp.RELATIVE_URLS, 'url(' + href.substring(0, href.lastIndexOf('/')) + '/$1)');
+ link.cssHelperText = text;
+ checkForFinish();
+ }, checkForFinish);
+ };
+ for (i = 0; i < linked.length; i++) {
+ processLink(linked[i]);
+ }
+ }
+ else {
+ finish();
+ }
+ };
+
+ var types = {
+ stylesheets: 'array',
+ mediaQueryLists: 'array',
+ rules: 'array',
+ selectors: 'object',
+ declarations: 'array',
+ properties: 'object'
+ };
+
+ var collections = {
+ stylesheets: null,
+ mediaQueryLists: null,
+ rules: null,
+ selectors: null,
+ declarations: null,
+ properties: null
+ };
+
+ var addToCollection = function (name, v) {
+ if (collections[name] !== null) {
+ if (types[name] === 'array') {
+ return (collections[name] = collections[name].concat(v));
+ }
+ else {
+ var c = collections[name];
+ for (var n in v) {
+ if (v.hasOwnProperty(n)) {
+ if (!c[n]) {
+ c[n] = v[n];
+ }
+ else {
+ c[n] = c[n].concat(v[n]);
+ }
+ }
+ }
+ return c;
+ }
+ }
+ };
+
+ var collect = function (name) {
+ collections[name] = (types[name] === 'array') ? [] : {};
+ for (var i = 0; i < parsed.length; i++) {
+ var pname = name === 'stylesheets' ? 'stylesheet' : name; // the exception
+ addToCollection(name, parsed[i].cssHelperParsed[pname]);
+ }
+ return collections[name];
+ };
+
+ // viewport size
+ var getViewportSize = function (d) {
+ if (typeof window.innerWidth != 'undefined') {
+ return window['inner' + d];
+ }
+ else if (typeof document.documentElement !== 'undefined'
+ && typeof document.documentElement.clientWidth !== 'undefined'
+ && document.documentElement.clientWidth != 0) {
+ return document.documentElement['client' + d];
+ }
+ };
+
+ // public static functions
+ return {
+ addStyle: function (s, mediaTypes, process) {
+ var el = document.createElement('style');
+ el.setAttribute('type', 'text/css');
+ if (mediaTypes && mediaTypes.length > 0) {
+ el.setAttribute('media', mediaTypes.join(','));
+ }
+ document.getElementsByTagName('head')[0].appendChild(el);
+ if (el.styleSheet) { // IE
+ el.styleSheet.cssText = s;
+ }
+ else {
+ el.appendChild(document.createTextNode(s));
+ }
+ el.addedWithCssHelper = true;
+ if (typeof process === 'undefined' || process === true) {
+ cssHelper.parsed(function (parsed) {
+ var o = parseEmbedded(el, s);
+ for (var n in o) {
+ if (o.hasOwnProperty(n)) {
+ addToCollection(n, o[n]);
+ }
+ }
+ broadcast('newStyleParsed', el);
+ });
+ }
+ else {
+ el.parsingDisallowed = true;
+ }
+ return el;
+ },
+
+ removeStyle: function (el) {
+ return el.parentNode.removeChild(el);
+ },
+
+ parsed: function (fn) {
+ if (parsing) {
+ wait(fn);
+ }
+ else {
+ if (typeof parsed !== 'undefined') {
+ if (typeof fn === 'function') {
+ fn(parsed);
+ }
+ }
+ else {
+ wait(fn);
+ parse();
+ }
+ }
+ },
+
+ stylesheets: function (fn) {
+ cssHelper.parsed(function (parsed) {
+ fn(collections.stylesheets || collect('stylesheets'));
+ });
+ },
+
+ mediaQueryLists: function (fn) {
+ cssHelper.parsed(function (parsed) {
+ fn(collections.mediaQueryLists || collect('mediaQueryLists'));
+ });
+ },
+
+ rules: function (fn) {
+ cssHelper.parsed(function (parsed) {
+ fn(collections.rules || collect('rules'));
+ });
+ },
+
+ selectors: function (fn) {
+ cssHelper.parsed(function (parsed) {
+ fn(collections.selectors || collect('selectors'));
+ });
+ },
+
+ declarations: function (fn) {
+ cssHelper.parsed(function (parsed) {
+ fn(collections.declarations || collect('declarations'));
+ });
+ },
+
+ properties: function (fn) {
+ cssHelper.parsed(function (parsed) {
+ fn(collections.properties || collect('properties'));
+ });
+ },
+
+ broadcast: broadcast,
+
+ addListener: function (n, fn) { // in case n is 'styleadd': added function is called everytime style is added and parsed
+ if (typeof fn === 'function') {
+ if (!events[n]) {
+ events[n] = {
+ listeners: []
+ };
+ }
+ events[n].listeners[events[n].listeners.length] = fn;
+ }
+ },
+
+ removeListener: function (n, fn) {
+ if (typeof fn === 'function' && events[n]) {
+ var ls = events[n].listeners;
+ for (var i = 0; i < ls.length; i++) {
+ if (ls[i] === fn) {
+ ls.splice(i, 1);
+ i -= 1;
+ }
+ }
+ }
+ },
+
+ getViewportWidth: function () {
+ return getViewportSize('Width');
+ },
+
+ getViewportHeight: function () {
+ return getViewportSize('Height');
+ }
+ };
+}();
+
+
+
+// function to test and apply parsed media queries against browser capabilities
+domReady(function enableCssMediaQueries() {
+ var meter;
+
+ var regExp = {
+ LENGTH_UNIT: /[0-9]+(em|ex|px|in|cm|mm|pt|pc)$/,
+ RESOLUTION_UNIT: /[0-9]+(dpi|dpcm)$/,
+ ASPECT_RATIO: /^[0-9]+\/[0-9]+$/,
+ ABSOLUTE_VALUE: /^[0-9]*(\.[0-9]+)*$/
+ };
+
+ var styles = [];
+
+ var nativeSupport = function () {
+ // check support for media queries
+ var id = 'css3-mediaqueries-test';
+ var el = document.createElement('div');
+ el.id = id;
+ var style = cssHelper.addStyle('@media all and (width) { #' + id +
+ ' { width: 1px !important; } }', [], false); // false means don't parse this temp style
+ document.body.appendChild(el);
+ var ret = el.offsetWidth === 1;
+ style.parentNode.removeChild(style);
+ el.parentNode.removeChild(el);
+ nativeSupport = function () {
+ return ret;
+ };
+ return ret;
+ };
+
+ var createMeter = function () { // create measuring element
+ meter = document.createElement('div');
+ meter.style.cssText = 'position:absolute;top:-9999em;left:-9999em;' +
+ 'margin:0;border:none;padding:0;width:1em;font-size:1em;'; // cssText is needed for IE, works for the others
+ document.body.appendChild(meter);
+ // meter must have browser default font size of 16px
+ if (meter.offsetWidth !== 16) {
+ meter.style.fontSize = 16 / meter.offsetWidth + 'em';
+ }
+ meter.style.width = '';
+ };
+
+ var measure = function (value) {
+ meter.style.width = value;
+ var amount = meter.offsetWidth;
+ meter.style.width = '';
+ return amount;
+ };
+
+ var testMediaFeature = function (feature, value) {
+ // non-testable features: monochrome|min-monochrome|max-monochrome|scan|grid
+ var l = feature.length;
+ var min = (feature.substring(0, 4) === 'min-');
+ var max = (!min && feature.substring(0, 4) === 'max-');
+
+ if (value !== null) { // determine value type and parse to usable amount
+ var valueType;
+ var amount;
+ if (regExp.LENGTH_UNIT.exec(value)) {
+ valueType = 'length';
+ amount = measure(value);
+ }
+ else if (regExp.RESOLUTION_UNIT.exec(value)) {
+ valueType = 'resolution';
+ amount = parseInt(value, 10);
+ var unit = value.substring((amount + '').length);
+ }
+ else if (regExp.ASPECT_RATIO.exec(value)) {
+ valueType = 'aspect-ratio';
+ amount = value.split('/');
+ }
+ else if (regExp.ABSOLUTE_VALUE) {
+ valueType = 'absolute';
+ amount = value;
+ }
+ else {
+ valueType = 'unknown';
+ }
+ }
+
+ var width, height;
+ if ('device-width' === feature.substring(l - 12, l)) { // screen width
+ width = screen.width;
+ if (value !== null) {
+ if (valueType === 'length') {
+ return ((min && width >= amount) || (max && width < amount) || (!min && !max && width === amount));
+ }
+ else {
+ return false;
+ }
+ }
+ else { // test width without value
+ return width > 0;
+ }
+ }
+ else if ('device-height' === feature.substring(l - 13, l)) { // screen height
+ height = screen.height;
+ if (value !== null) {
+ if (valueType === 'length') {
+ return ((min && height >= amount) || (max && height < amount) || (!min && !max && height === amount));
+ }
+ else {
+ return false;
+ }
+ }
+ else { // test height without value
+ return height > 0;
+ }
+ }
+ else if ('width' === feature.substring(l - 5, l)) { // viewport width
+ width = document.documentElement.clientWidth || document.body.clientWidth; // the latter for IE quirks mode
+ if (value !== null) {
+ if (valueType === 'length') {
+ return ((min && width >= amount) || (max && width < amount) || (!min && !max && width === amount));
+ }
+ else {
+ return false;
+ }
+ }
+ else { // test width without value
+ return width > 0;
+ }
+ }
+ else if ('height' === feature.substring(l - 6, l)) { // viewport height
+ height = document.documentElement.clientHeight || document.body.clientHeight; // the latter for IE quirks mode
+ if (value !== null) {
+ if (valueType === 'length') {
+ return ((min && height >= amount) || (max && height < amount) || (!min && !max && height === amount));
+ }
+ else {
+ return false;
+ }
+ }
+ else { // test height without value
+ return height > 0;
+ }
+ }
+ else if ('device-aspect-ratio' === feature.substring(l - 19, l)) { // screen aspect ratio
+ return valueType === 'aspect-ratio' && screen.width * amount[1] === screen.height * amount[0];
+ }
+ else if ('color-index' === feature.substring(l - 11, l)) { // number of colors
+ var colors = Math.pow(2, screen.colorDepth);
+ if (value !== null) {
+ if (valueType === 'absolute') {
+ return ((min && colors >= amount) || (max && colors < amount) || (!min && !max && colors === amount));
+ }
+ else {
+ return false;
+ }
+ }
+ else { // test height without value
+ return colors > 0;
+ }
+ }
+ else if ('color' === feature.substring(l - 5, l)) { // bits per color component
+ var color = screen.colorDepth;
+ if (value !== null) {
+ if (valueType === 'absolute') {
+ return ((min && color >= amount) || (max && color < amount) || (!min && !max && color === amount));
+ }
+ else {
+ return false;
+ }
+ }
+ else { // test height without value
+ return color > 0;
+ }
+ }
+ else if ('resolution' === feature.substring(l - 10, l)) {
+ var res;
+ if (unit === 'dpcm') {
+ res = measure('1cm');
+ }
+ else {
+ res = measure('1in');
+ }
+ if (value !== null) {
+ if (valueType === 'resolution') {
+ return ((min && res >= amount) || (max && res < amount) || (!min && !max && res === amount));
+ }
+ else {
+ return false;
+ }
+ }
+ else { // test height without value
+ return res > 0;
+ }
+ }
+ else {
+ return false;
+ }
+ };
+
+ var testMediaQuery = function (mq) {
+ var test = mq.getValid();
+ var expressions = mq.getExpressions();
+ var l = expressions.length;
+ if (l > 0) {
+ for (var i = 0; i < l && test; i++) {
+ test = testMediaFeature(expressions[i].mediaFeature, expressions[i].value);
+ }
+ var not = mq.getNot();
+ return (test && !not || not && !test);
+ }
+ return test;
+ };
+
+ var testMediaQueryList = function (mql, ts) {
+ // ts is null or an array with any media type but 'all'.
+ var mqs = mql.getMediaQueries();
+ var t = {};
+ for (var i = 0; i < mqs.length; i++) {
+ var type = mqs[i].getMediaType();
+ if (mqs[i].getExpressions().length === 0) {
+ continue;
+ // TODO: Browser check! Assuming old browsers do apply the bare media types, even in a list with media queries.
+ }
+ var typeAllowed = true;
+ if (type !== 'all' && ts && ts.length > 0) {
+ typeAllowed = false;
+ for (var j = 0; j < ts.length; j++) {
+ if (ts[j] === type) {
+ typeAllowed = true;
+ }
+ }
+ }
+ if (typeAllowed && testMediaQuery(mqs[i])) {
+ t[type] = true;
+ }
+ }
+ var s = [], c = 0;
+ for (var n in t) {
+ if (t.hasOwnProperty(n)) {
+ if (c > 0) {
+ s[c++] = ',';
+ }
+ s[c++] = n;
+ }
+ }
+ if (s.length > 0) {
+ styles[styles.length] = cssHelper.addStyle('@media ' + s.join('') + '{' + mql.getCssText() + '}', ts, false);
+ }
+ };
+
+ var testMediaQueryLists = function (mqls, ts) {
+ for (var i = 0; i < mqls.length; i++) {
+ testMediaQueryList(mqls[i], ts);
+ }
+ };
+
+ var testStylesheet = function (stsh) {
+ var amqs = stsh.getAttrMediaQueries();
+ var allPassed = false;
+ var t = {};
+ for (var i = 0; i < amqs.length; i++) {
+ if (testMediaQuery(amqs[i])) {
+ t[amqs[i].getMediaType()] = amqs[i].getExpressions().length > 0;
+ }
+ }
+ var ts = [], tswe = [];
+ for (var n in t) {
+ if (t.hasOwnProperty(n)) {
+ ts[ts.length] = n;
+ if (t[n]) {
+ tswe[tswe.length] = n
+ }
+ if (n === 'all') {
+ allPassed = true;
+ }
+ }
+ }
+ if (tswe.length > 0) { // types with query expressions that passed the test
+ styles[styles.length] = cssHelper.addStyle(stsh.getCssText(), tswe, false);
+ }
+ var mqls = stsh.getMediaQueryLists();
+ if (allPassed) {
+ // If 'all' in media attribute passed the test, then test all @media types in linked CSS and create style with those types.
+ testMediaQueryLists(mqls);
+ }
+ else {
+ // Or else, test only media attribute types that passed the test and also 'all'.
+ // For positive '@media all', create style with attribute types that passed their test.
+ testMediaQueryLists(mqls, ts);
+ }
+ };
+
+ var testStylesheets = function (stshs) {
+ for (var i = 0; i < stshs.length; i++) {
+ testStylesheet(stshs[i]);
+ }
+ if (ua.ie) {
+ // force repaint in IE
+ document.documentElement.style.display = 'block';
+ setTimeout(function () {
+ document.documentElement.style.display = '';
+ }, 0);
+ // delay broadcast somewhat for IE
+ setTimeout(function () {
+ cssHelper.broadcast('cssMediaQueriesTested');
+ }, 100);
+ }
+ else {
+ cssHelper.broadcast('cssMediaQueriesTested');
+ }
+ };
+
+ var test = function () {
+ for (var i = 0; i < styles.length; i++) {
+ cssHelper.removeStyle(styles[i]);
+ }
+ styles = [];
+ cssHelper.stylesheets(testStylesheets);
+ };
+
+ var scrollbarWidth = 0;
+ var checkForResize = function () {
+ var cvpw = cssHelper.getViewportWidth();
+ var cvph = cssHelper.getViewportHeight();
+
+ // determine scrollbar width in IE, see resizeHandler
+ if (ua.ie) {
+ var el = document.createElement('div');
+ el.style.position = 'absolute';
+ el.style.top = '-9999em';
+ el.style.overflow = 'scroll';
+ document.body.appendChild(el);
+ scrollbarWidth = el.offsetWidth - el.clientWidth;
+ document.body.removeChild(el);
+ }
+
+ var timer;
+ var resizeHandler = function () {
+ var vpw = cssHelper.getViewportWidth();
+ var vph = cssHelper.getViewportHeight();
+ // check whether vp size has really changed, because IE also triggers resize event when body size changes
+ // 20px allowance to accommodate short appearance of scrollbars in IE in some cases
+ if (Math.abs(vpw - cvpw) > scrollbarWidth || Math.abs(vph - cvph) > scrollbarWidth) {
+ cvpw = vpw;
+ cvph = vph;
+ clearTimeout(timer);
+ timer = setTimeout(function () {
+ if (!nativeSupport()) {
+ test();
+ }
+ else {
+ cssHelper.broadcast('cssMediaQueriesTested');
+ }
+ }, 500);
+ }
+ };
+
+ window.onresize = function () {
+ var x = window.onresize || function () {}; // save original
+ return function () {
+ x();
+ resizeHandler();
+ };
+ }();
+ };
+
+ // prevent jumping of layout by hiding everything before painting <body>
+ var docEl = document.documentElement;
+ docEl.style.marginLeft = '-32767px';
+
+ // make sure it comes back after a while
+ setTimeout(function () {
+ docEl.style.marginLeft = '';
+ }, 5000);
+
+ return function () {
+ if (!nativeSupport()) { // if browser doesn't support media queries
+ cssHelper.addListener('newStyleParsed', function (el) {
+ testStylesheet(el.cssHelperParsed.stylesheet);
+ });
+ // return visibility after media queries are tested
+ cssHelper.addListener('cssMediaQueriesTested', function () {
+ // force repaint in IE by changing width
+ if (ua.ie) {
+ docEl.style.width = '1px';
+ }
+ setTimeout(function () {
+ docEl.style.width = ''; // undo width
+ docEl.style.marginLeft = ''; // undo hide
+ }, 0);
+ // remove this listener to prevent following execution
+ cssHelper.removeListener('cssMediaQueriesTested', arguments.callee);
+ });
+ createMeter();
+ test();
+ }
+ else {
+ docEl.style.marginLeft = ''; // undo visibility hidden
+ }
+ checkForResize();
+ };
+}());
+
+
+// bonus: hotfix for IE6 SP1 (bug KB823727)
+try {
+ document.execCommand('BackgroundImageCache', false, true);
+} catch (e) {}
diff --git a/docs/_build/html/_static/doctools.js b/docs/_build/html/_static/doctools.js
new file mode 100644
index 0000000000000000000000000000000000000000..8cbf1b161a6527c8c6ad1c4f1fdc156e065ab262
--- /dev/null
+++ b/docs/_build/html/_static/doctools.js
@@ -0,0 +1,323 @@
+/*
+ * doctools.js
+ * ~~~~~~~~~~~
+ *
+ * Sphinx JavaScript utilities for all documentation.
+ *
+ * :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS.
+ * :license: BSD, see LICENSE for details.
+ *
+ */
+
+/**
+ * select a different prefix for underscore
+ */
+$u = _.noConflict();
+
+/**
+ * make the code below compatible with browsers without
+ * an installed firebug like debugger
+if (!window.console || !console.firebug) {
+ var names = ["log", "debug", "info", "warn", "error", "assert", "dir",
+ "dirxml", "group", "groupEnd", "time", "timeEnd", "count", "trace",
+ "profile", "profileEnd"];
+ window.console = {};
+ for (var i = 0; i < names.length; ++i)
+ window.console[names[i]] = function() {};
+}
+ */
+
+/**
+ * small helper function to urldecode strings
+ *
+ * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent#Decoding_query_parameters_from_a_URL
+ */
+jQuery.urldecode = function(x) {
+ if (!x) {
+ return x
+ }
+ return decodeURIComponent(x.replace(/\+/g, ' '));
+};
+
+/**
+ * small helper function to urlencode strings
+ */
+jQuery.urlencode = encodeURIComponent;
+
+/**
+ * This function returns the parsed url parameters of the
+ * current request. Multiple values per key are supported,
+ * it will always return arrays of strings for the value parts.
+ */
+jQuery.getQueryParameters = function(s) {
+ if (typeof s === 'undefined')
+ s = document.location.search;
+ var parts = s.substr(s.indexOf('?') + 1).split('&');
+ var result = {};
+ for (var i = 0; i < parts.length; i++) {
+ var tmp = parts[i].split('=', 2);
+ var key = jQuery.urldecode(tmp[0]);
+ var value = jQuery.urldecode(tmp[1]);
+ if (key in result)
+ result[key].push(value);
+ else
+ result[key] = [value];
+ }
+ return result;
+};
+
+/**
+ * highlight a given string on a jquery object by wrapping it in
+ * span elements with the given class name.
+ */
+jQuery.fn.highlightText = function(text, className) {
+ function highlight(node, addItems) {
+ if (node.nodeType === 3) {
+ var val = node.nodeValue;
+ var pos = val.toLowerCase().indexOf(text);
+ if (pos >= 0 &&
+ !jQuery(node.parentNode).hasClass(className) &&
+ !jQuery(node.parentNode).hasClass("nohighlight")) {
+ var span;
+ var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg");
+ if (isInSVG) {
+ span = document.createElementNS("http://www.w3.org/2000/svg", "tspan");
+ } else {
+ span = document.createElement("span");
+ span.className = className;
+ }
+ span.appendChild(document.createTextNode(val.substr(pos, text.length)));
+ node.parentNode.insertBefore(span, node.parentNode.insertBefore(
+ document.createTextNode(val.substr(pos + text.length)),
+ node.nextSibling));
+ node.nodeValue = val.substr(0, pos);
+ if (isInSVG) {
+ var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect");
+ var bbox = node.parentElement.getBBox();
+ rect.x.baseVal.value = bbox.x;
+ rect.y.baseVal.value = bbox.y;
+ rect.width.baseVal.value = bbox.width;
+ rect.height.baseVal.value = bbox.height;
+ rect.setAttribute('class', className);
+ addItems.push({
+ "parent": node.parentNode,
+ "target": rect});
+ }
+ }
+ }
+ else if (!jQuery(node).is("button, select, textarea")) {
+ jQuery.each(node.childNodes, function() {
+ highlight(this, addItems);
+ });
+ }
+ }
+ var addItems = [];
+ var result = this.each(function() {
+ highlight(this, addItems);
+ });
+ for (var i = 0; i < addItems.length; ++i) {
+ jQuery(addItems[i].parent).before(addItems[i].target);
+ }
+ return result;
+};
+
+/*
+ * backward compatibility for jQuery.browser
+ * This will be supported until firefox bug is fixed.
+ */
+if (!jQuery.browser) {
+ jQuery.uaMatch = function(ua) {
+ ua = ua.toLowerCase();
+
+ var match = /(chrome)[ \/]([\w.]+)/.exec(ua) ||
+ /(webkit)[ \/]([\w.]+)/.exec(ua) ||
+ /(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) ||
+ /(msie) ([\w.]+)/.exec(ua) ||
+ ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) ||
+ [];
+
+ return {
+ browser: match[ 1 ] || "",
+ version: match[ 2 ] || "0"
+ };
+ };
+ jQuery.browser = {};
+ jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true;
+}
+
+/**
+ * Small JavaScript module for the documentation.
+ */
+var Documentation = {
+
+ init : function() {
+ this.fixFirefoxAnchorBug();
+ this.highlightSearchWords();
+ this.initIndexTable();
+ if (DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) {
+ this.initOnKeyListeners();
+ }
+ },
+
+ /**
+ * i18n support
+ */
+ TRANSLATIONS : {},
+ PLURAL_EXPR : function(n) { return n === 1 ? 0 : 1; },
+ LOCALE : 'unknown',
+
+ // gettext and ngettext don't access this so that the functions
+ // can safely bound to a different name (_ = Documentation.gettext)
+ gettext : function(string) {
+ var translated = Documentation.TRANSLATIONS[string];
+ if (typeof translated === 'undefined')
+ return string;
+ return (typeof translated === 'string') ? translated : translated[0];
+ },
+
+ ngettext : function(singular, plural, n) {
+ var translated = Documentation.TRANSLATIONS[singular];
+ if (typeof translated === 'undefined')
+ return (n == 1) ? singular : plural;
+ return translated[Documentation.PLURALEXPR(n)];
+ },
+
+ addTranslations : function(catalog) {
+ for (var key in catalog.messages)
+ this.TRANSLATIONS[key] = catalog.messages[key];
+ this.PLURAL_EXPR = new Function('n', 'return +(' + catalog.plural_expr + ')');
+ this.LOCALE = catalog.locale;
+ },
+
+ /**
+ * add context elements like header anchor links
+ */
+ addContextElements : function() {
+ $('div[id] > :header:first').each(function() {
+ $('<a class="headerlink">\u00B6</a>').
+ attr('href', '#' + this.id).
+ attr('title', _('Permalink to this headline')).
+ appendTo(this);
+ });
+ $('dt[id]').each(function() {
+ $('<a class="headerlink">\u00B6</a>').
+ attr('href', '#' + this.id).
+ attr('title', _('Permalink to this definition')).
+ appendTo(this);
+ });
+ },
+
+ /**
+ * workaround a firefox stupidity
+ * see: https://bugzilla.mozilla.org/show_bug.cgi?id=645075
+ */
+ fixFirefoxAnchorBug : function() {
+ if (document.location.hash && $.browser.mozilla)
+ window.setTimeout(function() {
+ document.location.href += '';
+ }, 10);
+ },
+
+ /**
+ * highlight the search words provided in the url in the text
+ */
+ highlightSearchWords : function() {
+ var params = $.getQueryParameters();
+ var terms = (params.highlight) ? params.highlight[0].split(/\s+/) : [];
+ if (terms.length) {
+ var body = $('div.body');
+ if (!body.length) {
+ body = $('body');
+ }
+ window.setTimeout(function() {
+ $.each(terms, function() {
+ body.highlightText(this.toLowerCase(), 'highlighted');
+ });
+ }, 10);
+ $('<p class="highlight-link"><a href="javascript:Documentation.' +
+ 'hideSearchWords()">' + _('Hide Search Matches') + '</a></p>')
+ .appendTo($('#searchbox'));
+ }
+ },
+
+ /**
+ * init the domain index toggle buttons
+ */
+ initIndexTable : function() {
+ var togglers = $('img.toggler').click(function() {
+ var src = $(this).attr('src');
+ var idnum = $(this).attr('id').substr(7);
+ $('tr.cg-' + idnum).toggle();
+ if (src.substr(-9) === 'minus.png')
+ $(this).attr('src', src.substr(0, src.length-9) + 'plus.png');
+ else
+ $(this).attr('src', src.substr(0, src.length-8) + 'minus.png');
+ }).css('display', '');
+ if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) {
+ togglers.click();
+ }
+ },
+
+ /**
+ * helper function to hide the search marks again
+ */
+ hideSearchWords : function() {
+ $('#searchbox .highlight-link').fadeOut(300);
+ $('span.highlighted').removeClass('highlighted');
+ },
+
+ /**
+ * make the url absolute
+ */
+ makeURL : function(relativeURL) {
+ return DOCUMENTATION_OPTIONS.URL_ROOT + '/' + relativeURL;
+ },
+
+ /**
+ * get the current relative url
+ */
+ getCurrentURL : function() {
+ var path = document.location.pathname;
+ var parts = path.split(/\//);
+ $.each(DOCUMENTATION_OPTIONS.URL_ROOT.split(/\//), function() {
+ if (this === '..')
+ parts.pop();
+ });
+ var url = parts.join('/');
+ return path.substring(url.lastIndexOf('/') + 1, path.length - 1);
+ },
+
+ initOnKeyListeners: function() {
+ $(document).keydown(function(event) {
+ var activeElementType = document.activeElement.tagName;
+ // don't navigate when in search box, textarea, dropdown or button
+ if (activeElementType !== 'TEXTAREA' && activeElementType !== 'INPUT' && activeElementType !== 'SELECT'
+ && activeElementType !== 'BUTTON' && !event.altKey && !event.ctrlKey && !event.metaKey
+ && !event.shiftKey) {
+ switch (event.keyCode) {
+ case 37: // left
+ var prevHref = $('link[rel="prev"]').prop('href');
+ if (prevHref) {
+ window.location.href = prevHref;
+ return false;
+ }
+ break;
+ case 39: // right
+ var nextHref = $('link[rel="next"]').prop('href');
+ if (nextHref) {
+ window.location.href = nextHref;
+ return false;
+ }
+ break;
+ }
+ }
+ });
+ }
+};
+
+// quick alias for translations
+_ = Documentation.gettext;
+
+$(document).ready(function() {
+ Documentation.init();
+});
diff --git a/docs/_build/html/_static/documentation_options.js b/docs/_build/html/_static/documentation_options.js
new file mode 100644
index 0000000000000000000000000000000000000000..4daa6b50bdfc772793d2185ba9f8fa90507aac02
--- /dev/null
+++ b/docs/_build/html/_static/documentation_options.js
@@ -0,0 +1,12 @@
+var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
+ VERSION: '',
+ LANGUAGE: 'en',
+ COLLAPSE_INDEX: false,
+ BUILDER: 'html',
+ FILE_SUFFIX: '.html',
+ LINK_SUFFIX: '.html',
+ HAS_SOURCE: true,
+ SOURCELINK_SUFFIX: '.txt',
+ NAVIGATION_WITH_KEYS: false
+};
\ No newline at end of file
diff --git a/docs/_build/html/_static/file.png b/docs/_build/html/_static/file.png
new file mode 100644
index 0000000000000000000000000000000000000000..a858a410e4faa62ce324d814e4b816fff83a6fb3
Binary files /dev/null and b/docs/_build/html/_static/file.png differ
diff --git a/docs/_build/html/_static/jquery-3.5.1.js b/docs/_build/html/_static/jquery-3.5.1.js
new file mode 100644
index 0000000000000000000000000000000000000000..50937333b99a5e168ac9e8292b22edd7e96c3e6a
--- /dev/null
+++ b/docs/_build/html/_static/jquery-3.5.1.js
@@ -0,0 +1,10872 @@
+/*!
+ * jQuery JavaScript Library v3.5.1
+ * https://jquery.com/
+ *
+ * Includes Sizzle.js
+ * https://sizzlejs.com/
+ *
+ * Copyright JS Foundation and other contributors
+ * Released under the MIT license
+ * https://jquery.org/license
+ *
+ * Date: 2020-05-04T22:49Z
+ */
+( function( global, factory ) {
+
+ "use strict";
+
+ if ( typeof module === "object" && typeof module.exports === "object" ) {
+
+ // For CommonJS and CommonJS-like environments where a proper `window`
+ // is present, execute the factory and get jQuery.
+ // For environments that do not have a `window` with a `document`
+ // (such as Node.js), expose a factory as module.exports.
+ // This accentuates the need for the creation of a real `window`.
+ // e.g. var jQuery = require("jquery")(window);
+ // See ticket #14549 for more info.
+ module.exports = global.document ?
+ factory( global, true ) :
+ function( w ) {
+ if ( !w.document ) {
+ throw new Error( "jQuery requires a window with a document" );
+ }
+ return factory( w );
+ };
+ } else {
+ factory( global );
+ }
+
+// Pass this if window is not defined yet
+} )( typeof window !== "undefined" ? window : this, function( window, noGlobal ) {
+
+// Edge <= 12 - 13+, Firefox <=18 - 45+, IE 10 - 11, Safari 5.1 - 9+, iOS 6 - 9.1
+// throw exceptions when non-strict code (e.g., ASP.NET 4.5) accesses strict mode
+// arguments.callee.caller (trac-13335). But as of jQuery 3.0 (2016), strict mode should be common
+// enough that all such attempts are guarded in a try block.
+"use strict";
+
+var arr = [];
+
+var getProto = Object.getPrototypeOf;
+
+var slice = arr.slice;
+
+var flat = arr.flat ? function( array ) {
+ return arr.flat.call( array );
+} : function( array ) {
+ return arr.concat.apply( [], array );
+};
+
+
+var push = arr.push;
+
+var indexOf = arr.indexOf;
+
+var class2type = {};
+
+var toString = class2type.toString;
+
+var hasOwn = class2type.hasOwnProperty;
+
+var fnToString = hasOwn.toString;
+
+var ObjectFunctionString = fnToString.call( Object );
+
+var support = {};
+
+var isFunction = function isFunction( obj ) {
+
+ // Support: Chrome <=57, Firefox <=52
+ // In some browsers, typeof returns "function" for HTML <object> elements
+ // (i.e., `typeof document.createElement( "object" ) === "function"`).
+ // We don't want to classify *any* DOM node as a function.
+ return typeof obj === "function" && typeof obj.nodeType !== "number";
+ };
+
+
+var isWindow = function isWindow( obj ) {
+ return obj != null && obj === obj.window;
+ };
+
+
+var document = window.document;
+
+
+
+ var preservedScriptAttributes = {
+ type: true,
+ src: true,
+ nonce: true,
+ noModule: true
+ };
+
+ function DOMEval( code, node, doc ) {
+ doc = doc || document;
+
+ var i, val,
+ script = doc.createElement( "script" );
+
+ script.text = code;
+ if ( node ) {
+ for ( i in preservedScriptAttributes ) {
+
+ // Support: Firefox 64+, Edge 18+
+ // Some browsers don't support the "nonce" property on scripts.
+ // On the other hand, just using `getAttribute` is not enough as
+ // the `nonce` attribute is reset to an empty string whenever it
+ // becomes browsing-context connected.
+ // See https://github.com/whatwg/html/issues/2369
+ // See https://html.spec.whatwg.org/#nonce-attributes
+ // The `node.getAttribute` check was added for the sake of
+ // `jQuery.globalEval` so that it can fake a nonce-containing node
+ // via an object.
+ val = node[ i ] || node.getAttribute && node.getAttribute( i );
+ if ( val ) {
+ script.setAttribute( i, val );
+ }
+ }
+ }
+ doc.head.appendChild( script ).parentNode.removeChild( script );
+ }
+
+
+function toType( obj ) {
+ if ( obj == null ) {
+ return obj + "";
+ }
+
+ // Support: Android <=2.3 only (functionish RegExp)
+ return typeof obj === "object" || typeof obj === "function" ?
+ class2type[ toString.call( obj ) ] || "object" :
+ typeof obj;
+}
+/* global Symbol */
+// Defining this global in .eslintrc.json would create a danger of using the global
+// unguarded in another place, it seems safer to define global only for this module
+
+
+
+var
+ version = "3.5.1",
+
+ // Define a local copy of jQuery
+ jQuery = function( selector, context ) {
+
+ // The jQuery object is actually just the init constructor 'enhanced'
+ // Need init if jQuery is called (just allow error to be thrown if not included)
+ return new jQuery.fn.init( selector, context );
+ };
+
+jQuery.fn = jQuery.prototype = {
+
+ // The current version of jQuery being used
+ jquery: version,
+
+ constructor: jQuery,
+
+ // The default length of a jQuery object is 0
+ length: 0,
+
+ toArray: function() {
+ return slice.call( this );
+ },
+
+ // Get the Nth element in the matched element set OR
+ // Get the whole matched element set as a clean array
+ get: function( num ) {
+
+ // Return all the elements in a clean array
+ if ( num == null ) {
+ return slice.call( this );
+ }
+
+ // Return just the one element from the set
+ return num < 0 ? this[ num + this.length ] : this[ num ];
+ },
+
+ // Take an array of elements and push it onto the stack
+ // (returning the new matched element set)
+ pushStack: function( elems ) {
+
+ // Build a new jQuery matched element set
+ var ret = jQuery.merge( this.constructor(), elems );
+
+ // Add the old object onto the stack (as a reference)
+ ret.prevObject = this;
+
+ // Return the newly-formed element set
+ return ret;
+ },
+
+ // Execute a callback for every element in the matched set.
+ each: function( callback ) {
+ return jQuery.each( this, callback );
+ },
+
+ map: function( callback ) {
+ return this.pushStack( jQuery.map( this, function( elem, i ) {
+ return callback.call( elem, i, elem );
+ } ) );
+ },
+
+ slice: function() {
+ return this.pushStack( slice.apply( this, arguments ) );
+ },
+
+ first: function() {
+ return this.eq( 0 );
+ },
+
+ last: function() {
+ return this.eq( -1 );
+ },
+
+ even: function() {
+ return this.pushStack( jQuery.grep( this, function( _elem, i ) {
+ return ( i + 1 ) % 2;
+ } ) );
+ },
+
+ odd: function() {
+ return this.pushStack( jQuery.grep( this, function( _elem, i ) {
+ return i % 2;
+ } ) );
+ },
+
+ eq: function( i ) {
+ var len = this.length,
+ j = +i + ( i < 0 ? len : 0 );
+ return this.pushStack( j >= 0 && j < len ? [ this[ j ] ] : [] );
+ },
+
+ end: function() {
+ return this.prevObject || this.constructor();
+ },
+
+ // For internal use only.
+ // Behaves like an Array's method, not like a jQuery method.
+ push: push,
+ sort: arr.sort,
+ splice: arr.splice
+};
+
+jQuery.extend = jQuery.fn.extend = function() {
+ var options, name, src, copy, copyIsArray, clone,
+ target = arguments[ 0 ] || {},
+ i = 1,
+ length = arguments.length,
+ deep = false;
+
+ // Handle a deep copy situation
+ if ( typeof target === "boolean" ) {
+ deep = target;
+
+ // Skip the boolean and the target
+ target = arguments[ i ] || {};
+ i++;
+ }
+
+ // Handle case when target is a string or something (possible in deep copy)
+ if ( typeof target !== "object" && !isFunction( target ) ) {
+ target = {};
+ }
+
+ // Extend jQuery itself if only one argument is passed
+ if ( i === length ) {
+ target = this;
+ i--;
+ }
+
+ for ( ; i < length; i++ ) {
+
+ // Only deal with non-null/undefined values
+ if ( ( options = arguments[ i ] ) != null ) {
+
+ // Extend the base object
+ for ( name in options ) {
+ copy = options[ name ];
+
+ // Prevent Object.prototype pollution
+ // Prevent never-ending loop
+ if ( name === "__proto__" || target === copy ) {
+ continue;
+ }
+
+ // Recurse if we're merging plain objects or arrays
+ if ( deep && copy && ( jQuery.isPlainObject( copy ) ||
+ ( copyIsArray = Array.isArray( copy ) ) ) ) {
+ src = target[ name ];
+
+ // Ensure proper type for the source value
+ if ( copyIsArray && !Array.isArray( src ) ) {
+ clone = [];
+ } else if ( !copyIsArray && !jQuery.isPlainObject( src ) ) {
+ clone = {};
+ } else {
+ clone = src;
+ }
+ copyIsArray = false;
+
+ // Never move original objects, clone them
+ target[ name ] = jQuery.extend( deep, clone, copy );
+
+ // Don't bring in undefined values
+ } else if ( copy !== undefined ) {
+ target[ name ] = copy;
+ }
+ }
+ }
+ }
+
+ // Return the modified object
+ return target;
+};
+
+jQuery.extend( {
+
+ // Unique for each copy of jQuery on the page
+ expando: "jQuery" + ( version + Math.random() ).replace( /\D/g, "" ),
+
+ // Assume jQuery is ready without the ready module
+ isReady: true,
+
+ error: function( msg ) {
+ throw new Error( msg );
+ },
+
+ noop: function() {},
+
+ isPlainObject: function( obj ) {
+ var proto, Ctor;
+
+ // Detect obvious negatives
+ // Use toString instead of jQuery.type to catch host objects
+ if ( !obj || toString.call( obj ) !== "[object Object]" ) {
+ return false;
+ }
+
+ proto = getProto( obj );
+
+ // Objects with no prototype (e.g., `Object.create( null )`) are plain
+ if ( !proto ) {
+ return true;
+ }
+
+ // Objects with prototype are plain iff they were constructed by a global Object function
+ Ctor = hasOwn.call( proto, "constructor" ) && proto.constructor;
+ return typeof Ctor === "function" && fnToString.call( Ctor ) === ObjectFunctionString;
+ },
+
+ isEmptyObject: function( obj ) {
+ var name;
+
+ for ( name in obj ) {
+ return false;
+ }
+ return true;
+ },
+
+ // Evaluates a script in a provided context; falls back to the global one
+ // if not specified.
+ globalEval: function( code, options, doc ) {
+ DOMEval( code, { nonce: options && options.nonce }, doc );
+ },
+
+ each: function( obj, callback ) {
+ var length, i = 0;
+
+ if ( isArrayLike( obj ) ) {
+ length = obj.length;
+ for ( ; i < length; i++ ) {
+ if ( callback.call( obj[ i ], i, obj[ i ] ) === false ) {
+ break;
+ }
+ }
+ } else {
+ for ( i in obj ) {
+ if ( callback.call( obj[ i ], i, obj[ i ] ) === false ) {
+ break;
+ }
+ }
+ }
+
+ return obj;
+ },
+
+ // results is for internal usage only
+ makeArray: function( arr, results ) {
+ var ret = results || [];
+
+ if ( arr != null ) {
+ if ( isArrayLike( Object( arr ) ) ) {
+ jQuery.merge( ret,
+ typeof arr === "string" ?
+ [ arr ] : arr
+ );
+ } else {
+ push.call( ret, arr );
+ }
+ }
+
+ return ret;
+ },
+
+ inArray: function( elem, arr, i ) {
+ return arr == null ? -1 : indexOf.call( arr, elem, i );
+ },
+
+ // Support: Android <=4.0 only, PhantomJS 1 only
+ // push.apply(_, arraylike) throws on ancient WebKit
+ merge: function( first, second ) {
+ var len = +second.length,
+ j = 0,
+ i = first.length;
+
+ for ( ; j < len; j++ ) {
+ first[ i++ ] = second[ j ];
+ }
+
+ first.length = i;
+
+ return first;
+ },
+
+ grep: function( elems, callback, invert ) {
+ var callbackInverse,
+ matches = [],
+ i = 0,
+ length = elems.length,
+ callbackExpect = !invert;
+
+ // Go through the array, only saving the items
+ // that pass the validator function
+ for ( ; i < length; i++ ) {
+ callbackInverse = !callback( elems[ i ], i );
+ if ( callbackInverse !== callbackExpect ) {
+ matches.push( elems[ i ] );
+ }
+ }
+
+ return matches;
+ },
+
+ // arg is for internal usage only
+ map: function( elems, callback, arg ) {
+ var length, value,
+ i = 0,
+ ret = [];
+
+ // Go through the array, translating each of the items to their new values
+ if ( isArrayLike( elems ) ) {
+ length = elems.length;
+ for ( ; i < length; i++ ) {
+ value = callback( elems[ i ], i, arg );
+
+ if ( value != null ) {
+ ret.push( value );
+ }
+ }
+
+ // Go through every key on the object,
+ } else {
+ for ( i in elems ) {
+ value = callback( elems[ i ], i, arg );
+
+ if ( value != null ) {
+ ret.push( value );
+ }
+ }
+ }
+
+ // Flatten any nested arrays
+ return flat( ret );
+ },
+
+ // A global GUID counter for objects
+ guid: 1,
+
+ // jQuery.support is not used in Core but other projects attach their
+ // properties to it so it needs to exist.
+ support: support
+} );
+
+if ( typeof Symbol === "function" ) {
+ jQuery.fn[ Symbol.iterator ] = arr[ Symbol.iterator ];
+}
+
+// Populate the class2type map
+jQuery.each( "Boolean Number String Function Array Date RegExp Object Error Symbol".split( " " ),
+function( _i, name ) {
+ class2type[ "[object " + name + "]" ] = name.toLowerCase();
+} );
+
+function isArrayLike( obj ) {
+
+ // Support: real iOS 8.2 only (not reproducible in simulator)
+ // `in` check used to prevent JIT error (gh-2145)
+ // hasOwn isn't used here due to false negatives
+ // regarding Nodelist length in IE
+ var length = !!obj && "length" in obj && obj.length,
+ type = toType( obj );
+
+ if ( isFunction( obj ) || isWindow( obj ) ) {
+ return false;
+ }
+
+ return type === "array" || length === 0 ||
+ typeof length === "number" && length > 0 && ( length - 1 ) in obj;
+}
+var Sizzle =
+/*!
+ * Sizzle CSS Selector Engine v2.3.5
+ * https://sizzlejs.com/
+ *
+ * Copyright JS Foundation and other contributors
+ * Released under the MIT license
+ * https://js.foundation/
+ *
+ * Date: 2020-03-14
+ */
+( function( window ) {
+var i,
+ support,
+ Expr,
+ getText,
+ isXML,
+ tokenize,
+ compile,
+ select,
+ outermostContext,
+ sortInput,
+ hasDuplicate,
+
+ // Local document vars
+ setDocument,
+ document,
+ docElem,
+ documentIsHTML,
+ rbuggyQSA,
+ rbuggyMatches,
+ matches,
+ contains,
+
+ // Instance-specific data
+ expando = "sizzle" + 1 * new Date(),
+ preferredDoc = window.document,
+ dirruns = 0,
+ done = 0,
+ classCache = createCache(),
+ tokenCache = createCache(),
+ compilerCache = createCache(),
+ nonnativeSelectorCache = createCache(),
+ sortOrder = function( a, b ) {
+ if ( a === b ) {
+ hasDuplicate = true;
+ }
+ return 0;
+ },
+
+ // Instance methods
+ hasOwn = ( {} ).hasOwnProperty,
+ arr = [],
+ pop = arr.pop,
+ pushNative = arr.push,
+ push = arr.push,
+ slice = arr.slice,
+
+ // Use a stripped-down indexOf as it's faster than native
+ // https://jsperf.com/thor-indexof-vs-for/5
+ indexOf = function( list, elem ) {
+ var i = 0,
+ len = list.length;
+ for ( ; i < len; i++ ) {
+ if ( list[ i ] === elem ) {
+ return i;
+ }
+ }
+ return -1;
+ },
+
+ booleans = "checked|selected|async|autofocus|autoplay|controls|defer|disabled|hidden|" +
+ "ismap|loop|multiple|open|readonly|required|scoped",
+
+ // Regular expressions
+
+ // http://www.w3.org/TR/css3-selectors/#whitespace
+ whitespace = "[\\x20\\t\\r\\n\\f]",
+
+ // https://www.w3.org/TR/css-syntax-3/#ident-token-diagram
+ identifier = "(?:\\\\[\\da-fA-F]{1,6}" + whitespace +
+ "?|\\\\[^\\r\\n\\f]|[\\w-]|[^\0-\\x7f])+",
+
+ // Attribute selectors: http://www.w3.org/TR/selectors/#attribute-selectors
+ attributes = "\\[" + whitespace + "*(" + identifier + ")(?:" + whitespace +
+
+ // Operator (capture 2)
+ "*([*^$|!~]?=)" + whitespace +
+
+ // "Attribute values must be CSS identifiers [capture 5]
+ // or strings [capture 3 or capture 4]"
+ "*(?:'((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\"|(" + identifier + "))|)" +
+ whitespace + "*\\]",
+
+ pseudos = ":(" + identifier + ")(?:\\((" +
+
+ // To reduce the number of selectors needing tokenize in the preFilter, prefer arguments:
+ // 1. quoted (capture 3; capture 4 or capture 5)
+ "('((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\")|" +
+
+ // 2. simple (capture 6)
+ "((?:\\\\.|[^\\\\()[\\]]|" + attributes + ")*)|" +
+
+ // 3. anything else (capture 2)
+ ".*" +
+ ")\\)|)",
+
+ // Leading and non-escaped trailing whitespace, capturing some non-whitespace characters preceding the latter
+ rwhitespace = new RegExp( whitespace + "+", "g" ),
+ rtrim = new RegExp( "^" + whitespace + "+|((?:^|[^\\\\])(?:\\\\.)*)" +
+ whitespace + "+$", "g" ),
+
+ rcomma = new RegExp( "^" + whitespace + "*," + whitespace + "*" ),
+ rcombinators = new RegExp( "^" + whitespace + "*([>+~]|" + whitespace + ")" + whitespace +
+ "*" ),
+ rdescend = new RegExp( whitespace + "|>" ),
+
+ rpseudo = new RegExp( pseudos ),
+ ridentifier = new RegExp( "^" + identifier + "$" ),
+
+ matchExpr = {
+ "ID": new RegExp( "^#(" + identifier + ")" ),
+ "CLASS": new RegExp( "^\\.(" + identifier + ")" ),
+ "TAG": new RegExp( "^(" + identifier + "|[*])" ),
+ "ATTR": new RegExp( "^" + attributes ),
+ "PSEUDO": new RegExp( "^" + pseudos ),
+ "CHILD": new RegExp( "^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\(" +
+ whitespace + "*(even|odd|(([+-]|)(\\d*)n|)" + whitespace + "*(?:([+-]|)" +
+ whitespace + "*(\\d+)|))" + whitespace + "*\\)|)", "i" ),
+ "bool": new RegExp( "^(?:" + booleans + ")$", "i" ),
+
+ // For use in libraries implementing .is()
+ // We use this for POS matching in `select`
+ "needsContext": new RegExp( "^" + whitespace +
+ "*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\(" + whitespace +
+ "*((?:-\\d)?\\d*)" + whitespace + "*\\)|)(?=[^-]|$)", "i" )
+ },
+
+ rhtml = /HTML$/i,
+ rinputs = /^(?:input|select|textarea|button)$/i,
+ rheader = /^h\d$/i,
+
+ rnative = /^[^{]+\{\s*\[native \w/,
+
+ // Easily-parseable/retrievable ID or TAG or CLASS selectors
+ rquickExpr = /^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/,
+
+ rsibling = /[+~]/,
+
+ // CSS escapes
+ // http://www.w3.org/TR/CSS21/syndata.html#escaped-characters
+ runescape = new RegExp( "\\\\[\\da-fA-F]{1,6}" + whitespace + "?|\\\\([^\\r\\n\\f])", "g" ),
+ funescape = function( escape, nonHex ) {
+ var high = "0x" + escape.slice( 1 ) - 0x10000;
+
+ return nonHex ?
+
+ // Strip the backslash prefix from a non-hex escape sequence
+ nonHex :
+
+ // Replace a hexadecimal escape sequence with the encoded Unicode code point
+ // Support: IE <=11+
+ // For values outside the Basic Multilingual Plane (BMP), manually construct a
+ // surrogate pair
+ high < 0 ?
+ String.fromCharCode( high + 0x10000 ) :
+ String.fromCharCode( high >> 10 | 0xD800, high & 0x3FF | 0xDC00 );
+ },
+
+ // CSS string/identifier serialization
+ // https://drafts.csswg.org/cssom/#common-serializing-idioms
+ rcssescape = /([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g,
+ fcssescape = function( ch, asCodePoint ) {
+ if ( asCodePoint ) {
+
+ // U+0000 NULL becomes U+FFFD REPLACEMENT CHARACTER
+ if ( ch === "\0" ) {
+ return "\uFFFD";
+ }
+
+ // Control characters and (dependent upon position) numbers get escaped as code points
+ return ch.slice( 0, -1 ) + "\\" +
+ ch.charCodeAt( ch.length - 1 ).toString( 16 ) + " ";
+ }
+
+ // Other potentially-special ASCII characters get backslash-escaped
+ return "\\" + ch;
+ },
+
+ // Used for iframes
+ // See setDocument()
+ // Removing the function wrapper causes a "Permission Denied"
+ // error in IE
+ unloadHandler = function() {
+ setDocument();
+ },
+
+ inDisabledFieldset = addCombinator(
+ function( elem ) {
+ return elem.disabled === true && elem.nodeName.toLowerCase() === "fieldset";
+ },
+ { dir: "parentNode", next: "legend" }
+ );
+
+// Optimize for push.apply( _, NodeList )
+try {
+ push.apply(
+ ( arr = slice.call( preferredDoc.childNodes ) ),
+ preferredDoc.childNodes
+ );
+
+ // Support: Android<4.0
+ // Detect silently failing push.apply
+ // eslint-disable-next-line no-unused-expressions
+ arr[ preferredDoc.childNodes.length ].nodeType;
+} catch ( e ) {
+ push = { apply: arr.length ?
+
+ // Leverage slice if possible
+ function( target, els ) {
+ pushNative.apply( target, slice.call( els ) );
+ } :
+
+ // Support: IE<9
+ // Otherwise append directly
+ function( target, els ) {
+ var j = target.length,
+ i = 0;
+
+ // Can't trust NodeList.length
+ while ( ( target[ j++ ] = els[ i++ ] ) ) {}
+ target.length = j - 1;
+ }
+ };
+}
+
+function Sizzle( selector, context, results, seed ) {
+ var m, i, elem, nid, match, groups, newSelector,
+ newContext = context && context.ownerDocument,
+
+ // nodeType defaults to 9, since context defaults to document
+ nodeType = context ? context.nodeType : 9;
+
+ results = results || [];
+
+ // Return early from calls with invalid selector or context
+ if ( typeof selector !== "string" || !selector ||
+ nodeType !== 1 && nodeType !== 9 && nodeType !== 11 ) {
+
+ return results;
+ }
+
+ // Try to shortcut find operations (as opposed to filters) in HTML documents
+ if ( !seed ) {
+ setDocument( context );
+ context = context || document;
+
+ if ( documentIsHTML ) {
+
+ // If the selector is sufficiently simple, try using a "get*By*" DOM method
+ // (excepting DocumentFragment context, where the methods don't exist)
+ if ( nodeType !== 11 && ( match = rquickExpr.exec( selector ) ) ) {
+
+ // ID selector
+ if ( ( m = match[ 1 ] ) ) {
+
+ // Document context
+ if ( nodeType === 9 ) {
+ if ( ( elem = context.getElementById( m ) ) ) {
+
+ // Support: IE, Opera, Webkit
+ // TODO: identify versions
+ // getElementById can match elements by name instead of ID
+ if ( elem.id === m ) {
+ results.push( elem );
+ return results;
+ }
+ } else {
+ return results;
+ }
+
+ // Element context
+ } else {
+
+ // Support: IE, Opera, Webkit
+ // TODO: identify versions
+ // getElementById can match elements by name instead of ID
+ if ( newContext && ( elem = newContext.getElementById( m ) ) &&
+ contains( context, elem ) &&
+ elem.id === m ) {
+
+ results.push( elem );
+ return results;
+ }
+ }
+
+ // Type selector
+ } else if ( match[ 2 ] ) {
+ push.apply( results, context.getElementsByTagName( selector ) );
+ return results;
+
+ // Class selector
+ } else if ( ( m = match[ 3 ] ) && support.getElementsByClassName &&
+ context.getElementsByClassName ) {
+
+ push.apply( results, context.getElementsByClassName( m ) );
+ return results;
+ }
+ }
+
+ // Take advantage of querySelectorAll
+ if ( support.qsa &&
+ !nonnativeSelectorCache[ selector + " " ] &&
+ ( !rbuggyQSA || !rbuggyQSA.test( selector ) ) &&
+
+ // Support: IE 8 only
+ // Exclude object elements
+ ( nodeType !== 1 || context.nodeName.toLowerCase() !== "object" ) ) {
+
+ newSelector = selector;
+ newContext = context;
+
+ // qSA considers elements outside a scoping root when evaluating child or
+ // descendant combinators, which is not what we want.
+ // In such cases, we work around the behavior by prefixing every selector in the
+ // list with an ID selector referencing the scope context.
+ // The technique has to be used as well when a leading combinator is used
+ // as such selectors are not recognized by querySelectorAll.
+ // Thanks to Andrew Dupont for this technique.
+ if ( nodeType === 1 &&
+ ( rdescend.test( selector ) || rcombinators.test( selector ) ) ) {
+
+ // Expand context for sibling selectors
+ newContext = rsibling.test( selector ) && testContext( context.parentNode ) ||
+ context;
+
+ // We can use :scope instead of the ID hack if the browser
+ // supports it & if we're not changing the context.
+ if ( newContext !== context || !support.scope ) {
+
+ // Capture the context ID, setting it first if necessary
+ if ( ( nid = context.getAttribute( "id" ) ) ) {
+ nid = nid.replace( rcssescape, fcssescape );
+ } else {
+ context.setAttribute( "id", ( nid = expando ) );
+ }
+ }
+
+ // Prefix every selector in the list
+ groups = tokenize( selector );
+ i = groups.length;
+ while ( i-- ) {
+ groups[ i ] = ( nid ? "#" + nid : ":scope" ) + " " +
+ toSelector( groups[ i ] );
+ }
+ newSelector = groups.join( "," );
+ }
+
+ try {
+ push.apply( results,
+ newContext.querySelectorAll( newSelector )
+ );
+ return results;
+ } catch ( qsaError ) {
+ nonnativeSelectorCache( selector, true );
+ } finally {
+ if ( nid === expando ) {
+ context.removeAttribute( "id" );
+ }
+ }
+ }
+ }
+ }
+
+ // All others
+ return select( selector.replace( rtrim, "$1" ), context, results, seed );
+}
+
+/**
+ * Create key-value caches of limited size
+ * @returns {function(string, object)} Returns the Object data after storing it on itself with
+ * property name the (space-suffixed) string and (if the cache is larger than Expr.cacheLength)
+ * deleting the oldest entry
+ */
+function createCache() {
+ var keys = [];
+
+ function cache( key, value ) {
+
+ // Use (key + " ") to avoid collision with native prototype properties (see Issue #157)
+ if ( keys.push( key + " " ) > Expr.cacheLength ) {
+
+ // Only keep the most recent entries
+ delete cache[ keys.shift() ];
+ }
+ return ( cache[ key + " " ] = value );
+ }
+ return cache;
+}
+
+/**
+ * Mark a function for special use by Sizzle
+ * @param {Function} fn The function to mark
+ */
+function markFunction( fn ) {
+ fn[ expando ] = true;
+ return fn;
+}
+
+/**
+ * Support testing using an element
+ * @param {Function} fn Passed the created element and returns a boolean result
+ */
+function assert( fn ) {
+ var el = document.createElement( "fieldset" );
+
+ try {
+ return !!fn( el );
+ } catch ( e ) {
+ return false;
+ } finally {
+
+ // Remove from its parent by default
+ if ( el.parentNode ) {
+ el.parentNode.removeChild( el );
+ }
+
+ // release memory in IE
+ el = null;
+ }
+}
+
+/**
+ * Adds the same handler for all of the specified attrs
+ * @param {String} attrs Pipe-separated list of attributes
+ * @param {Function} handler The method that will be applied
+ */
+function addHandle( attrs, handler ) {
+ var arr = attrs.split( "|" ),
+ i = arr.length;
+
+ while ( i-- ) {
+ Expr.attrHandle[ arr[ i ] ] = handler;
+ }
+}
+
+/**
+ * Checks document order of two siblings
+ * @param {Element} a
+ * @param {Element} b
+ * @returns {Number} Returns less than 0 if a precedes b, greater than 0 if a follows b
+ */
+function siblingCheck( a, b ) {
+ var cur = b && a,
+ diff = cur && a.nodeType === 1 && b.nodeType === 1 &&
+ a.sourceIndex - b.sourceIndex;
+
+ // Use IE sourceIndex if available on both nodes
+ if ( diff ) {
+ return diff;
+ }
+
+ // Check if b follows a
+ if ( cur ) {
+ while ( ( cur = cur.nextSibling ) ) {
+ if ( cur === b ) {
+ return -1;
+ }
+ }
+ }
+
+ return a ? 1 : -1;
+}
+
+/**
+ * Returns a function to use in pseudos for input types
+ * @param {String} type
+ */
+function createInputPseudo( type ) {
+ return function( elem ) {
+ var name = elem.nodeName.toLowerCase();
+ return name === "input" && elem.type === type;
+ };
+}
+
+/**
+ * Returns a function to use in pseudos for buttons
+ * @param {String} type
+ */
+function createButtonPseudo( type ) {
+ return function( elem ) {
+ var name = elem.nodeName.toLowerCase();
+ return ( name === "input" || name === "button" ) && elem.type === type;
+ };
+}
+
+/**
+ * Returns a function to use in pseudos for :enabled/:disabled
+ * @param {Boolean} disabled true for :disabled; false for :enabled
+ */
+function createDisabledPseudo( disabled ) {
+
+ // Known :disabled false positives: fieldset[disabled] > legend:nth-of-type(n+2) :can-disable
+ return function( elem ) {
+
+ // Only certain elements can match :enabled or :disabled
+ // https://html.spec.whatwg.org/multipage/scripting.html#selector-enabled
+ // https://html.spec.whatwg.org/multipage/scripting.html#selector-disabled
+ if ( "form" in elem ) {
+
+ // Check for inherited disabledness on relevant non-disabled elements:
+ // * listed form-associated elements in a disabled fieldset
+ // https://html.spec.whatwg.org/multipage/forms.html#category-listed
+ // https://html.spec.whatwg.org/multipage/forms.html#concept-fe-disabled
+ // * option elements in a disabled optgroup
+ // https://html.spec.whatwg.org/multipage/forms.html#concept-option-disabled
+ // All such elements have a "form" property.
+ if ( elem.parentNode && elem.disabled === false ) {
+
+ // Option elements defer to a parent optgroup if present
+ if ( "label" in elem ) {
+ if ( "label" in elem.parentNode ) {
+ return elem.parentNode.disabled === disabled;
+ } else {
+ return elem.disabled === disabled;
+ }
+ }
+
+ // Support: IE 6 - 11
+ // Use the isDisabled shortcut property to check for disabled fieldset ancestors
+ return elem.isDisabled === disabled ||
+
+ // Where there is no isDisabled, check manually
+ /* jshint -W018 */
+ elem.isDisabled !== !disabled &&
+ inDisabledFieldset( elem ) === disabled;
+ }
+
+ return elem.disabled === disabled;
+
+ // Try to winnow out elements that can't be disabled before trusting the disabled property.
+ // Some victims get caught in our net (label, legend, menu, track), but it shouldn't
+ // even exist on them, let alone have a boolean value.
+ } else if ( "label" in elem ) {
+ return elem.disabled === disabled;
+ }
+
+ // Remaining elements are neither :enabled nor :disabled
+ return false;
+ };
+}
+
+/**
+ * Returns a function to use in pseudos for positionals
+ * @param {Function} fn
+ */
+function createPositionalPseudo( fn ) {
+ return markFunction( function( argument ) {
+ argument = +argument;
+ return markFunction( function( seed, matches ) {
+ var j,
+ matchIndexes = fn( [], seed.length, argument ),
+ i = matchIndexes.length;
+
+ // Match elements found at the specified indexes
+ while ( i-- ) {
+ if ( seed[ ( j = matchIndexes[ i ] ) ] ) {
+ seed[ j ] = !( matches[ j ] = seed[ j ] );
+ }
+ }
+ } );
+ } );
+}
+
+/**
+ * Checks a node for validity as a Sizzle context
+ * @param {Element|Object=} context
+ * @returns {Element|Object|Boolean} The input node if acceptable, otherwise a falsy value
+ */
+function testContext( context ) {
+ return context && typeof context.getElementsByTagName !== "undefined" && context;
+}
+
+// Expose support vars for convenience
+support = Sizzle.support = {};
+
+/**
+ * Detects XML nodes
+ * @param {Element|Object} elem An element or a document
+ * @returns {Boolean} True iff elem is a non-HTML XML node
+ */
+isXML = Sizzle.isXML = function( elem ) {
+ var namespace = elem.namespaceURI,
+ docElem = ( elem.ownerDocument || elem ).documentElement;
+
+ // Support: IE <=8
+ // Assume HTML when documentElement doesn't yet exist, such as inside loading iframes
+ // https://bugs.jquery.com/ticket/4833
+ return !rhtml.test( namespace || docElem && docElem.nodeName || "HTML" );
+};
+
+/**
+ * Sets document-related variables once based on the current document
+ * @param {Element|Object} [doc] An element or document object to use to set the document
+ * @returns {Object} Returns the current document
+ */
+setDocument = Sizzle.setDocument = function( node ) {
+ var hasCompare, subWindow,
+ doc = node ? node.ownerDocument || node : preferredDoc;
+
+ // Return early if doc is invalid or already selected
+ // Support: IE 11+, Edge 17 - 18+
+ // IE/Edge sometimes throw a "Permission denied" error when strict-comparing
+ // two documents; shallow comparisons work.
+ // eslint-disable-next-line eqeqeq
+ if ( doc == document || doc.nodeType !== 9 || !doc.documentElement ) {
+ return document;
+ }
+
+ // Update global variables
+ document = doc;
+ docElem = document.documentElement;
+ documentIsHTML = !isXML( document );
+
+ // Support: IE 9 - 11+, Edge 12 - 18+
+ // Accessing iframe documents after unload throws "permission denied" errors (jQuery #13936)
+ // Support: IE 11+, Edge 17 - 18+
+ // IE/Edge sometimes throw a "Permission denied" error when strict-comparing
+ // two documents; shallow comparisons work.
+ // eslint-disable-next-line eqeqeq
+ if ( preferredDoc != document &&
+ ( subWindow = document.defaultView ) && subWindow.top !== subWindow ) {
+
+ // Support: IE 11, Edge
+ if ( subWindow.addEventListener ) {
+ subWindow.addEventListener( "unload", unloadHandler, false );
+
+ // Support: IE 9 - 10 only
+ } else if ( subWindow.attachEvent ) {
+ subWindow.attachEvent( "onunload", unloadHandler );
+ }
+ }
+
+ // Support: IE 8 - 11+, Edge 12 - 18+, Chrome <=16 - 25 only, Firefox <=3.6 - 31 only,
+ // Safari 4 - 5 only, Opera <=11.6 - 12.x only
+ // IE/Edge & older browsers don't support the :scope pseudo-class.
+ // Support: Safari 6.0 only
+ // Safari 6.0 supports :scope but it's an alias of :root there.
+ support.scope = assert( function( el ) {
+ docElem.appendChild( el ).appendChild( document.createElement( "div" ) );
+ return typeof el.querySelectorAll !== "undefined" &&
+ !el.querySelectorAll( ":scope fieldset div" ).length;
+ } );
+
+ /* Attributes
+ ---------------------------------------------------------------------- */
+
+ // Support: IE<8
+ // Verify that getAttribute really returns attributes and not properties
+ // (excepting IE8 booleans)
+ support.attributes = assert( function( el ) {
+ el.className = "i";
+ return !el.getAttribute( "className" );
+ } );
+
+ /* getElement(s)By*
+ ---------------------------------------------------------------------- */
+
+ // Check if getElementsByTagName("*") returns only elements
+ support.getElementsByTagName = assert( function( el ) {
+ el.appendChild( document.createComment( "" ) );
+ return !el.getElementsByTagName( "*" ).length;
+ } );
+
+ // Support: IE<9
+ support.getElementsByClassName = rnative.test( document.getElementsByClassName );
+
+ // Support: IE<10
+ // Check if getElementById returns elements by name
+ // The broken getElementById methods don't pick up programmatically-set names,
+ // so use a roundabout getElementsByName test
+ support.getById = assert( function( el ) {
+ docElem.appendChild( el ).id = expando;
+ return !document.getElementsByName || !document.getElementsByName( expando ).length;
+ } );
+
+ // ID filter and find
+ if ( support.getById ) {
+ Expr.filter[ "ID" ] = function( id ) {
+ var attrId = id.replace( runescape, funescape );
+ return function( elem ) {
+ return elem.getAttribute( "id" ) === attrId;
+ };
+ };
+ Expr.find[ "ID" ] = function( id, context ) {
+ if ( typeof context.getElementById !== "undefined" && documentIsHTML ) {
+ var elem = context.getElementById( id );
+ return elem ? [ elem ] : [];
+ }
+ };
+ } else {
+ Expr.filter[ "ID" ] = function( id ) {
+ var attrId = id.replace( runescape, funescape );
+ return function( elem ) {
+ var node = typeof elem.getAttributeNode !== "undefined" &&
+ elem.getAttributeNode( "id" );
+ return node && node.value === attrId;
+ };
+ };
+
+ // Support: IE 6 - 7 only
+ // getElementById is not reliable as a find shortcut
+ Expr.find[ "ID" ] = function( id, context ) {
+ if ( typeof context.getElementById !== "undefined" && documentIsHTML ) {
+ var node, i, elems,
+ elem = context.getElementById( id );
+
+ if ( elem ) {
+
+ // Verify the id attribute
+ node = elem.getAttributeNode( "id" );
+ if ( node && node.value === id ) {
+ return [ elem ];
+ }
+
+ // Fall back on getElementsByName
+ elems = context.getElementsByName( id );
+ i = 0;
+ while ( ( elem = elems[ i++ ] ) ) {
+ node = elem.getAttributeNode( "id" );
+ if ( node && node.value === id ) {
+ return [ elem ];
+ }
+ }
+ }
+
+ return [];
+ }
+ };
+ }
+
+ // Tag
+ Expr.find[ "TAG" ] = support.getElementsByTagName ?
+ function( tag, context ) {
+ if ( typeof context.getElementsByTagName !== "undefined" ) {
+ return context.getElementsByTagName( tag );
+
+ // DocumentFragment nodes don't have gEBTN
+ } else if ( support.qsa ) {
+ return context.querySelectorAll( tag );
+ }
+ } :
+
+ function( tag, context ) {
+ var elem,
+ tmp = [],
+ i = 0,
+
+ // By happy coincidence, a (broken) gEBTN appears on DocumentFragment nodes too
+ results = context.getElementsByTagName( tag );
+
+ // Filter out possible comments
+ if ( tag === "*" ) {
+ while ( ( elem = results[ i++ ] ) ) {
+ if ( elem.nodeType === 1 ) {
+ tmp.push( elem );
+ }
+ }
+
+ return tmp;
+ }
+ return results;
+ };
+
+ // Class
+ Expr.find[ "CLASS" ] = support.getElementsByClassName && function( className, context ) {
+ if ( typeof context.getElementsByClassName !== "undefined" && documentIsHTML ) {
+ return context.getElementsByClassName( className );
+ }
+ };
+
+ /* QSA/matchesSelector
+ ---------------------------------------------------------------------- */
+
+ // QSA and matchesSelector support
+
+ // matchesSelector(:active) reports false when true (IE9/Opera 11.5)
+ rbuggyMatches = [];
+
+ // qSa(:focus) reports false when true (Chrome 21)
+ // We allow this because of a bug in IE8/9 that throws an error
+ // whenever `document.activeElement` is accessed on an iframe
+ // So, we allow :focus to pass through QSA all the time to avoid the IE error
+ // See https://bugs.jquery.com/ticket/13378
+ rbuggyQSA = [];
+
+ if ( ( support.qsa = rnative.test( document.querySelectorAll ) ) ) {
+
+ // Build QSA regex
+ // Regex strategy adopted from Diego Perini
+ assert( function( el ) {
+
+ var input;
+
+ // Select is set to empty string on purpose
+ // This is to test IE's treatment of not explicitly
+ // setting a boolean content attribute,
+ // since its presence should be enough
+ // https://bugs.jquery.com/ticket/12359
+ docElem.appendChild( el ).innerHTML = "<a id='" + expando + "'></a>" +
+ "<select id='" + expando + "-\r\\' msallowcapture=''>" +
+ "<option selected=''></option></select>";
+
+ // Support: IE8, Opera 11-12.16
+ // Nothing should be selected when empty strings follow ^= or $= or *=
+ // The test attribute must be unknown in Opera but "safe" for WinRT
+ // https://msdn.microsoft.com/en-us/library/ie/hh465388.aspx#attribute_section
+ if ( el.querySelectorAll( "[msallowcapture^='']" ).length ) {
+ rbuggyQSA.push( "[*^$]=" + whitespace + "*(?:''|\"\")" );
+ }
+
+ // Support: IE8
+ // Boolean attributes and "value" are not treated correctly
+ if ( !el.querySelectorAll( "[selected]" ).length ) {
+ rbuggyQSA.push( "\\[" + whitespace + "*(?:value|" + booleans + ")" );
+ }
+
+ // Support: Chrome<29, Android<4.4, Safari<7.0+, iOS<7.0+, PhantomJS<1.9.8+
+ if ( !el.querySelectorAll( "[id~=" + expando + "-]" ).length ) {
+ rbuggyQSA.push( "~=" );
+ }
+
+ // Support: IE 11+, Edge 15 - 18+
+ // IE 11/Edge don't find elements on a `[name='']` query in some cases.
+ // Adding a temporary attribute to the document before the selection works
+ // around the issue.
+ // Interestingly, IE 10 & older don't seem to have the issue.
+ input = document.createElement( "input" );
+ input.setAttribute( "name", "" );
+ el.appendChild( input );
+ if ( !el.querySelectorAll( "[name='']" ).length ) {
+ rbuggyQSA.push( "\\[" + whitespace + "*name" + whitespace + "*=" +
+ whitespace + "*(?:''|\"\")" );
+ }
+
+ // Webkit/Opera - :checked should return selected option elements
+ // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked
+ // IE8 throws error here and will not see later tests
+ if ( !el.querySelectorAll( ":checked" ).length ) {
+ rbuggyQSA.push( ":checked" );
+ }
+
+ // Support: Safari 8+, iOS 8+
+ // https://bugs.webkit.org/show_bug.cgi?id=136851
+ // In-page `selector#id sibling-combinator selector` fails
+ if ( !el.querySelectorAll( "a#" + expando + "+*" ).length ) {
+ rbuggyQSA.push( ".#.+[+~]" );
+ }
+
+ // Support: Firefox <=3.6 - 5 only
+ // Old Firefox doesn't throw on a badly-escaped identifier.
+ el.querySelectorAll( "\\\f" );
+ rbuggyQSA.push( "[\\r\\n\\f]" );
+ } );
+
+ assert( function( el ) {
+ el.innerHTML = "<a href='' disabled='disabled'></a>" +
+ "<select disabled='disabled'><option/></select>";
+
+ // Support: Windows 8 Native Apps
+ // The type and name attributes are restricted during .innerHTML assignment
+ var input = document.createElement( "input" );
+ input.setAttribute( "type", "hidden" );
+ el.appendChild( input ).setAttribute( "name", "D" );
+
+ // Support: IE8
+ // Enforce case-sensitivity of name attribute
+ if ( el.querySelectorAll( "[name=d]" ).length ) {
+ rbuggyQSA.push( "name" + whitespace + "*[*^$|!~]?=" );
+ }
+
+ // FF 3.5 - :enabled/:disabled and hidden elements (hidden elements are still enabled)
+ // IE8 throws error here and will not see later tests
+ if ( el.querySelectorAll( ":enabled" ).length !== 2 ) {
+ rbuggyQSA.push( ":enabled", ":disabled" );
+ }
+
+ // Support: IE9-11+
+ // IE's :disabled selector does not pick up the children of disabled fieldsets
+ docElem.appendChild( el ).disabled = true;
+ if ( el.querySelectorAll( ":disabled" ).length !== 2 ) {
+ rbuggyQSA.push( ":enabled", ":disabled" );
+ }
+
+ // Support: Opera 10 - 11 only
+ // Opera 10-11 does not throw on post-comma invalid pseudos
+ el.querySelectorAll( "*,:x" );
+ rbuggyQSA.push( ",.*:" );
+ } );
+ }
+
+ if ( ( support.matchesSelector = rnative.test( ( matches = docElem.matches ||
+ docElem.webkitMatchesSelector ||
+ docElem.mozMatchesSelector ||
+ docElem.oMatchesSelector ||
+ docElem.msMatchesSelector ) ) ) ) {
+
+ assert( function( el ) {
+
+ // Check to see if it's possible to do matchesSelector
+ // on a disconnected node (IE 9)
+ support.disconnectedMatch = matches.call( el, "*" );
+
+ // This should fail with an exception
+ // Gecko does not error, returns false instead
+ matches.call( el, "[s!='']:x" );
+ rbuggyMatches.push( "!=", pseudos );
+ } );
+ }
+
+ rbuggyQSA = rbuggyQSA.length && new RegExp( rbuggyQSA.join( "|" ) );
+ rbuggyMatches = rbuggyMatches.length && new RegExp( rbuggyMatches.join( "|" ) );
+
+ /* Contains
+ ---------------------------------------------------------------------- */
+ hasCompare = rnative.test( docElem.compareDocumentPosition );
+
+ // Element contains another
+ // Purposefully self-exclusive
+ // As in, an element does not contain itself
+ contains = hasCompare || rnative.test( docElem.contains ) ?
+ function( a, b ) {
+ var adown = a.nodeType === 9 ? a.documentElement : a,
+ bup = b && b.parentNode;
+ return a === bup || !!( bup && bup.nodeType === 1 && (
+ adown.contains ?
+ adown.contains( bup ) :
+ a.compareDocumentPosition && a.compareDocumentPosition( bup ) & 16
+ ) );
+ } :
+ function( a, b ) {
+ if ( b ) {
+ while ( ( b = b.parentNode ) ) {
+ if ( b === a ) {
+ return true;
+ }
+ }
+ }
+ return false;
+ };
+
+ /* Sorting
+ ---------------------------------------------------------------------- */
+
+ // Document order sorting
+ sortOrder = hasCompare ?
+ function( a, b ) {
+
+ // Flag for duplicate removal
+ if ( a === b ) {
+ hasDuplicate = true;
+ return 0;
+ }
+
+ // Sort on method existence if only one input has compareDocumentPosition
+ var compare = !a.compareDocumentPosition - !b.compareDocumentPosition;
+ if ( compare ) {
+ return compare;
+ }
+
+ // Calculate position if both inputs belong to the same document
+ // Support: IE 11+, Edge 17 - 18+
+ // IE/Edge sometimes throw a "Permission denied" error when strict-comparing
+ // two documents; shallow comparisons work.
+ // eslint-disable-next-line eqeqeq
+ compare = ( a.ownerDocument || a ) == ( b.ownerDocument || b ) ?
+ a.compareDocumentPosition( b ) :
+
+ // Otherwise we know they are disconnected
+ 1;
+
+ // Disconnected nodes
+ if ( compare & 1 ||
+ ( !support.sortDetached && b.compareDocumentPosition( a ) === compare ) ) {
+
+ // Choose the first element that is related to our preferred document
+ // Support: IE 11+, Edge 17 - 18+
+ // IE/Edge sometimes throw a "Permission denied" error when strict-comparing
+ // two documents; shallow comparisons work.
+ // eslint-disable-next-line eqeqeq
+ if ( a == document || a.ownerDocument == preferredDoc &&
+ contains( preferredDoc, a ) ) {
+ return -1;
+ }
+
+ // Support: IE 11+, Edge 17 - 18+
+ // IE/Edge sometimes throw a "Permission denied" error when strict-comparing
+ // two documents; shallow comparisons work.
+ // eslint-disable-next-line eqeqeq
+ if ( b == document || b.ownerDocument == preferredDoc &&
+ contains( preferredDoc, b ) ) {
+ return 1;
+ }
+
+ // Maintain original order
+ return sortInput ?
+ ( indexOf( sortInput, a ) - indexOf( sortInput, b ) ) :
+ 0;
+ }
+
+ return compare & 4 ? -1 : 1;
+ } :
+ function( a, b ) {
+
+ // Exit early if the nodes are identical
+ if ( a === b ) {
+ hasDuplicate = true;
+ return 0;
+ }
+
+ var cur,
+ i = 0,
+ aup = a.parentNode,
+ bup = b.parentNode,
+ ap = [ a ],
+ bp = [ b ];
+
+ // Parentless nodes are either documents or disconnected
+ if ( !aup || !bup ) {
+
+ // Support: IE 11+, Edge 17 - 18+
+ // IE/Edge sometimes throw a "Permission denied" error when strict-comparing
+ // two documents; shallow comparisons work.
+ /* eslint-disable eqeqeq */
+ return a == document ? -1 :
+ b == document ? 1 :
+ /* eslint-enable eqeqeq */
+ aup ? -1 :
+ bup ? 1 :
+ sortInput ?
+ ( indexOf( sortInput, a ) - indexOf( sortInput, b ) ) :
+ 0;
+
+ // If the nodes are siblings, we can do a quick check
+ } else if ( aup === bup ) {
+ return siblingCheck( a, b );
+ }
+
+ // Otherwise we need full lists of their ancestors for comparison
+ cur = a;
+ while ( ( cur = cur.parentNode ) ) {
+ ap.unshift( cur );
+ }
+ cur = b;
+ while ( ( cur = cur.parentNode ) ) {
+ bp.unshift( cur );
+ }
+
+ // Walk down the tree looking for a discrepancy
+ while ( ap[ i ] === bp[ i ] ) {
+ i++;
+ }
+
+ return i ?
+
+ // Do a sibling check if the nodes have a common ancestor
+ siblingCheck( ap[ i ], bp[ i ] ) :
+
+ // Otherwise nodes in our document sort first
+ // Support: IE 11+, Edge 17 - 18+
+ // IE/Edge sometimes throw a "Permission denied" error when strict-comparing
+ // two documents; shallow comparisons work.
+ /* eslint-disable eqeqeq */
+ ap[ i ] == preferredDoc ? -1 :
+ bp[ i ] == preferredDoc ? 1 :
+ /* eslint-enable eqeqeq */
+ 0;
+ };
+
+ return document;
+};
+
+Sizzle.matches = function( expr, elements ) {
+ return Sizzle( expr, null, null, elements );
+};
+
+Sizzle.matchesSelector = function( elem, expr ) {
+ setDocument( elem );
+
+ if ( support.matchesSelector && documentIsHTML &&
+ !nonnativeSelectorCache[ expr + " " ] &&
+ ( !rbuggyMatches || !rbuggyMatches.test( expr ) ) &&
+ ( !rbuggyQSA || !rbuggyQSA.test( expr ) ) ) {
+
+ try {
+ var ret = matches.call( elem, expr );
+
+ // IE 9's matchesSelector returns false on disconnected nodes
+ if ( ret || support.disconnectedMatch ||
+
+ // As well, disconnected nodes are said to be in a document
+ // fragment in IE 9
+ elem.document && elem.document.nodeType !== 11 ) {
+ return ret;
+ }
+ } catch ( e ) {
+ nonnativeSelectorCache( expr, true );
+ }
+ }
+
+ return Sizzle( expr, document, null, [ elem ] ).length > 0;
+};
+
+Sizzle.contains = function( context, elem ) {
+
+ // Set document vars if needed
+ // Support: IE 11+, Edge 17 - 18+
+ // IE/Edge sometimes throw a "Permission denied" error when strict-comparing
+ // two documents; shallow comparisons work.
+ // eslint-disable-next-line eqeqeq
+ if ( ( context.ownerDocument || context ) != document ) {
+ setDocument( context );
+ }
+ return contains( context, elem );
+};
+
+Sizzle.attr = function( elem, name ) {
+
+ // Set document vars if needed
+ // Support: IE 11+, Edge 17 - 18+
+ // IE/Edge sometimes throw a "Permission denied" error when strict-comparing
+ // two documents; shallow comparisons work.
+ // eslint-disable-next-line eqeqeq
+ if ( ( elem.ownerDocument || elem ) != document ) {
+ setDocument( elem );
+ }
+
+ var fn = Expr.attrHandle[ name.toLowerCase() ],
+
+ // Don't get fooled by Object.prototype properties (jQuery #13807)
+ val = fn && hasOwn.call( Expr.attrHandle, name.toLowerCase() ) ?
+ fn( elem, name, !documentIsHTML ) :
+ undefined;
+
+ return val !== undefined ?
+ val :
+ support.attributes || !documentIsHTML ?
+ elem.getAttribute( name ) :
+ ( val = elem.getAttributeNode( name ) ) && val.specified ?
+ val.value :
+ null;
+};
+
+Sizzle.escape = function( sel ) {
+ return ( sel + "" ).replace( rcssescape, fcssescape );
+};
+
+Sizzle.error = function( msg ) {
+ throw new Error( "Syntax error, unrecognized expression: " + msg );
+};
+
+/**
+ * Document sorting and removing duplicates
+ * @param {ArrayLike} results
+ */
+Sizzle.uniqueSort = function( results ) {
+ var elem,
+ duplicates = [],
+ j = 0,
+ i = 0;
+
+ // Unless we *know* we can detect duplicates, assume their presence
+ hasDuplicate = !support.detectDuplicates;
+ sortInput = !support.sortStable && results.slice( 0 );
+ results.sort( sortOrder );
+
+ if ( hasDuplicate ) {
+ while ( ( elem = results[ i++ ] ) ) {
+ if ( elem === results[ i ] ) {
+ j = duplicates.push( i );
+ }
+ }
+ while ( j-- ) {
+ results.splice( duplicates[ j ], 1 );
+ }
+ }
+
+ // Clear input after sorting to release objects
+ // See https://github.com/jquery/sizzle/pull/225
+ sortInput = null;
+
+ return results;
+};
+
+/**
+ * Utility function for retrieving the text value of an array of DOM nodes
+ * @param {Array|Element} elem
+ */
+getText = Sizzle.getText = function( elem ) {
+ var node,
+ ret = "",
+ i = 0,
+ nodeType = elem.nodeType;
+
+ if ( !nodeType ) {
+
+ // If no nodeType, this is expected to be an array
+ while ( ( node = elem[ i++ ] ) ) {
+
+ // Do not traverse comment nodes
+ ret += getText( node );
+ }
+ } else if ( nodeType === 1 || nodeType === 9 || nodeType === 11 ) {
+
+ // Use textContent for elements
+ // innerText usage removed for consistency of new lines (jQuery #11153)
+ if ( typeof elem.textContent === "string" ) {
+ return elem.textContent;
+ } else {
+
+ // Traverse its children
+ for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) {
+ ret += getText( elem );
+ }
+ }
+ } else if ( nodeType === 3 || nodeType === 4 ) {
+ return elem.nodeValue;
+ }
+
+ // Do not include comment or processing instruction nodes
+
+ return ret;
+};
+
+Expr = Sizzle.selectors = {
+
+ // Can be adjusted by the user
+ cacheLength: 50,
+
+ createPseudo: markFunction,
+
+ match: matchExpr,
+
+ attrHandle: {},
+
+ find: {},
+
+ relative: {
+ ">": { dir: "parentNode", first: true },
+ " ": { dir: "parentNode" },
+ "+": { dir: "previousSibling", first: true },
+ "~": { dir: "previousSibling" }
+ },
+
+ preFilter: {
+ "ATTR": function( match ) {
+ match[ 1 ] = match[ 1 ].replace( runescape, funescape );
+
+ // Move the given value to match[3] whether quoted or unquoted
+ match[ 3 ] = ( match[ 3 ] || match[ 4 ] ||
+ match[ 5 ] || "" ).replace( runescape, funescape );
+
+ if ( match[ 2 ] === "~=" ) {
+ match[ 3 ] = " " + match[ 3 ] + " ";
+ }
+
+ return match.slice( 0, 4 );
+ },
+
+ "CHILD": function( match ) {
+
+ /* matches from matchExpr["CHILD"]
+ 1 type (only|nth|...)
+ 2 what (child|of-type)
+ 3 argument (even|odd|\d*|\d*n([+-]\d+)?|...)
+ 4 xn-component of xn+y argument ([+-]?\d*n|)
+ 5 sign of xn-component
+ 6 x of xn-component
+ 7 sign of y-component
+ 8 y of y-component
+ */
+ match[ 1 ] = match[ 1 ].toLowerCase();
+
+ if ( match[ 1 ].slice( 0, 3 ) === "nth" ) {
+
+ // nth-* requires argument
+ if ( !match[ 3 ] ) {
+ Sizzle.error( match[ 0 ] );
+ }
+
+ // numeric x and y parameters for Expr.filter.CHILD
+ // remember that false/true cast respectively to 0/1
+ match[ 4 ] = +( match[ 4 ] ?
+ match[ 5 ] + ( match[ 6 ] || 1 ) :
+ 2 * ( match[ 3 ] === "even" || match[ 3 ] === "odd" ) );
+ match[ 5 ] = +( ( match[ 7 ] + match[ 8 ] ) || match[ 3 ] === "odd" );
+
+ // other types prohibit arguments
+ } else if ( match[ 3 ] ) {
+ Sizzle.error( match[ 0 ] );
+ }
+
+ return match;
+ },
+
+ "PSEUDO": function( match ) {
+ var excess,
+ unquoted = !match[ 6 ] && match[ 2 ];
+
+ if ( matchExpr[ "CHILD" ].test( match[ 0 ] ) ) {
+ return null;
+ }
+
+ // Accept quoted arguments as-is
+ if ( match[ 3 ] ) {
+ match[ 2 ] = match[ 4 ] || match[ 5 ] || "";
+
+ // Strip excess characters from unquoted arguments
+ } else if ( unquoted && rpseudo.test( unquoted ) &&
+
+ // Get excess from tokenize (recursively)
+ ( excess = tokenize( unquoted, true ) ) &&
+
+ // advance to the next closing parenthesis
+ ( excess = unquoted.indexOf( ")", unquoted.length - excess ) - unquoted.length ) ) {
+
+ // excess is a negative index
+ match[ 0 ] = match[ 0 ].slice( 0, excess );
+ match[ 2 ] = unquoted.slice( 0, excess );
+ }
+
+ // Return only captures needed by the pseudo filter method (type and argument)
+ return match.slice( 0, 3 );
+ }
+ },
+
+ filter: {
+
+ "TAG": function( nodeNameSelector ) {
+ var nodeName = nodeNameSelector.replace( runescape, funescape ).toLowerCase();
+ return nodeNameSelector === "*" ?
+ function() {
+ return true;
+ } :
+ function( elem ) {
+ return elem.nodeName && elem.nodeName.toLowerCase() === nodeName;
+ };
+ },
+
+ "CLASS": function( className ) {
+ var pattern = classCache[ className + " " ];
+
+ return pattern ||
+ ( pattern = new RegExp( "(^|" + whitespace +
+ ")" + className + "(" + whitespace + "|$)" ) ) && classCache(
+ className, function( elem ) {
+ return pattern.test(
+ typeof elem.className === "string" && elem.className ||
+ typeof elem.getAttribute !== "undefined" &&
+ elem.getAttribute( "class" ) ||
+ ""
+ );
+ } );
+ },
+
+ "ATTR": function( name, operator, check ) {
+ return function( elem ) {
+ var result = Sizzle.attr( elem, name );
+
+ if ( result == null ) {
+ return operator === "!=";
+ }
+ if ( !operator ) {
+ return true;
+ }
+
+ result += "";
+
+ /* eslint-disable max-len */
+
+ return operator === "=" ? result === check :
+ operator === "!=" ? result !== check :
+ operator === "^=" ? check && result.indexOf( check ) === 0 :
+ operator === "*=" ? check && result.indexOf( check ) > -1 :
+ operator === "$=" ? check && result.slice( -check.length ) === check :
+ operator === "~=" ? ( " " + result.replace( rwhitespace, " " ) + " " ).indexOf( check ) > -1 :
+ operator === "|=" ? result === check || result.slice( 0, check.length + 1 ) === check + "-" :
+ false;
+ /* eslint-enable max-len */
+
+ };
+ },
+
+ "CHILD": function( type, what, _argument, first, last ) {
+ var simple = type.slice( 0, 3 ) !== "nth",
+ forward = type.slice( -4 ) !== "last",
+ ofType = what === "of-type";
+
+ return first === 1 && last === 0 ?
+
+ // Shortcut for :nth-*(n)
+ function( elem ) {
+ return !!elem.parentNode;
+ } :
+
+ function( elem, _context, xml ) {
+ var cache, uniqueCache, outerCache, node, nodeIndex, start,
+ dir = simple !== forward ? "nextSibling" : "previousSibling",
+ parent = elem.parentNode,
+ name = ofType && elem.nodeName.toLowerCase(),
+ useCache = !xml && !ofType,
+ diff = false;
+
+ if ( parent ) {
+
+ // :(first|last|only)-(child|of-type)
+ if ( simple ) {
+ while ( dir ) {
+ node = elem;
+ while ( ( node = node[ dir ] ) ) {
+ if ( ofType ?
+ node.nodeName.toLowerCase() === name :
+ node.nodeType === 1 ) {
+
+ return false;
+ }
+ }
+
+ // Reverse direction for :only-* (if we haven't yet done so)
+ start = dir = type === "only" && !start && "nextSibling";
+ }
+ return true;
+ }
+
+ start = [ forward ? parent.firstChild : parent.lastChild ];
+
+ // non-xml :nth-child(...) stores cache data on `parent`
+ if ( forward && useCache ) {
+
+ // Seek `elem` from a previously-cached index
+
+ // ...in a gzip-friendly way
+ node = parent;
+ outerCache = node[ expando ] || ( node[ expando ] = {} );
+
+ // Support: IE <9 only
+ // Defend against cloned attroperties (jQuery gh-1709)
+ uniqueCache = outerCache[ node.uniqueID ] ||
+ ( outerCache[ node.uniqueID ] = {} );
+
+ cache = uniqueCache[ type ] || [];
+ nodeIndex = cache[ 0 ] === dirruns && cache[ 1 ];
+ diff = nodeIndex && cache[ 2 ];
+ node = nodeIndex && parent.childNodes[ nodeIndex ];
+
+ while ( ( node = ++nodeIndex && node && node[ dir ] ||
+
+ // Fallback to seeking `elem` from the start
+ ( diff = nodeIndex = 0 ) || start.pop() ) ) {
+
+ // When found, cache indexes on `parent` and break
+ if ( node.nodeType === 1 && ++diff && node === elem ) {
+ uniqueCache[ type ] = [ dirruns, nodeIndex, diff ];
+ break;
+ }
+ }
+
+ } else {
+
+ // Use previously-cached element index if available
+ if ( useCache ) {
+
+ // ...in a gzip-friendly way
+ node = elem;
+ outerCache = node[ expando ] || ( node[ expando ] = {} );
+
+ // Support: IE <9 only
+ // Defend against cloned attroperties (jQuery gh-1709)
+ uniqueCache = outerCache[ node.uniqueID ] ||
+ ( outerCache[ node.uniqueID ] = {} );
+
+ cache = uniqueCache[ type ] || [];
+ nodeIndex = cache[ 0 ] === dirruns && cache[ 1 ];
+ diff = nodeIndex;
+ }
+
+ // xml :nth-child(...)
+ // or :nth-last-child(...) or :nth(-last)?-of-type(...)
+ if ( diff === false ) {
+
+ // Use the same loop as above to seek `elem` from the start
+ while ( ( node = ++nodeIndex && node && node[ dir ] ||
+ ( diff = nodeIndex = 0 ) || start.pop() ) ) {
+
+ if ( ( ofType ?
+ node.nodeName.toLowerCase() === name :
+ node.nodeType === 1 ) &&
+ ++diff ) {
+
+ // Cache the index of each encountered element
+ if ( useCache ) {
+ outerCache = node[ expando ] ||
+ ( node[ expando ] = {} );
+
+ // Support: IE <9 only
+ // Defend against cloned attroperties (jQuery gh-1709)
+ uniqueCache = outerCache[ node.uniqueID ] ||
+ ( outerCache[ node.uniqueID ] = {} );
+
+ uniqueCache[ type ] = [ dirruns, diff ];
+ }
+
+ if ( node === elem ) {
+ break;
+ }
+ }
+ }
+ }
+ }
+
+ // Incorporate the offset, then check against cycle size
+ diff -= last;
+ return diff === first || ( diff % first === 0 && diff / first >= 0 );
+ }
+ };
+ },
+
+ "PSEUDO": function( pseudo, argument ) {
+
+ // pseudo-class names are case-insensitive
+ // http://www.w3.org/TR/selectors/#pseudo-classes
+ // Prioritize by case sensitivity in case custom pseudos are added with uppercase letters
+ // Remember that setFilters inherits from pseudos
+ var args,
+ fn = Expr.pseudos[ pseudo ] || Expr.setFilters[ pseudo.toLowerCase() ] ||
+ Sizzle.error( "unsupported pseudo: " + pseudo );
+
+ // The user may use createPseudo to indicate that
+ // arguments are needed to create the filter function
+ // just as Sizzle does
+ if ( fn[ expando ] ) {
+ return fn( argument );
+ }
+
+ // But maintain support for old signatures
+ if ( fn.length > 1 ) {
+ args = [ pseudo, pseudo, "", argument ];
+ return Expr.setFilters.hasOwnProperty( pseudo.toLowerCase() ) ?
+ markFunction( function( seed, matches ) {
+ var idx,
+ matched = fn( seed, argument ),
+ i = matched.length;
+ while ( i-- ) {
+ idx = indexOf( seed, matched[ i ] );
+ seed[ idx ] = !( matches[ idx ] = matched[ i ] );
+ }
+ } ) :
+ function( elem ) {
+ return fn( elem, 0, args );
+ };
+ }
+
+ return fn;
+ }
+ },
+
+ pseudos: {
+
+ // Potentially complex pseudos
+ "not": markFunction( function( selector ) {
+
+ // Trim the selector passed to compile
+ // to avoid treating leading and trailing
+ // spaces as combinators
+ var input = [],
+ results = [],
+ matcher = compile( selector.replace( rtrim, "$1" ) );
+
+ return matcher[ expando ] ?
+ markFunction( function( seed, matches, _context, xml ) {
+ var elem,
+ unmatched = matcher( seed, null, xml, [] ),
+ i = seed.length;
+
+ // Match elements unmatched by `matcher`
+ while ( i-- ) {
+ if ( ( elem = unmatched[ i ] ) ) {
+ seed[ i ] = !( matches[ i ] = elem );
+ }
+ }
+ } ) :
+ function( elem, _context, xml ) {
+ input[ 0 ] = elem;
+ matcher( input, null, xml, results );
+
+ // Don't keep the element (issue #299)
+ input[ 0 ] = null;
+ return !results.pop();
+ };
+ } ),
+
+ "has": markFunction( function( selector ) {
+ return function( elem ) {
+ return Sizzle( selector, elem ).length > 0;
+ };
+ } ),
+
+ "contains": markFunction( function( text ) {
+ text = text.replace( runescape, funescape );
+ return function( elem ) {
+ return ( elem.textContent || getText( elem ) ).indexOf( text ) > -1;
+ };
+ } ),
+
+ // "Whether an element is represented by a :lang() selector
+ // is based solely on the element's language value
+ // being equal to the identifier C,
+ // or beginning with the identifier C immediately followed by "-".
+ // The matching of C against the element's language value is performed case-insensitively.
+ // The identifier C does not have to be a valid language name."
+ // http://www.w3.org/TR/selectors/#lang-pseudo
+ "lang": markFunction( function( lang ) {
+
+ // lang value must be a valid identifier
+ if ( !ridentifier.test( lang || "" ) ) {
+ Sizzle.error( "unsupported lang: " + lang );
+ }
+ lang = lang.replace( runescape, funescape ).toLowerCase();
+ return function( elem ) {
+ var elemLang;
+ do {
+ if ( ( elemLang = documentIsHTML ?
+ elem.lang :
+ elem.getAttribute( "xml:lang" ) || elem.getAttribute( "lang" ) ) ) {
+
+ elemLang = elemLang.toLowerCase();
+ return elemLang === lang || elemLang.indexOf( lang + "-" ) === 0;
+ }
+ } while ( ( elem = elem.parentNode ) && elem.nodeType === 1 );
+ return false;
+ };
+ } ),
+
+ // Miscellaneous
+ "target": function( elem ) {
+ var hash = window.location && window.location.hash;
+ return hash && hash.slice( 1 ) === elem.id;
+ },
+
+ "root": function( elem ) {
+ return elem === docElem;
+ },
+
+ "focus": function( elem ) {
+ return elem === document.activeElement &&
+ ( !document.hasFocus || document.hasFocus() ) &&
+ !!( elem.type || elem.href || ~elem.tabIndex );
+ },
+
+ // Boolean properties
+ "enabled": createDisabledPseudo( false ),
+ "disabled": createDisabledPseudo( true ),
+
+ "checked": function( elem ) {
+
+ // In CSS3, :checked should return both checked and selected elements
+ // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked
+ var nodeName = elem.nodeName.toLowerCase();
+ return ( nodeName === "input" && !!elem.checked ) ||
+ ( nodeName === "option" && !!elem.selected );
+ },
+
+ "selected": function( elem ) {
+
+ // Accessing this property makes selected-by-default
+ // options in Safari work properly
+ if ( elem.parentNode ) {
+ // eslint-disable-next-line no-unused-expressions
+ elem.parentNode.selectedIndex;
+ }
+
+ return elem.selected === true;
+ },
+
+ // Contents
+ "empty": function( elem ) {
+
+ // http://www.w3.org/TR/selectors/#empty-pseudo
+ // :empty is negated by element (1) or content nodes (text: 3; cdata: 4; entity ref: 5),
+ // but not by others (comment: 8; processing instruction: 7; etc.)
+ // nodeType < 6 works because attributes (2) do not appear as children
+ for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) {
+ if ( elem.nodeType < 6 ) {
+ return false;
+ }
+ }
+ return true;
+ },
+
+ "parent": function( elem ) {
+ return !Expr.pseudos[ "empty" ]( elem );
+ },
+
+ // Element/input types
+ "header": function( elem ) {
+ return rheader.test( elem.nodeName );
+ },
+
+ "input": function( elem ) {
+ return rinputs.test( elem.nodeName );
+ },
+
+ "button": function( elem ) {
+ var name = elem.nodeName.toLowerCase();
+ return name === "input" && elem.type === "button" || name === "button";
+ },
+
+ "text": function( elem ) {
+ var attr;
+ return elem.nodeName.toLowerCase() === "input" &&
+ elem.type === "text" &&
+
+ // Support: IE<8
+ // New HTML5 attribute values (e.g., "search") appear with elem.type === "text"
+ ( ( attr = elem.getAttribute( "type" ) ) == null ||
+ attr.toLowerCase() === "text" );
+ },
+
+ // Position-in-collection
+ "first": createPositionalPseudo( function() {
+ return [ 0 ];
+ } ),
+
+ "last": createPositionalPseudo( function( _matchIndexes, length ) {
+ return [ length - 1 ];
+ } ),
+
+ "eq": createPositionalPseudo( function( _matchIndexes, length, argument ) {
+ return [ argument < 0 ? argument + length : argument ];
+ } ),
+
+ "even": createPositionalPseudo( function( matchIndexes, length ) {
+ var i = 0;
+ for ( ; i < length; i += 2 ) {
+ matchIndexes.push( i );
+ }
+ return matchIndexes;
+ } ),
+
+ "odd": createPositionalPseudo( function( matchIndexes, length ) {
+ var i = 1;
+ for ( ; i < length; i += 2 ) {
+ matchIndexes.push( i );
+ }
+ return matchIndexes;
+ } ),
+
+ "lt": createPositionalPseudo( function( matchIndexes, length, argument ) {
+ var i = argument < 0 ?
+ argument + length :
+ argument > length ?
+ length :
+ argument;
+ for ( ; --i >= 0; ) {
+ matchIndexes.push( i );
+ }
+ return matchIndexes;
+ } ),
+
+ "gt": createPositionalPseudo( function( matchIndexes, length, argument ) {
+ var i = argument < 0 ? argument + length : argument;
+ for ( ; ++i < length; ) {
+ matchIndexes.push( i );
+ }
+ return matchIndexes;
+ } )
+ }
+};
+
+Expr.pseudos[ "nth" ] = Expr.pseudos[ "eq" ];
+
+// Add button/input type pseudos
+for ( i in { radio: true, checkbox: true, file: true, password: true, image: true } ) {
+ Expr.pseudos[ i ] = createInputPseudo( i );
+}
+for ( i in { submit: true, reset: true } ) {
+ Expr.pseudos[ i ] = createButtonPseudo( i );
+}
+
+// Easy API for creating new setFilters
+function setFilters() {}
+setFilters.prototype = Expr.filters = Expr.pseudos;
+Expr.setFilters = new setFilters();
+
+tokenize = Sizzle.tokenize = function( selector, parseOnly ) {
+ var matched, match, tokens, type,
+ soFar, groups, preFilters,
+ cached = tokenCache[ selector + " " ];
+
+ if ( cached ) {
+ return parseOnly ? 0 : cached.slice( 0 );
+ }
+
+ soFar = selector;
+ groups = [];
+ preFilters = Expr.preFilter;
+
+ while ( soFar ) {
+
+ // Comma and first run
+ if ( !matched || ( match = rcomma.exec( soFar ) ) ) {
+ if ( match ) {
+
+ // Don't consume trailing commas as valid
+ soFar = soFar.slice( match[ 0 ].length ) || soFar;
+ }
+ groups.push( ( tokens = [] ) );
+ }
+
+ matched = false;
+
+ // Combinators
+ if ( ( match = rcombinators.exec( soFar ) ) ) {
+ matched = match.shift();
+ tokens.push( {
+ value: matched,
+
+ // Cast descendant combinators to space
+ type: match[ 0 ].replace( rtrim, " " )
+ } );
+ soFar = soFar.slice( matched.length );
+ }
+
+ // Filters
+ for ( type in Expr.filter ) {
+ if ( ( match = matchExpr[ type ].exec( soFar ) ) && ( !preFilters[ type ] ||
+ ( match = preFilters[ type ]( match ) ) ) ) {
+ matched = match.shift();
+ tokens.push( {
+ value: matched,
+ type: type,
+ matches: match
+ } );
+ soFar = soFar.slice( matched.length );
+ }
+ }
+
+ if ( !matched ) {
+ break;
+ }
+ }
+
+ // Return the length of the invalid excess
+ // if we're just parsing
+ // Otherwise, throw an error or return tokens
+ return parseOnly ?
+ soFar.length :
+ soFar ?
+ Sizzle.error( selector ) :
+
+ // Cache the tokens
+ tokenCache( selector, groups ).slice( 0 );
+};
+
+function toSelector( tokens ) {
+ var i = 0,
+ len = tokens.length,
+ selector = "";
+ for ( ; i < len; i++ ) {
+ selector += tokens[ i ].value;
+ }
+ return selector;
+}
+
+function addCombinator( matcher, combinator, base ) {
+ var dir = combinator.dir,
+ skip = combinator.next,
+ key = skip || dir,
+ checkNonElements = base && key === "parentNode",
+ doneName = done++;
+
+ return combinator.first ?
+
+ // Check against closest ancestor/preceding element
+ function( elem, context, xml ) {
+ while ( ( elem = elem[ dir ] ) ) {
+ if ( elem.nodeType === 1 || checkNonElements ) {
+ return matcher( elem, context, xml );
+ }
+ }
+ return false;
+ } :
+
+ // Check against all ancestor/preceding elements
+ function( elem, context, xml ) {
+ var oldCache, uniqueCache, outerCache,
+ newCache = [ dirruns, doneName ];
+
+ // We can't set arbitrary data on XML nodes, so they don't benefit from combinator caching
+ if ( xml ) {
+ while ( ( elem = elem[ dir ] ) ) {
+ if ( elem.nodeType === 1 || checkNonElements ) {
+ if ( matcher( elem, context, xml ) ) {
+ return true;
+ }
+ }
+ }
+ } else {
+ while ( ( elem = elem[ dir ] ) ) {
+ if ( elem.nodeType === 1 || checkNonElements ) {
+ outerCache = elem[ expando ] || ( elem[ expando ] = {} );
+
+ // Support: IE <9 only
+ // Defend against cloned attroperties (jQuery gh-1709)
+ uniqueCache = outerCache[ elem.uniqueID ] ||
+ ( outerCache[ elem.uniqueID ] = {} );
+
+ if ( skip && skip === elem.nodeName.toLowerCase() ) {
+ elem = elem[ dir ] || elem;
+ } else if ( ( oldCache = uniqueCache[ key ] ) &&
+ oldCache[ 0 ] === dirruns && oldCache[ 1 ] === doneName ) {
+
+ // Assign to newCache so results back-propagate to previous elements
+ return ( newCache[ 2 ] = oldCache[ 2 ] );
+ } else {
+
+ // Reuse newcache so results back-propagate to previous elements
+ uniqueCache[ key ] = newCache;
+
+ // A match means we're done; a fail means we have to keep checking
+ if ( ( newCache[ 2 ] = matcher( elem, context, xml ) ) ) {
+ return true;
+ }
+ }
+ }
+ }
+ }
+ return false;
+ };
+}
+
+function elementMatcher( matchers ) {
+ return matchers.length > 1 ?
+ function( elem, context, xml ) {
+ var i = matchers.length;
+ while ( i-- ) {
+ if ( !matchers[ i ]( elem, context, xml ) ) {
+ return false;
+ }
+ }
+ return true;
+ } :
+ matchers[ 0 ];
+}
+
+function multipleContexts( selector, contexts, results ) {
+ var i = 0,
+ len = contexts.length;
+ for ( ; i < len; i++ ) {
+ Sizzle( selector, contexts[ i ], results );
+ }
+ return results;
+}
+
+function condense( unmatched, map, filter, context, xml ) {
+ var elem,
+ newUnmatched = [],
+ i = 0,
+ len = unmatched.length,
+ mapped = map != null;
+
+ for ( ; i < len; i++ ) {
+ if ( ( elem = unmatched[ i ] ) ) {
+ if ( !filter || filter( elem, context, xml ) ) {
+ newUnmatched.push( elem );
+ if ( mapped ) {
+ map.push( i );
+ }
+ }
+ }
+ }
+
+ return newUnmatched;
+}
+
+function setMatcher( preFilter, selector, matcher, postFilter, postFinder, postSelector ) {
+ if ( postFilter && !postFilter[ expando ] ) {
+ postFilter = setMatcher( postFilter );
+ }
+ if ( postFinder && !postFinder[ expando ] ) {
+ postFinder = setMatcher( postFinder, postSelector );
+ }
+ return markFunction( function( seed, results, context, xml ) {
+ var temp, i, elem,
+ preMap = [],
+ postMap = [],
+ preexisting = results.length,
+
+ // Get initial elements from seed or context
+ elems = seed || multipleContexts(
+ selector || "*",
+ context.nodeType ? [ context ] : context,
+ []
+ ),
+
+ // Prefilter to get matcher input, preserving a map for seed-results synchronization
+ matcherIn = preFilter && ( seed || !selector ) ?
+ condense( elems, preMap, preFilter, context, xml ) :
+ elems,
+
+ matcherOut = matcher ?
+
+ // If we have a postFinder, or filtered seed, or non-seed postFilter or preexisting results,
+ postFinder || ( seed ? preFilter : preexisting || postFilter ) ?
+
+ // ...intermediate processing is necessary
+ [] :
+
+ // ...otherwise use results directly
+ results :
+ matcherIn;
+
+ // Find primary matches
+ if ( matcher ) {
+ matcher( matcherIn, matcherOut, context, xml );
+ }
+
+ // Apply postFilter
+ if ( postFilter ) {
+ temp = condense( matcherOut, postMap );
+ postFilter( temp, [], context, xml );
+
+ // Un-match failing elements by moving them back to matcherIn
+ i = temp.length;
+ while ( i-- ) {
+ if ( ( elem = temp[ i ] ) ) {
+ matcherOut[ postMap[ i ] ] = !( matcherIn[ postMap[ i ] ] = elem );
+ }
+ }
+ }
+
+ if ( seed ) {
+ if ( postFinder || preFilter ) {
+ if ( postFinder ) {
+
+ // Get the final matcherOut by condensing this intermediate into postFinder contexts
+ temp = [];
+ i = matcherOut.length;
+ while ( i-- ) {
+ if ( ( elem = matcherOut[ i ] ) ) {
+
+ // Restore matcherIn since elem is not yet a final match
+ temp.push( ( matcherIn[ i ] = elem ) );
+ }
+ }
+ postFinder( null, ( matcherOut = [] ), temp, xml );
+ }
+
+ // Move matched elements from seed to results to keep them synchronized
+ i = matcherOut.length;
+ while ( i-- ) {
+ if ( ( elem = matcherOut[ i ] ) &&
+ ( temp = postFinder ? indexOf( seed, elem ) : preMap[ i ] ) > -1 ) {
+
+ seed[ temp ] = !( results[ temp ] = elem );
+ }
+ }
+ }
+
+ // Add elements to results, through postFinder if defined
+ } else {
+ matcherOut = condense(
+ matcherOut === results ?
+ matcherOut.splice( preexisting, matcherOut.length ) :
+ matcherOut
+ );
+ if ( postFinder ) {
+ postFinder( null, results, matcherOut, xml );
+ } else {
+ push.apply( results, matcherOut );
+ }
+ }
+ } );
+}
+
+function matcherFromTokens( tokens ) {
+ var checkContext, matcher, j,
+ len = tokens.length,
+ leadingRelative = Expr.relative[ tokens[ 0 ].type ],
+ implicitRelative = leadingRelative || Expr.relative[ " " ],
+ i = leadingRelative ? 1 : 0,
+
+ // The foundational matcher ensures that elements are reachable from top-level context(s)
+ matchContext = addCombinator( function( elem ) {
+ return elem === checkContext;
+ }, implicitRelative, true ),
+ matchAnyContext = addCombinator( function( elem ) {
+ return indexOf( checkContext, elem ) > -1;
+ }, implicitRelative, true ),
+ matchers = [ function( elem, context, xml ) {
+ var ret = ( !leadingRelative && ( xml || context !== outermostContext ) ) || (
+ ( checkContext = context ).nodeType ?
+ matchContext( elem, context, xml ) :
+ matchAnyContext( elem, context, xml ) );
+
+ // Avoid hanging onto element (issue #299)
+ checkContext = null;
+ return ret;
+ } ];
+
+ for ( ; i < len; i++ ) {
+ if ( ( matcher = Expr.relative[ tokens[ i ].type ] ) ) {
+ matchers = [ addCombinator( elementMatcher( matchers ), matcher ) ];
+ } else {
+ matcher = Expr.filter[ tokens[ i ].type ].apply( null, tokens[ i ].matches );
+
+ // Return special upon seeing a positional matcher
+ if ( matcher[ expando ] ) {
+
+ // Find the next relative operator (if any) for proper handling
+ j = ++i;
+ for ( ; j < len; j++ ) {
+ if ( Expr.relative[ tokens[ j ].type ] ) {
+ break;
+ }
+ }
+ return setMatcher(
+ i > 1 && elementMatcher( matchers ),
+ i > 1 && toSelector(
+
+ // If the preceding token was a descendant combinator, insert an implicit any-element `*`
+ tokens
+ .slice( 0, i - 1 )
+ .concat( { value: tokens[ i - 2 ].type === " " ? "*" : "" } )
+ ).replace( rtrim, "$1" ),
+ matcher,
+ i < j && matcherFromTokens( tokens.slice( i, j ) ),
+ j < len && matcherFromTokens( ( tokens = tokens.slice( j ) ) ),
+ j < len && toSelector( tokens )
+ );
+ }
+ matchers.push( matcher );
+ }
+ }
+
+ return elementMatcher( matchers );
+}
+
+function matcherFromGroupMatchers( elementMatchers, setMatchers ) {
+ var bySet = setMatchers.length > 0,
+ byElement = elementMatchers.length > 0,
+ superMatcher = function( seed, context, xml, results, outermost ) {
+ var elem, j, matcher,
+ matchedCount = 0,
+ i = "0",
+ unmatched = seed && [],
+ setMatched = [],
+ contextBackup = outermostContext,
+
+ // We must always have either seed elements or outermost context
+ elems = seed || byElement && Expr.find[ "TAG" ]( "*", outermost ),
+
+ // Use integer dirruns iff this is the outermost matcher
+ dirrunsUnique = ( dirruns += contextBackup == null ? 1 : Math.random() || 0.1 ),
+ len = elems.length;
+
+ if ( outermost ) {
+
+ // Support: IE 11+, Edge 17 - 18+
+ // IE/Edge sometimes throw a "Permission denied" error when strict-comparing
+ // two documents; shallow comparisons work.
+ // eslint-disable-next-line eqeqeq
+ outermostContext = context == document || context || outermost;
+ }
+
+ // Add elements passing elementMatchers directly to results
+ // Support: IE<9, Safari
+ // Tolerate NodeList properties (IE: "length"; Safari: <number>) matching elements by id
+ for ( ; i !== len && ( elem = elems[ i ] ) != null; i++ ) {
+ if ( byElement && elem ) {
+ j = 0;
+
+ // Support: IE 11+, Edge 17 - 18+
+ // IE/Edge sometimes throw a "Permission denied" error when strict-comparing
+ // two documents; shallow comparisons work.
+ // eslint-disable-next-line eqeqeq
+ if ( !context && elem.ownerDocument != document ) {
+ setDocument( elem );
+ xml = !documentIsHTML;
+ }
+ while ( ( matcher = elementMatchers[ j++ ] ) ) {
+ if ( matcher( elem, context || document, xml ) ) {
+ results.push( elem );
+ break;
+ }
+ }
+ if ( outermost ) {
+ dirruns = dirrunsUnique;
+ }
+ }
+
+ // Track unmatched elements for set filters
+ if ( bySet ) {
+
+ // They will have gone through all possible matchers
+ if ( ( elem = !matcher && elem ) ) {
+ matchedCount--;
+ }
+
+ // Lengthen the array for every element, matched or not
+ if ( seed ) {
+ unmatched.push( elem );
+ }
+ }
+ }
+
+ // `i` is now the count of elements visited above, and adding it to `matchedCount`
+ // makes the latter nonnegative.
+ matchedCount += i;
+
+ // Apply set filters to unmatched elements
+ // NOTE: This can be skipped if there are no unmatched elements (i.e., `matchedCount`
+ // equals `i`), unless we didn't visit _any_ elements in the above loop because we have
+ // no element matchers and no seed.
+ // Incrementing an initially-string "0" `i` allows `i` to remain a string only in that
+ // case, which will result in a "00" `matchedCount` that differs from `i` but is also
+ // numerically zero.
+ if ( bySet && i !== matchedCount ) {
+ j = 0;
+ while ( ( matcher = setMatchers[ j++ ] ) ) {
+ matcher( unmatched, setMatched, context, xml );
+ }
+
+ if ( seed ) {
+
+ // Reintegrate element matches to eliminate the need for sorting
+ if ( matchedCount > 0 ) {
+ while ( i-- ) {
+ if ( !( unmatched[ i ] || setMatched[ i ] ) ) {
+ setMatched[ i ] = pop.call( results );
+ }
+ }
+ }
+
+ // Discard index placeholder values to get only actual matches
+ setMatched = condense( setMatched );
+ }
+
+ // Add matches to results
+ push.apply( results, setMatched );
+
+ // Seedless set matches succeeding multiple successful matchers stipulate sorting
+ if ( outermost && !seed && setMatched.length > 0 &&
+ ( matchedCount + setMatchers.length ) > 1 ) {
+
+ Sizzle.uniqueSort( results );
+ }
+ }
+
+ // Override manipulation of globals by nested matchers
+ if ( outermost ) {
+ dirruns = dirrunsUnique;
+ outermostContext = contextBackup;
+ }
+
+ return unmatched;
+ };
+
+ return bySet ?
+ markFunction( superMatcher ) :
+ superMatcher;
+}
+
+compile = Sizzle.compile = function( selector, match /* Internal Use Only */ ) {
+ var i,
+ setMatchers = [],
+ elementMatchers = [],
+ cached = compilerCache[ selector + " " ];
+
+ if ( !cached ) {
+
+ // Generate a function of recursive functions that can be used to check each element
+ if ( !match ) {
+ match = tokenize( selector );
+ }
+ i = match.length;
+ while ( i-- ) {
+ cached = matcherFromTokens( match[ i ] );
+ if ( cached[ expando ] ) {
+ setMatchers.push( cached );
+ } else {
+ elementMatchers.push( cached );
+ }
+ }
+
+ // Cache the compiled function
+ cached = compilerCache(
+ selector,
+ matcherFromGroupMatchers( elementMatchers, setMatchers )
+ );
+
+ // Save selector and tokenization
+ cached.selector = selector;
+ }
+ return cached;
+};
+
+/**
+ * A low-level selection function that works with Sizzle's compiled
+ * selector functions
+ * @param {String|Function} selector A selector or a pre-compiled
+ * selector function built with Sizzle.compile
+ * @param {Element} context
+ * @param {Array} [results]
+ * @param {Array} [seed] A set of elements to match against
+ */
+select = Sizzle.select = function( selector, context, results, seed ) {
+ var i, tokens, token, type, find,
+ compiled = typeof selector === "function" && selector,
+ match = !seed && tokenize( ( selector = compiled.selector || selector ) );
+
+ results = results || [];
+
+ // Try to minimize operations if there is only one selector in the list and no seed
+ // (the latter of which guarantees us context)
+ if ( match.length === 1 ) {
+
+ // Reduce context if the leading compound selector is an ID
+ tokens = match[ 0 ] = match[ 0 ].slice( 0 );
+ if ( tokens.length > 2 && ( token = tokens[ 0 ] ).type === "ID" &&
+ context.nodeType === 9 && documentIsHTML && Expr.relative[ tokens[ 1 ].type ] ) {
+
+ context = ( Expr.find[ "ID" ]( token.matches[ 0 ]
+ .replace( runescape, funescape ), context ) || [] )[ 0 ];
+ if ( !context ) {
+ return results;
+
+ // Precompiled matchers will still verify ancestry, so step up a level
+ } else if ( compiled ) {
+ context = context.parentNode;
+ }
+
+ selector = selector.slice( tokens.shift().value.length );
+ }
+
+ // Fetch a seed set for right-to-left matching
+ i = matchExpr[ "needsContext" ].test( selector ) ? 0 : tokens.length;
+ while ( i-- ) {
+ token = tokens[ i ];
+
+ // Abort if we hit a combinator
+ if ( Expr.relative[ ( type = token.type ) ] ) {
+ break;
+ }
+ if ( ( find = Expr.find[ type ] ) ) {
+
+ // Search, expanding context for leading sibling combinators
+ if ( ( seed = find(
+ token.matches[ 0 ].replace( runescape, funescape ),
+ rsibling.test( tokens[ 0 ].type ) && testContext( context.parentNode ) ||
+ context
+ ) ) ) {
+
+ // If seed is empty or no tokens remain, we can return early
+ tokens.splice( i, 1 );
+ selector = seed.length && toSelector( tokens );
+ if ( !selector ) {
+ push.apply( results, seed );
+ return results;
+ }
+
+ break;
+ }
+ }
+ }
+ }
+
+ // Compile and execute a filtering function if one is not provided
+ // Provide `match` to avoid retokenization if we modified the selector above
+ ( compiled || compile( selector, match ) )(
+ seed,
+ context,
+ !documentIsHTML,
+ results,
+ !context || rsibling.test( selector ) && testContext( context.parentNode ) || context
+ );
+ return results;
+};
+
+// One-time assignments
+
+// Sort stability
+support.sortStable = expando.split( "" ).sort( sortOrder ).join( "" ) === expando;
+
+// Support: Chrome 14-35+
+// Always assume duplicates if they aren't passed to the comparison function
+support.detectDuplicates = !!hasDuplicate;
+
+// Initialize against the default document
+setDocument();
+
+// Support: Webkit<537.32 - Safari 6.0.3/Chrome 25 (fixed in Chrome 27)
+// Detached nodes confoundingly follow *each other*
+support.sortDetached = assert( function( el ) {
+
+ // Should return 1, but returns 4 (following)
+ return el.compareDocumentPosition( document.createElement( "fieldset" ) ) & 1;
+} );
+
+// Support: IE<8
+// Prevent attribute/property "interpolation"
+// https://msdn.microsoft.com/en-us/library/ms536429%28VS.85%29.aspx
+if ( !assert( function( el ) {
+ el.innerHTML = "<a href='#'></a>";
+ return el.firstChild.getAttribute( "href" ) === "#";
+} ) ) {
+ addHandle( "type|href|height|width", function( elem, name, isXML ) {
+ if ( !isXML ) {
+ return elem.getAttribute( name, name.toLowerCase() === "type" ? 1 : 2 );
+ }
+ } );
+}
+
+// Support: IE<9
+// Use defaultValue in place of getAttribute("value")
+if ( !support.attributes || !assert( function( el ) {
+ el.innerHTML = "<input/>";
+ el.firstChild.setAttribute( "value", "" );
+ return el.firstChild.getAttribute( "value" ) === "";
+} ) ) {
+ addHandle( "value", function( elem, _name, isXML ) {
+ if ( !isXML && elem.nodeName.toLowerCase() === "input" ) {
+ return elem.defaultValue;
+ }
+ } );
+}
+
+// Support: IE<9
+// Use getAttributeNode to fetch booleans when getAttribute lies
+if ( !assert( function( el ) {
+ return el.getAttribute( "disabled" ) == null;
+} ) ) {
+ addHandle( booleans, function( elem, name, isXML ) {
+ var val;
+ if ( !isXML ) {
+ return elem[ name ] === true ? name.toLowerCase() :
+ ( val = elem.getAttributeNode( name ) ) && val.specified ?
+ val.value :
+ null;
+ }
+ } );
+}
+
+return Sizzle;
+
+} )( window );
+
+
+
+jQuery.find = Sizzle;
+jQuery.expr = Sizzle.selectors;
+
+// Deprecated
+jQuery.expr[ ":" ] = jQuery.expr.pseudos;
+jQuery.uniqueSort = jQuery.unique = Sizzle.uniqueSort;
+jQuery.text = Sizzle.getText;
+jQuery.isXMLDoc = Sizzle.isXML;
+jQuery.contains = Sizzle.contains;
+jQuery.escapeSelector = Sizzle.escape;
+
+
+
+
+var dir = function( elem, dir, until ) {
+ var matched = [],
+ truncate = until !== undefined;
+
+ while ( ( elem = elem[ dir ] ) && elem.nodeType !== 9 ) {
+ if ( elem.nodeType === 1 ) {
+ if ( truncate && jQuery( elem ).is( until ) ) {
+ break;
+ }
+ matched.push( elem );
+ }
+ }
+ return matched;
+};
+
+
+var siblings = function( n, elem ) {
+ var matched = [];
+
+ for ( ; n; n = n.nextSibling ) {
+ if ( n.nodeType === 1 && n !== elem ) {
+ matched.push( n );
+ }
+ }
+
+ return matched;
+};
+
+
+var rneedsContext = jQuery.expr.match.needsContext;
+
+
+
+function nodeName( elem, name ) {
+
+ return elem.nodeName && elem.nodeName.toLowerCase() === name.toLowerCase();
+
+};
+var rsingleTag = ( /^<([a-z][^\/\0>:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i );
+
+
+
+// Implement the identical functionality for filter and not
+function winnow( elements, qualifier, not ) {
+ if ( isFunction( qualifier ) ) {
+ return jQuery.grep( elements, function( elem, i ) {
+ return !!qualifier.call( elem, i, elem ) !== not;
+ } );
+ }
+
+ // Single element
+ if ( qualifier.nodeType ) {
+ return jQuery.grep( elements, function( elem ) {
+ return ( elem === qualifier ) !== not;
+ } );
+ }
+
+ // Arraylike of elements (jQuery, arguments, Array)
+ if ( typeof qualifier !== "string" ) {
+ return jQuery.grep( elements, function( elem ) {
+ return ( indexOf.call( qualifier, elem ) > -1 ) !== not;
+ } );
+ }
+
+ // Filtered directly for both simple and complex selectors
+ return jQuery.filter( qualifier, elements, not );
+}
+
+jQuery.filter = function( expr, elems, not ) {
+ var elem = elems[ 0 ];
+
+ if ( not ) {
+ expr = ":not(" + expr + ")";
+ }
+
+ if ( elems.length === 1 && elem.nodeType === 1 ) {
+ return jQuery.find.matchesSelector( elem, expr ) ? [ elem ] : [];
+ }
+
+ return jQuery.find.matches( expr, jQuery.grep( elems, function( elem ) {
+ return elem.nodeType === 1;
+ } ) );
+};
+
+jQuery.fn.extend( {
+ find: function( selector ) {
+ var i, ret,
+ len = this.length,
+ self = this;
+
+ if ( typeof selector !== "string" ) {
+ return this.pushStack( jQuery( selector ).filter( function() {
+ for ( i = 0; i < len; i++ ) {
+ if ( jQuery.contains( self[ i ], this ) ) {
+ return true;
+ }
+ }
+ } ) );
+ }
+
+ ret = this.pushStack( [] );
+
+ for ( i = 0; i < len; i++ ) {
+ jQuery.find( selector, self[ i ], ret );
+ }
+
+ return len > 1 ? jQuery.uniqueSort( ret ) : ret;
+ },
+ filter: function( selector ) {
+ return this.pushStack( winnow( this, selector || [], false ) );
+ },
+ not: function( selector ) {
+ return this.pushStack( winnow( this, selector || [], true ) );
+ },
+ is: function( selector ) {
+ return !!winnow(
+ this,
+
+ // If this is a positional/relative selector, check membership in the returned set
+ // so $("p:first").is("p:last") won't return true for a doc with two "p".
+ typeof selector === "string" && rneedsContext.test( selector ) ?
+ jQuery( selector ) :
+ selector || [],
+ false
+ ).length;
+ }
+} );
+
+
+// Initialize a jQuery object
+
+
+// A central reference to the root jQuery(document)
+var rootjQuery,
+
+ // A simple way to check for HTML strings
+ // Prioritize #id over <tag> to avoid XSS via location.hash (#9521)
+ // Strict HTML recognition (#11290: must start with <)
+ // Shortcut simple #id case for speed
+ rquickExpr = /^(?:\s*(<[\w\W]+>)[^>]*|#([\w-]+))$/,
+
+ init = jQuery.fn.init = function( selector, context, root ) {
+ var match, elem;
+
+ // HANDLE: $(""), $(null), $(undefined), $(false)
+ if ( !selector ) {
+ return this;
+ }
+
+ // Method init() accepts an alternate rootjQuery
+ // so migrate can support jQuery.sub (gh-2101)
+ root = root || rootjQuery;
+
+ // Handle HTML strings
+ if ( typeof selector === "string" ) {
+ if ( selector[ 0 ] === "<" &&
+ selector[ selector.length - 1 ] === ">" &&
+ selector.length >= 3 ) {
+
+ // Assume that strings that start and end with <> are HTML and skip the regex check
+ match = [ null, selector, null ];
+
+ } else {
+ match = rquickExpr.exec( selector );
+ }
+
+ // Match html or make sure no context is specified for #id
+ if ( match && ( match[ 1 ] || !context ) ) {
+
+ // HANDLE: $(html) -> $(array)
+ if ( match[ 1 ] ) {
+ context = context instanceof jQuery ? context[ 0 ] : context;
+
+ // Option to run scripts is true for back-compat
+ // Intentionally let the error be thrown if parseHTML is not present
+ jQuery.merge( this, jQuery.parseHTML(
+ match[ 1 ],
+ context && context.nodeType ? context.ownerDocument || context : document,
+ true
+ ) );
+
+ // HANDLE: $(html, props)
+ if ( rsingleTag.test( match[ 1 ] ) && jQuery.isPlainObject( context ) ) {
+ for ( match in context ) {
+
+ // Properties of context are called as methods if possible
+ if ( isFunction( this[ match ] ) ) {
+ this[ match ]( context[ match ] );
+
+ // ...and otherwise set as attributes
+ } else {
+ this.attr( match, context[ match ] );
+ }
+ }
+ }
+
+ return this;
+
+ // HANDLE: $(#id)
+ } else {
+ elem = document.getElementById( match[ 2 ] );
+
+ if ( elem ) {
+
+ // Inject the element directly into the jQuery object
+ this[ 0 ] = elem;
+ this.length = 1;
+ }
+ return this;
+ }
+
+ // HANDLE: $(expr, $(...))
+ } else if ( !context || context.jquery ) {
+ return ( context || root ).find( selector );
+
+ // HANDLE: $(expr, context)
+ // (which is just equivalent to: $(context).find(expr)
+ } else {
+ return this.constructor( context ).find( selector );
+ }
+
+ // HANDLE: $(DOMElement)
+ } else if ( selector.nodeType ) {
+ this[ 0 ] = selector;
+ this.length = 1;
+ return this;
+
+ // HANDLE: $(function)
+ // Shortcut for document ready
+ } else if ( isFunction( selector ) ) {
+ return root.ready !== undefined ?
+ root.ready( selector ) :
+
+ // Execute immediately if ready is not present
+ selector( jQuery );
+ }
+
+ return jQuery.makeArray( selector, this );
+ };
+
+// Give the init function the jQuery prototype for later instantiation
+init.prototype = jQuery.fn;
+
+// Initialize central reference
+rootjQuery = jQuery( document );
+
+
+var rparentsprev = /^(?:parents|prev(?:Until|All))/,
+
+ // Methods guaranteed to produce a unique set when starting from a unique set
+ guaranteedUnique = {
+ children: true,
+ contents: true,
+ next: true,
+ prev: true
+ };
+
+jQuery.fn.extend( {
+ has: function( target ) {
+ var targets = jQuery( target, this ),
+ l = targets.length;
+
+ return this.filter( function() {
+ var i = 0;
+ for ( ; i < l; i++ ) {
+ if ( jQuery.contains( this, targets[ i ] ) ) {
+ return true;
+ }
+ }
+ } );
+ },
+
+ closest: function( selectors, context ) {
+ var cur,
+ i = 0,
+ l = this.length,
+ matched = [],
+ targets = typeof selectors !== "string" && jQuery( selectors );
+
+ // Positional selectors never match, since there's no _selection_ context
+ if ( !rneedsContext.test( selectors ) ) {
+ for ( ; i < l; i++ ) {
+ for ( cur = this[ i ]; cur && cur !== context; cur = cur.parentNode ) {
+
+ // Always skip document fragments
+ if ( cur.nodeType < 11 && ( targets ?
+ targets.index( cur ) > -1 :
+
+ // Don't pass non-elements to Sizzle
+ cur.nodeType === 1 &&
+ jQuery.find.matchesSelector( cur, selectors ) ) ) {
+
+ matched.push( cur );
+ break;
+ }
+ }
+ }
+ }
+
+ return this.pushStack( matched.length > 1 ? jQuery.uniqueSort( matched ) : matched );
+ },
+
+ // Determine the position of an element within the set
+ index: function( elem ) {
+
+ // No argument, return index in parent
+ if ( !elem ) {
+ return ( this[ 0 ] && this[ 0 ].parentNode ) ? this.first().prevAll().length : -1;
+ }
+
+ // Index in selector
+ if ( typeof elem === "string" ) {
+ return indexOf.call( jQuery( elem ), this[ 0 ] );
+ }
+
+ // Locate the position of the desired element
+ return indexOf.call( this,
+
+ // If it receives a jQuery object, the first element is used
+ elem.jquery ? elem[ 0 ] : elem
+ );
+ },
+
+ add: function( selector, context ) {
+ return this.pushStack(
+ jQuery.uniqueSort(
+ jQuery.merge( this.get(), jQuery( selector, context ) )
+ )
+ );
+ },
+
+ addBack: function( selector ) {
+ return this.add( selector == null ?
+ this.prevObject : this.prevObject.filter( selector )
+ );
+ }
+} );
+
+function sibling( cur, dir ) {
+ while ( ( cur = cur[ dir ] ) && cur.nodeType !== 1 ) {}
+ return cur;
+}
+
+jQuery.each( {
+ parent: function( elem ) {
+ var parent = elem.parentNode;
+ return parent && parent.nodeType !== 11 ? parent : null;
+ },
+ parents: function( elem ) {
+ return dir( elem, "parentNode" );
+ },
+ parentsUntil: function( elem, _i, until ) {
+ return dir( elem, "parentNode", until );
+ },
+ next: function( elem ) {
+ return sibling( elem, "nextSibling" );
+ },
+ prev: function( elem ) {
+ return sibling( elem, "previousSibling" );
+ },
+ nextAll: function( elem ) {
+ return dir( elem, "nextSibling" );
+ },
+ prevAll: function( elem ) {
+ return dir( elem, "previousSibling" );
+ },
+ nextUntil: function( elem, _i, until ) {
+ return dir( elem, "nextSibling", until );
+ },
+ prevUntil: function( elem, _i, until ) {
+ return dir( elem, "previousSibling", until );
+ },
+ siblings: function( elem ) {
+ return siblings( ( elem.parentNode || {} ).firstChild, elem );
+ },
+ children: function( elem ) {
+ return siblings( elem.firstChild );
+ },
+ contents: function( elem ) {
+ if ( elem.contentDocument != null &&
+
+ // Support: IE 11+
+ // <object> elements with no `data` attribute has an object
+ // `contentDocument` with a `null` prototype.
+ getProto( elem.contentDocument ) ) {
+
+ return elem.contentDocument;
+ }
+
+ // Support: IE 9 - 11 only, iOS 7 only, Android Browser <=4.3 only
+ // Treat the template element as a regular one in browsers that
+ // don't support it.
+ if ( nodeName( elem, "template" ) ) {
+ elem = elem.content || elem;
+ }
+
+ return jQuery.merge( [], elem.childNodes );
+ }
+}, function( name, fn ) {
+ jQuery.fn[ name ] = function( until, selector ) {
+ var matched = jQuery.map( this, fn, until );
+
+ if ( name.slice( -5 ) !== "Until" ) {
+ selector = until;
+ }
+
+ if ( selector && typeof selector === "string" ) {
+ matched = jQuery.filter( selector, matched );
+ }
+
+ if ( this.length > 1 ) {
+
+ // Remove duplicates
+ if ( !guaranteedUnique[ name ] ) {
+ jQuery.uniqueSort( matched );
+ }
+
+ // Reverse order for parents* and prev-derivatives
+ if ( rparentsprev.test( name ) ) {
+ matched.reverse();
+ }
+ }
+
+ return this.pushStack( matched );
+ };
+} );
+var rnothtmlwhite = ( /[^\x20\t\r\n\f]+/g );
+
+
+
+// Convert String-formatted options into Object-formatted ones
+function createOptions( options ) {
+ var object = {};
+ jQuery.each( options.match( rnothtmlwhite ) || [], function( _, flag ) {
+ object[ flag ] = true;
+ } );
+ return object;
+}
+
+/*
+ * Create a callback list using the following parameters:
+ *
+ * options: an optional list of space-separated options that will change how
+ * the callback list behaves or a more traditional option object
+ *
+ * By default a callback list will act like an event callback list and can be
+ * "fired" multiple times.
+ *
+ * Possible options:
+ *
+ * once: will ensure the callback list can only be fired once (like a Deferred)
+ *
+ * memory: will keep track of previous values and will call any callback added
+ * after the list has been fired right away with the latest "memorized"
+ * values (like a Deferred)
+ *
+ * unique: will ensure a callback can only be added once (no duplicate in the list)
+ *
+ * stopOnFalse: interrupt callings when a callback returns false
+ *
+ */
+jQuery.Callbacks = function( options ) {
+
+ // Convert options from String-formatted to Object-formatted if needed
+ // (we check in cache first)
+ options = typeof options === "string" ?
+ createOptions( options ) :
+ jQuery.extend( {}, options );
+
+ var // Flag to know if list is currently firing
+ firing,
+
+ // Last fire value for non-forgettable lists
+ memory,
+
+ // Flag to know if list was already fired
+ fired,
+
+ // Flag to prevent firing
+ locked,
+
+ // Actual callback list
+ list = [],
+
+ // Queue of execution data for repeatable lists
+ queue = [],
+
+ // Index of currently firing callback (modified by add/remove as needed)
+ firingIndex = -1,
+
+ // Fire callbacks
+ fire = function() {
+
+ // Enforce single-firing
+ locked = locked || options.once;
+
+ // Execute callbacks for all pending executions,
+ // respecting firingIndex overrides and runtime changes
+ fired = firing = true;
+ for ( ; queue.length; firingIndex = -1 ) {
+ memory = queue.shift();
+ while ( ++firingIndex < list.length ) {
+
+ // Run callback and check for early termination
+ if ( list[ firingIndex ].apply( memory[ 0 ], memory[ 1 ] ) === false &&
+ options.stopOnFalse ) {
+
+ // Jump to end and forget the data so .add doesn't re-fire
+ firingIndex = list.length;
+ memory = false;
+ }
+ }
+ }
+
+ // Forget the data if we're done with it
+ if ( !options.memory ) {
+ memory = false;
+ }
+
+ firing = false;
+
+ // Clean up if we're done firing for good
+ if ( locked ) {
+
+ // Keep an empty list if we have data for future add calls
+ if ( memory ) {
+ list = [];
+
+ // Otherwise, this object is spent
+ } else {
+ list = "";
+ }
+ }
+ },
+
+ // Actual Callbacks object
+ self = {
+
+ // Add a callback or a collection of callbacks to the list
+ add: function() {
+ if ( list ) {
+
+ // If we have memory from a past run, we should fire after adding
+ if ( memory && !firing ) {
+ firingIndex = list.length - 1;
+ queue.push( memory );
+ }
+
+ ( function add( args ) {
+ jQuery.each( args, function( _, arg ) {
+ if ( isFunction( arg ) ) {
+ if ( !options.unique || !self.has( arg ) ) {
+ list.push( arg );
+ }
+ } else if ( arg && arg.length && toType( arg ) !== "string" ) {
+
+ // Inspect recursively
+ add( arg );
+ }
+ } );
+ } )( arguments );
+
+ if ( memory && !firing ) {
+ fire();
+ }
+ }
+ return this;
+ },
+
+ // Remove a callback from the list
+ remove: function() {
+ jQuery.each( arguments, function( _, arg ) {
+ var index;
+ while ( ( index = jQuery.inArray( arg, list, index ) ) > -1 ) {
+ list.splice( index, 1 );
+
+ // Handle firing indexes
+ if ( index <= firingIndex ) {
+ firingIndex--;
+ }
+ }
+ } );
+ return this;
+ },
+
+ // Check if a given callback is in the list.
+ // If no argument is given, return whether or not list has callbacks attached.
+ has: function( fn ) {
+ return fn ?
+ jQuery.inArray( fn, list ) > -1 :
+ list.length > 0;
+ },
+
+ // Remove all callbacks from the list
+ empty: function() {
+ if ( list ) {
+ list = [];
+ }
+ return this;
+ },
+
+ // Disable .fire and .add
+ // Abort any current/pending executions
+ // Clear all callbacks and values
+ disable: function() {
+ locked = queue = [];
+ list = memory = "";
+ return this;
+ },
+ disabled: function() {
+ return !list;
+ },
+
+ // Disable .fire
+ // Also disable .add unless we have memory (since it would have no effect)
+ // Abort any pending executions
+ lock: function() {
+ locked = queue = [];
+ if ( !memory && !firing ) {
+ list = memory = "";
+ }
+ return this;
+ },
+ locked: function() {
+ return !!locked;
+ },
+
+ // Call all callbacks with the given context and arguments
+ fireWith: function( context, args ) {
+ if ( !locked ) {
+ args = args || [];
+ args = [ context, args.slice ? args.slice() : args ];
+ queue.push( args );
+ if ( !firing ) {
+ fire();
+ }
+ }
+ return this;
+ },
+
+ // Call all the callbacks with the given arguments
+ fire: function() {
+ self.fireWith( this, arguments );
+ return this;
+ },
+
+ // To know if the callbacks have already been called at least once
+ fired: function() {
+ return !!fired;
+ }
+ };
+
+ return self;
+};
+
+
+function Identity( v ) {
+ return v;
+}
+function Thrower( ex ) {
+ throw ex;
+}
+
+function adoptValue( value, resolve, reject, noValue ) {
+ var method;
+
+ try {
+
+ // Check for promise aspect first to privilege synchronous behavior
+ if ( value && isFunction( ( method = value.promise ) ) ) {
+ method.call( value ).done( resolve ).fail( reject );
+
+ // Other thenables
+ } else if ( value && isFunction( ( method = value.then ) ) ) {
+ method.call( value, resolve, reject );
+
+ // Other non-thenables
+ } else {
+
+ // Control `resolve` arguments by letting Array#slice cast boolean `noValue` to integer:
+ // * false: [ value ].slice( 0 ) => resolve( value )
+ // * true: [ value ].slice( 1 ) => resolve()
+ resolve.apply( undefined, [ value ].slice( noValue ) );
+ }
+
+ // For Promises/A+, convert exceptions into rejections
+ // Since jQuery.when doesn't unwrap thenables, we can skip the extra checks appearing in
+ // Deferred#then to conditionally suppress rejection.
+ } catch ( value ) {
+
+ // Support: Android 4.0 only
+ // Strict mode functions invoked without .call/.apply get global-object context
+ reject.apply( undefined, [ value ] );
+ }
+}
+
+jQuery.extend( {
+
+ Deferred: function( func ) {
+ var tuples = [
+
+ // action, add listener, callbacks,
+ // ... .then handlers, argument index, [final state]
+ [ "notify", "progress", jQuery.Callbacks( "memory" ),
+ jQuery.Callbacks( "memory" ), 2 ],
+ [ "resolve", "done", jQuery.Callbacks( "once memory" ),
+ jQuery.Callbacks( "once memory" ), 0, "resolved" ],
+ [ "reject", "fail", jQuery.Callbacks( "once memory" ),
+ jQuery.Callbacks( "once memory" ), 1, "rejected" ]
+ ],
+ state = "pending",
+ promise = {
+ state: function() {
+ return state;
+ },
+ always: function() {
+ deferred.done( arguments ).fail( arguments );
+ return this;
+ },
+ "catch": function( fn ) {
+ return promise.then( null, fn );
+ },
+
+ // Keep pipe for back-compat
+ pipe: function( /* fnDone, fnFail, fnProgress */ ) {
+ var fns = arguments;
+
+ return jQuery.Deferred( function( newDefer ) {
+ jQuery.each( tuples, function( _i, tuple ) {
+
+ // Map tuples (progress, done, fail) to arguments (done, fail, progress)
+ var fn = isFunction( fns[ tuple[ 4 ] ] ) && fns[ tuple[ 4 ] ];
+
+ // deferred.progress(function() { bind to newDefer or newDefer.notify })
+ // deferred.done(function() { bind to newDefer or newDefer.resolve })
+ // deferred.fail(function() { bind to newDefer or newDefer.reject })
+ deferred[ tuple[ 1 ] ]( function() {
+ var returned = fn && fn.apply( this, arguments );
+ if ( returned && isFunction( returned.promise ) ) {
+ returned.promise()
+ .progress( newDefer.notify )
+ .done( newDefer.resolve )
+ .fail( newDefer.reject );
+ } else {
+ newDefer[ tuple[ 0 ] + "With" ](
+ this,
+ fn ? [ returned ] : arguments
+ );
+ }
+ } );
+ } );
+ fns = null;
+ } ).promise();
+ },
+ then: function( onFulfilled, onRejected, onProgress ) {
+ var maxDepth = 0;
+ function resolve( depth, deferred, handler, special ) {
+ return function() {
+ var that = this,
+ args = arguments,
+ mightThrow = function() {
+ var returned, then;
+
+ // Support: Promises/A+ section 2.3.3.3.3
+ // https://promisesaplus.com/#point-59
+ // Ignore double-resolution attempts
+ if ( depth < maxDepth ) {
+ return;
+ }
+
+ returned = handler.apply( that, args );
+
+ // Support: Promises/A+ section 2.3.1
+ // https://promisesaplus.com/#point-48
+ if ( returned === deferred.promise() ) {
+ throw new TypeError( "Thenable self-resolution" );
+ }
+
+ // Support: Promises/A+ sections 2.3.3.1, 3.5
+ // https://promisesaplus.com/#point-54
+ // https://promisesaplus.com/#point-75
+ // Retrieve `then` only once
+ then = returned &&
+
+ // Support: Promises/A+ section 2.3.4
+ // https://promisesaplus.com/#point-64
+ // Only check objects and functions for thenability
+ ( typeof returned === "object" ||
+ typeof returned === "function" ) &&
+ returned.then;
+
+ // Handle a returned thenable
+ if ( isFunction( then ) ) {
+
+ // Special processors (notify) just wait for resolution
+ if ( special ) {
+ then.call(
+ returned,
+ resolve( maxDepth, deferred, Identity, special ),
+ resolve( maxDepth, deferred, Thrower, special )
+ );
+
+ // Normal processors (resolve) also hook into progress
+ } else {
+
+ // ...and disregard older resolution values
+ maxDepth++;
+
+ then.call(
+ returned,
+ resolve( maxDepth, deferred, Identity, special ),
+ resolve( maxDepth, deferred, Thrower, special ),
+ resolve( maxDepth, deferred, Identity,
+ deferred.notifyWith )
+ );
+ }
+
+ // Handle all other returned values
+ } else {
+
+ // Only substitute handlers pass on context
+ // and multiple values (non-spec behavior)
+ if ( handler !== Identity ) {
+ that = undefined;
+ args = [ returned ];
+ }
+
+ // Process the value(s)
+ // Default process is resolve
+ ( special || deferred.resolveWith )( that, args );
+ }
+ },
+
+ // Only normal processors (resolve) catch and reject exceptions
+ process = special ?
+ mightThrow :
+ function() {
+ try {
+ mightThrow();
+ } catch ( e ) {
+
+ if ( jQuery.Deferred.exceptionHook ) {
+ jQuery.Deferred.exceptionHook( e,
+ process.stackTrace );
+ }
+
+ // Support: Promises/A+ section 2.3.3.3.4.1
+ // https://promisesaplus.com/#point-61
+ // Ignore post-resolution exceptions
+ if ( depth + 1 >= maxDepth ) {
+
+ // Only substitute handlers pass on context
+ // and multiple values (non-spec behavior)
+ if ( handler !== Thrower ) {
+ that = undefined;
+ args = [ e ];
+ }
+
+ deferred.rejectWith( that, args );
+ }
+ }
+ };
+
+ // Support: Promises/A+ section 2.3.3.3.1
+ // https://promisesaplus.com/#point-57
+ // Re-resolve promises immediately to dodge false rejection from
+ // subsequent errors
+ if ( depth ) {
+ process();
+ } else {
+
+ // Call an optional hook to record the stack, in case of exception
+ // since it's otherwise lost when execution goes async
+ if ( jQuery.Deferred.getStackHook ) {
+ process.stackTrace = jQuery.Deferred.getStackHook();
+ }
+ window.setTimeout( process );
+ }
+ };
+ }
+
+ return jQuery.Deferred( function( newDefer ) {
+
+ // progress_handlers.add( ... )
+ tuples[ 0 ][ 3 ].add(
+ resolve(
+ 0,
+ newDefer,
+ isFunction( onProgress ) ?
+ onProgress :
+ Identity,
+ newDefer.notifyWith
+ )
+ );
+
+ // fulfilled_handlers.add( ... )
+ tuples[ 1 ][ 3 ].add(
+ resolve(
+ 0,
+ newDefer,
+ isFunction( onFulfilled ) ?
+ onFulfilled :
+ Identity
+ )
+ );
+
+ // rejected_handlers.add( ... )
+ tuples[ 2 ][ 3 ].add(
+ resolve(
+ 0,
+ newDefer,
+ isFunction( onRejected ) ?
+ onRejected :
+ Thrower
+ )
+ );
+ } ).promise();
+ },
+
+ // Get a promise for this deferred
+ // If obj is provided, the promise aspect is added to the object
+ promise: function( obj ) {
+ return obj != null ? jQuery.extend( obj, promise ) : promise;
+ }
+ },
+ deferred = {};
+
+ // Add list-specific methods
+ jQuery.each( tuples, function( i, tuple ) {
+ var list = tuple[ 2 ],
+ stateString = tuple[ 5 ];
+
+ // promise.progress = list.add
+ // promise.done = list.add
+ // promise.fail = list.add
+ promise[ tuple[ 1 ] ] = list.add;
+
+ // Handle state
+ if ( stateString ) {
+ list.add(
+ function() {
+
+ // state = "resolved" (i.e., fulfilled)
+ // state = "rejected"
+ state = stateString;
+ },
+
+ // rejected_callbacks.disable
+ // fulfilled_callbacks.disable
+ tuples[ 3 - i ][ 2 ].disable,
+
+ // rejected_handlers.disable
+ // fulfilled_handlers.disable
+ tuples[ 3 - i ][ 3 ].disable,
+
+ // progress_callbacks.lock
+ tuples[ 0 ][ 2 ].lock,
+
+ // progress_handlers.lock
+ tuples[ 0 ][ 3 ].lock
+ );
+ }
+
+ // progress_handlers.fire
+ // fulfilled_handlers.fire
+ // rejected_handlers.fire
+ list.add( tuple[ 3 ].fire );
+
+ // deferred.notify = function() { deferred.notifyWith(...) }
+ // deferred.resolve = function() { deferred.resolveWith(...) }
+ // deferred.reject = function() { deferred.rejectWith(...) }
+ deferred[ tuple[ 0 ] ] = function() {
+ deferred[ tuple[ 0 ] + "With" ]( this === deferred ? undefined : this, arguments );
+ return this;
+ };
+
+ // deferred.notifyWith = list.fireWith
+ // deferred.resolveWith = list.fireWith
+ // deferred.rejectWith = list.fireWith
+ deferred[ tuple[ 0 ] + "With" ] = list.fireWith;
+ } );
+
+ // Make the deferred a promise
+ promise.promise( deferred );
+
+ // Call given func if any
+ if ( func ) {
+ func.call( deferred, deferred );
+ }
+
+ // All done!
+ return deferred;
+ },
+
+ // Deferred helper
+ when: function( singleValue ) {
+ var
+
+ // count of uncompleted subordinates
+ remaining = arguments.length,
+
+ // count of unprocessed arguments
+ i = remaining,
+
+ // subordinate fulfillment data
+ resolveContexts = Array( i ),
+ resolveValues = slice.call( arguments ),
+
+ // the master Deferred
+ master = jQuery.Deferred(),
+
+ // subordinate callback factory
+ updateFunc = function( i ) {
+ return function( value ) {
+ resolveContexts[ i ] = this;
+ resolveValues[ i ] = arguments.length > 1 ? slice.call( arguments ) : value;
+ if ( !( --remaining ) ) {
+ master.resolveWith( resolveContexts, resolveValues );
+ }
+ };
+ };
+
+ // Single- and empty arguments are adopted like Promise.resolve
+ if ( remaining <= 1 ) {
+ adoptValue( singleValue, master.done( updateFunc( i ) ).resolve, master.reject,
+ !remaining );
+
+ // Use .then() to unwrap secondary thenables (cf. gh-3000)
+ if ( master.state() === "pending" ||
+ isFunction( resolveValues[ i ] && resolveValues[ i ].then ) ) {
+
+ return master.then();
+ }
+ }
+
+ // Multiple arguments are aggregated like Promise.all array elements
+ while ( i-- ) {
+ adoptValue( resolveValues[ i ], updateFunc( i ), master.reject );
+ }
+
+ return master.promise();
+ }
+} );
+
+
+// These usually indicate a programmer mistake during development,
+// warn about them ASAP rather than swallowing them by default.
+var rerrorNames = /^(Eval|Internal|Range|Reference|Syntax|Type|URI)Error$/;
+
+jQuery.Deferred.exceptionHook = function( error, stack ) {
+
+ // Support: IE 8 - 9 only
+ // Console exists when dev tools are open, which can happen at any time
+ if ( window.console && window.console.warn && error && rerrorNames.test( error.name ) ) {
+ window.console.warn( "jQuery.Deferred exception: " + error.message, error.stack, stack );
+ }
+};
+
+
+
+
+jQuery.readyException = function( error ) {
+ window.setTimeout( function() {
+ throw error;
+ } );
+};
+
+
+
+
+// The deferred used on DOM ready
+var readyList = jQuery.Deferred();
+
+jQuery.fn.ready = function( fn ) {
+
+ readyList
+ .then( fn )
+
+ // Wrap jQuery.readyException in a function so that the lookup
+ // happens at the time of error handling instead of callback
+ // registration.
+ .catch( function( error ) {
+ jQuery.readyException( error );
+ } );
+
+ return this;
+};
+
+jQuery.extend( {
+
+ // Is the DOM ready to be used? Set to true once it occurs.
+ isReady: false,
+
+ // A counter to track how many items to wait for before
+ // the ready event fires. See #6781
+ readyWait: 1,
+
+ // Handle when the DOM is ready
+ ready: function( wait ) {
+
+ // Abort if there are pending holds or we're already ready
+ if ( wait === true ? --jQuery.readyWait : jQuery.isReady ) {
+ return;
+ }
+
+ // Remember that the DOM is ready
+ jQuery.isReady = true;
+
+ // If a normal DOM Ready event fired, decrement, and wait if need be
+ if ( wait !== true && --jQuery.readyWait > 0 ) {
+ return;
+ }
+
+ // If there are functions bound, to execute
+ readyList.resolveWith( document, [ jQuery ] );
+ }
+} );
+
+jQuery.ready.then = readyList.then;
+
+// The ready event handler and self cleanup method
+function completed() {
+ document.removeEventListener( "DOMContentLoaded", completed );
+ window.removeEventListener( "load", completed );
+ jQuery.ready();
+}
+
+// Catch cases where $(document).ready() is called
+// after the browser event has already occurred.
+// Support: IE <=9 - 10 only
+// Older IE sometimes signals "interactive" too soon
+if ( document.readyState === "complete" ||
+ ( document.readyState !== "loading" && !document.documentElement.doScroll ) ) {
+
+ // Handle it asynchronously to allow scripts the opportunity to delay ready
+ window.setTimeout( jQuery.ready );
+
+} else {
+
+ // Use the handy event callback
+ document.addEventListener( "DOMContentLoaded", completed );
+
+ // A fallback to window.onload, that will always work
+ window.addEventListener( "load", completed );
+}
+
+
+
+
+// Multifunctional method to get and set values of a collection
+// The value/s can optionally be executed if it's a function
+var access = function( elems, fn, key, value, chainable, emptyGet, raw ) {
+ var i = 0,
+ len = elems.length,
+ bulk = key == null;
+
+ // Sets many values
+ if ( toType( key ) === "object" ) {
+ chainable = true;
+ for ( i in key ) {
+ access( elems, fn, i, key[ i ], true, emptyGet, raw );
+ }
+
+ // Sets one value
+ } else if ( value !== undefined ) {
+ chainable = true;
+
+ if ( !isFunction( value ) ) {
+ raw = true;
+ }
+
+ if ( bulk ) {
+
+ // Bulk operations run against the entire set
+ if ( raw ) {
+ fn.call( elems, value );
+ fn = null;
+
+ // ...except when executing function values
+ } else {
+ bulk = fn;
+ fn = function( elem, _key, value ) {
+ return bulk.call( jQuery( elem ), value );
+ };
+ }
+ }
+
+ if ( fn ) {
+ for ( ; i < len; i++ ) {
+ fn(
+ elems[ i ], key, raw ?
+ value :
+ value.call( elems[ i ], i, fn( elems[ i ], key ) )
+ );
+ }
+ }
+ }
+
+ if ( chainable ) {
+ return elems;
+ }
+
+ // Gets
+ if ( bulk ) {
+ return fn.call( elems );
+ }
+
+ return len ? fn( elems[ 0 ], key ) : emptyGet;
+};
+
+
+// Matches dashed string for camelizing
+var rmsPrefix = /^-ms-/,
+ rdashAlpha = /-([a-z])/g;
+
+// Used by camelCase as callback to replace()
+function fcamelCase( _all, letter ) {
+ return letter.toUpperCase();
+}
+
+// Convert dashed to camelCase; used by the css and data modules
+// Support: IE <=9 - 11, Edge 12 - 15
+// Microsoft forgot to hump their vendor prefix (#9572)
+function camelCase( string ) {
+ return string.replace( rmsPrefix, "ms-" ).replace( rdashAlpha, fcamelCase );
+}
+var acceptData = function( owner ) {
+
+ // Accepts only:
+ // - Node
+ // - Node.ELEMENT_NODE
+ // - Node.DOCUMENT_NODE
+ // - Object
+ // - Any
+ return owner.nodeType === 1 || owner.nodeType === 9 || !( +owner.nodeType );
+};
+
+
+
+
+function Data() {
+ this.expando = jQuery.expando + Data.uid++;
+}
+
+Data.uid = 1;
+
+Data.prototype = {
+
+ cache: function( owner ) {
+
+ // Check if the owner object already has a cache
+ var value = owner[ this.expando ];
+
+ // If not, create one
+ if ( !value ) {
+ value = {};
+
+ // We can accept data for non-element nodes in modern browsers,
+ // but we should not, see #8335.
+ // Always return an empty object.
+ if ( acceptData( owner ) ) {
+
+ // If it is a node unlikely to be stringify-ed or looped over
+ // use plain assignment
+ if ( owner.nodeType ) {
+ owner[ this.expando ] = value;
+
+ // Otherwise secure it in a non-enumerable property
+ // configurable must be true to allow the property to be
+ // deleted when data is removed
+ } else {
+ Object.defineProperty( owner, this.expando, {
+ value: value,
+ configurable: true
+ } );
+ }
+ }
+ }
+
+ return value;
+ },
+ set: function( owner, data, value ) {
+ var prop,
+ cache = this.cache( owner );
+
+ // Handle: [ owner, key, value ] args
+ // Always use camelCase key (gh-2257)
+ if ( typeof data === "string" ) {
+ cache[ camelCase( data ) ] = value;
+
+ // Handle: [ owner, { properties } ] args
+ } else {
+
+ // Copy the properties one-by-one to the cache object
+ for ( prop in data ) {
+ cache[ camelCase( prop ) ] = data[ prop ];
+ }
+ }
+ return cache;
+ },
+ get: function( owner, key ) {
+ return key === undefined ?
+ this.cache( owner ) :
+
+ // Always use camelCase key (gh-2257)
+ owner[ this.expando ] && owner[ this.expando ][ camelCase( key ) ];
+ },
+ access: function( owner, key, value ) {
+
+ // In cases where either:
+ //
+ // 1. No key was specified
+ // 2. A string key was specified, but no value provided
+ //
+ // Take the "read" path and allow the get method to determine
+ // which value to return, respectively either:
+ //
+ // 1. The entire cache object
+ // 2. The data stored at the key
+ //
+ if ( key === undefined ||
+ ( ( key && typeof key === "string" ) && value === undefined ) ) {
+
+ return this.get( owner, key );
+ }
+
+ // When the key is not a string, or both a key and value
+ // are specified, set or extend (existing objects) with either:
+ //
+ // 1. An object of properties
+ // 2. A key and value
+ //
+ this.set( owner, key, value );
+
+ // Since the "set" path can have two possible entry points
+ // return the expected data based on which path was taken[*]
+ return value !== undefined ? value : key;
+ },
+ remove: function( owner, key ) {
+ var i,
+ cache = owner[ this.expando ];
+
+ if ( cache === undefined ) {
+ return;
+ }
+
+ if ( key !== undefined ) {
+
+ // Support array or space separated string of keys
+ if ( Array.isArray( key ) ) {
+
+ // If key is an array of keys...
+ // We always set camelCase keys, so remove that.
+ key = key.map( camelCase );
+ } else {
+ key = camelCase( key );
+
+ // If a key with the spaces exists, use it.
+ // Otherwise, create an array by matching non-whitespace
+ key = key in cache ?
+ [ key ] :
+ ( key.match( rnothtmlwhite ) || [] );
+ }
+
+ i = key.length;
+
+ while ( i-- ) {
+ delete cache[ key[ i ] ];
+ }
+ }
+
+ // Remove the expando if there's no more data
+ if ( key === undefined || jQuery.isEmptyObject( cache ) ) {
+
+ // Support: Chrome <=35 - 45
+ // Webkit & Blink performance suffers when deleting properties
+ // from DOM nodes, so set to undefined instead
+ // https://bugs.chromium.org/p/chromium/issues/detail?id=378607 (bug restricted)
+ if ( owner.nodeType ) {
+ owner[ this.expando ] = undefined;
+ } else {
+ delete owner[ this.expando ];
+ }
+ }
+ },
+ hasData: function( owner ) {
+ var cache = owner[ this.expando ];
+ return cache !== undefined && !jQuery.isEmptyObject( cache );
+ }
+};
+var dataPriv = new Data();
+
+var dataUser = new Data();
+
+
+
+// Implementation Summary
+//
+// 1. Enforce API surface and semantic compatibility with 1.9.x branch
+// 2. Improve the module's maintainability by reducing the storage
+// paths to a single mechanism.
+// 3. Use the same single mechanism to support "private" and "user" data.
+// 4. _Never_ expose "private" data to user code (TODO: Drop _data, _removeData)
+// 5. Avoid exposing implementation details on user objects (eg. expando properties)
+// 6. Provide a clear path for implementation upgrade to WeakMap in 2014
+
+var rbrace = /^(?:\{[\w\W]*\}|\[[\w\W]*\])$/,
+ rmultiDash = /[A-Z]/g;
+
+function getData( data ) {
+ if ( data === "true" ) {
+ return true;
+ }
+
+ if ( data === "false" ) {
+ return false;
+ }
+
+ if ( data === "null" ) {
+ return null;
+ }
+
+ // Only convert to a number if it doesn't change the string
+ if ( data === +data + "" ) {
+ return +data;
+ }
+
+ if ( rbrace.test( data ) ) {
+ return JSON.parse( data );
+ }
+
+ return data;
+}
+
+function dataAttr( elem, key, data ) {
+ var name;
+
+ // If nothing was found internally, try to fetch any
+ // data from the HTML5 data-* attribute
+ if ( data === undefined && elem.nodeType === 1 ) {
+ name = "data-" + key.replace( rmultiDash, "-$&" ).toLowerCase();
+ data = elem.getAttribute( name );
+
+ if ( typeof data === "string" ) {
+ try {
+ data = getData( data );
+ } catch ( e ) {}
+
+ // Make sure we set the data so it isn't changed later
+ dataUser.set( elem, key, data );
+ } else {
+ data = undefined;
+ }
+ }
+ return data;
+}
+
+jQuery.extend( {
+ hasData: function( elem ) {
+ return dataUser.hasData( elem ) || dataPriv.hasData( elem );
+ },
+
+ data: function( elem, name, data ) {
+ return dataUser.access( elem, name, data );
+ },
+
+ removeData: function( elem, name ) {
+ dataUser.remove( elem, name );
+ },
+
+ // TODO: Now that all calls to _data and _removeData have been replaced
+ // with direct calls to dataPriv methods, these can be deprecated.
+ _data: function( elem, name, data ) {
+ return dataPriv.access( elem, name, data );
+ },
+
+ _removeData: function( elem, name ) {
+ dataPriv.remove( elem, name );
+ }
+} );
+
+jQuery.fn.extend( {
+ data: function( key, value ) {
+ var i, name, data,
+ elem = this[ 0 ],
+ attrs = elem && elem.attributes;
+
+ // Gets all values
+ if ( key === undefined ) {
+ if ( this.length ) {
+ data = dataUser.get( elem );
+
+ if ( elem.nodeType === 1 && !dataPriv.get( elem, "hasDataAttrs" ) ) {
+ i = attrs.length;
+ while ( i-- ) {
+
+ // Support: IE 11 only
+ // The attrs elements can be null (#14894)
+ if ( attrs[ i ] ) {
+ name = attrs[ i ].name;
+ if ( name.indexOf( "data-" ) === 0 ) {
+ name = camelCase( name.slice( 5 ) );
+ dataAttr( elem, name, data[ name ] );
+ }
+ }
+ }
+ dataPriv.set( elem, "hasDataAttrs", true );
+ }
+ }
+
+ return data;
+ }
+
+ // Sets multiple values
+ if ( typeof key === "object" ) {
+ return this.each( function() {
+ dataUser.set( this, key );
+ } );
+ }
+
+ return access( this, function( value ) {
+ var data;
+
+ // The calling jQuery object (element matches) is not empty
+ // (and therefore has an element appears at this[ 0 ]) and the
+ // `value` parameter was not undefined. An empty jQuery object
+ // will result in `undefined` for elem = this[ 0 ] which will
+ // throw an exception if an attempt to read a data cache is made.
+ if ( elem && value === undefined ) {
+
+ // Attempt to get data from the cache
+ // The key will always be camelCased in Data
+ data = dataUser.get( elem, key );
+ if ( data !== undefined ) {
+ return data;
+ }
+
+ // Attempt to "discover" the data in
+ // HTML5 custom data-* attrs
+ data = dataAttr( elem, key );
+ if ( data !== undefined ) {
+ return data;
+ }
+
+ // We tried really hard, but the data doesn't exist.
+ return;
+ }
+
+ // Set the data...
+ this.each( function() {
+
+ // We always store the camelCased key
+ dataUser.set( this, key, value );
+ } );
+ }, null, value, arguments.length > 1, null, true );
+ },
+
+ removeData: function( key ) {
+ return this.each( function() {
+ dataUser.remove( this, key );
+ } );
+ }
+} );
+
+
+jQuery.extend( {
+ queue: function( elem, type, data ) {
+ var queue;
+
+ if ( elem ) {
+ type = ( type || "fx" ) + "queue";
+ queue = dataPriv.get( elem, type );
+
+ // Speed up dequeue by getting out quickly if this is just a lookup
+ if ( data ) {
+ if ( !queue || Array.isArray( data ) ) {
+ queue = dataPriv.access( elem, type, jQuery.makeArray( data ) );
+ } else {
+ queue.push( data );
+ }
+ }
+ return queue || [];
+ }
+ },
+
+ dequeue: function( elem, type ) {
+ type = type || "fx";
+
+ var queue = jQuery.queue( elem, type ),
+ startLength = queue.length,
+ fn = queue.shift(),
+ hooks = jQuery._queueHooks( elem, type ),
+ next = function() {
+ jQuery.dequeue( elem, type );
+ };
+
+ // If the fx queue is dequeued, always remove the progress sentinel
+ if ( fn === "inprogress" ) {
+ fn = queue.shift();
+ startLength--;
+ }
+
+ if ( fn ) {
+
+ // Add a progress sentinel to prevent the fx queue from being
+ // automatically dequeued
+ if ( type === "fx" ) {
+ queue.unshift( "inprogress" );
+ }
+
+ // Clear up the last queue stop function
+ delete hooks.stop;
+ fn.call( elem, next, hooks );
+ }
+
+ if ( !startLength && hooks ) {
+ hooks.empty.fire();
+ }
+ },
+
+ // Not public - generate a queueHooks object, or return the current one
+ _queueHooks: function( elem, type ) {
+ var key = type + "queueHooks";
+ return dataPriv.get( elem, key ) || dataPriv.access( elem, key, {
+ empty: jQuery.Callbacks( "once memory" ).add( function() {
+ dataPriv.remove( elem, [ type + "queue", key ] );
+ } )
+ } );
+ }
+} );
+
+jQuery.fn.extend( {
+ queue: function( type, data ) {
+ var setter = 2;
+
+ if ( typeof type !== "string" ) {
+ data = type;
+ type = "fx";
+ setter--;
+ }
+
+ if ( arguments.length < setter ) {
+ return jQuery.queue( this[ 0 ], type );
+ }
+
+ return data === undefined ?
+ this :
+ this.each( function() {
+ var queue = jQuery.queue( this, type, data );
+
+ // Ensure a hooks for this queue
+ jQuery._queueHooks( this, type );
+
+ if ( type === "fx" && queue[ 0 ] !== "inprogress" ) {
+ jQuery.dequeue( this, type );
+ }
+ } );
+ },
+ dequeue: function( type ) {
+ return this.each( function() {
+ jQuery.dequeue( this, type );
+ } );
+ },
+ clearQueue: function( type ) {
+ return this.queue( type || "fx", [] );
+ },
+
+ // Get a promise resolved when queues of a certain type
+ // are emptied (fx is the type by default)
+ promise: function( type, obj ) {
+ var tmp,
+ count = 1,
+ defer = jQuery.Deferred(),
+ elements = this,
+ i = this.length,
+ resolve = function() {
+ if ( !( --count ) ) {
+ defer.resolveWith( elements, [ elements ] );
+ }
+ };
+
+ if ( typeof type !== "string" ) {
+ obj = type;
+ type = undefined;
+ }
+ type = type || "fx";
+
+ while ( i-- ) {
+ tmp = dataPriv.get( elements[ i ], type + "queueHooks" );
+ if ( tmp && tmp.empty ) {
+ count++;
+ tmp.empty.add( resolve );
+ }
+ }
+ resolve();
+ return defer.promise( obj );
+ }
+} );
+var pnum = ( /[+-]?(?:\d*\.|)\d+(?:[eE][+-]?\d+|)/ ).source;
+
+var rcssNum = new RegExp( "^(?:([+-])=|)(" + pnum + ")([a-z%]*)$", "i" );
+
+
+var cssExpand = [ "Top", "Right", "Bottom", "Left" ];
+
+var documentElement = document.documentElement;
+
+
+
+ var isAttached = function( elem ) {
+ return jQuery.contains( elem.ownerDocument, elem );
+ },
+ composed = { composed: true };
+
+ // Support: IE 9 - 11+, Edge 12 - 18+, iOS 10.0 - 10.2 only
+ // Check attachment across shadow DOM boundaries when possible (gh-3504)
+ // Support: iOS 10.0-10.2 only
+ // Early iOS 10 versions support `attachShadow` but not `getRootNode`,
+ // leading to errors. We need to check for `getRootNode`.
+ if ( documentElement.getRootNode ) {
+ isAttached = function( elem ) {
+ return jQuery.contains( elem.ownerDocument, elem ) ||
+ elem.getRootNode( composed ) === elem.ownerDocument;
+ };
+ }
+var isHiddenWithinTree = function( elem, el ) {
+
+ // isHiddenWithinTree might be called from jQuery#filter function;
+ // in that case, element will be second argument
+ elem = el || elem;
+
+ // Inline style trumps all
+ return elem.style.display === "none" ||
+ elem.style.display === "" &&
+
+ // Otherwise, check computed style
+ // Support: Firefox <=43 - 45
+ // Disconnected elements can have computed display: none, so first confirm that elem is
+ // in the document.
+ isAttached( elem ) &&
+
+ jQuery.css( elem, "display" ) === "none";
+ };
+
+
+
+function adjustCSS( elem, prop, valueParts, tween ) {
+ var adjusted, scale,
+ maxIterations = 20,
+ currentValue = tween ?
+ function() {
+ return tween.cur();
+ } :
+ function() {
+ return jQuery.css( elem, prop, "" );
+ },
+ initial = currentValue(),
+ unit = valueParts && valueParts[ 3 ] || ( jQuery.cssNumber[ prop ] ? "" : "px" ),
+
+ // Starting value computation is required for potential unit mismatches
+ initialInUnit = elem.nodeType &&
+ ( jQuery.cssNumber[ prop ] || unit !== "px" && +initial ) &&
+ rcssNum.exec( jQuery.css( elem, prop ) );
+
+ if ( initialInUnit && initialInUnit[ 3 ] !== unit ) {
+
+ // Support: Firefox <=54
+ // Halve the iteration target value to prevent interference from CSS upper bounds (gh-2144)
+ initial = initial / 2;
+
+ // Trust units reported by jQuery.css
+ unit = unit || initialInUnit[ 3 ];
+
+ // Iteratively approximate from a nonzero starting point
+ initialInUnit = +initial || 1;
+
+ while ( maxIterations-- ) {
+
+ // Evaluate and update our best guess (doubling guesses that zero out).
+ // Finish if the scale equals or crosses 1 (making the old*new product non-positive).
+ jQuery.style( elem, prop, initialInUnit + unit );
+ if ( ( 1 - scale ) * ( 1 - ( scale = currentValue() / initial || 0.5 ) ) <= 0 ) {
+ maxIterations = 0;
+ }
+ initialInUnit = initialInUnit / scale;
+
+ }
+
+ initialInUnit = initialInUnit * 2;
+ jQuery.style( elem, prop, initialInUnit + unit );
+
+ // Make sure we update the tween properties later on
+ valueParts = valueParts || [];
+ }
+
+ if ( valueParts ) {
+ initialInUnit = +initialInUnit || +initial || 0;
+
+ // Apply relative offset (+=/-=) if specified
+ adjusted = valueParts[ 1 ] ?
+ initialInUnit + ( valueParts[ 1 ] + 1 ) * valueParts[ 2 ] :
+ +valueParts[ 2 ];
+ if ( tween ) {
+ tween.unit = unit;
+ tween.start = initialInUnit;
+ tween.end = adjusted;
+ }
+ }
+ return adjusted;
+}
+
+
+var defaultDisplayMap = {};
+
+function getDefaultDisplay( elem ) {
+ var temp,
+ doc = elem.ownerDocument,
+ nodeName = elem.nodeName,
+ display = defaultDisplayMap[ nodeName ];
+
+ if ( display ) {
+ return display;
+ }
+
+ temp = doc.body.appendChild( doc.createElement( nodeName ) );
+ display = jQuery.css( temp, "display" );
+
+ temp.parentNode.removeChild( temp );
+
+ if ( display === "none" ) {
+ display = "block";
+ }
+ defaultDisplayMap[ nodeName ] = display;
+
+ return display;
+}
+
+function showHide( elements, show ) {
+ var display, elem,
+ values = [],
+ index = 0,
+ length = elements.length;
+
+ // Determine new display value for elements that need to change
+ for ( ; index < length; index++ ) {
+ elem = elements[ index ];
+ if ( !elem.style ) {
+ continue;
+ }
+
+ display = elem.style.display;
+ if ( show ) {
+
+ // Since we force visibility upon cascade-hidden elements, an immediate (and slow)
+ // check is required in this first loop unless we have a nonempty display value (either
+ // inline or about-to-be-restored)
+ if ( display === "none" ) {
+ values[ index ] = dataPriv.get( elem, "display" ) || null;
+ if ( !values[ index ] ) {
+ elem.style.display = "";
+ }
+ }
+ if ( elem.style.display === "" && isHiddenWithinTree( elem ) ) {
+ values[ index ] = getDefaultDisplay( elem );
+ }
+ } else {
+ if ( display !== "none" ) {
+ values[ index ] = "none";
+
+ // Remember what we're overwriting
+ dataPriv.set( elem, "display", display );
+ }
+ }
+ }
+
+ // Set the display of the elements in a second loop to avoid constant reflow
+ for ( index = 0; index < length; index++ ) {
+ if ( values[ index ] != null ) {
+ elements[ index ].style.display = values[ index ];
+ }
+ }
+
+ return elements;
+}
+
+jQuery.fn.extend( {
+ show: function() {
+ return showHide( this, true );
+ },
+ hide: function() {
+ return showHide( this );
+ },
+ toggle: function( state ) {
+ if ( typeof state === "boolean" ) {
+ return state ? this.show() : this.hide();
+ }
+
+ return this.each( function() {
+ if ( isHiddenWithinTree( this ) ) {
+ jQuery( this ).show();
+ } else {
+ jQuery( this ).hide();
+ }
+ } );
+ }
+} );
+var rcheckableType = ( /^(?:checkbox|radio)$/i );
+
+var rtagName = ( /<([a-z][^\/\0>\x20\t\r\n\f]*)/i );
+
+var rscriptType = ( /^$|^module$|\/(?:java|ecma)script/i );
+
+
+
+( function() {
+ var fragment = document.createDocumentFragment(),
+ div = fragment.appendChild( document.createElement( "div" ) ),
+ input = document.createElement( "input" );
+
+ // Support: Android 4.0 - 4.3 only
+ // Check state lost if the name is set (#11217)
+ // Support: Windows Web Apps (WWA)
+ // `name` and `type` must use .setAttribute for WWA (#14901)
+ input.setAttribute( "type", "radio" );
+ input.setAttribute( "checked", "checked" );
+ input.setAttribute( "name", "t" );
+
+ div.appendChild( input );
+
+ // Support: Android <=4.1 only
+ // Older WebKit doesn't clone checked state correctly in fragments
+ support.checkClone = div.cloneNode( true ).cloneNode( true ).lastChild.checked;
+
+ // Support: IE <=11 only
+ // Make sure textarea (and checkbox) defaultValue is properly cloned
+ div.innerHTML = "<textarea>x</textarea>";
+ support.noCloneChecked = !!div.cloneNode( true ).lastChild.defaultValue;
+
+ // Support: IE <=9 only
+ // IE <=9 replaces <option> tags with their contents when inserted outside of
+ // the select element.
+ div.innerHTML = "<option></option>";
+ support.option = !!div.lastChild;
+} )();
+
+
+// We have to close these tags to support XHTML (#13200)
+var wrapMap = {
+
+ // XHTML parsers do not magically insert elements in the
+ // same way that tag soup parsers do. So we cannot shorten
+ // this by omitting <tbody> or other required elements.
+ thead: [ 1, "<table>", "</table>" ],
+ col: [ 2, "<table><colgroup>", "</colgroup></table>" ],
+ tr: [ 2, "<table><tbody>", "</tbody></table>" ],
+ td: [ 3, "<table><tbody><tr>", "</tr></tbody></table>" ],
+
+ _default: [ 0, "", "" ]
+};
+
+wrapMap.tbody = wrapMap.tfoot = wrapMap.colgroup = wrapMap.caption = wrapMap.thead;
+wrapMap.th = wrapMap.td;
+
+// Support: IE <=9 only
+if ( !support.option ) {
+ wrapMap.optgroup = wrapMap.option = [ 1, "<select multiple='multiple'>", "</select>" ];
+}
+
+
+function getAll( context, tag ) {
+
+ // Support: IE <=9 - 11 only
+ // Use typeof to avoid zero-argument method invocation on host objects (#15151)
+ var ret;
+
+ if ( typeof context.getElementsByTagName !== "undefined" ) {
+ ret = context.getElementsByTagName( tag || "*" );
+
+ } else if ( typeof context.querySelectorAll !== "undefined" ) {
+ ret = context.querySelectorAll( tag || "*" );
+
+ } else {
+ ret = [];
+ }
+
+ if ( tag === undefined || tag && nodeName( context, tag ) ) {
+ return jQuery.merge( [ context ], ret );
+ }
+
+ return ret;
+}
+
+
+// Mark scripts as having already been evaluated
+function setGlobalEval( elems, refElements ) {
+ var i = 0,
+ l = elems.length;
+
+ for ( ; i < l; i++ ) {
+ dataPriv.set(
+ elems[ i ],
+ "globalEval",
+ !refElements || dataPriv.get( refElements[ i ], "globalEval" )
+ );
+ }
+}
+
+
+var rhtml = /<|&#?\w+;/;
+
+function buildFragment( elems, context, scripts, selection, ignored ) {
+ var elem, tmp, tag, wrap, attached, j,
+ fragment = context.createDocumentFragment(),
+ nodes = [],
+ i = 0,
+ l = elems.length;
+
+ for ( ; i < l; i++ ) {
+ elem = elems[ i ];
+
+ if ( elem || elem === 0 ) {
+
+ // Add nodes directly
+ if ( toType( elem ) === "object" ) {
+
+ // Support: Android <=4.0 only, PhantomJS 1 only
+ // push.apply(_, arraylike) throws on ancient WebKit
+ jQuery.merge( nodes, elem.nodeType ? [ elem ] : elem );
+
+ // Convert non-html into a text node
+ } else if ( !rhtml.test( elem ) ) {
+ nodes.push( context.createTextNode( elem ) );
+
+ // Convert html into DOM nodes
+ } else {
+ tmp = tmp || fragment.appendChild( context.createElement( "div" ) );
+
+ // Deserialize a standard representation
+ tag = ( rtagName.exec( elem ) || [ "", "" ] )[ 1 ].toLowerCase();
+ wrap = wrapMap[ tag ] || wrapMap._default;
+ tmp.innerHTML = wrap[ 1 ] + jQuery.htmlPrefilter( elem ) + wrap[ 2 ];
+
+ // Descend through wrappers to the right content
+ j = wrap[ 0 ];
+ while ( j-- ) {
+ tmp = tmp.lastChild;
+ }
+
+ // Support: Android <=4.0 only, PhantomJS 1 only
+ // push.apply(_, arraylike) throws on ancient WebKit
+ jQuery.merge( nodes, tmp.childNodes );
+
+ // Remember the top-level container
+ tmp = fragment.firstChild;
+
+ // Ensure the created nodes are orphaned (#12392)
+ tmp.textContent = "";
+ }
+ }
+ }
+
+ // Remove wrapper from fragment
+ fragment.textContent = "";
+
+ i = 0;
+ while ( ( elem = nodes[ i++ ] ) ) {
+
+ // Skip elements already in the context collection (trac-4087)
+ if ( selection && jQuery.inArray( elem, selection ) > -1 ) {
+ if ( ignored ) {
+ ignored.push( elem );
+ }
+ continue;
+ }
+
+ attached = isAttached( elem );
+
+ // Append to fragment
+ tmp = getAll( fragment.appendChild( elem ), "script" );
+
+ // Preserve script evaluation history
+ if ( attached ) {
+ setGlobalEval( tmp );
+ }
+
+ // Capture executables
+ if ( scripts ) {
+ j = 0;
+ while ( ( elem = tmp[ j++ ] ) ) {
+ if ( rscriptType.test( elem.type || "" ) ) {
+ scripts.push( elem );
+ }
+ }
+ }
+ }
+
+ return fragment;
+}
+
+
+var
+ rkeyEvent = /^key/,
+ rmouseEvent = /^(?:mouse|pointer|contextmenu|drag|drop)|click/,
+ rtypenamespace = /^([^.]*)(?:\.(.+)|)/;
+
+function returnTrue() {
+ return true;
+}
+
+function returnFalse() {
+ return false;
+}
+
+// Support: IE <=9 - 11+
+// focus() and blur() are asynchronous, except when they are no-op.
+// So expect focus to be synchronous when the element is already active,
+// and blur to be synchronous when the element is not already active.
+// (focus and blur are always synchronous in other supported browsers,
+// this just defines when we can count on it).
+function expectSync( elem, type ) {
+ return ( elem === safeActiveElement() ) === ( type === "focus" );
+}
+
+// Support: IE <=9 only
+// Accessing document.activeElement can throw unexpectedly
+// https://bugs.jquery.com/ticket/13393
+function safeActiveElement() {
+ try {
+ return document.activeElement;
+ } catch ( err ) { }
+}
+
+function on( elem, types, selector, data, fn, one ) {
+ var origFn, type;
+
+ // Types can be a map of types/handlers
+ if ( typeof types === "object" ) {
+
+ // ( types-Object, selector, data )
+ if ( typeof selector !== "string" ) {
+
+ // ( types-Object, data )
+ data = data || selector;
+ selector = undefined;
+ }
+ for ( type in types ) {
+ on( elem, type, selector, data, types[ type ], one );
+ }
+ return elem;
+ }
+
+ if ( data == null && fn == null ) {
+
+ // ( types, fn )
+ fn = selector;
+ data = selector = undefined;
+ } else if ( fn == null ) {
+ if ( typeof selector === "string" ) {
+
+ // ( types, selector, fn )
+ fn = data;
+ data = undefined;
+ } else {
+
+ // ( types, data, fn )
+ fn = data;
+ data = selector;
+ selector = undefined;
+ }
+ }
+ if ( fn === false ) {
+ fn = returnFalse;
+ } else if ( !fn ) {
+ return elem;
+ }
+
+ if ( one === 1 ) {
+ origFn = fn;
+ fn = function( event ) {
+
+ // Can use an empty set, since event contains the info
+ jQuery().off( event );
+ return origFn.apply( this, arguments );
+ };
+
+ // Use same guid so caller can remove using origFn
+ fn.guid = origFn.guid || ( origFn.guid = jQuery.guid++ );
+ }
+ return elem.each( function() {
+ jQuery.event.add( this, types, fn, data, selector );
+ } );
+}
+
+/*
+ * Helper functions for managing events -- not part of the public interface.
+ * Props to Dean Edwards' addEvent library for many of the ideas.
+ */
+jQuery.event = {
+
+ global: {},
+
+ add: function( elem, types, handler, data, selector ) {
+
+ var handleObjIn, eventHandle, tmp,
+ events, t, handleObj,
+ special, handlers, type, namespaces, origType,
+ elemData = dataPriv.get( elem );
+
+ // Only attach events to objects that accept data
+ if ( !acceptData( elem ) ) {
+ return;
+ }
+
+ // Caller can pass in an object of custom data in lieu of the handler
+ if ( handler.handler ) {
+ handleObjIn = handler;
+ handler = handleObjIn.handler;
+ selector = handleObjIn.selector;
+ }
+
+ // Ensure that invalid selectors throw exceptions at attach time
+ // Evaluate against documentElement in case elem is a non-element node (e.g., document)
+ if ( selector ) {
+ jQuery.find.matchesSelector( documentElement, selector );
+ }
+
+ // Make sure that the handler has a unique ID, used to find/remove it later
+ if ( !handler.guid ) {
+ handler.guid = jQuery.guid++;
+ }
+
+ // Init the element's event structure and main handler, if this is the first
+ if ( !( events = elemData.events ) ) {
+ events = elemData.events = Object.create( null );
+ }
+ if ( !( eventHandle = elemData.handle ) ) {
+ eventHandle = elemData.handle = function( e ) {
+
+ // Discard the second event of a jQuery.event.trigger() and
+ // when an event is called after a page has unloaded
+ return typeof jQuery !== "undefined" && jQuery.event.triggered !== e.type ?
+ jQuery.event.dispatch.apply( elem, arguments ) : undefined;
+ };
+ }
+
+ // Handle multiple events separated by a space
+ types = ( types || "" ).match( rnothtmlwhite ) || [ "" ];
+ t = types.length;
+ while ( t-- ) {
+ tmp = rtypenamespace.exec( types[ t ] ) || [];
+ type = origType = tmp[ 1 ];
+ namespaces = ( tmp[ 2 ] || "" ).split( "." ).sort();
+
+ // There *must* be a type, no attaching namespace-only handlers
+ if ( !type ) {
+ continue;
+ }
+
+ // If event changes its type, use the special event handlers for the changed type
+ special = jQuery.event.special[ type ] || {};
+
+ // If selector defined, determine special event api type, otherwise given type
+ type = ( selector ? special.delegateType : special.bindType ) || type;
+
+ // Update special based on newly reset type
+ special = jQuery.event.special[ type ] || {};
+
+ // handleObj is passed to all event handlers
+ handleObj = jQuery.extend( {
+ type: type,
+ origType: origType,
+ data: data,
+ handler: handler,
+ guid: handler.guid,
+ selector: selector,
+ needsContext: selector && jQuery.expr.match.needsContext.test( selector ),
+ namespace: namespaces.join( "." )
+ }, handleObjIn );
+
+ // Init the event handler queue if we're the first
+ if ( !( handlers = events[ type ] ) ) {
+ handlers = events[ type ] = [];
+ handlers.delegateCount = 0;
+
+ // Only use addEventListener if the special events handler returns false
+ if ( !special.setup ||
+ special.setup.call( elem, data, namespaces, eventHandle ) === false ) {
+
+ if ( elem.addEventListener ) {
+ elem.addEventListener( type, eventHandle );
+ }
+ }
+ }
+
+ if ( special.add ) {
+ special.add.call( elem, handleObj );
+
+ if ( !handleObj.handler.guid ) {
+ handleObj.handler.guid = handler.guid;
+ }
+ }
+
+ // Add to the element's handler list, delegates in front
+ if ( selector ) {
+ handlers.splice( handlers.delegateCount++, 0, handleObj );
+ } else {
+ handlers.push( handleObj );
+ }
+
+ // Keep track of which events have ever been used, for event optimization
+ jQuery.event.global[ type ] = true;
+ }
+
+ },
+
+ // Detach an event or set of events from an element
+ remove: function( elem, types, handler, selector, mappedTypes ) {
+
+ var j, origCount, tmp,
+ events, t, handleObj,
+ special, handlers, type, namespaces, origType,
+ elemData = dataPriv.hasData( elem ) && dataPriv.get( elem );
+
+ if ( !elemData || !( events = elemData.events ) ) {
+ return;
+ }
+
+ // Once for each type.namespace in types; type may be omitted
+ types = ( types || "" ).match( rnothtmlwhite ) || [ "" ];
+ t = types.length;
+ while ( t-- ) {
+ tmp = rtypenamespace.exec( types[ t ] ) || [];
+ type = origType = tmp[ 1 ];
+ namespaces = ( tmp[ 2 ] || "" ).split( "." ).sort();
+
+ // Unbind all events (on this namespace, if provided) for the element
+ if ( !type ) {
+ for ( type in events ) {
+ jQuery.event.remove( elem, type + types[ t ], handler, selector, true );
+ }
+ continue;
+ }
+
+ special = jQuery.event.special[ type ] || {};
+ type = ( selector ? special.delegateType : special.bindType ) || type;
+ handlers = events[ type ] || [];
+ tmp = tmp[ 2 ] &&
+ new RegExp( "(^|\\.)" + namespaces.join( "\\.(?:.*\\.|)" ) + "(\\.|$)" );
+
+ // Remove matching events
+ origCount = j = handlers.length;
+ while ( j-- ) {
+ handleObj = handlers[ j ];
+
+ if ( ( mappedTypes || origType === handleObj.origType ) &&
+ ( !handler || handler.guid === handleObj.guid ) &&
+ ( !tmp || tmp.test( handleObj.namespace ) ) &&
+ ( !selector || selector === handleObj.selector ||
+ selector === "**" && handleObj.selector ) ) {
+ handlers.splice( j, 1 );
+
+ if ( handleObj.selector ) {
+ handlers.delegateCount--;
+ }
+ if ( special.remove ) {
+ special.remove.call( elem, handleObj );
+ }
+ }
+ }
+
+ // Remove generic event handler if we removed something and no more handlers exist
+ // (avoids potential for endless recursion during removal of special event handlers)
+ if ( origCount && !handlers.length ) {
+ if ( !special.teardown ||
+ special.teardown.call( elem, namespaces, elemData.handle ) === false ) {
+
+ jQuery.removeEvent( elem, type, elemData.handle );
+ }
+
+ delete events[ type ];
+ }
+ }
+
+ // Remove data and the expando if it's no longer used
+ if ( jQuery.isEmptyObject( events ) ) {
+ dataPriv.remove( elem, "handle events" );
+ }
+ },
+
+ dispatch: function( nativeEvent ) {
+
+ var i, j, ret, matched, handleObj, handlerQueue,
+ args = new Array( arguments.length ),
+
+ // Make a writable jQuery.Event from the native event object
+ event = jQuery.event.fix( nativeEvent ),
+
+ handlers = (
+ dataPriv.get( this, "events" ) || Object.create( null )
+ )[ event.type ] || [],
+ special = jQuery.event.special[ event.type ] || {};
+
+ // Use the fix-ed jQuery.Event rather than the (read-only) native event
+ args[ 0 ] = event;
+
+ for ( i = 1; i < arguments.length; i++ ) {
+ args[ i ] = arguments[ i ];
+ }
+
+ event.delegateTarget = this;
+
+ // Call the preDispatch hook for the mapped type, and let it bail if desired
+ if ( special.preDispatch && special.preDispatch.call( this, event ) === false ) {
+ return;
+ }
+
+ // Determine handlers
+ handlerQueue = jQuery.event.handlers.call( this, event, handlers );
+
+ // Run delegates first; they may want to stop propagation beneath us
+ i = 0;
+ while ( ( matched = handlerQueue[ i++ ] ) && !event.isPropagationStopped() ) {
+ event.currentTarget = matched.elem;
+
+ j = 0;
+ while ( ( handleObj = matched.handlers[ j++ ] ) &&
+ !event.isImmediatePropagationStopped() ) {
+
+ // If the event is namespaced, then each handler is only invoked if it is
+ // specially universal or its namespaces are a superset of the event's.
+ if ( !event.rnamespace || handleObj.namespace === false ||
+ event.rnamespace.test( handleObj.namespace ) ) {
+
+ event.handleObj = handleObj;
+ event.data = handleObj.data;
+
+ ret = ( ( jQuery.event.special[ handleObj.origType ] || {} ).handle ||
+ handleObj.handler ).apply( matched.elem, args );
+
+ if ( ret !== undefined ) {
+ if ( ( event.result = ret ) === false ) {
+ event.preventDefault();
+ event.stopPropagation();
+ }
+ }
+ }
+ }
+ }
+
+ // Call the postDispatch hook for the mapped type
+ if ( special.postDispatch ) {
+ special.postDispatch.call( this, event );
+ }
+
+ return event.result;
+ },
+
+ handlers: function( event, handlers ) {
+ var i, handleObj, sel, matchedHandlers, matchedSelectors,
+ handlerQueue = [],
+ delegateCount = handlers.delegateCount,
+ cur = event.target;
+
+ // Find delegate handlers
+ if ( delegateCount &&
+
+ // Support: IE <=9
+ // Black-hole SVG <use> instance trees (trac-13180)
+ cur.nodeType &&
+
+ // Support: Firefox <=42
+ // Suppress spec-violating clicks indicating a non-primary pointer button (trac-3861)
+ // https://www.w3.org/TR/DOM-Level-3-Events/#event-type-click
+ // Support: IE 11 only
+ // ...but not arrow key "clicks" of radio inputs, which can have `button` -1 (gh-2343)
+ !( event.type === "click" && event.button >= 1 ) ) {
+
+ for ( ; cur !== this; cur = cur.parentNode || this ) {
+
+ // Don't check non-elements (#13208)
+ // Don't process clicks on disabled elements (#6911, #8165, #11382, #11764)
+ if ( cur.nodeType === 1 && !( event.type === "click" && cur.disabled === true ) ) {
+ matchedHandlers = [];
+ matchedSelectors = {};
+ for ( i = 0; i < delegateCount; i++ ) {
+ handleObj = handlers[ i ];
+
+ // Don't conflict with Object.prototype properties (#13203)
+ sel = handleObj.selector + " ";
+
+ if ( matchedSelectors[ sel ] === undefined ) {
+ matchedSelectors[ sel ] = handleObj.needsContext ?
+ jQuery( sel, this ).index( cur ) > -1 :
+ jQuery.find( sel, this, null, [ cur ] ).length;
+ }
+ if ( matchedSelectors[ sel ] ) {
+ matchedHandlers.push( handleObj );
+ }
+ }
+ if ( matchedHandlers.length ) {
+ handlerQueue.push( { elem: cur, handlers: matchedHandlers } );
+ }
+ }
+ }
+ }
+
+ // Add the remaining (directly-bound) handlers
+ cur = this;
+ if ( delegateCount < handlers.length ) {
+ handlerQueue.push( { elem: cur, handlers: handlers.slice( delegateCount ) } );
+ }
+
+ return handlerQueue;
+ },
+
+ addProp: function( name, hook ) {
+ Object.defineProperty( jQuery.Event.prototype, name, {
+ enumerable: true,
+ configurable: true,
+
+ get: isFunction( hook ) ?
+ function() {
+ if ( this.originalEvent ) {
+ return hook( this.originalEvent );
+ }
+ } :
+ function() {
+ if ( this.originalEvent ) {
+ return this.originalEvent[ name ];
+ }
+ },
+
+ set: function( value ) {
+ Object.defineProperty( this, name, {
+ enumerable: true,
+ configurable: true,
+ writable: true,
+ value: value
+ } );
+ }
+ } );
+ },
+
+ fix: function( originalEvent ) {
+ return originalEvent[ jQuery.expando ] ?
+ originalEvent :
+ new jQuery.Event( originalEvent );
+ },
+
+ special: {
+ load: {
+
+ // Prevent triggered image.load events from bubbling to window.load
+ noBubble: true
+ },
+ click: {
+
+ // Utilize native event to ensure correct state for checkable inputs
+ setup: function( data ) {
+
+ // For mutual compressibility with _default, replace `this` access with a local var.
+ // `|| data` is dead code meant only to preserve the variable through minification.
+ var el = this || data;
+
+ // Claim the first handler
+ if ( rcheckableType.test( el.type ) &&
+ el.click && nodeName( el, "input" ) ) {
+
+ // dataPriv.set( el, "click", ... )
+ leverageNative( el, "click", returnTrue );
+ }
+
+ // Return false to allow normal processing in the caller
+ return false;
+ },
+ trigger: function( data ) {
+
+ // For mutual compressibility with _default, replace `this` access with a local var.
+ // `|| data` is dead code meant only to preserve the variable through minification.
+ var el = this || data;
+
+ // Force setup before triggering a click
+ if ( rcheckableType.test( el.type ) &&
+ el.click && nodeName( el, "input" ) ) {
+
+ leverageNative( el, "click" );
+ }
+
+ // Return non-false to allow normal event-path propagation
+ return true;
+ },
+
+ // For cross-browser consistency, suppress native .click() on links
+ // Also prevent it if we're currently inside a leveraged native-event stack
+ _default: function( event ) {
+ var target = event.target;
+ return rcheckableType.test( target.type ) &&
+ target.click && nodeName( target, "input" ) &&
+ dataPriv.get( target, "click" ) ||
+ nodeName( target, "a" );
+ }
+ },
+
+ beforeunload: {
+ postDispatch: function( event ) {
+
+ // Support: Firefox 20+
+ // Firefox doesn't alert if the returnValue field is not set.
+ if ( event.result !== undefined && event.originalEvent ) {
+ event.originalEvent.returnValue = event.result;
+ }
+ }
+ }
+ }
+};
+
+// Ensure the presence of an event listener that handles manually-triggered
+// synthetic events by interrupting progress until reinvoked in response to
+// *native* events that it fires directly, ensuring that state changes have
+// already occurred before other listeners are invoked.
+function leverageNative( el, type, expectSync ) {
+
+ // Missing expectSync indicates a trigger call, which must force setup through jQuery.event.add
+ if ( !expectSync ) {
+ if ( dataPriv.get( el, type ) === undefined ) {
+ jQuery.event.add( el, type, returnTrue );
+ }
+ return;
+ }
+
+ // Register the controller as a special universal handler for all event namespaces
+ dataPriv.set( el, type, false );
+ jQuery.event.add( el, type, {
+ namespace: false,
+ handler: function( event ) {
+ var notAsync, result,
+ saved = dataPriv.get( this, type );
+
+ if ( ( event.isTrigger & 1 ) && this[ type ] ) {
+
+ // Interrupt processing of the outer synthetic .trigger()ed event
+ // Saved data should be false in such cases, but might be a leftover capture object
+ // from an async native handler (gh-4350)
+ if ( !saved.length ) {
+
+ // Store arguments for use when handling the inner native event
+ // There will always be at least one argument (an event object), so this array
+ // will not be confused with a leftover capture object.
+ saved = slice.call( arguments );
+ dataPriv.set( this, type, saved );
+
+ // Trigger the native event and capture its result
+ // Support: IE <=9 - 11+
+ // focus() and blur() are asynchronous
+ notAsync = expectSync( this, type );
+ this[ type ]();
+ result = dataPriv.get( this, type );
+ if ( saved !== result || notAsync ) {
+ dataPriv.set( this, type, false );
+ } else {
+ result = {};
+ }
+ if ( saved !== result ) {
+
+ // Cancel the outer synthetic event
+ event.stopImmediatePropagation();
+ event.preventDefault();
+ return result.value;
+ }
+
+ // If this is an inner synthetic event for an event with a bubbling surrogate
+ // (focus or blur), assume that the surrogate already propagated from triggering the
+ // native event and prevent that from happening again here.
+ // This technically gets the ordering wrong w.r.t. to `.trigger()` (in which the
+ // bubbling surrogate propagates *after* the non-bubbling base), but that seems
+ // less bad than duplication.
+ } else if ( ( jQuery.event.special[ type ] || {} ).delegateType ) {
+ event.stopPropagation();
+ }
+
+ // If this is a native event triggered above, everything is now in order
+ // Fire an inner synthetic event with the original arguments
+ } else if ( saved.length ) {
+
+ // ...and capture the result
+ dataPriv.set( this, type, {
+ value: jQuery.event.trigger(
+
+ // Support: IE <=9 - 11+
+ // Extend with the prototype to reset the above stopImmediatePropagation()
+ jQuery.extend( saved[ 0 ], jQuery.Event.prototype ),
+ saved.slice( 1 ),
+ this
+ )
+ } );
+
+ // Abort handling of the native event
+ event.stopImmediatePropagation();
+ }
+ }
+ } );
+}
+
+jQuery.removeEvent = function( elem, type, handle ) {
+
+ // This "if" is needed for plain objects
+ if ( elem.removeEventListener ) {
+ elem.removeEventListener( type, handle );
+ }
+};
+
+jQuery.Event = function( src, props ) {
+
+ // Allow instantiation without the 'new' keyword
+ if ( !( this instanceof jQuery.Event ) ) {
+ return new jQuery.Event( src, props );
+ }
+
+ // Event object
+ if ( src && src.type ) {
+ this.originalEvent = src;
+ this.type = src.type;
+
+ // Events bubbling up the document may have been marked as prevented
+ // by a handler lower down the tree; reflect the correct value.
+ this.isDefaultPrevented = src.defaultPrevented ||
+ src.defaultPrevented === undefined &&
+
+ // Support: Android <=2.3 only
+ src.returnValue === false ?
+ returnTrue :
+ returnFalse;
+
+ // Create target properties
+ // Support: Safari <=6 - 7 only
+ // Target should not be a text node (#504, #13143)
+ this.target = ( src.target && src.target.nodeType === 3 ) ?
+ src.target.parentNode :
+ src.target;
+
+ this.currentTarget = src.currentTarget;
+ this.relatedTarget = src.relatedTarget;
+
+ // Event type
+ } else {
+ this.type = src;
+ }
+
+ // Put explicitly provided properties onto the event object
+ if ( props ) {
+ jQuery.extend( this, props );
+ }
+
+ // Create a timestamp if incoming event doesn't have one
+ this.timeStamp = src && src.timeStamp || Date.now();
+
+ // Mark it as fixed
+ this[ jQuery.expando ] = true;
+};
+
+// jQuery.Event is based on DOM3 Events as specified by the ECMAScript Language Binding
+// https://www.w3.org/TR/2003/WD-DOM-Level-3-Events-20030331/ecma-script-binding.html
+jQuery.Event.prototype = {
+ constructor: jQuery.Event,
+ isDefaultPrevented: returnFalse,
+ isPropagationStopped: returnFalse,
+ isImmediatePropagationStopped: returnFalse,
+ isSimulated: false,
+
+ preventDefault: function() {
+ var e = this.originalEvent;
+
+ this.isDefaultPrevented = returnTrue;
+
+ if ( e && !this.isSimulated ) {
+ e.preventDefault();
+ }
+ },
+ stopPropagation: function() {
+ var e = this.originalEvent;
+
+ this.isPropagationStopped = returnTrue;
+
+ if ( e && !this.isSimulated ) {
+ e.stopPropagation();
+ }
+ },
+ stopImmediatePropagation: function() {
+ var e = this.originalEvent;
+
+ this.isImmediatePropagationStopped = returnTrue;
+
+ if ( e && !this.isSimulated ) {
+ e.stopImmediatePropagation();
+ }
+
+ this.stopPropagation();
+ }
+};
+
+// Includes all common event props including KeyEvent and MouseEvent specific props
+jQuery.each( {
+ altKey: true,
+ bubbles: true,
+ cancelable: true,
+ changedTouches: true,
+ ctrlKey: true,
+ detail: true,
+ eventPhase: true,
+ metaKey: true,
+ pageX: true,
+ pageY: true,
+ shiftKey: true,
+ view: true,
+ "char": true,
+ code: true,
+ charCode: true,
+ key: true,
+ keyCode: true,
+ button: true,
+ buttons: true,
+ clientX: true,
+ clientY: true,
+ offsetX: true,
+ offsetY: true,
+ pointerId: true,
+ pointerType: true,
+ screenX: true,
+ screenY: true,
+ targetTouches: true,
+ toElement: true,
+ touches: true,
+
+ which: function( event ) {
+ var button = event.button;
+
+ // Add which for key events
+ if ( event.which == null && rkeyEvent.test( event.type ) ) {
+ return event.charCode != null ? event.charCode : event.keyCode;
+ }
+
+ // Add which for click: 1 === left; 2 === middle; 3 === right
+ if ( !event.which && button !== undefined && rmouseEvent.test( event.type ) ) {
+ if ( button & 1 ) {
+ return 1;
+ }
+
+ if ( button & 2 ) {
+ return 3;
+ }
+
+ if ( button & 4 ) {
+ return 2;
+ }
+
+ return 0;
+ }
+
+ return event.which;
+ }
+}, jQuery.event.addProp );
+
+jQuery.each( { focus: "focusin", blur: "focusout" }, function( type, delegateType ) {
+ jQuery.event.special[ type ] = {
+
+ // Utilize native event if possible so blur/focus sequence is correct
+ setup: function() {
+
+ // Claim the first handler
+ // dataPriv.set( this, "focus", ... )
+ // dataPriv.set( this, "blur", ... )
+ leverageNative( this, type, expectSync );
+
+ // Return false to allow normal processing in the caller
+ return false;
+ },
+ trigger: function() {
+
+ // Force setup before trigger
+ leverageNative( this, type );
+
+ // Return non-false to allow normal event-path propagation
+ return true;
+ },
+
+ delegateType: delegateType
+ };
+} );
+
+// Create mouseenter/leave events using mouseover/out and event-time checks
+// so that event delegation works in jQuery.
+// Do the same for pointerenter/pointerleave and pointerover/pointerout
+//
+// Support: Safari 7 only
+// Safari sends mouseenter too often; see:
+// https://bugs.chromium.org/p/chromium/issues/detail?id=470258
+// for the description of the bug (it existed in older Chrome versions as well).
+jQuery.each( {
+ mouseenter: "mouseover",
+ mouseleave: "mouseout",
+ pointerenter: "pointerover",
+ pointerleave: "pointerout"
+}, function( orig, fix ) {
+ jQuery.event.special[ orig ] = {
+ delegateType: fix,
+ bindType: fix,
+
+ handle: function( event ) {
+ var ret,
+ target = this,
+ related = event.relatedTarget,
+ handleObj = event.handleObj;
+
+ // For mouseenter/leave call the handler if related is outside the target.
+ // NB: No relatedTarget if the mouse left/entered the browser window
+ if ( !related || ( related !== target && !jQuery.contains( target, related ) ) ) {
+ event.type = handleObj.origType;
+ ret = handleObj.handler.apply( this, arguments );
+ event.type = fix;
+ }
+ return ret;
+ }
+ };
+} );
+
+jQuery.fn.extend( {
+
+ on: function( types, selector, data, fn ) {
+ return on( this, types, selector, data, fn );
+ },
+ one: function( types, selector, data, fn ) {
+ return on( this, types, selector, data, fn, 1 );
+ },
+ off: function( types, selector, fn ) {
+ var handleObj, type;
+ if ( types && types.preventDefault && types.handleObj ) {
+
+ // ( event ) dispatched jQuery.Event
+ handleObj = types.handleObj;
+ jQuery( types.delegateTarget ).off(
+ handleObj.namespace ?
+ handleObj.origType + "." + handleObj.namespace :
+ handleObj.origType,
+ handleObj.selector,
+ handleObj.handler
+ );
+ return this;
+ }
+ if ( typeof types === "object" ) {
+
+ // ( types-object [, selector] )
+ for ( type in types ) {
+ this.off( type, selector, types[ type ] );
+ }
+ return this;
+ }
+ if ( selector === false || typeof selector === "function" ) {
+
+ // ( types [, fn] )
+ fn = selector;
+ selector = undefined;
+ }
+ if ( fn === false ) {
+ fn = returnFalse;
+ }
+ return this.each( function() {
+ jQuery.event.remove( this, types, fn, selector );
+ } );
+ }
+} );
+
+
+var
+
+ // Support: IE <=10 - 11, Edge 12 - 13 only
+ // In IE/Edge using regex groups here causes severe slowdowns.
+ // See https://connect.microsoft.com/IE/feedback/details/1736512/
+ rnoInnerhtml = /<script|<style|<link/i,
+
+ // checked="checked" or checked
+ rchecked = /checked\s*(?:[^=]|=\s*.checked.)/i,
+ rcleanScript = /^\s*<!(?:\[CDATA\[|--)|(?:\]\]|--)>\s*$/g;
+
+// Prefer a tbody over its parent table for containing new rows
+function manipulationTarget( elem, content ) {
+ if ( nodeName( elem, "table" ) &&
+ nodeName( content.nodeType !== 11 ? content : content.firstChild, "tr" ) ) {
+
+ return jQuery( elem ).children( "tbody" )[ 0 ] || elem;
+ }
+
+ return elem;
+}
+
+// Replace/restore the type attribute of script elements for safe DOM manipulation
+function disableScript( elem ) {
+ elem.type = ( elem.getAttribute( "type" ) !== null ) + "/" + elem.type;
+ return elem;
+}
+function restoreScript( elem ) {
+ if ( ( elem.type || "" ).slice( 0, 5 ) === "true/" ) {
+ elem.type = elem.type.slice( 5 );
+ } else {
+ elem.removeAttribute( "type" );
+ }
+
+ return elem;
+}
+
+function cloneCopyEvent( src, dest ) {
+ var i, l, type, pdataOld, udataOld, udataCur, events;
+
+ if ( dest.nodeType !== 1 ) {
+ return;
+ }
+
+ // 1. Copy private data: events, handlers, etc.
+ if ( dataPriv.hasData( src ) ) {
+ pdataOld = dataPriv.get( src );
+ events = pdataOld.events;
+
+ if ( events ) {
+ dataPriv.remove( dest, "handle events" );
+
+ for ( type in events ) {
+ for ( i = 0, l = events[ type ].length; i < l; i++ ) {
+ jQuery.event.add( dest, type, events[ type ][ i ] );
+ }
+ }
+ }
+ }
+
+ // 2. Copy user data
+ if ( dataUser.hasData( src ) ) {
+ udataOld = dataUser.access( src );
+ udataCur = jQuery.extend( {}, udataOld );
+
+ dataUser.set( dest, udataCur );
+ }
+}
+
+// Fix IE bugs, see support tests
+function fixInput( src, dest ) {
+ var nodeName = dest.nodeName.toLowerCase();
+
+ // Fails to persist the checked state of a cloned checkbox or radio button.
+ if ( nodeName === "input" && rcheckableType.test( src.type ) ) {
+ dest.checked = src.checked;
+
+ // Fails to return the selected option to the default selected state when cloning options
+ } else if ( nodeName === "input" || nodeName === "textarea" ) {
+ dest.defaultValue = src.defaultValue;
+ }
+}
+
+function domManip( collection, args, callback, ignored ) {
+
+ // Flatten any nested arrays
+ args = flat( args );
+
+ var fragment, first, scripts, hasScripts, node, doc,
+ i = 0,
+ l = collection.length,
+ iNoClone = l - 1,
+ value = args[ 0 ],
+ valueIsFunction = isFunction( value );
+
+ // We can't cloneNode fragments that contain checked, in WebKit
+ if ( valueIsFunction ||
+ ( l > 1 && typeof value === "string" &&
+ !support.checkClone && rchecked.test( value ) ) ) {
+ return collection.each( function( index ) {
+ var self = collection.eq( index );
+ if ( valueIsFunction ) {
+ args[ 0 ] = value.call( this, index, self.html() );
+ }
+ domManip( self, args, callback, ignored );
+ } );
+ }
+
+ if ( l ) {
+ fragment = buildFragment( args, collection[ 0 ].ownerDocument, false, collection, ignored );
+ first = fragment.firstChild;
+
+ if ( fragment.childNodes.length === 1 ) {
+ fragment = first;
+ }
+
+ // Require either new content or an interest in ignored elements to invoke the callback
+ if ( first || ignored ) {
+ scripts = jQuery.map( getAll( fragment, "script" ), disableScript );
+ hasScripts = scripts.length;
+
+ // Use the original fragment for the last item
+ // instead of the first because it can end up
+ // being emptied incorrectly in certain situations (#8070).
+ for ( ; i < l; i++ ) {
+ node = fragment;
+
+ if ( i !== iNoClone ) {
+ node = jQuery.clone( node, true, true );
+
+ // Keep references to cloned scripts for later restoration
+ if ( hasScripts ) {
+
+ // Support: Android <=4.0 only, PhantomJS 1 only
+ // push.apply(_, arraylike) throws on ancient WebKit
+ jQuery.merge( scripts, getAll( node, "script" ) );
+ }
+ }
+
+ callback.call( collection[ i ], node, i );
+ }
+
+ if ( hasScripts ) {
+ doc = scripts[ scripts.length - 1 ].ownerDocument;
+
+ // Reenable scripts
+ jQuery.map( scripts, restoreScript );
+
+ // Evaluate executable scripts on first document insertion
+ for ( i = 0; i < hasScripts; i++ ) {
+ node = scripts[ i ];
+ if ( rscriptType.test( node.type || "" ) &&
+ !dataPriv.access( node, "globalEval" ) &&
+ jQuery.contains( doc, node ) ) {
+
+ if ( node.src && ( node.type || "" ).toLowerCase() !== "module" ) {
+
+ // Optional AJAX dependency, but won't run scripts if not present
+ if ( jQuery._evalUrl && !node.noModule ) {
+ jQuery._evalUrl( node.src, {
+ nonce: node.nonce || node.getAttribute( "nonce" )
+ }, doc );
+ }
+ } else {
+ DOMEval( node.textContent.replace( rcleanScript, "" ), node, doc );
+ }
+ }
+ }
+ }
+ }
+ }
+
+ return collection;
+}
+
+function remove( elem, selector, keepData ) {
+ var node,
+ nodes = selector ? jQuery.filter( selector, elem ) : elem,
+ i = 0;
+
+ for ( ; ( node = nodes[ i ] ) != null; i++ ) {
+ if ( !keepData && node.nodeType === 1 ) {
+ jQuery.cleanData( getAll( node ) );
+ }
+
+ if ( node.parentNode ) {
+ if ( keepData && isAttached( node ) ) {
+ setGlobalEval( getAll( node, "script" ) );
+ }
+ node.parentNode.removeChild( node );
+ }
+ }
+
+ return elem;
+}
+
+jQuery.extend( {
+ htmlPrefilter: function( html ) {
+ return html;
+ },
+
+ clone: function( elem, dataAndEvents, deepDataAndEvents ) {
+ var i, l, srcElements, destElements,
+ clone = elem.cloneNode( true ),
+ inPage = isAttached( elem );
+
+ // Fix IE cloning issues
+ if ( !support.noCloneChecked && ( elem.nodeType === 1 || elem.nodeType === 11 ) &&
+ !jQuery.isXMLDoc( elem ) ) {
+
+ // We eschew Sizzle here for performance reasons: https://jsperf.com/getall-vs-sizzle/2
+ destElements = getAll( clone );
+ srcElements = getAll( elem );
+
+ for ( i = 0, l = srcElements.length; i < l; i++ ) {
+ fixInput( srcElements[ i ], destElements[ i ] );
+ }
+ }
+
+ // Copy the events from the original to the clone
+ if ( dataAndEvents ) {
+ if ( deepDataAndEvents ) {
+ srcElements = srcElements || getAll( elem );
+ destElements = destElements || getAll( clone );
+
+ for ( i = 0, l = srcElements.length; i < l; i++ ) {
+ cloneCopyEvent( srcElements[ i ], destElements[ i ] );
+ }
+ } else {
+ cloneCopyEvent( elem, clone );
+ }
+ }
+
+ // Preserve script evaluation history
+ destElements = getAll( clone, "script" );
+ if ( destElements.length > 0 ) {
+ setGlobalEval( destElements, !inPage && getAll( elem, "script" ) );
+ }
+
+ // Return the cloned set
+ return clone;
+ },
+
+ cleanData: function( elems ) {
+ var data, elem, type,
+ special = jQuery.event.special,
+ i = 0;
+
+ for ( ; ( elem = elems[ i ] ) !== undefined; i++ ) {
+ if ( acceptData( elem ) ) {
+ if ( ( data = elem[ dataPriv.expando ] ) ) {
+ if ( data.events ) {
+ for ( type in data.events ) {
+ if ( special[ type ] ) {
+ jQuery.event.remove( elem, type );
+
+ // This is a shortcut to avoid jQuery.event.remove's overhead
+ } else {
+ jQuery.removeEvent( elem, type, data.handle );
+ }
+ }
+ }
+
+ // Support: Chrome <=35 - 45+
+ // Assign undefined instead of using delete, see Data#remove
+ elem[ dataPriv.expando ] = undefined;
+ }
+ if ( elem[ dataUser.expando ] ) {
+
+ // Support: Chrome <=35 - 45+
+ // Assign undefined instead of using delete, see Data#remove
+ elem[ dataUser.expando ] = undefined;
+ }
+ }
+ }
+ }
+} );
+
+jQuery.fn.extend( {
+ detach: function( selector ) {
+ return remove( this, selector, true );
+ },
+
+ remove: function( selector ) {
+ return remove( this, selector );
+ },
+
+ text: function( value ) {
+ return access( this, function( value ) {
+ return value === undefined ?
+ jQuery.text( this ) :
+ this.empty().each( function() {
+ if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) {
+ this.textContent = value;
+ }
+ } );
+ }, null, value, arguments.length );
+ },
+
+ append: function() {
+ return domManip( this, arguments, function( elem ) {
+ if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) {
+ var target = manipulationTarget( this, elem );
+ target.appendChild( elem );
+ }
+ } );
+ },
+
+ prepend: function() {
+ return domManip( this, arguments, function( elem ) {
+ if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) {
+ var target = manipulationTarget( this, elem );
+ target.insertBefore( elem, target.firstChild );
+ }
+ } );
+ },
+
+ before: function() {
+ return domManip( this, arguments, function( elem ) {
+ if ( this.parentNode ) {
+ this.parentNode.insertBefore( elem, this );
+ }
+ } );
+ },
+
+ after: function() {
+ return domManip( this, arguments, function( elem ) {
+ if ( this.parentNode ) {
+ this.parentNode.insertBefore( elem, this.nextSibling );
+ }
+ } );
+ },
+
+ empty: function() {
+ var elem,
+ i = 0;
+
+ for ( ; ( elem = this[ i ] ) != null; i++ ) {
+ if ( elem.nodeType === 1 ) {
+
+ // Prevent memory leaks
+ jQuery.cleanData( getAll( elem, false ) );
+
+ // Remove any remaining nodes
+ elem.textContent = "";
+ }
+ }
+
+ return this;
+ },
+
+ clone: function( dataAndEvents, deepDataAndEvents ) {
+ dataAndEvents = dataAndEvents == null ? false : dataAndEvents;
+ deepDataAndEvents = deepDataAndEvents == null ? dataAndEvents : deepDataAndEvents;
+
+ return this.map( function() {
+ return jQuery.clone( this, dataAndEvents, deepDataAndEvents );
+ } );
+ },
+
+ html: function( value ) {
+ return access( this, function( value ) {
+ var elem = this[ 0 ] || {},
+ i = 0,
+ l = this.length;
+
+ if ( value === undefined && elem.nodeType === 1 ) {
+ return elem.innerHTML;
+ }
+
+ // See if we can take a shortcut and just use innerHTML
+ if ( typeof value === "string" && !rnoInnerhtml.test( value ) &&
+ !wrapMap[ ( rtagName.exec( value ) || [ "", "" ] )[ 1 ].toLowerCase() ] ) {
+
+ value = jQuery.htmlPrefilter( value );
+
+ try {
+ for ( ; i < l; i++ ) {
+ elem = this[ i ] || {};
+
+ // Remove element nodes and prevent memory leaks
+ if ( elem.nodeType === 1 ) {
+ jQuery.cleanData( getAll( elem, false ) );
+ elem.innerHTML = value;
+ }
+ }
+
+ elem = 0;
+
+ // If using innerHTML throws an exception, use the fallback method
+ } catch ( e ) {}
+ }
+
+ if ( elem ) {
+ this.empty().append( value );
+ }
+ }, null, value, arguments.length );
+ },
+
+ replaceWith: function() {
+ var ignored = [];
+
+ // Make the changes, replacing each non-ignored context element with the new content
+ return domManip( this, arguments, function( elem ) {
+ var parent = this.parentNode;
+
+ if ( jQuery.inArray( this, ignored ) < 0 ) {
+ jQuery.cleanData( getAll( this ) );
+ if ( parent ) {
+ parent.replaceChild( elem, this );
+ }
+ }
+
+ // Force callback invocation
+ }, ignored );
+ }
+} );
+
+jQuery.each( {
+ appendTo: "append",
+ prependTo: "prepend",
+ insertBefore: "before",
+ insertAfter: "after",
+ replaceAll: "replaceWith"
+}, function( name, original ) {
+ jQuery.fn[ name ] = function( selector ) {
+ var elems,
+ ret = [],
+ insert = jQuery( selector ),
+ last = insert.length - 1,
+ i = 0;
+
+ for ( ; i <= last; i++ ) {
+ elems = i === last ? this : this.clone( true );
+ jQuery( insert[ i ] )[ original ]( elems );
+
+ // Support: Android <=4.0 only, PhantomJS 1 only
+ // .get() because push.apply(_, arraylike) throws on ancient WebKit
+ push.apply( ret, elems.get() );
+ }
+
+ return this.pushStack( ret );
+ };
+} );
+var rnumnonpx = new RegExp( "^(" + pnum + ")(?!px)[a-z%]+$", "i" );
+
+var getStyles = function( elem ) {
+
+ // Support: IE <=11 only, Firefox <=30 (#15098, #14150)
+ // IE throws on elements created in popups
+ // FF meanwhile throws on frame elements through "defaultView.getComputedStyle"
+ var view = elem.ownerDocument.defaultView;
+
+ if ( !view || !view.opener ) {
+ view = window;
+ }
+
+ return view.getComputedStyle( elem );
+ };
+
+var swap = function( elem, options, callback ) {
+ var ret, name,
+ old = {};
+
+ // Remember the old values, and insert the new ones
+ for ( name in options ) {
+ old[ name ] = elem.style[ name ];
+ elem.style[ name ] = options[ name ];
+ }
+
+ ret = callback.call( elem );
+
+ // Revert the old values
+ for ( name in options ) {
+ elem.style[ name ] = old[ name ];
+ }
+
+ return ret;
+};
+
+
+var rboxStyle = new RegExp( cssExpand.join( "|" ), "i" );
+
+
+
+( function() {
+
+ // Executing both pixelPosition & boxSizingReliable tests require only one layout
+ // so they're executed at the same time to save the second computation.
+ function computeStyleTests() {
+
+ // This is a singleton, we need to execute it only once
+ if ( !div ) {
+ return;
+ }
+
+ container.style.cssText = "position:absolute;left:-11111px;width:60px;" +
+ "margin-top:1px;padding:0;border:0";
+ div.style.cssText =
+ "position:relative;display:block;box-sizing:border-box;overflow:scroll;" +
+ "margin:auto;border:1px;padding:1px;" +
+ "width:60%;top:1%";
+ documentElement.appendChild( container ).appendChild( div );
+
+ var divStyle = window.getComputedStyle( div );
+ pixelPositionVal = divStyle.top !== "1%";
+
+ // Support: Android 4.0 - 4.3 only, Firefox <=3 - 44
+ reliableMarginLeftVal = roundPixelMeasures( divStyle.marginLeft ) === 12;
+
+ // Support: Android 4.0 - 4.3 only, Safari <=9.1 - 10.1, iOS <=7.0 - 9.3
+ // Some styles come back with percentage values, even though they shouldn't
+ div.style.right = "60%";
+ pixelBoxStylesVal = roundPixelMeasures( divStyle.right ) === 36;
+
+ // Support: IE 9 - 11 only
+ // Detect misreporting of content dimensions for box-sizing:border-box elements
+ boxSizingReliableVal = roundPixelMeasures( divStyle.width ) === 36;
+
+ // Support: IE 9 only
+ // Detect overflow:scroll screwiness (gh-3699)
+ // Support: Chrome <=64
+ // Don't get tricked when zoom affects offsetWidth (gh-4029)
+ div.style.position = "absolute";
+ scrollboxSizeVal = roundPixelMeasures( div.offsetWidth / 3 ) === 12;
+
+ documentElement.removeChild( container );
+
+ // Nullify the div so it wouldn't be stored in the memory and
+ // it will also be a sign that checks already performed
+ div = null;
+ }
+
+ function roundPixelMeasures( measure ) {
+ return Math.round( parseFloat( measure ) );
+ }
+
+ var pixelPositionVal, boxSizingReliableVal, scrollboxSizeVal, pixelBoxStylesVal,
+ reliableTrDimensionsVal, reliableMarginLeftVal,
+ container = document.createElement( "div" ),
+ div = document.createElement( "div" );
+
+ // Finish early in limited (non-browser) environments
+ if ( !div.style ) {
+ return;
+ }
+
+ // Support: IE <=9 - 11 only
+ // Style of cloned element affects source element cloned (#8908)
+ div.style.backgroundClip = "content-box";
+ div.cloneNode( true ).style.backgroundClip = "";
+ support.clearCloneStyle = div.style.backgroundClip === "content-box";
+
+ jQuery.extend( support, {
+ boxSizingReliable: function() {
+ computeStyleTests();
+ return boxSizingReliableVal;
+ },
+ pixelBoxStyles: function() {
+ computeStyleTests();
+ return pixelBoxStylesVal;
+ },
+ pixelPosition: function() {
+ computeStyleTests();
+ return pixelPositionVal;
+ },
+ reliableMarginLeft: function() {
+ computeStyleTests();
+ return reliableMarginLeftVal;
+ },
+ scrollboxSize: function() {
+ computeStyleTests();
+ return scrollboxSizeVal;
+ },
+
+ // Support: IE 9 - 11+, Edge 15 - 18+
+ // IE/Edge misreport `getComputedStyle` of table rows with width/height
+ // set in CSS while `offset*` properties report correct values.
+ // Behavior in IE 9 is more subtle than in newer versions & it passes
+ // some versions of this test; make sure not to make it pass there!
+ reliableTrDimensions: function() {
+ var table, tr, trChild, trStyle;
+ if ( reliableTrDimensionsVal == null ) {
+ table = document.createElement( "table" );
+ tr = document.createElement( "tr" );
+ trChild = document.createElement( "div" );
+
+ table.style.cssText = "position:absolute;left:-11111px";
+ tr.style.height = "1px";
+ trChild.style.height = "9px";
+
+ documentElement
+ .appendChild( table )
+ .appendChild( tr )
+ .appendChild( trChild );
+
+ trStyle = window.getComputedStyle( tr );
+ reliableTrDimensionsVal = parseInt( trStyle.height ) > 3;
+
+ documentElement.removeChild( table );
+ }
+ return reliableTrDimensionsVal;
+ }
+ } );
+} )();
+
+
+function curCSS( elem, name, computed ) {
+ var width, minWidth, maxWidth, ret,
+
+ // Support: Firefox 51+
+ // Retrieving style before computed somehow
+ // fixes an issue with getting wrong values
+ // on detached elements
+ style = elem.style;
+
+ computed = computed || getStyles( elem );
+
+ // getPropertyValue is needed for:
+ // .css('filter') (IE 9 only, #12537)
+ // .css('--customProperty) (#3144)
+ if ( computed ) {
+ ret = computed.getPropertyValue( name ) || computed[ name ];
+
+ if ( ret === "" && !isAttached( elem ) ) {
+ ret = jQuery.style( elem, name );
+ }
+
+ // A tribute to the "awesome hack by Dean Edwards"
+ // Android Browser returns percentage for some values,
+ // but width seems to be reliably pixels.
+ // This is against the CSSOM draft spec:
+ // https://drafts.csswg.org/cssom/#resolved-values
+ if ( !support.pixelBoxStyles() && rnumnonpx.test( ret ) && rboxStyle.test( name ) ) {
+
+ // Remember the original values
+ width = style.width;
+ minWidth = style.minWidth;
+ maxWidth = style.maxWidth;
+
+ // Put in the new values to get a computed value out
+ style.minWidth = style.maxWidth = style.width = ret;
+ ret = computed.width;
+
+ // Revert the changed values
+ style.width = width;
+ style.minWidth = minWidth;
+ style.maxWidth = maxWidth;
+ }
+ }
+
+ return ret !== undefined ?
+
+ // Support: IE <=9 - 11 only
+ // IE returns zIndex value as an integer.
+ ret + "" :
+ ret;
+}
+
+
+function addGetHookIf( conditionFn, hookFn ) {
+
+ // Define the hook, we'll check on the first run if it's really needed.
+ return {
+ get: function() {
+ if ( conditionFn() ) {
+
+ // Hook not needed (or it's not possible to use it due
+ // to missing dependency), remove it.
+ delete this.get;
+ return;
+ }
+
+ // Hook needed; redefine it so that the support test is not executed again.
+ return ( this.get = hookFn ).apply( this, arguments );
+ }
+ };
+}
+
+
+var cssPrefixes = [ "Webkit", "Moz", "ms" ],
+ emptyStyle = document.createElement( "div" ).style,
+ vendorProps = {};
+
+// Return a vendor-prefixed property or undefined
+function vendorPropName( name ) {
+
+ // Check for vendor prefixed names
+ var capName = name[ 0 ].toUpperCase() + name.slice( 1 ),
+ i = cssPrefixes.length;
+
+ while ( i-- ) {
+ name = cssPrefixes[ i ] + capName;
+ if ( name in emptyStyle ) {
+ return name;
+ }
+ }
+}
+
+// Return a potentially-mapped jQuery.cssProps or vendor prefixed property
+function finalPropName( name ) {
+ var final = jQuery.cssProps[ name ] || vendorProps[ name ];
+
+ if ( final ) {
+ return final;
+ }
+ if ( name in emptyStyle ) {
+ return name;
+ }
+ return vendorProps[ name ] = vendorPropName( name ) || name;
+}
+
+
+var
+
+ // Swappable if display is none or starts with table
+ // except "table", "table-cell", or "table-caption"
+ // See here for display values: https://developer.mozilla.org/en-US/docs/CSS/display
+ rdisplayswap = /^(none|table(?!-c[ea]).+)/,
+ rcustomProp = /^--/,
+ cssShow = { position: "absolute", visibility: "hidden", display: "block" },
+ cssNormalTransform = {
+ letterSpacing: "0",
+ fontWeight: "400"
+ };
+
+function setPositiveNumber( _elem, value, subtract ) {
+
+ // Any relative (+/-) values have already been
+ // normalized at this point
+ var matches = rcssNum.exec( value );
+ return matches ?
+
+ // Guard against undefined "subtract", e.g., when used as in cssHooks
+ Math.max( 0, matches[ 2 ] - ( subtract || 0 ) ) + ( matches[ 3 ] || "px" ) :
+ value;
+}
+
+function boxModelAdjustment( elem, dimension, box, isBorderBox, styles, computedVal ) {
+ var i = dimension === "width" ? 1 : 0,
+ extra = 0,
+ delta = 0;
+
+ // Adjustment may not be necessary
+ if ( box === ( isBorderBox ? "border" : "content" ) ) {
+ return 0;
+ }
+
+ for ( ; i < 4; i += 2 ) {
+
+ // Both box models exclude margin
+ if ( box === "margin" ) {
+ delta += jQuery.css( elem, box + cssExpand[ i ], true, styles );
+ }
+
+ // If we get here with a content-box, we're seeking "padding" or "border" or "margin"
+ if ( !isBorderBox ) {
+
+ // Add padding
+ delta += jQuery.css( elem, "padding" + cssExpand[ i ], true, styles );
+
+ // For "border" or "margin", add border
+ if ( box !== "padding" ) {
+ delta += jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles );
+
+ // But still keep track of it otherwise
+ } else {
+ extra += jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles );
+ }
+
+ // If we get here with a border-box (content + padding + border), we're seeking "content" or
+ // "padding" or "margin"
+ } else {
+
+ // For "content", subtract padding
+ if ( box === "content" ) {
+ delta -= jQuery.css( elem, "padding" + cssExpand[ i ], true, styles );
+ }
+
+ // For "content" or "padding", subtract border
+ if ( box !== "margin" ) {
+ delta -= jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles );
+ }
+ }
+ }
+
+ // Account for positive content-box scroll gutter when requested by providing computedVal
+ if ( !isBorderBox && computedVal >= 0 ) {
+
+ // offsetWidth/offsetHeight is a rounded sum of content, padding, scroll gutter, and border
+ // Assuming integer scroll gutter, subtract the rest and round down
+ delta += Math.max( 0, Math.ceil(
+ elem[ "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ) ] -
+ computedVal -
+ delta -
+ extra -
+ 0.5
+
+ // If offsetWidth/offsetHeight is unknown, then we can't determine content-box scroll gutter
+ // Use an explicit zero to avoid NaN (gh-3964)
+ ) ) || 0;
+ }
+
+ return delta;
+}
+
+function getWidthOrHeight( elem, dimension, extra ) {
+
+ // Start with computed style
+ var styles = getStyles( elem ),
+
+ // To avoid forcing a reflow, only fetch boxSizing if we need it (gh-4322).
+ // Fake content-box until we know it's needed to know the true value.
+ boxSizingNeeded = !support.boxSizingReliable() || extra,
+ isBorderBox = boxSizingNeeded &&
+ jQuery.css( elem, "boxSizing", false, styles ) === "border-box",
+ valueIsBorderBox = isBorderBox,
+
+ val = curCSS( elem, dimension, styles ),
+ offsetProp = "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 );
+
+ // Support: Firefox <=54
+ // Return a confounding non-pixel value or feign ignorance, as appropriate.
+ if ( rnumnonpx.test( val ) ) {
+ if ( !extra ) {
+ return val;
+ }
+ val = "auto";
+ }
+
+
+ // Support: IE 9 - 11 only
+ // Use offsetWidth/offsetHeight for when box sizing is unreliable.
+ // In those cases, the computed value can be trusted to be border-box.
+ if ( ( !support.boxSizingReliable() && isBorderBox ||
+
+ // Support: IE 10 - 11+, Edge 15 - 18+
+ // IE/Edge misreport `getComputedStyle` of table rows with width/height
+ // set in CSS while `offset*` properties report correct values.
+ // Interestingly, in some cases IE 9 doesn't suffer from this issue.
+ !support.reliableTrDimensions() && nodeName( elem, "tr" ) ||
+
+ // Fall back to offsetWidth/offsetHeight when value is "auto"
+ // This happens for inline elements with no explicit setting (gh-3571)
+ val === "auto" ||
+
+ // Support: Android <=4.1 - 4.3 only
+ // Also use offsetWidth/offsetHeight for misreported inline dimensions (gh-3602)
+ !parseFloat( val ) && jQuery.css( elem, "display", false, styles ) === "inline" ) &&
+
+ // Make sure the element is visible & connected
+ elem.getClientRects().length ) {
+
+ isBorderBox = jQuery.css( elem, "boxSizing", false, styles ) === "border-box";
+
+ // Where available, offsetWidth/offsetHeight approximate border box dimensions.
+ // Where not available (e.g., SVG), assume unreliable box-sizing and interpret the
+ // retrieved value as a content box dimension.
+ valueIsBorderBox = offsetProp in elem;
+ if ( valueIsBorderBox ) {
+ val = elem[ offsetProp ];
+ }
+ }
+
+ // Normalize "" and auto
+ val = parseFloat( val ) || 0;
+
+ // Adjust for the element's box model
+ return ( val +
+ boxModelAdjustment(
+ elem,
+ dimension,
+ extra || ( isBorderBox ? "border" : "content" ),
+ valueIsBorderBox,
+ styles,
+
+ // Provide the current computed size to request scroll gutter calculation (gh-3589)
+ val
+ )
+ ) + "px";
+}
+
+jQuery.extend( {
+
+ // Add in style property hooks for overriding the default
+ // behavior of getting and setting a style property
+ cssHooks: {
+ opacity: {
+ get: function( elem, computed ) {
+ if ( computed ) {
+
+ // We should always get a number back from opacity
+ var ret = curCSS( elem, "opacity" );
+ return ret === "" ? "1" : ret;
+ }
+ }
+ }
+ },
+
+ // Don't automatically add "px" to these possibly-unitless properties
+ cssNumber: {
+ "animationIterationCount": true,
+ "columnCount": true,
+ "fillOpacity": true,
+ "flexGrow": true,
+ "flexShrink": true,
+ "fontWeight": true,
+ "gridArea": true,
+ "gridColumn": true,
+ "gridColumnEnd": true,
+ "gridColumnStart": true,
+ "gridRow": true,
+ "gridRowEnd": true,
+ "gridRowStart": true,
+ "lineHeight": true,
+ "opacity": true,
+ "order": true,
+ "orphans": true,
+ "widows": true,
+ "zIndex": true,
+ "zoom": true
+ },
+
+ // Add in properties whose names you wish to fix before
+ // setting or getting the value
+ cssProps: {},
+
+ // Get and set the style property on a DOM Node
+ style: function( elem, name, value, extra ) {
+
+ // Don't set styles on text and comment nodes
+ if ( !elem || elem.nodeType === 3 || elem.nodeType === 8 || !elem.style ) {
+ return;
+ }
+
+ // Make sure that we're working with the right name
+ var ret, type, hooks,
+ origName = camelCase( name ),
+ isCustomProp = rcustomProp.test( name ),
+ style = elem.style;
+
+ // Make sure that we're working with the right name. We don't
+ // want to query the value if it is a CSS custom property
+ // since they are user-defined.
+ if ( !isCustomProp ) {
+ name = finalPropName( origName );
+ }
+
+ // Gets hook for the prefixed version, then unprefixed version
+ hooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ];
+
+ // Check if we're setting a value
+ if ( value !== undefined ) {
+ type = typeof value;
+
+ // Convert "+=" or "-=" to relative numbers (#7345)
+ if ( type === "string" && ( ret = rcssNum.exec( value ) ) && ret[ 1 ] ) {
+ value = adjustCSS( elem, name, ret );
+
+ // Fixes bug #9237
+ type = "number";
+ }
+
+ // Make sure that null and NaN values aren't set (#7116)
+ if ( value == null || value !== value ) {
+ return;
+ }
+
+ // If a number was passed in, add the unit (except for certain CSS properties)
+ // The isCustomProp check can be removed in jQuery 4.0 when we only auto-append
+ // "px" to a few hardcoded values.
+ if ( type === "number" && !isCustomProp ) {
+ value += ret && ret[ 3 ] || ( jQuery.cssNumber[ origName ] ? "" : "px" );
+ }
+
+ // background-* props affect original clone's values
+ if ( !support.clearCloneStyle && value === "" && name.indexOf( "background" ) === 0 ) {
+ style[ name ] = "inherit";
+ }
+
+ // If a hook was provided, use that value, otherwise just set the specified value
+ if ( !hooks || !( "set" in hooks ) ||
+ ( value = hooks.set( elem, value, extra ) ) !== undefined ) {
+
+ if ( isCustomProp ) {
+ style.setProperty( name, value );
+ } else {
+ style[ name ] = value;
+ }
+ }
+
+ } else {
+
+ // If a hook was provided get the non-computed value from there
+ if ( hooks && "get" in hooks &&
+ ( ret = hooks.get( elem, false, extra ) ) !== undefined ) {
+
+ return ret;
+ }
+
+ // Otherwise just get the value from the style object
+ return style[ name ];
+ }
+ },
+
+ css: function( elem, name, extra, styles ) {
+ var val, num, hooks,
+ origName = camelCase( name ),
+ isCustomProp = rcustomProp.test( name );
+
+ // Make sure that we're working with the right name. We don't
+ // want to modify the value if it is a CSS custom property
+ // since they are user-defined.
+ if ( !isCustomProp ) {
+ name = finalPropName( origName );
+ }
+
+ // Try prefixed name followed by the unprefixed name
+ hooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ];
+
+ // If a hook was provided get the computed value from there
+ if ( hooks && "get" in hooks ) {
+ val = hooks.get( elem, true, extra );
+ }
+
+ // Otherwise, if a way to get the computed value exists, use that
+ if ( val === undefined ) {
+ val = curCSS( elem, name, styles );
+ }
+
+ // Convert "normal" to computed value
+ if ( val === "normal" && name in cssNormalTransform ) {
+ val = cssNormalTransform[ name ];
+ }
+
+ // Make numeric if forced or a qualifier was provided and val looks numeric
+ if ( extra === "" || extra ) {
+ num = parseFloat( val );
+ return extra === true || isFinite( num ) ? num || 0 : val;
+ }
+
+ return val;
+ }
+} );
+
+jQuery.each( [ "height", "width" ], function( _i, dimension ) {
+ jQuery.cssHooks[ dimension ] = {
+ get: function( elem, computed, extra ) {
+ if ( computed ) {
+
+ // Certain elements can have dimension info if we invisibly show them
+ // but it must have a current display style that would benefit
+ return rdisplayswap.test( jQuery.css( elem, "display" ) ) &&
+
+ // Support: Safari 8+
+ // Table columns in Safari have non-zero offsetWidth & zero
+ // getBoundingClientRect().width unless display is changed.
+ // Support: IE <=11 only
+ // Running getBoundingClientRect on a disconnected node
+ // in IE throws an error.
+ ( !elem.getClientRects().length || !elem.getBoundingClientRect().width ) ?
+ swap( elem, cssShow, function() {
+ return getWidthOrHeight( elem, dimension, extra );
+ } ) :
+ getWidthOrHeight( elem, dimension, extra );
+ }
+ },
+
+ set: function( elem, value, extra ) {
+ var matches,
+ styles = getStyles( elem ),
+
+ // Only read styles.position if the test has a chance to fail
+ // to avoid forcing a reflow.
+ scrollboxSizeBuggy = !support.scrollboxSize() &&
+ styles.position === "absolute",
+
+ // To avoid forcing a reflow, only fetch boxSizing if we need it (gh-3991)
+ boxSizingNeeded = scrollboxSizeBuggy || extra,
+ isBorderBox = boxSizingNeeded &&
+ jQuery.css( elem, "boxSizing", false, styles ) === "border-box",
+ subtract = extra ?
+ boxModelAdjustment(
+ elem,
+ dimension,
+ extra,
+ isBorderBox,
+ styles
+ ) :
+ 0;
+
+ // Account for unreliable border-box dimensions by comparing offset* to computed and
+ // faking a content-box to get border and padding (gh-3699)
+ if ( isBorderBox && scrollboxSizeBuggy ) {
+ subtract -= Math.ceil(
+ elem[ "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ) ] -
+ parseFloat( styles[ dimension ] ) -
+ boxModelAdjustment( elem, dimension, "border", false, styles ) -
+ 0.5
+ );
+ }
+
+ // Convert to pixels if value adjustment is needed
+ if ( subtract && ( matches = rcssNum.exec( value ) ) &&
+ ( matches[ 3 ] || "px" ) !== "px" ) {
+
+ elem.style[ dimension ] = value;
+ value = jQuery.css( elem, dimension );
+ }
+
+ return setPositiveNumber( elem, value, subtract );
+ }
+ };
+} );
+
+jQuery.cssHooks.marginLeft = addGetHookIf( support.reliableMarginLeft,
+ function( elem, computed ) {
+ if ( computed ) {
+ return ( parseFloat( curCSS( elem, "marginLeft" ) ) ||
+ elem.getBoundingClientRect().left -
+ swap( elem, { marginLeft: 0 }, function() {
+ return elem.getBoundingClientRect().left;
+ } )
+ ) + "px";
+ }
+ }
+);
+
+// These hooks are used by animate to expand properties
+jQuery.each( {
+ margin: "",
+ padding: "",
+ border: "Width"
+}, function( prefix, suffix ) {
+ jQuery.cssHooks[ prefix + suffix ] = {
+ expand: function( value ) {
+ var i = 0,
+ expanded = {},
+
+ // Assumes a single number if not a string
+ parts = typeof value === "string" ? value.split( " " ) : [ value ];
+
+ for ( ; i < 4; i++ ) {
+ expanded[ prefix + cssExpand[ i ] + suffix ] =
+ parts[ i ] || parts[ i - 2 ] || parts[ 0 ];
+ }
+
+ return expanded;
+ }
+ };
+
+ if ( prefix !== "margin" ) {
+ jQuery.cssHooks[ prefix + suffix ].set = setPositiveNumber;
+ }
+} );
+
+jQuery.fn.extend( {
+ css: function( name, value ) {
+ return access( this, function( elem, name, value ) {
+ var styles, len,
+ map = {},
+ i = 0;
+
+ if ( Array.isArray( name ) ) {
+ styles = getStyles( elem );
+ len = name.length;
+
+ for ( ; i < len; i++ ) {
+ map[ name[ i ] ] = jQuery.css( elem, name[ i ], false, styles );
+ }
+
+ return map;
+ }
+
+ return value !== undefined ?
+ jQuery.style( elem, name, value ) :
+ jQuery.css( elem, name );
+ }, name, value, arguments.length > 1 );
+ }
+} );
+
+
+function Tween( elem, options, prop, end, easing ) {
+ return new Tween.prototype.init( elem, options, prop, end, easing );
+}
+jQuery.Tween = Tween;
+
+Tween.prototype = {
+ constructor: Tween,
+ init: function( elem, options, prop, end, easing, unit ) {
+ this.elem = elem;
+ this.prop = prop;
+ this.easing = easing || jQuery.easing._default;
+ this.options = options;
+ this.start = this.now = this.cur();
+ this.end = end;
+ this.unit = unit || ( jQuery.cssNumber[ prop ] ? "" : "px" );
+ },
+ cur: function() {
+ var hooks = Tween.propHooks[ this.prop ];
+
+ return hooks && hooks.get ?
+ hooks.get( this ) :
+ Tween.propHooks._default.get( this );
+ },
+ run: function( percent ) {
+ var eased,
+ hooks = Tween.propHooks[ this.prop ];
+
+ if ( this.options.duration ) {
+ this.pos = eased = jQuery.easing[ this.easing ](
+ percent, this.options.duration * percent, 0, 1, this.options.duration
+ );
+ } else {
+ this.pos = eased = percent;
+ }
+ this.now = ( this.end - this.start ) * eased + this.start;
+
+ if ( this.options.step ) {
+ this.options.step.call( this.elem, this.now, this );
+ }
+
+ if ( hooks && hooks.set ) {
+ hooks.set( this );
+ } else {
+ Tween.propHooks._default.set( this );
+ }
+ return this;
+ }
+};
+
+Tween.prototype.init.prototype = Tween.prototype;
+
+Tween.propHooks = {
+ _default: {
+ get: function( tween ) {
+ var result;
+
+ // Use a property on the element directly when it is not a DOM element,
+ // or when there is no matching style property that exists.
+ if ( tween.elem.nodeType !== 1 ||
+ tween.elem[ tween.prop ] != null && tween.elem.style[ tween.prop ] == null ) {
+ return tween.elem[ tween.prop ];
+ }
+
+ // Passing an empty string as a 3rd parameter to .css will automatically
+ // attempt a parseFloat and fallback to a string if the parse fails.
+ // Simple values such as "10px" are parsed to Float;
+ // complex values such as "rotate(1rad)" are returned as-is.
+ result = jQuery.css( tween.elem, tween.prop, "" );
+
+ // Empty strings, null, undefined and "auto" are converted to 0.
+ return !result || result === "auto" ? 0 : result;
+ },
+ set: function( tween ) {
+
+ // Use step hook for back compat.
+ // Use cssHook if its there.
+ // Use .style if available and use plain properties where available.
+ if ( jQuery.fx.step[ tween.prop ] ) {
+ jQuery.fx.step[ tween.prop ]( tween );
+ } else if ( tween.elem.nodeType === 1 && (
+ jQuery.cssHooks[ tween.prop ] ||
+ tween.elem.style[ finalPropName( tween.prop ) ] != null ) ) {
+ jQuery.style( tween.elem, tween.prop, tween.now + tween.unit );
+ } else {
+ tween.elem[ tween.prop ] = tween.now;
+ }
+ }
+ }
+};
+
+// Support: IE <=9 only
+// Panic based approach to setting things on disconnected nodes
+Tween.propHooks.scrollTop = Tween.propHooks.scrollLeft = {
+ set: function( tween ) {
+ if ( tween.elem.nodeType && tween.elem.parentNode ) {
+ tween.elem[ tween.prop ] = tween.now;
+ }
+ }
+};
+
+jQuery.easing = {
+ linear: function( p ) {
+ return p;
+ },
+ swing: function( p ) {
+ return 0.5 - Math.cos( p * Math.PI ) / 2;
+ },
+ _default: "swing"
+};
+
+jQuery.fx = Tween.prototype.init;
+
+// Back compat <1.8 extension point
+jQuery.fx.step = {};
+
+
+
+
+var
+ fxNow, inProgress,
+ rfxtypes = /^(?:toggle|show|hide)$/,
+ rrun = /queueHooks$/;
+
+function schedule() {
+ if ( inProgress ) {
+ if ( document.hidden === false && window.requestAnimationFrame ) {
+ window.requestAnimationFrame( schedule );
+ } else {
+ window.setTimeout( schedule, jQuery.fx.interval );
+ }
+
+ jQuery.fx.tick();
+ }
+}
+
+// Animations created synchronously will run synchronously
+function createFxNow() {
+ window.setTimeout( function() {
+ fxNow = undefined;
+ } );
+ return ( fxNow = Date.now() );
+}
+
+// Generate parameters to create a standard animation
+function genFx( type, includeWidth ) {
+ var which,
+ i = 0,
+ attrs = { height: type };
+
+ // If we include width, step value is 1 to do all cssExpand values,
+ // otherwise step value is 2 to skip over Left and Right
+ includeWidth = includeWidth ? 1 : 0;
+ for ( ; i < 4; i += 2 - includeWidth ) {
+ which = cssExpand[ i ];
+ attrs[ "margin" + which ] = attrs[ "padding" + which ] = type;
+ }
+
+ if ( includeWidth ) {
+ attrs.opacity = attrs.width = type;
+ }
+
+ return attrs;
+}
+
+function createTween( value, prop, animation ) {
+ var tween,
+ collection = ( Animation.tweeners[ prop ] || [] ).concat( Animation.tweeners[ "*" ] ),
+ index = 0,
+ length = collection.length;
+ for ( ; index < length; index++ ) {
+ if ( ( tween = collection[ index ].call( animation, prop, value ) ) ) {
+
+ // We're done with this property
+ return tween;
+ }
+ }
+}
+
+function defaultPrefilter( elem, props, opts ) {
+ var prop, value, toggle, hooks, oldfire, propTween, restoreDisplay, display,
+ isBox = "width" in props || "height" in props,
+ anim = this,
+ orig = {},
+ style = elem.style,
+ hidden = elem.nodeType && isHiddenWithinTree( elem ),
+ dataShow = dataPriv.get( elem, "fxshow" );
+
+ // Queue-skipping animations hijack the fx hooks
+ if ( !opts.queue ) {
+ hooks = jQuery._queueHooks( elem, "fx" );
+ if ( hooks.unqueued == null ) {
+ hooks.unqueued = 0;
+ oldfire = hooks.empty.fire;
+ hooks.empty.fire = function() {
+ if ( !hooks.unqueued ) {
+ oldfire();
+ }
+ };
+ }
+ hooks.unqueued++;
+
+ anim.always( function() {
+
+ // Ensure the complete handler is called before this completes
+ anim.always( function() {
+ hooks.unqueued--;
+ if ( !jQuery.queue( elem, "fx" ).length ) {
+ hooks.empty.fire();
+ }
+ } );
+ } );
+ }
+
+ // Detect show/hide animations
+ for ( prop in props ) {
+ value = props[ prop ];
+ if ( rfxtypes.test( value ) ) {
+ delete props[ prop ];
+ toggle = toggle || value === "toggle";
+ if ( value === ( hidden ? "hide" : "show" ) ) {
+
+ // Pretend to be hidden if this is a "show" and
+ // there is still data from a stopped show/hide
+ if ( value === "show" && dataShow && dataShow[ prop ] !== undefined ) {
+ hidden = true;
+
+ // Ignore all other no-op show/hide data
+ } else {
+ continue;
+ }
+ }
+ orig[ prop ] = dataShow && dataShow[ prop ] || jQuery.style( elem, prop );
+ }
+ }
+
+ // Bail out if this is a no-op like .hide().hide()
+ propTween = !jQuery.isEmptyObject( props );
+ if ( !propTween && jQuery.isEmptyObject( orig ) ) {
+ return;
+ }
+
+ // Restrict "overflow" and "display" styles during box animations
+ if ( isBox && elem.nodeType === 1 ) {
+
+ // Support: IE <=9 - 11, Edge 12 - 15
+ // Record all 3 overflow attributes because IE does not infer the shorthand
+ // from identically-valued overflowX and overflowY and Edge just mirrors
+ // the overflowX value there.
+ opts.overflow = [ style.overflow, style.overflowX, style.overflowY ];
+
+ // Identify a display type, preferring old show/hide data over the CSS cascade
+ restoreDisplay = dataShow && dataShow.display;
+ if ( restoreDisplay == null ) {
+ restoreDisplay = dataPriv.get( elem, "display" );
+ }
+ display = jQuery.css( elem, "display" );
+ if ( display === "none" ) {
+ if ( restoreDisplay ) {
+ display = restoreDisplay;
+ } else {
+
+ // Get nonempty value(s) by temporarily forcing visibility
+ showHide( [ elem ], true );
+ restoreDisplay = elem.style.display || restoreDisplay;
+ display = jQuery.css( elem, "display" );
+ showHide( [ elem ] );
+ }
+ }
+
+ // Animate inline elements as inline-block
+ if ( display === "inline" || display === "inline-block" && restoreDisplay != null ) {
+ if ( jQuery.css( elem, "float" ) === "none" ) {
+
+ // Restore the original display value at the end of pure show/hide animations
+ if ( !propTween ) {
+ anim.done( function() {
+ style.display = restoreDisplay;
+ } );
+ if ( restoreDisplay == null ) {
+ display = style.display;
+ restoreDisplay = display === "none" ? "" : display;
+ }
+ }
+ style.display = "inline-block";
+ }
+ }
+ }
+
+ if ( opts.overflow ) {
+ style.overflow = "hidden";
+ anim.always( function() {
+ style.overflow = opts.overflow[ 0 ];
+ style.overflowX = opts.overflow[ 1 ];
+ style.overflowY = opts.overflow[ 2 ];
+ } );
+ }
+
+ // Implement show/hide animations
+ propTween = false;
+ for ( prop in orig ) {
+
+ // General show/hide setup for this element animation
+ if ( !propTween ) {
+ if ( dataShow ) {
+ if ( "hidden" in dataShow ) {
+ hidden = dataShow.hidden;
+ }
+ } else {
+ dataShow = dataPriv.access( elem, "fxshow", { display: restoreDisplay } );
+ }
+
+ // Store hidden/visible for toggle so `.stop().toggle()` "reverses"
+ if ( toggle ) {
+ dataShow.hidden = !hidden;
+ }
+
+ // Show elements before animating them
+ if ( hidden ) {
+ showHide( [ elem ], true );
+ }
+
+ /* eslint-disable no-loop-func */
+
+ anim.done( function() {
+
+ /* eslint-enable no-loop-func */
+
+ // The final step of a "hide" animation is actually hiding the element
+ if ( !hidden ) {
+ showHide( [ elem ] );
+ }
+ dataPriv.remove( elem, "fxshow" );
+ for ( prop in orig ) {
+ jQuery.style( elem, prop, orig[ prop ] );
+ }
+ } );
+ }
+
+ // Per-property setup
+ propTween = createTween( hidden ? dataShow[ prop ] : 0, prop, anim );
+ if ( !( prop in dataShow ) ) {
+ dataShow[ prop ] = propTween.start;
+ if ( hidden ) {
+ propTween.end = propTween.start;
+ propTween.start = 0;
+ }
+ }
+ }
+}
+
+function propFilter( props, specialEasing ) {
+ var index, name, easing, value, hooks;
+
+ // camelCase, specialEasing and expand cssHook pass
+ for ( index in props ) {
+ name = camelCase( index );
+ easing = specialEasing[ name ];
+ value = props[ index ];
+ if ( Array.isArray( value ) ) {
+ easing = value[ 1 ];
+ value = props[ index ] = value[ 0 ];
+ }
+
+ if ( index !== name ) {
+ props[ name ] = value;
+ delete props[ index ];
+ }
+
+ hooks = jQuery.cssHooks[ name ];
+ if ( hooks && "expand" in hooks ) {
+ value = hooks.expand( value );
+ delete props[ name ];
+
+ // Not quite $.extend, this won't overwrite existing keys.
+ // Reusing 'index' because we have the correct "name"
+ for ( index in value ) {
+ if ( !( index in props ) ) {
+ props[ index ] = value[ index ];
+ specialEasing[ index ] = easing;
+ }
+ }
+ } else {
+ specialEasing[ name ] = easing;
+ }
+ }
+}
+
+function Animation( elem, properties, options ) {
+ var result,
+ stopped,
+ index = 0,
+ length = Animation.prefilters.length,
+ deferred = jQuery.Deferred().always( function() {
+
+ // Don't match elem in the :animated selector
+ delete tick.elem;
+ } ),
+ tick = function() {
+ if ( stopped ) {
+ return false;
+ }
+ var currentTime = fxNow || createFxNow(),
+ remaining = Math.max( 0, animation.startTime + animation.duration - currentTime ),
+
+ // Support: Android 2.3 only
+ // Archaic crash bug won't allow us to use `1 - ( 0.5 || 0 )` (#12497)
+ temp = remaining / animation.duration || 0,
+ percent = 1 - temp,
+ index = 0,
+ length = animation.tweens.length;
+
+ for ( ; index < length; index++ ) {
+ animation.tweens[ index ].run( percent );
+ }
+
+ deferred.notifyWith( elem, [ animation, percent, remaining ] );
+
+ // If there's more to do, yield
+ if ( percent < 1 && length ) {
+ return remaining;
+ }
+
+ // If this was an empty animation, synthesize a final progress notification
+ if ( !length ) {
+ deferred.notifyWith( elem, [ animation, 1, 0 ] );
+ }
+
+ // Resolve the animation and report its conclusion
+ deferred.resolveWith( elem, [ animation ] );
+ return false;
+ },
+ animation = deferred.promise( {
+ elem: elem,
+ props: jQuery.extend( {}, properties ),
+ opts: jQuery.extend( true, {
+ specialEasing: {},
+ easing: jQuery.easing._default
+ }, options ),
+ originalProperties: properties,
+ originalOptions: options,
+ startTime: fxNow || createFxNow(),
+ duration: options.duration,
+ tweens: [],
+ createTween: function( prop, end ) {
+ var tween = jQuery.Tween( elem, animation.opts, prop, end,
+ animation.opts.specialEasing[ prop ] || animation.opts.easing );
+ animation.tweens.push( tween );
+ return tween;
+ },
+ stop: function( gotoEnd ) {
+ var index = 0,
+
+ // If we are going to the end, we want to run all the tweens
+ // otherwise we skip this part
+ length = gotoEnd ? animation.tweens.length : 0;
+ if ( stopped ) {
+ return this;
+ }
+ stopped = true;
+ for ( ; index < length; index++ ) {
+ animation.tweens[ index ].run( 1 );
+ }
+
+ // Resolve when we played the last frame; otherwise, reject
+ if ( gotoEnd ) {
+ deferred.notifyWith( elem, [ animation, 1, 0 ] );
+ deferred.resolveWith( elem, [ animation, gotoEnd ] );
+ } else {
+ deferred.rejectWith( elem, [ animation, gotoEnd ] );
+ }
+ return this;
+ }
+ } ),
+ props = animation.props;
+
+ propFilter( props, animation.opts.specialEasing );
+
+ for ( ; index < length; index++ ) {
+ result = Animation.prefilters[ index ].call( animation, elem, props, animation.opts );
+ if ( result ) {
+ if ( isFunction( result.stop ) ) {
+ jQuery._queueHooks( animation.elem, animation.opts.queue ).stop =
+ result.stop.bind( result );
+ }
+ return result;
+ }
+ }
+
+ jQuery.map( props, createTween, animation );
+
+ if ( isFunction( animation.opts.start ) ) {
+ animation.opts.start.call( elem, animation );
+ }
+
+ // Attach callbacks from options
+ animation
+ .progress( animation.opts.progress )
+ .done( animation.opts.done, animation.opts.complete )
+ .fail( animation.opts.fail )
+ .always( animation.opts.always );
+
+ jQuery.fx.timer(
+ jQuery.extend( tick, {
+ elem: elem,
+ anim: animation,
+ queue: animation.opts.queue
+ } )
+ );
+
+ return animation;
+}
+
+jQuery.Animation = jQuery.extend( Animation, {
+
+ tweeners: {
+ "*": [ function( prop, value ) {
+ var tween = this.createTween( prop, value );
+ adjustCSS( tween.elem, prop, rcssNum.exec( value ), tween );
+ return tween;
+ } ]
+ },
+
+ tweener: function( props, callback ) {
+ if ( isFunction( props ) ) {
+ callback = props;
+ props = [ "*" ];
+ } else {
+ props = props.match( rnothtmlwhite );
+ }
+
+ var prop,
+ index = 0,
+ length = props.length;
+
+ for ( ; index < length; index++ ) {
+ prop = props[ index ];
+ Animation.tweeners[ prop ] = Animation.tweeners[ prop ] || [];
+ Animation.tweeners[ prop ].unshift( callback );
+ }
+ },
+
+ prefilters: [ defaultPrefilter ],
+
+ prefilter: function( callback, prepend ) {
+ if ( prepend ) {
+ Animation.prefilters.unshift( callback );
+ } else {
+ Animation.prefilters.push( callback );
+ }
+ }
+} );
+
+jQuery.speed = function( speed, easing, fn ) {
+ var opt = speed && typeof speed === "object" ? jQuery.extend( {}, speed ) : {
+ complete: fn || !fn && easing ||
+ isFunction( speed ) && speed,
+ duration: speed,
+ easing: fn && easing || easing && !isFunction( easing ) && easing
+ };
+
+ // Go to the end state if fx are off
+ if ( jQuery.fx.off ) {
+ opt.duration = 0;
+
+ } else {
+ if ( typeof opt.duration !== "number" ) {
+ if ( opt.duration in jQuery.fx.speeds ) {
+ opt.duration = jQuery.fx.speeds[ opt.duration ];
+
+ } else {
+ opt.duration = jQuery.fx.speeds._default;
+ }
+ }
+ }
+
+ // Normalize opt.queue - true/undefined/null -> "fx"
+ if ( opt.queue == null || opt.queue === true ) {
+ opt.queue = "fx";
+ }
+
+ // Queueing
+ opt.old = opt.complete;
+
+ opt.complete = function() {
+ if ( isFunction( opt.old ) ) {
+ opt.old.call( this );
+ }
+
+ if ( opt.queue ) {
+ jQuery.dequeue( this, opt.queue );
+ }
+ };
+
+ return opt;
+};
+
+jQuery.fn.extend( {
+ fadeTo: function( speed, to, easing, callback ) {
+
+ // Show any hidden elements after setting opacity to 0
+ return this.filter( isHiddenWithinTree ).css( "opacity", 0 ).show()
+
+ // Animate to the value specified
+ .end().animate( { opacity: to }, speed, easing, callback );
+ },
+ animate: function( prop, speed, easing, callback ) {
+ var empty = jQuery.isEmptyObject( prop ),
+ optall = jQuery.speed( speed, easing, callback ),
+ doAnimation = function() {
+
+ // Operate on a copy of prop so per-property easing won't be lost
+ var anim = Animation( this, jQuery.extend( {}, prop ), optall );
+
+ // Empty animations, or finishing resolves immediately
+ if ( empty || dataPriv.get( this, "finish" ) ) {
+ anim.stop( true );
+ }
+ };
+ doAnimation.finish = doAnimation;
+
+ return empty || optall.queue === false ?
+ this.each( doAnimation ) :
+ this.queue( optall.queue, doAnimation );
+ },
+ stop: function( type, clearQueue, gotoEnd ) {
+ var stopQueue = function( hooks ) {
+ var stop = hooks.stop;
+ delete hooks.stop;
+ stop( gotoEnd );
+ };
+
+ if ( typeof type !== "string" ) {
+ gotoEnd = clearQueue;
+ clearQueue = type;
+ type = undefined;
+ }
+ if ( clearQueue ) {
+ this.queue( type || "fx", [] );
+ }
+
+ return this.each( function() {
+ var dequeue = true,
+ index = type != null && type + "queueHooks",
+ timers = jQuery.timers,
+ data = dataPriv.get( this );
+
+ if ( index ) {
+ if ( data[ index ] && data[ index ].stop ) {
+ stopQueue( data[ index ] );
+ }
+ } else {
+ for ( index in data ) {
+ if ( data[ index ] && data[ index ].stop && rrun.test( index ) ) {
+ stopQueue( data[ index ] );
+ }
+ }
+ }
+
+ for ( index = timers.length; index--; ) {
+ if ( timers[ index ].elem === this &&
+ ( type == null || timers[ index ].queue === type ) ) {
+
+ timers[ index ].anim.stop( gotoEnd );
+ dequeue = false;
+ timers.splice( index, 1 );
+ }
+ }
+
+ // Start the next in the queue if the last step wasn't forced.
+ // Timers currently will call their complete callbacks, which
+ // will dequeue but only if they were gotoEnd.
+ if ( dequeue || !gotoEnd ) {
+ jQuery.dequeue( this, type );
+ }
+ } );
+ },
+ finish: function( type ) {
+ if ( type !== false ) {
+ type = type || "fx";
+ }
+ return this.each( function() {
+ var index,
+ data = dataPriv.get( this ),
+ queue = data[ type + "queue" ],
+ hooks = data[ type + "queueHooks" ],
+ timers = jQuery.timers,
+ length = queue ? queue.length : 0;
+
+ // Enable finishing flag on private data
+ data.finish = true;
+
+ // Empty the queue first
+ jQuery.queue( this, type, [] );
+
+ if ( hooks && hooks.stop ) {
+ hooks.stop.call( this, true );
+ }
+
+ // Look for any active animations, and finish them
+ for ( index = timers.length; index--; ) {
+ if ( timers[ index ].elem === this && timers[ index ].queue === type ) {
+ timers[ index ].anim.stop( true );
+ timers.splice( index, 1 );
+ }
+ }
+
+ // Look for any animations in the old queue and finish them
+ for ( index = 0; index < length; index++ ) {
+ if ( queue[ index ] && queue[ index ].finish ) {
+ queue[ index ].finish.call( this );
+ }
+ }
+
+ // Turn off finishing flag
+ delete data.finish;
+ } );
+ }
+} );
+
+jQuery.each( [ "toggle", "show", "hide" ], function( _i, name ) {
+ var cssFn = jQuery.fn[ name ];
+ jQuery.fn[ name ] = function( speed, easing, callback ) {
+ return speed == null || typeof speed === "boolean" ?
+ cssFn.apply( this, arguments ) :
+ this.animate( genFx( name, true ), speed, easing, callback );
+ };
+} );
+
+// Generate shortcuts for custom animations
+jQuery.each( {
+ slideDown: genFx( "show" ),
+ slideUp: genFx( "hide" ),
+ slideToggle: genFx( "toggle" ),
+ fadeIn: { opacity: "show" },
+ fadeOut: { opacity: "hide" },
+ fadeToggle: { opacity: "toggle" }
+}, function( name, props ) {
+ jQuery.fn[ name ] = function( speed, easing, callback ) {
+ return this.animate( props, speed, easing, callback );
+ };
+} );
+
+jQuery.timers = [];
+jQuery.fx.tick = function() {
+ var timer,
+ i = 0,
+ timers = jQuery.timers;
+
+ fxNow = Date.now();
+
+ for ( ; i < timers.length; i++ ) {
+ timer = timers[ i ];
+
+ // Run the timer and safely remove it when done (allowing for external removal)
+ if ( !timer() && timers[ i ] === timer ) {
+ timers.splice( i--, 1 );
+ }
+ }
+
+ if ( !timers.length ) {
+ jQuery.fx.stop();
+ }
+ fxNow = undefined;
+};
+
+jQuery.fx.timer = function( timer ) {
+ jQuery.timers.push( timer );
+ jQuery.fx.start();
+};
+
+jQuery.fx.interval = 13;
+jQuery.fx.start = function() {
+ if ( inProgress ) {
+ return;
+ }
+
+ inProgress = true;
+ schedule();
+};
+
+jQuery.fx.stop = function() {
+ inProgress = null;
+};
+
+jQuery.fx.speeds = {
+ slow: 600,
+ fast: 200,
+
+ // Default speed
+ _default: 400
+};
+
+
+// Based off of the plugin by Clint Helfers, with permission.
+// https://web.archive.org/web/20100324014747/http://blindsignals.com/index.php/2009/07/jquery-delay/
+jQuery.fn.delay = function( time, type ) {
+ time = jQuery.fx ? jQuery.fx.speeds[ time ] || time : time;
+ type = type || "fx";
+
+ return this.queue( type, function( next, hooks ) {
+ var timeout = window.setTimeout( next, time );
+ hooks.stop = function() {
+ window.clearTimeout( timeout );
+ };
+ } );
+};
+
+
+( function() {
+ var input = document.createElement( "input" ),
+ select = document.createElement( "select" ),
+ opt = select.appendChild( document.createElement( "option" ) );
+
+ input.type = "checkbox";
+
+ // Support: Android <=4.3 only
+ // Default value for a checkbox should be "on"
+ support.checkOn = input.value !== "";
+
+ // Support: IE <=11 only
+ // Must access selectedIndex to make default options select
+ support.optSelected = opt.selected;
+
+ // Support: IE <=11 only
+ // An input loses its value after becoming a radio
+ input = document.createElement( "input" );
+ input.value = "t";
+ input.type = "radio";
+ support.radioValue = input.value === "t";
+} )();
+
+
+var boolHook,
+ attrHandle = jQuery.expr.attrHandle;
+
+jQuery.fn.extend( {
+ attr: function( name, value ) {
+ return access( this, jQuery.attr, name, value, arguments.length > 1 );
+ },
+
+ removeAttr: function( name ) {
+ return this.each( function() {
+ jQuery.removeAttr( this, name );
+ } );
+ }
+} );
+
+jQuery.extend( {
+ attr: function( elem, name, value ) {
+ var ret, hooks,
+ nType = elem.nodeType;
+
+ // Don't get/set attributes on text, comment and attribute nodes
+ if ( nType === 3 || nType === 8 || nType === 2 ) {
+ return;
+ }
+
+ // Fallback to prop when attributes are not supported
+ if ( typeof elem.getAttribute === "undefined" ) {
+ return jQuery.prop( elem, name, value );
+ }
+
+ // Attribute hooks are determined by the lowercase version
+ // Grab necessary hook if one is defined
+ if ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) {
+ hooks = jQuery.attrHooks[ name.toLowerCase() ] ||
+ ( jQuery.expr.match.bool.test( name ) ? boolHook : undefined );
+ }
+
+ if ( value !== undefined ) {
+ if ( value === null ) {
+ jQuery.removeAttr( elem, name );
+ return;
+ }
+
+ if ( hooks && "set" in hooks &&
+ ( ret = hooks.set( elem, value, name ) ) !== undefined ) {
+ return ret;
+ }
+
+ elem.setAttribute( name, value + "" );
+ return value;
+ }
+
+ if ( hooks && "get" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) {
+ return ret;
+ }
+
+ ret = jQuery.find.attr( elem, name );
+
+ // Non-existent attributes return null, we normalize to undefined
+ return ret == null ? undefined : ret;
+ },
+
+ attrHooks: {
+ type: {
+ set: function( elem, value ) {
+ if ( !support.radioValue && value === "radio" &&
+ nodeName( elem, "input" ) ) {
+ var val = elem.value;
+ elem.setAttribute( "type", value );
+ if ( val ) {
+ elem.value = val;
+ }
+ return value;
+ }
+ }
+ }
+ },
+
+ removeAttr: function( elem, value ) {
+ var name,
+ i = 0,
+
+ // Attribute names can contain non-HTML whitespace characters
+ // https://html.spec.whatwg.org/multipage/syntax.html#attributes-2
+ attrNames = value && value.match( rnothtmlwhite );
+
+ if ( attrNames && elem.nodeType === 1 ) {
+ while ( ( name = attrNames[ i++ ] ) ) {
+ elem.removeAttribute( name );
+ }
+ }
+ }
+} );
+
+// Hooks for boolean attributes
+boolHook = {
+ set: function( elem, value, name ) {
+ if ( value === false ) {
+
+ // Remove boolean attributes when set to false
+ jQuery.removeAttr( elem, name );
+ } else {
+ elem.setAttribute( name, name );
+ }
+ return name;
+ }
+};
+
+jQuery.each( jQuery.expr.match.bool.source.match( /\w+/g ), function( _i, name ) {
+ var getter = attrHandle[ name ] || jQuery.find.attr;
+
+ attrHandle[ name ] = function( elem, name, isXML ) {
+ var ret, handle,
+ lowercaseName = name.toLowerCase();
+
+ if ( !isXML ) {
+
+ // Avoid an infinite loop by temporarily removing this function from the getter
+ handle = attrHandle[ lowercaseName ];
+ attrHandle[ lowercaseName ] = ret;
+ ret = getter( elem, name, isXML ) != null ?
+ lowercaseName :
+ null;
+ attrHandle[ lowercaseName ] = handle;
+ }
+ return ret;
+ };
+} );
+
+
+
+
+var rfocusable = /^(?:input|select|textarea|button)$/i,
+ rclickable = /^(?:a|area)$/i;
+
+jQuery.fn.extend( {
+ prop: function( name, value ) {
+ return access( this, jQuery.prop, name, value, arguments.length > 1 );
+ },
+
+ removeProp: function( name ) {
+ return this.each( function() {
+ delete this[ jQuery.propFix[ name ] || name ];
+ } );
+ }
+} );
+
+jQuery.extend( {
+ prop: function( elem, name, value ) {
+ var ret, hooks,
+ nType = elem.nodeType;
+
+ // Don't get/set properties on text, comment and attribute nodes
+ if ( nType === 3 || nType === 8 || nType === 2 ) {
+ return;
+ }
+
+ if ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) {
+
+ // Fix name and attach hooks
+ name = jQuery.propFix[ name ] || name;
+ hooks = jQuery.propHooks[ name ];
+ }
+
+ if ( value !== undefined ) {
+ if ( hooks && "set" in hooks &&
+ ( ret = hooks.set( elem, value, name ) ) !== undefined ) {
+ return ret;
+ }
+
+ return ( elem[ name ] = value );
+ }
+
+ if ( hooks && "get" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) {
+ return ret;
+ }
+
+ return elem[ name ];
+ },
+
+ propHooks: {
+ tabIndex: {
+ get: function( elem ) {
+
+ // Support: IE <=9 - 11 only
+ // elem.tabIndex doesn't always return the
+ // correct value when it hasn't been explicitly set
+ // https://web.archive.org/web/20141116233347/http://fluidproject.org/blog/2008/01/09/getting-setting-and-removing-tabindex-values-with-javascript/
+ // Use proper attribute retrieval(#12072)
+ var tabindex = jQuery.find.attr( elem, "tabindex" );
+
+ if ( tabindex ) {
+ return parseInt( tabindex, 10 );
+ }
+
+ if (
+ rfocusable.test( elem.nodeName ) ||
+ rclickable.test( elem.nodeName ) &&
+ elem.href
+ ) {
+ return 0;
+ }
+
+ return -1;
+ }
+ }
+ },
+
+ propFix: {
+ "for": "htmlFor",
+ "class": "className"
+ }
+} );
+
+// Support: IE <=11 only
+// Accessing the selectedIndex property
+// forces the browser to respect setting selected
+// on the option
+// The getter ensures a default option is selected
+// when in an optgroup
+// eslint rule "no-unused-expressions" is disabled for this code
+// since it considers such accessions noop
+if ( !support.optSelected ) {
+ jQuery.propHooks.selected = {
+ get: function( elem ) {
+
+ /* eslint no-unused-expressions: "off" */
+
+ var parent = elem.parentNode;
+ if ( parent && parent.parentNode ) {
+ parent.parentNode.selectedIndex;
+ }
+ return null;
+ },
+ set: function( elem ) {
+
+ /* eslint no-unused-expressions: "off" */
+
+ var parent = elem.parentNode;
+ if ( parent ) {
+ parent.selectedIndex;
+
+ if ( parent.parentNode ) {
+ parent.parentNode.selectedIndex;
+ }
+ }
+ }
+ };
+}
+
+jQuery.each( [
+ "tabIndex",
+ "readOnly",
+ "maxLength",
+ "cellSpacing",
+ "cellPadding",
+ "rowSpan",
+ "colSpan",
+ "useMap",
+ "frameBorder",
+ "contentEditable"
+], function() {
+ jQuery.propFix[ this.toLowerCase() ] = this;
+} );
+
+
+
+
+ // Strip and collapse whitespace according to HTML spec
+ // https://infra.spec.whatwg.org/#strip-and-collapse-ascii-whitespace
+ function stripAndCollapse( value ) {
+ var tokens = value.match( rnothtmlwhite ) || [];
+ return tokens.join( " " );
+ }
+
+
+function getClass( elem ) {
+ return elem.getAttribute && elem.getAttribute( "class" ) || "";
+}
+
+function classesToArray( value ) {
+ if ( Array.isArray( value ) ) {
+ return value;
+ }
+ if ( typeof value === "string" ) {
+ return value.match( rnothtmlwhite ) || [];
+ }
+ return [];
+}
+
+jQuery.fn.extend( {
+ addClass: function( value ) {
+ var classes, elem, cur, curValue, clazz, j, finalValue,
+ i = 0;
+
+ if ( isFunction( value ) ) {
+ return this.each( function( j ) {
+ jQuery( this ).addClass( value.call( this, j, getClass( this ) ) );
+ } );
+ }
+
+ classes = classesToArray( value );
+
+ if ( classes.length ) {
+ while ( ( elem = this[ i++ ] ) ) {
+ curValue = getClass( elem );
+ cur = elem.nodeType === 1 && ( " " + stripAndCollapse( curValue ) + " " );
+
+ if ( cur ) {
+ j = 0;
+ while ( ( clazz = classes[ j++ ] ) ) {
+ if ( cur.indexOf( " " + clazz + " " ) < 0 ) {
+ cur += clazz + " ";
+ }
+ }
+
+ // Only assign if different to avoid unneeded rendering.
+ finalValue = stripAndCollapse( cur );
+ if ( curValue !== finalValue ) {
+ elem.setAttribute( "class", finalValue );
+ }
+ }
+ }
+ }
+
+ return this;
+ },
+
+ removeClass: function( value ) {
+ var classes, elem, cur, curValue, clazz, j, finalValue,
+ i = 0;
+
+ if ( isFunction( value ) ) {
+ return this.each( function( j ) {
+ jQuery( this ).removeClass( value.call( this, j, getClass( this ) ) );
+ } );
+ }
+
+ if ( !arguments.length ) {
+ return this.attr( "class", "" );
+ }
+
+ classes = classesToArray( value );
+
+ if ( classes.length ) {
+ while ( ( elem = this[ i++ ] ) ) {
+ curValue = getClass( elem );
+
+ // This expression is here for better compressibility (see addClass)
+ cur = elem.nodeType === 1 && ( " " + stripAndCollapse( curValue ) + " " );
+
+ if ( cur ) {
+ j = 0;
+ while ( ( clazz = classes[ j++ ] ) ) {
+
+ // Remove *all* instances
+ while ( cur.indexOf( " " + clazz + " " ) > -1 ) {
+ cur = cur.replace( " " + clazz + " ", " " );
+ }
+ }
+
+ // Only assign if different to avoid unneeded rendering.
+ finalValue = stripAndCollapse( cur );
+ if ( curValue !== finalValue ) {
+ elem.setAttribute( "class", finalValue );
+ }
+ }
+ }
+ }
+
+ return this;
+ },
+
+ toggleClass: function( value, stateVal ) {
+ var type = typeof value,
+ isValidValue = type === "string" || Array.isArray( value );
+
+ if ( typeof stateVal === "boolean" && isValidValue ) {
+ return stateVal ? this.addClass( value ) : this.removeClass( value );
+ }
+
+ if ( isFunction( value ) ) {
+ return this.each( function( i ) {
+ jQuery( this ).toggleClass(
+ value.call( this, i, getClass( this ), stateVal ),
+ stateVal
+ );
+ } );
+ }
+
+ return this.each( function() {
+ var className, i, self, classNames;
+
+ if ( isValidValue ) {
+
+ // Toggle individual class names
+ i = 0;
+ self = jQuery( this );
+ classNames = classesToArray( value );
+
+ while ( ( className = classNames[ i++ ] ) ) {
+
+ // Check each className given, space separated list
+ if ( self.hasClass( className ) ) {
+ self.removeClass( className );
+ } else {
+ self.addClass( className );
+ }
+ }
+
+ // Toggle whole class name
+ } else if ( value === undefined || type === "boolean" ) {
+ className = getClass( this );
+ if ( className ) {
+
+ // Store className if set
+ dataPriv.set( this, "__className__", className );
+ }
+
+ // If the element has a class name or if we're passed `false`,
+ // then remove the whole classname (if there was one, the above saved it).
+ // Otherwise bring back whatever was previously saved (if anything),
+ // falling back to the empty string if nothing was stored.
+ if ( this.setAttribute ) {
+ this.setAttribute( "class",
+ className || value === false ?
+ "" :
+ dataPriv.get( this, "__className__" ) || ""
+ );
+ }
+ }
+ } );
+ },
+
+ hasClass: function( selector ) {
+ var className, elem,
+ i = 0;
+
+ className = " " + selector + " ";
+ while ( ( elem = this[ i++ ] ) ) {
+ if ( elem.nodeType === 1 &&
+ ( " " + stripAndCollapse( getClass( elem ) ) + " " ).indexOf( className ) > -1 ) {
+ return true;
+ }
+ }
+
+ return false;
+ }
+} );
+
+
+
+
+var rreturn = /\r/g;
+
+jQuery.fn.extend( {
+ val: function( value ) {
+ var hooks, ret, valueIsFunction,
+ elem = this[ 0 ];
+
+ if ( !arguments.length ) {
+ if ( elem ) {
+ hooks = jQuery.valHooks[ elem.type ] ||
+ jQuery.valHooks[ elem.nodeName.toLowerCase() ];
+
+ if ( hooks &&
+ "get" in hooks &&
+ ( ret = hooks.get( elem, "value" ) ) !== undefined
+ ) {
+ return ret;
+ }
+
+ ret = elem.value;
+
+ // Handle most common string cases
+ if ( typeof ret === "string" ) {
+ return ret.replace( rreturn, "" );
+ }
+
+ // Handle cases where value is null/undef or number
+ return ret == null ? "" : ret;
+ }
+
+ return;
+ }
+
+ valueIsFunction = isFunction( value );
+
+ return this.each( function( i ) {
+ var val;
+
+ if ( this.nodeType !== 1 ) {
+ return;
+ }
+
+ if ( valueIsFunction ) {
+ val = value.call( this, i, jQuery( this ).val() );
+ } else {
+ val = value;
+ }
+
+ // Treat null/undefined as ""; convert numbers to string
+ if ( val == null ) {
+ val = "";
+
+ } else if ( typeof val === "number" ) {
+ val += "";
+
+ } else if ( Array.isArray( val ) ) {
+ val = jQuery.map( val, function( value ) {
+ return value == null ? "" : value + "";
+ } );
+ }
+
+ hooks = jQuery.valHooks[ this.type ] || jQuery.valHooks[ this.nodeName.toLowerCase() ];
+
+ // If set returns undefined, fall back to normal setting
+ if ( !hooks || !( "set" in hooks ) || hooks.set( this, val, "value" ) === undefined ) {
+ this.value = val;
+ }
+ } );
+ }
+} );
+
+jQuery.extend( {
+ valHooks: {
+ option: {
+ get: function( elem ) {
+
+ var val = jQuery.find.attr( elem, "value" );
+ return val != null ?
+ val :
+
+ // Support: IE <=10 - 11 only
+ // option.text throws exceptions (#14686, #14858)
+ // Strip and collapse whitespace
+ // https://html.spec.whatwg.org/#strip-and-collapse-whitespace
+ stripAndCollapse( jQuery.text( elem ) );
+ }
+ },
+ select: {
+ get: function( elem ) {
+ var value, option, i,
+ options = elem.options,
+ index = elem.selectedIndex,
+ one = elem.type === "select-one",
+ values = one ? null : [],
+ max = one ? index + 1 : options.length;
+
+ if ( index < 0 ) {
+ i = max;
+
+ } else {
+ i = one ? index : 0;
+ }
+
+ // Loop through all the selected options
+ for ( ; i < max; i++ ) {
+ option = options[ i ];
+
+ // Support: IE <=9 only
+ // IE8-9 doesn't update selected after form reset (#2551)
+ if ( ( option.selected || i === index ) &&
+
+ // Don't return options that are disabled or in a disabled optgroup
+ !option.disabled &&
+ ( !option.parentNode.disabled ||
+ !nodeName( option.parentNode, "optgroup" ) ) ) {
+
+ // Get the specific value for the option
+ value = jQuery( option ).val();
+
+ // We don't need an array for one selects
+ if ( one ) {
+ return value;
+ }
+
+ // Multi-Selects return an array
+ values.push( value );
+ }
+ }
+
+ return values;
+ },
+
+ set: function( elem, value ) {
+ var optionSet, option,
+ options = elem.options,
+ values = jQuery.makeArray( value ),
+ i = options.length;
+
+ while ( i-- ) {
+ option = options[ i ];
+
+ /* eslint-disable no-cond-assign */
+
+ if ( option.selected =
+ jQuery.inArray( jQuery.valHooks.option.get( option ), values ) > -1
+ ) {
+ optionSet = true;
+ }
+
+ /* eslint-enable no-cond-assign */
+ }
+
+ // Force browsers to behave consistently when non-matching value is set
+ if ( !optionSet ) {
+ elem.selectedIndex = -1;
+ }
+ return values;
+ }
+ }
+ }
+} );
+
+// Radios and checkboxes getter/setter
+jQuery.each( [ "radio", "checkbox" ], function() {
+ jQuery.valHooks[ this ] = {
+ set: function( elem, value ) {
+ if ( Array.isArray( value ) ) {
+ return ( elem.checked = jQuery.inArray( jQuery( elem ).val(), value ) > -1 );
+ }
+ }
+ };
+ if ( !support.checkOn ) {
+ jQuery.valHooks[ this ].get = function( elem ) {
+ return elem.getAttribute( "value" ) === null ? "on" : elem.value;
+ };
+ }
+} );
+
+
+
+
+// Return jQuery for attributes-only inclusion
+
+
+support.focusin = "onfocusin" in window;
+
+
+var rfocusMorph = /^(?:focusinfocus|focusoutblur)$/,
+ stopPropagationCallback = function( e ) {
+ e.stopPropagation();
+ };
+
+jQuery.extend( jQuery.event, {
+
+ trigger: function( event, data, elem, onlyHandlers ) {
+
+ var i, cur, tmp, bubbleType, ontype, handle, special, lastElement,
+ eventPath = [ elem || document ],
+ type = hasOwn.call( event, "type" ) ? event.type : event,
+ namespaces = hasOwn.call( event, "namespace" ) ? event.namespace.split( "." ) : [];
+
+ cur = lastElement = tmp = elem = elem || document;
+
+ // Don't do events on text and comment nodes
+ if ( elem.nodeType === 3 || elem.nodeType === 8 ) {
+ return;
+ }
+
+ // focus/blur morphs to focusin/out; ensure we're not firing them right now
+ if ( rfocusMorph.test( type + jQuery.event.triggered ) ) {
+ return;
+ }
+
+ if ( type.indexOf( "." ) > -1 ) {
+
+ // Namespaced trigger; create a regexp to match event type in handle()
+ namespaces = type.split( "." );
+ type = namespaces.shift();
+ namespaces.sort();
+ }
+ ontype = type.indexOf( ":" ) < 0 && "on" + type;
+
+ // Caller can pass in a jQuery.Event object, Object, or just an event type string
+ event = event[ jQuery.expando ] ?
+ event :
+ new jQuery.Event( type, typeof event === "object" && event );
+
+ // Trigger bitmask: & 1 for native handlers; & 2 for jQuery (always true)
+ event.isTrigger = onlyHandlers ? 2 : 3;
+ event.namespace = namespaces.join( "." );
+ event.rnamespace = event.namespace ?
+ new RegExp( "(^|\\.)" + namespaces.join( "\\.(?:.*\\.|)" ) + "(\\.|$)" ) :
+ null;
+
+ // Clean up the event in case it is being reused
+ event.result = undefined;
+ if ( !event.target ) {
+ event.target = elem;
+ }
+
+ // Clone any incoming data and prepend the event, creating the handler arg list
+ data = data == null ?
+ [ event ] :
+ jQuery.makeArray( data, [ event ] );
+
+ // Allow special events to draw outside the lines
+ special = jQuery.event.special[ type ] || {};
+ if ( !onlyHandlers && special.trigger && special.trigger.apply( elem, data ) === false ) {
+ return;
+ }
+
+ // Determine event propagation path in advance, per W3C events spec (#9951)
+ // Bubble up to document, then to window; watch for a global ownerDocument var (#9724)
+ if ( !onlyHandlers && !special.noBubble && !isWindow( elem ) ) {
+
+ bubbleType = special.delegateType || type;
+ if ( !rfocusMorph.test( bubbleType + type ) ) {
+ cur = cur.parentNode;
+ }
+ for ( ; cur; cur = cur.parentNode ) {
+ eventPath.push( cur );
+ tmp = cur;
+ }
+
+ // Only add window if we got to document (e.g., not plain obj or detached DOM)
+ if ( tmp === ( elem.ownerDocument || document ) ) {
+ eventPath.push( tmp.defaultView || tmp.parentWindow || window );
+ }
+ }
+
+ // Fire handlers on the event path
+ i = 0;
+ while ( ( cur = eventPath[ i++ ] ) && !event.isPropagationStopped() ) {
+ lastElement = cur;
+ event.type = i > 1 ?
+ bubbleType :
+ special.bindType || type;
+
+ // jQuery handler
+ handle = (
+ dataPriv.get( cur, "events" ) || Object.create( null )
+ )[ event.type ] &&
+ dataPriv.get( cur, "handle" );
+ if ( handle ) {
+ handle.apply( cur, data );
+ }
+
+ // Native handler
+ handle = ontype && cur[ ontype ];
+ if ( handle && handle.apply && acceptData( cur ) ) {
+ event.result = handle.apply( cur, data );
+ if ( event.result === false ) {
+ event.preventDefault();
+ }
+ }
+ }
+ event.type = type;
+
+ // If nobody prevented the default action, do it now
+ if ( !onlyHandlers && !event.isDefaultPrevented() ) {
+
+ if ( ( !special._default ||
+ special._default.apply( eventPath.pop(), data ) === false ) &&
+ acceptData( elem ) ) {
+
+ // Call a native DOM method on the target with the same name as the event.
+ // Don't do default actions on window, that's where global variables be (#6170)
+ if ( ontype && isFunction( elem[ type ] ) && !isWindow( elem ) ) {
+
+ // Don't re-trigger an onFOO event when we call its FOO() method
+ tmp = elem[ ontype ];
+
+ if ( tmp ) {
+ elem[ ontype ] = null;
+ }
+
+ // Prevent re-triggering of the same event, since we already bubbled it above
+ jQuery.event.triggered = type;
+
+ if ( event.isPropagationStopped() ) {
+ lastElement.addEventListener( type, stopPropagationCallback );
+ }
+
+ elem[ type ]();
+
+ if ( event.isPropagationStopped() ) {
+ lastElement.removeEventListener( type, stopPropagationCallback );
+ }
+
+ jQuery.event.triggered = undefined;
+
+ if ( tmp ) {
+ elem[ ontype ] = tmp;
+ }
+ }
+ }
+ }
+
+ return event.result;
+ },
+
+ // Piggyback on a donor event to simulate a different one
+ // Used only for `focus(in | out)` events
+ simulate: function( type, elem, event ) {
+ var e = jQuery.extend(
+ new jQuery.Event(),
+ event,
+ {
+ type: type,
+ isSimulated: true
+ }
+ );
+
+ jQuery.event.trigger( e, null, elem );
+ }
+
+} );
+
+jQuery.fn.extend( {
+
+ trigger: function( type, data ) {
+ return this.each( function() {
+ jQuery.event.trigger( type, data, this );
+ } );
+ },
+ triggerHandler: function( type, data ) {
+ var elem = this[ 0 ];
+ if ( elem ) {
+ return jQuery.event.trigger( type, data, elem, true );
+ }
+ }
+} );
+
+
+// Support: Firefox <=44
+// Firefox doesn't have focus(in | out) events
+// Related ticket - https://bugzilla.mozilla.org/show_bug.cgi?id=687787
+//
+// Support: Chrome <=48 - 49, Safari <=9.0 - 9.1
+// focus(in | out) events fire after focus & blur events,
+// which is spec violation - http://www.w3.org/TR/DOM-Level-3-Events/#events-focusevent-event-order
+// Related ticket - https://bugs.chromium.org/p/chromium/issues/detail?id=449857
+if ( !support.focusin ) {
+ jQuery.each( { focus: "focusin", blur: "focusout" }, function( orig, fix ) {
+
+ // Attach a single capturing handler on the document while someone wants focusin/focusout
+ var handler = function( event ) {
+ jQuery.event.simulate( fix, event.target, jQuery.event.fix( event ) );
+ };
+
+ jQuery.event.special[ fix ] = {
+ setup: function() {
+
+ // Handle: regular nodes (via `this.ownerDocument`), window
+ // (via `this.document`) & document (via `this`).
+ var doc = this.ownerDocument || this.document || this,
+ attaches = dataPriv.access( doc, fix );
+
+ if ( !attaches ) {
+ doc.addEventListener( orig, handler, true );
+ }
+ dataPriv.access( doc, fix, ( attaches || 0 ) + 1 );
+ },
+ teardown: function() {
+ var doc = this.ownerDocument || this.document || this,
+ attaches = dataPriv.access( doc, fix ) - 1;
+
+ if ( !attaches ) {
+ doc.removeEventListener( orig, handler, true );
+ dataPriv.remove( doc, fix );
+
+ } else {
+ dataPriv.access( doc, fix, attaches );
+ }
+ }
+ };
+ } );
+}
+var location = window.location;
+
+var nonce = { guid: Date.now() };
+
+var rquery = ( /\?/ );
+
+
+
+// Cross-browser xml parsing
+jQuery.parseXML = function( data ) {
+ var xml;
+ if ( !data || typeof data !== "string" ) {
+ return null;
+ }
+
+ // Support: IE 9 - 11 only
+ // IE throws on parseFromString with invalid input.
+ try {
+ xml = ( new window.DOMParser() ).parseFromString( data, "text/xml" );
+ } catch ( e ) {
+ xml = undefined;
+ }
+
+ if ( !xml || xml.getElementsByTagName( "parsererror" ).length ) {
+ jQuery.error( "Invalid XML: " + data );
+ }
+ return xml;
+};
+
+
+var
+ rbracket = /\[\]$/,
+ rCRLF = /\r?\n/g,
+ rsubmitterTypes = /^(?:submit|button|image|reset|file)$/i,
+ rsubmittable = /^(?:input|select|textarea|keygen)/i;
+
+function buildParams( prefix, obj, traditional, add ) {
+ var name;
+
+ if ( Array.isArray( obj ) ) {
+
+ // Serialize array item.
+ jQuery.each( obj, function( i, v ) {
+ if ( traditional || rbracket.test( prefix ) ) {
+
+ // Treat each array item as a scalar.
+ add( prefix, v );
+
+ } else {
+
+ // Item is non-scalar (array or object), encode its numeric index.
+ buildParams(
+ prefix + "[" + ( typeof v === "object" && v != null ? i : "" ) + "]",
+ v,
+ traditional,
+ add
+ );
+ }
+ } );
+
+ } else if ( !traditional && toType( obj ) === "object" ) {
+
+ // Serialize object item.
+ for ( name in obj ) {
+ buildParams( prefix + "[" + name + "]", obj[ name ], traditional, add );
+ }
+
+ } else {
+
+ // Serialize scalar item.
+ add( prefix, obj );
+ }
+}
+
+// Serialize an array of form elements or a set of
+// key/values into a query string
+jQuery.param = function( a, traditional ) {
+ var prefix,
+ s = [],
+ add = function( key, valueOrFunction ) {
+
+ // If value is a function, invoke it and use its return value
+ var value = isFunction( valueOrFunction ) ?
+ valueOrFunction() :
+ valueOrFunction;
+
+ s[ s.length ] = encodeURIComponent( key ) + "=" +
+ encodeURIComponent( value == null ? "" : value );
+ };
+
+ if ( a == null ) {
+ return "";
+ }
+
+ // If an array was passed in, assume that it is an array of form elements.
+ if ( Array.isArray( a ) || ( a.jquery && !jQuery.isPlainObject( a ) ) ) {
+
+ // Serialize the form elements
+ jQuery.each( a, function() {
+ add( this.name, this.value );
+ } );
+
+ } else {
+
+ // If traditional, encode the "old" way (the way 1.3.2 or older
+ // did it), otherwise encode params recursively.
+ for ( prefix in a ) {
+ buildParams( prefix, a[ prefix ], traditional, add );
+ }
+ }
+
+ // Return the resulting serialization
+ return s.join( "&" );
+};
+
+jQuery.fn.extend( {
+ serialize: function() {
+ return jQuery.param( this.serializeArray() );
+ },
+ serializeArray: function() {
+ return this.map( function() {
+
+ // Can add propHook for "elements" to filter or add form elements
+ var elements = jQuery.prop( this, "elements" );
+ return elements ? jQuery.makeArray( elements ) : this;
+ } )
+ .filter( function() {
+ var type = this.type;
+
+ // Use .is( ":disabled" ) so that fieldset[disabled] works
+ return this.name && !jQuery( this ).is( ":disabled" ) &&
+ rsubmittable.test( this.nodeName ) && !rsubmitterTypes.test( type ) &&
+ ( this.checked || !rcheckableType.test( type ) );
+ } )
+ .map( function( _i, elem ) {
+ var val = jQuery( this ).val();
+
+ if ( val == null ) {
+ return null;
+ }
+
+ if ( Array.isArray( val ) ) {
+ return jQuery.map( val, function( val ) {
+ return { name: elem.name, value: val.replace( rCRLF, "\r\n" ) };
+ } );
+ }
+
+ return { name: elem.name, value: val.replace( rCRLF, "\r\n" ) };
+ } ).get();
+ }
+} );
+
+
+var
+ r20 = /%20/g,
+ rhash = /#.*$/,
+ rantiCache = /([?&])_=[^&]*/,
+ rheaders = /^(.*?):[ \t]*([^\r\n]*)$/mg,
+
+ // #7653, #8125, #8152: local protocol detection
+ rlocalProtocol = /^(?:about|app|app-storage|.+-extension|file|res|widget):$/,
+ rnoContent = /^(?:GET|HEAD)$/,
+ rprotocol = /^\/\//,
+
+ /* Prefilters
+ * 1) They are useful to introduce custom dataTypes (see ajax/jsonp.js for an example)
+ * 2) These are called:
+ * - BEFORE asking for a transport
+ * - AFTER param serialization (s.data is a string if s.processData is true)
+ * 3) key is the dataType
+ * 4) the catchall symbol "*" can be used
+ * 5) execution will start with transport dataType and THEN continue down to "*" if needed
+ */
+ prefilters = {},
+
+ /* Transports bindings
+ * 1) key is the dataType
+ * 2) the catchall symbol "*" can be used
+ * 3) selection will start with transport dataType and THEN go to "*" if needed
+ */
+ transports = {},
+
+ // Avoid comment-prolog char sequence (#10098); must appease lint and evade compression
+ allTypes = "*/".concat( "*" ),
+
+ // Anchor tag for parsing the document origin
+ originAnchor = document.createElement( "a" );
+ originAnchor.href = location.href;
+
+// Base "constructor" for jQuery.ajaxPrefilter and jQuery.ajaxTransport
+function addToPrefiltersOrTransports( structure ) {
+
+ // dataTypeExpression is optional and defaults to "*"
+ return function( dataTypeExpression, func ) {
+
+ if ( typeof dataTypeExpression !== "string" ) {
+ func = dataTypeExpression;
+ dataTypeExpression = "*";
+ }
+
+ var dataType,
+ i = 0,
+ dataTypes = dataTypeExpression.toLowerCase().match( rnothtmlwhite ) || [];
+
+ if ( isFunction( func ) ) {
+
+ // For each dataType in the dataTypeExpression
+ while ( ( dataType = dataTypes[ i++ ] ) ) {
+
+ // Prepend if requested
+ if ( dataType[ 0 ] === "+" ) {
+ dataType = dataType.slice( 1 ) || "*";
+ ( structure[ dataType ] = structure[ dataType ] || [] ).unshift( func );
+
+ // Otherwise append
+ } else {
+ ( structure[ dataType ] = structure[ dataType ] || [] ).push( func );
+ }
+ }
+ }
+ };
+}
+
+// Base inspection function for prefilters and transports
+function inspectPrefiltersOrTransports( structure, options, originalOptions, jqXHR ) {
+
+ var inspected = {},
+ seekingTransport = ( structure === transports );
+
+ function inspect( dataType ) {
+ var selected;
+ inspected[ dataType ] = true;
+ jQuery.each( structure[ dataType ] || [], function( _, prefilterOrFactory ) {
+ var dataTypeOrTransport = prefilterOrFactory( options, originalOptions, jqXHR );
+ if ( typeof dataTypeOrTransport === "string" &&
+ !seekingTransport && !inspected[ dataTypeOrTransport ] ) {
+
+ options.dataTypes.unshift( dataTypeOrTransport );
+ inspect( dataTypeOrTransport );
+ return false;
+ } else if ( seekingTransport ) {
+ return !( selected = dataTypeOrTransport );
+ }
+ } );
+ return selected;
+ }
+
+ return inspect( options.dataTypes[ 0 ] ) || !inspected[ "*" ] && inspect( "*" );
+}
+
+// A special extend for ajax options
+// that takes "flat" options (not to be deep extended)
+// Fixes #9887
+function ajaxExtend( target, src ) {
+ var key, deep,
+ flatOptions = jQuery.ajaxSettings.flatOptions || {};
+
+ for ( key in src ) {
+ if ( src[ key ] !== undefined ) {
+ ( flatOptions[ key ] ? target : ( deep || ( deep = {} ) ) )[ key ] = src[ key ];
+ }
+ }
+ if ( deep ) {
+ jQuery.extend( true, target, deep );
+ }
+
+ return target;
+}
+
+/* Handles responses to an ajax request:
+ * - finds the right dataType (mediates between content-type and expected dataType)
+ * - returns the corresponding response
+ */
+function ajaxHandleResponses( s, jqXHR, responses ) {
+
+ var ct, type, finalDataType, firstDataType,
+ contents = s.contents,
+ dataTypes = s.dataTypes;
+
+ // Remove auto dataType and get content-type in the process
+ while ( dataTypes[ 0 ] === "*" ) {
+ dataTypes.shift();
+ if ( ct === undefined ) {
+ ct = s.mimeType || jqXHR.getResponseHeader( "Content-Type" );
+ }
+ }
+
+ // Check if we're dealing with a known content-type
+ if ( ct ) {
+ for ( type in contents ) {
+ if ( contents[ type ] && contents[ type ].test( ct ) ) {
+ dataTypes.unshift( type );
+ break;
+ }
+ }
+ }
+
+ // Check to see if we have a response for the expected dataType
+ if ( dataTypes[ 0 ] in responses ) {
+ finalDataType = dataTypes[ 0 ];
+ } else {
+
+ // Try convertible dataTypes
+ for ( type in responses ) {
+ if ( !dataTypes[ 0 ] || s.converters[ type + " " + dataTypes[ 0 ] ] ) {
+ finalDataType = type;
+ break;
+ }
+ if ( !firstDataType ) {
+ firstDataType = type;
+ }
+ }
+
+ // Or just use first one
+ finalDataType = finalDataType || firstDataType;
+ }
+
+ // If we found a dataType
+ // We add the dataType to the list if needed
+ // and return the corresponding response
+ if ( finalDataType ) {
+ if ( finalDataType !== dataTypes[ 0 ] ) {
+ dataTypes.unshift( finalDataType );
+ }
+ return responses[ finalDataType ];
+ }
+}
+
+/* Chain conversions given the request and the original response
+ * Also sets the responseXXX fields on the jqXHR instance
+ */
+function ajaxConvert( s, response, jqXHR, isSuccess ) {
+ var conv2, current, conv, tmp, prev,
+ converters = {},
+
+ // Work with a copy of dataTypes in case we need to modify it for conversion
+ dataTypes = s.dataTypes.slice();
+
+ // Create converters map with lowercased keys
+ if ( dataTypes[ 1 ] ) {
+ for ( conv in s.converters ) {
+ converters[ conv.toLowerCase() ] = s.converters[ conv ];
+ }
+ }
+
+ current = dataTypes.shift();
+
+ // Convert to each sequential dataType
+ while ( current ) {
+
+ if ( s.responseFields[ current ] ) {
+ jqXHR[ s.responseFields[ current ] ] = response;
+ }
+
+ // Apply the dataFilter if provided
+ if ( !prev && isSuccess && s.dataFilter ) {
+ response = s.dataFilter( response, s.dataType );
+ }
+
+ prev = current;
+ current = dataTypes.shift();
+
+ if ( current ) {
+
+ // There's only work to do if current dataType is non-auto
+ if ( current === "*" ) {
+
+ current = prev;
+
+ // Convert response if prev dataType is non-auto and differs from current
+ } else if ( prev !== "*" && prev !== current ) {
+
+ // Seek a direct converter
+ conv = converters[ prev + " " + current ] || converters[ "* " + current ];
+
+ // If none found, seek a pair
+ if ( !conv ) {
+ for ( conv2 in converters ) {
+
+ // If conv2 outputs current
+ tmp = conv2.split( " " );
+ if ( tmp[ 1 ] === current ) {
+
+ // If prev can be converted to accepted input
+ conv = converters[ prev + " " + tmp[ 0 ] ] ||
+ converters[ "* " + tmp[ 0 ] ];
+ if ( conv ) {
+
+ // Condense equivalence converters
+ if ( conv === true ) {
+ conv = converters[ conv2 ];
+
+ // Otherwise, insert the intermediate dataType
+ } else if ( converters[ conv2 ] !== true ) {
+ current = tmp[ 0 ];
+ dataTypes.unshift( tmp[ 1 ] );
+ }
+ break;
+ }
+ }
+ }
+ }
+
+ // Apply converter (if not an equivalence)
+ if ( conv !== true ) {
+
+ // Unless errors are allowed to bubble, catch and return them
+ if ( conv && s.throws ) {
+ response = conv( response );
+ } else {
+ try {
+ response = conv( response );
+ } catch ( e ) {
+ return {
+ state: "parsererror",
+ error: conv ? e : "No conversion from " + prev + " to " + current
+ };
+ }
+ }
+ }
+ }
+ }
+ }
+
+ return { state: "success", data: response };
+}
+
+jQuery.extend( {
+
+ // Counter for holding the number of active queries
+ active: 0,
+
+ // Last-Modified header cache for next request
+ lastModified: {},
+ etag: {},
+
+ ajaxSettings: {
+ url: location.href,
+ type: "GET",
+ isLocal: rlocalProtocol.test( location.protocol ),
+ global: true,
+ processData: true,
+ async: true,
+ contentType: "application/x-www-form-urlencoded; charset=UTF-8",
+
+ /*
+ timeout: 0,
+ data: null,
+ dataType: null,
+ username: null,
+ password: null,
+ cache: null,
+ throws: false,
+ traditional: false,
+ headers: {},
+ */
+
+ accepts: {
+ "*": allTypes,
+ text: "text/plain",
+ html: "text/html",
+ xml: "application/xml, text/xml",
+ json: "application/json, text/javascript"
+ },
+
+ contents: {
+ xml: /\bxml\b/,
+ html: /\bhtml/,
+ json: /\bjson\b/
+ },
+
+ responseFields: {
+ xml: "responseXML",
+ text: "responseText",
+ json: "responseJSON"
+ },
+
+ // Data converters
+ // Keys separate source (or catchall "*") and destination types with a single space
+ converters: {
+
+ // Convert anything to text
+ "* text": String,
+
+ // Text to html (true = no transformation)
+ "text html": true,
+
+ // Evaluate text as a json expression
+ "text json": JSON.parse,
+
+ // Parse text as xml
+ "text xml": jQuery.parseXML
+ },
+
+ // For options that shouldn't be deep extended:
+ // you can add your own custom options here if
+ // and when you create one that shouldn't be
+ // deep extended (see ajaxExtend)
+ flatOptions: {
+ url: true,
+ context: true
+ }
+ },
+
+ // Creates a full fledged settings object into target
+ // with both ajaxSettings and settings fields.
+ // If target is omitted, writes into ajaxSettings.
+ ajaxSetup: function( target, settings ) {
+ return settings ?
+
+ // Building a settings object
+ ajaxExtend( ajaxExtend( target, jQuery.ajaxSettings ), settings ) :
+
+ // Extending ajaxSettings
+ ajaxExtend( jQuery.ajaxSettings, target );
+ },
+
+ ajaxPrefilter: addToPrefiltersOrTransports( prefilters ),
+ ajaxTransport: addToPrefiltersOrTransports( transports ),
+
+ // Main method
+ ajax: function( url, options ) {
+
+ // If url is an object, simulate pre-1.5 signature
+ if ( typeof url === "object" ) {
+ options = url;
+ url = undefined;
+ }
+
+ // Force options to be an object
+ options = options || {};
+
+ var transport,
+
+ // URL without anti-cache param
+ cacheURL,
+
+ // Response headers
+ responseHeadersString,
+ responseHeaders,
+
+ // timeout handle
+ timeoutTimer,
+
+ // Url cleanup var
+ urlAnchor,
+
+ // Request state (becomes false upon send and true upon completion)
+ completed,
+
+ // To know if global events are to be dispatched
+ fireGlobals,
+
+ // Loop variable
+ i,
+
+ // uncached part of the url
+ uncached,
+
+ // Create the final options object
+ s = jQuery.ajaxSetup( {}, options ),
+
+ // Callbacks context
+ callbackContext = s.context || s,
+
+ // Context for global events is callbackContext if it is a DOM node or jQuery collection
+ globalEventContext = s.context &&
+ ( callbackContext.nodeType || callbackContext.jquery ) ?
+ jQuery( callbackContext ) :
+ jQuery.event,
+
+ // Deferreds
+ deferred = jQuery.Deferred(),
+ completeDeferred = jQuery.Callbacks( "once memory" ),
+
+ // Status-dependent callbacks
+ statusCode = s.statusCode || {},
+
+ // Headers (they are sent all at once)
+ requestHeaders = {},
+ requestHeadersNames = {},
+
+ // Default abort message
+ strAbort = "canceled",
+
+ // Fake xhr
+ jqXHR = {
+ readyState: 0,
+
+ // Builds headers hashtable if needed
+ getResponseHeader: function( key ) {
+ var match;
+ if ( completed ) {
+ if ( !responseHeaders ) {
+ responseHeaders = {};
+ while ( ( match = rheaders.exec( responseHeadersString ) ) ) {
+ responseHeaders[ match[ 1 ].toLowerCase() + " " ] =
+ ( responseHeaders[ match[ 1 ].toLowerCase() + " " ] || [] )
+ .concat( match[ 2 ] );
+ }
+ }
+ match = responseHeaders[ key.toLowerCase() + " " ];
+ }
+ return match == null ? null : match.join( ", " );
+ },
+
+ // Raw string
+ getAllResponseHeaders: function() {
+ return completed ? responseHeadersString : null;
+ },
+
+ // Caches the header
+ setRequestHeader: function( name, value ) {
+ if ( completed == null ) {
+ name = requestHeadersNames[ name.toLowerCase() ] =
+ requestHeadersNames[ name.toLowerCase() ] || name;
+ requestHeaders[ name ] = value;
+ }
+ return this;
+ },
+
+ // Overrides response content-type header
+ overrideMimeType: function( type ) {
+ if ( completed == null ) {
+ s.mimeType = type;
+ }
+ return this;
+ },
+
+ // Status-dependent callbacks
+ statusCode: function( map ) {
+ var code;
+ if ( map ) {
+ if ( completed ) {
+
+ // Execute the appropriate callbacks
+ jqXHR.always( map[ jqXHR.status ] );
+ } else {
+
+ // Lazy-add the new callbacks in a way that preserves old ones
+ for ( code in map ) {
+ statusCode[ code ] = [ statusCode[ code ], map[ code ] ];
+ }
+ }
+ }
+ return this;
+ },
+
+ // Cancel the request
+ abort: function( statusText ) {
+ var finalText = statusText || strAbort;
+ if ( transport ) {
+ transport.abort( finalText );
+ }
+ done( 0, finalText );
+ return this;
+ }
+ };
+
+ // Attach deferreds
+ deferred.promise( jqXHR );
+
+ // Add protocol if not provided (prefilters might expect it)
+ // Handle falsy url in the settings object (#10093: consistency with old signature)
+ // We also use the url parameter if available
+ s.url = ( ( url || s.url || location.href ) + "" )
+ .replace( rprotocol, location.protocol + "//" );
+
+ // Alias method option to type as per ticket #12004
+ s.type = options.method || options.type || s.method || s.type;
+
+ // Extract dataTypes list
+ s.dataTypes = ( s.dataType || "*" ).toLowerCase().match( rnothtmlwhite ) || [ "" ];
+
+ // A cross-domain request is in order when the origin doesn't match the current origin.
+ if ( s.crossDomain == null ) {
+ urlAnchor = document.createElement( "a" );
+
+ // Support: IE <=8 - 11, Edge 12 - 15
+ // IE throws exception on accessing the href property if url is malformed,
+ // e.g. http://example.com:80x/
+ try {
+ urlAnchor.href = s.url;
+
+ // Support: IE <=8 - 11 only
+ // Anchor's host property isn't correctly set when s.url is relative
+ urlAnchor.href = urlAnchor.href;
+ s.crossDomain = originAnchor.protocol + "//" + originAnchor.host !==
+ urlAnchor.protocol + "//" + urlAnchor.host;
+ } catch ( e ) {
+
+ // If there is an error parsing the URL, assume it is crossDomain,
+ // it can be rejected by the transport if it is invalid
+ s.crossDomain = true;
+ }
+ }
+
+ // Convert data if not already a string
+ if ( s.data && s.processData && typeof s.data !== "string" ) {
+ s.data = jQuery.param( s.data, s.traditional );
+ }
+
+ // Apply prefilters
+ inspectPrefiltersOrTransports( prefilters, s, options, jqXHR );
+
+ // If request was aborted inside a prefilter, stop there
+ if ( completed ) {
+ return jqXHR;
+ }
+
+ // We can fire global events as of now if asked to
+ // Don't fire events if jQuery.event is undefined in an AMD-usage scenario (#15118)
+ fireGlobals = jQuery.event && s.global;
+
+ // Watch for a new set of requests
+ if ( fireGlobals && jQuery.active++ === 0 ) {
+ jQuery.event.trigger( "ajaxStart" );
+ }
+
+ // Uppercase the type
+ s.type = s.type.toUpperCase();
+
+ // Determine if request has content
+ s.hasContent = !rnoContent.test( s.type );
+
+ // Save the URL in case we're toying with the If-Modified-Since
+ // and/or If-None-Match header later on
+ // Remove hash to simplify url manipulation
+ cacheURL = s.url.replace( rhash, "" );
+
+ // More options handling for requests with no content
+ if ( !s.hasContent ) {
+
+ // Remember the hash so we can put it back
+ uncached = s.url.slice( cacheURL.length );
+
+ // If data is available and should be processed, append data to url
+ if ( s.data && ( s.processData || typeof s.data === "string" ) ) {
+ cacheURL += ( rquery.test( cacheURL ) ? "&" : "?" ) + s.data;
+
+ // #9682: remove data so that it's not used in an eventual retry
+ delete s.data;
+ }
+
+ // Add or update anti-cache param if needed
+ if ( s.cache === false ) {
+ cacheURL = cacheURL.replace( rantiCache, "$1" );
+ uncached = ( rquery.test( cacheURL ) ? "&" : "?" ) + "_=" + ( nonce.guid++ ) +
+ uncached;
+ }
+
+ // Put hash and anti-cache on the URL that will be requested (gh-1732)
+ s.url = cacheURL + uncached;
+
+ // Change '%20' to '+' if this is encoded form body content (gh-2658)
+ } else if ( s.data && s.processData &&
+ ( s.contentType || "" ).indexOf( "application/x-www-form-urlencoded" ) === 0 ) {
+ s.data = s.data.replace( r20, "+" );
+ }
+
+ // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode.
+ if ( s.ifModified ) {
+ if ( jQuery.lastModified[ cacheURL ] ) {
+ jqXHR.setRequestHeader( "If-Modified-Since", jQuery.lastModified[ cacheURL ] );
+ }
+ if ( jQuery.etag[ cacheURL ] ) {
+ jqXHR.setRequestHeader( "If-None-Match", jQuery.etag[ cacheURL ] );
+ }
+ }
+
+ // Set the correct header, if data is being sent
+ if ( s.data && s.hasContent && s.contentType !== false || options.contentType ) {
+ jqXHR.setRequestHeader( "Content-Type", s.contentType );
+ }
+
+ // Set the Accepts header for the server, depending on the dataType
+ jqXHR.setRequestHeader(
+ "Accept",
+ s.dataTypes[ 0 ] && s.accepts[ s.dataTypes[ 0 ] ] ?
+ s.accepts[ s.dataTypes[ 0 ] ] +
+ ( s.dataTypes[ 0 ] !== "*" ? ", " + allTypes + "; q=0.01" : "" ) :
+ s.accepts[ "*" ]
+ );
+
+ // Check for headers option
+ for ( i in s.headers ) {
+ jqXHR.setRequestHeader( i, s.headers[ i ] );
+ }
+
+ // Allow custom headers/mimetypes and early abort
+ if ( s.beforeSend &&
+ ( s.beforeSend.call( callbackContext, jqXHR, s ) === false || completed ) ) {
+
+ // Abort if not done already and return
+ return jqXHR.abort();
+ }
+
+ // Aborting is no longer a cancellation
+ strAbort = "abort";
+
+ // Install callbacks on deferreds
+ completeDeferred.add( s.complete );
+ jqXHR.done( s.success );
+ jqXHR.fail( s.error );
+
+ // Get transport
+ transport = inspectPrefiltersOrTransports( transports, s, options, jqXHR );
+
+ // If no transport, we auto-abort
+ if ( !transport ) {
+ done( -1, "No Transport" );
+ } else {
+ jqXHR.readyState = 1;
+
+ // Send global event
+ if ( fireGlobals ) {
+ globalEventContext.trigger( "ajaxSend", [ jqXHR, s ] );
+ }
+
+ // If request was aborted inside ajaxSend, stop there
+ if ( completed ) {
+ return jqXHR;
+ }
+
+ // Timeout
+ if ( s.async && s.timeout > 0 ) {
+ timeoutTimer = window.setTimeout( function() {
+ jqXHR.abort( "timeout" );
+ }, s.timeout );
+ }
+
+ try {
+ completed = false;
+ transport.send( requestHeaders, done );
+ } catch ( e ) {
+
+ // Rethrow post-completion exceptions
+ if ( completed ) {
+ throw e;
+ }
+
+ // Propagate others as results
+ done( -1, e );
+ }
+ }
+
+ // Callback for when everything is done
+ function done( status, nativeStatusText, responses, headers ) {
+ var isSuccess, success, error, response, modified,
+ statusText = nativeStatusText;
+
+ // Ignore repeat invocations
+ if ( completed ) {
+ return;
+ }
+
+ completed = true;
+
+ // Clear timeout if it exists
+ if ( timeoutTimer ) {
+ window.clearTimeout( timeoutTimer );
+ }
+
+ // Dereference transport for early garbage collection
+ // (no matter how long the jqXHR object will be used)
+ transport = undefined;
+
+ // Cache response headers
+ responseHeadersString = headers || "";
+
+ // Set readyState
+ jqXHR.readyState = status > 0 ? 4 : 0;
+
+ // Determine if successful
+ isSuccess = status >= 200 && status < 300 || status === 304;
+
+ // Get response data
+ if ( responses ) {
+ response = ajaxHandleResponses( s, jqXHR, responses );
+ }
+
+ // Use a noop converter for missing script
+ if ( !isSuccess && jQuery.inArray( "script", s.dataTypes ) > -1 ) {
+ s.converters[ "text script" ] = function() {};
+ }
+
+ // Convert no matter what (that way responseXXX fields are always set)
+ response = ajaxConvert( s, response, jqXHR, isSuccess );
+
+ // If successful, handle type chaining
+ if ( isSuccess ) {
+
+ // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode.
+ if ( s.ifModified ) {
+ modified = jqXHR.getResponseHeader( "Last-Modified" );
+ if ( modified ) {
+ jQuery.lastModified[ cacheURL ] = modified;
+ }
+ modified = jqXHR.getResponseHeader( "etag" );
+ if ( modified ) {
+ jQuery.etag[ cacheURL ] = modified;
+ }
+ }
+
+ // if no content
+ if ( status === 204 || s.type === "HEAD" ) {
+ statusText = "nocontent";
+
+ // if not modified
+ } else if ( status === 304 ) {
+ statusText = "notmodified";
+
+ // If we have data, let's convert it
+ } else {
+ statusText = response.state;
+ success = response.data;
+ error = response.error;
+ isSuccess = !error;
+ }
+ } else {
+
+ // Extract error from statusText and normalize for non-aborts
+ error = statusText;
+ if ( status || !statusText ) {
+ statusText = "error";
+ if ( status < 0 ) {
+ status = 0;
+ }
+ }
+ }
+
+ // Set data for the fake xhr object
+ jqXHR.status = status;
+ jqXHR.statusText = ( nativeStatusText || statusText ) + "";
+
+ // Success/Error
+ if ( isSuccess ) {
+ deferred.resolveWith( callbackContext, [ success, statusText, jqXHR ] );
+ } else {
+ deferred.rejectWith( callbackContext, [ jqXHR, statusText, error ] );
+ }
+
+ // Status-dependent callbacks
+ jqXHR.statusCode( statusCode );
+ statusCode = undefined;
+
+ if ( fireGlobals ) {
+ globalEventContext.trigger( isSuccess ? "ajaxSuccess" : "ajaxError",
+ [ jqXHR, s, isSuccess ? success : error ] );
+ }
+
+ // Complete
+ completeDeferred.fireWith( callbackContext, [ jqXHR, statusText ] );
+
+ if ( fireGlobals ) {
+ globalEventContext.trigger( "ajaxComplete", [ jqXHR, s ] );
+
+ // Handle the global AJAX counter
+ if ( !( --jQuery.active ) ) {
+ jQuery.event.trigger( "ajaxStop" );
+ }
+ }
+ }
+
+ return jqXHR;
+ },
+
+ getJSON: function( url, data, callback ) {
+ return jQuery.get( url, data, callback, "json" );
+ },
+
+ getScript: function( url, callback ) {
+ return jQuery.get( url, undefined, callback, "script" );
+ }
+} );
+
+jQuery.each( [ "get", "post" ], function( _i, method ) {
+ jQuery[ method ] = function( url, data, callback, type ) {
+
+ // Shift arguments if data argument was omitted
+ if ( isFunction( data ) ) {
+ type = type || callback;
+ callback = data;
+ data = undefined;
+ }
+
+ // The url can be an options object (which then must have .url)
+ return jQuery.ajax( jQuery.extend( {
+ url: url,
+ type: method,
+ dataType: type,
+ data: data,
+ success: callback
+ }, jQuery.isPlainObject( url ) && url ) );
+ };
+} );
+
+jQuery.ajaxPrefilter( function( s ) {
+ var i;
+ for ( i in s.headers ) {
+ if ( i.toLowerCase() === "content-type" ) {
+ s.contentType = s.headers[ i ] || "";
+ }
+ }
+} );
+
+
+jQuery._evalUrl = function( url, options, doc ) {
+ return jQuery.ajax( {
+ url: url,
+
+ // Make this explicit, since user can override this through ajaxSetup (#11264)
+ type: "GET",
+ dataType: "script",
+ cache: true,
+ async: false,
+ global: false,
+
+ // Only evaluate the response if it is successful (gh-4126)
+ // dataFilter is not invoked for failure responses, so using it instead
+ // of the default converter is kludgy but it works.
+ converters: {
+ "text script": function() {}
+ },
+ dataFilter: function( response ) {
+ jQuery.globalEval( response, options, doc );
+ }
+ } );
+};
+
+
+jQuery.fn.extend( {
+ wrapAll: function( html ) {
+ var wrap;
+
+ if ( this[ 0 ] ) {
+ if ( isFunction( html ) ) {
+ html = html.call( this[ 0 ] );
+ }
+
+ // The elements to wrap the target around
+ wrap = jQuery( html, this[ 0 ].ownerDocument ).eq( 0 ).clone( true );
+
+ if ( this[ 0 ].parentNode ) {
+ wrap.insertBefore( this[ 0 ] );
+ }
+
+ wrap.map( function() {
+ var elem = this;
+
+ while ( elem.firstElementChild ) {
+ elem = elem.firstElementChild;
+ }
+
+ return elem;
+ } ).append( this );
+ }
+
+ return this;
+ },
+
+ wrapInner: function( html ) {
+ if ( isFunction( html ) ) {
+ return this.each( function( i ) {
+ jQuery( this ).wrapInner( html.call( this, i ) );
+ } );
+ }
+
+ return this.each( function() {
+ var self = jQuery( this ),
+ contents = self.contents();
+
+ if ( contents.length ) {
+ contents.wrapAll( html );
+
+ } else {
+ self.append( html );
+ }
+ } );
+ },
+
+ wrap: function( html ) {
+ var htmlIsFunction = isFunction( html );
+
+ return this.each( function( i ) {
+ jQuery( this ).wrapAll( htmlIsFunction ? html.call( this, i ) : html );
+ } );
+ },
+
+ unwrap: function( selector ) {
+ this.parent( selector ).not( "body" ).each( function() {
+ jQuery( this ).replaceWith( this.childNodes );
+ } );
+ return this;
+ }
+} );
+
+
+jQuery.expr.pseudos.hidden = function( elem ) {
+ return !jQuery.expr.pseudos.visible( elem );
+};
+jQuery.expr.pseudos.visible = function( elem ) {
+ return !!( elem.offsetWidth || elem.offsetHeight || elem.getClientRects().length );
+};
+
+
+
+
+jQuery.ajaxSettings.xhr = function() {
+ try {
+ return new window.XMLHttpRequest();
+ } catch ( e ) {}
+};
+
+var xhrSuccessStatus = {
+
+ // File protocol always yields status code 0, assume 200
+ 0: 200,
+
+ // Support: IE <=9 only
+ // #1450: sometimes IE returns 1223 when it should be 204
+ 1223: 204
+ },
+ xhrSupported = jQuery.ajaxSettings.xhr();
+
+support.cors = !!xhrSupported && ( "withCredentials" in xhrSupported );
+support.ajax = xhrSupported = !!xhrSupported;
+
+jQuery.ajaxTransport( function( options ) {
+ var callback, errorCallback;
+
+ // Cross domain only allowed if supported through XMLHttpRequest
+ if ( support.cors || xhrSupported && !options.crossDomain ) {
+ return {
+ send: function( headers, complete ) {
+ var i,
+ xhr = options.xhr();
+
+ xhr.open(
+ options.type,
+ options.url,
+ options.async,
+ options.username,
+ options.password
+ );
+
+ // Apply custom fields if provided
+ if ( options.xhrFields ) {
+ for ( i in options.xhrFields ) {
+ xhr[ i ] = options.xhrFields[ i ];
+ }
+ }
+
+ // Override mime type if needed
+ if ( options.mimeType && xhr.overrideMimeType ) {
+ xhr.overrideMimeType( options.mimeType );
+ }
+
+ // X-Requested-With header
+ // For cross-domain requests, seeing as conditions for a preflight are
+ // akin to a jigsaw puzzle, we simply never set it to be sure.
+ // (it can always be set on a per-request basis or even using ajaxSetup)
+ // For same-domain requests, won't change header if already provided.
+ if ( !options.crossDomain && !headers[ "X-Requested-With" ] ) {
+ headers[ "X-Requested-With" ] = "XMLHttpRequest";
+ }
+
+ // Set headers
+ for ( i in headers ) {
+ xhr.setRequestHeader( i, headers[ i ] );
+ }
+
+ // Callback
+ callback = function( type ) {
+ return function() {
+ if ( callback ) {
+ callback = errorCallback = xhr.onload =
+ xhr.onerror = xhr.onabort = xhr.ontimeout =
+ xhr.onreadystatechange = null;
+
+ if ( type === "abort" ) {
+ xhr.abort();
+ } else if ( type === "error" ) {
+
+ // Support: IE <=9 only
+ // On a manual native abort, IE9 throws
+ // errors on any property access that is not readyState
+ if ( typeof xhr.status !== "number" ) {
+ complete( 0, "error" );
+ } else {
+ complete(
+
+ // File: protocol always yields status 0; see #8605, #14207
+ xhr.status,
+ xhr.statusText
+ );
+ }
+ } else {
+ complete(
+ xhrSuccessStatus[ xhr.status ] || xhr.status,
+ xhr.statusText,
+
+ // Support: IE <=9 only
+ // IE9 has no XHR2 but throws on binary (trac-11426)
+ // For XHR2 non-text, let the caller handle it (gh-2498)
+ ( xhr.responseType || "text" ) !== "text" ||
+ typeof xhr.responseText !== "string" ?
+ { binary: xhr.response } :
+ { text: xhr.responseText },
+ xhr.getAllResponseHeaders()
+ );
+ }
+ }
+ };
+ };
+
+ // Listen to events
+ xhr.onload = callback();
+ errorCallback = xhr.onerror = xhr.ontimeout = callback( "error" );
+
+ // Support: IE 9 only
+ // Use onreadystatechange to replace onabort
+ // to handle uncaught aborts
+ if ( xhr.onabort !== undefined ) {
+ xhr.onabort = errorCallback;
+ } else {
+ xhr.onreadystatechange = function() {
+
+ // Check readyState before timeout as it changes
+ if ( xhr.readyState === 4 ) {
+
+ // Allow onerror to be called first,
+ // but that will not handle a native abort
+ // Also, save errorCallback to a variable
+ // as xhr.onerror cannot be accessed
+ window.setTimeout( function() {
+ if ( callback ) {
+ errorCallback();
+ }
+ } );
+ }
+ };
+ }
+
+ // Create the abort callback
+ callback = callback( "abort" );
+
+ try {
+
+ // Do send the request (this may raise an exception)
+ xhr.send( options.hasContent && options.data || null );
+ } catch ( e ) {
+
+ // #14683: Only rethrow if this hasn't been notified as an error yet
+ if ( callback ) {
+ throw e;
+ }
+ }
+ },
+
+ abort: function() {
+ if ( callback ) {
+ callback();
+ }
+ }
+ };
+ }
+} );
+
+
+
+
+// Prevent auto-execution of scripts when no explicit dataType was provided (See gh-2432)
+jQuery.ajaxPrefilter( function( s ) {
+ if ( s.crossDomain ) {
+ s.contents.script = false;
+ }
+} );
+
+// Install script dataType
+jQuery.ajaxSetup( {
+ accepts: {
+ script: "text/javascript, application/javascript, " +
+ "application/ecmascript, application/x-ecmascript"
+ },
+ contents: {
+ script: /\b(?:java|ecma)script\b/
+ },
+ converters: {
+ "text script": function( text ) {
+ jQuery.globalEval( text );
+ return text;
+ }
+ }
+} );
+
+// Handle cache's special case and crossDomain
+jQuery.ajaxPrefilter( "script", function( s ) {
+ if ( s.cache === undefined ) {
+ s.cache = false;
+ }
+ if ( s.crossDomain ) {
+ s.type = "GET";
+ }
+} );
+
+// Bind script tag hack transport
+jQuery.ajaxTransport( "script", function( s ) {
+
+ // This transport only deals with cross domain or forced-by-attrs requests
+ if ( s.crossDomain || s.scriptAttrs ) {
+ var script, callback;
+ return {
+ send: function( _, complete ) {
+ script = jQuery( "<script>" )
+ .attr( s.scriptAttrs || {} )
+ .prop( { charset: s.scriptCharset, src: s.url } )
+ .on( "load error", callback = function( evt ) {
+ script.remove();
+ callback = null;
+ if ( evt ) {
+ complete( evt.type === "error" ? 404 : 200, evt.type );
+ }
+ } );
+
+ // Use native DOM manipulation to avoid our domManip AJAX trickery
+ document.head.appendChild( script[ 0 ] );
+ },
+ abort: function() {
+ if ( callback ) {
+ callback();
+ }
+ }
+ };
+ }
+} );
+
+
+
+
+var oldCallbacks = [],
+ rjsonp = /(=)\?(?=&|$)|\?\?/;
+
+// Default jsonp settings
+jQuery.ajaxSetup( {
+ jsonp: "callback",
+ jsonpCallback: function() {
+ var callback = oldCallbacks.pop() || ( jQuery.expando + "_" + ( nonce.guid++ ) );
+ this[ callback ] = true;
+ return callback;
+ }
+} );
+
+// Detect, normalize options and install callbacks for jsonp requests
+jQuery.ajaxPrefilter( "json jsonp", function( s, originalSettings, jqXHR ) {
+
+ var callbackName, overwritten, responseContainer,
+ jsonProp = s.jsonp !== false && ( rjsonp.test( s.url ) ?
+ "url" :
+ typeof s.data === "string" &&
+ ( s.contentType || "" )
+ .indexOf( "application/x-www-form-urlencoded" ) === 0 &&
+ rjsonp.test( s.data ) && "data"
+ );
+
+ // Handle iff the expected data type is "jsonp" or we have a parameter to set
+ if ( jsonProp || s.dataTypes[ 0 ] === "jsonp" ) {
+
+ // Get callback name, remembering preexisting value associated with it
+ callbackName = s.jsonpCallback = isFunction( s.jsonpCallback ) ?
+ s.jsonpCallback() :
+ s.jsonpCallback;
+
+ // Insert callback into url or form data
+ if ( jsonProp ) {
+ s[ jsonProp ] = s[ jsonProp ].replace( rjsonp, "$1" + callbackName );
+ } else if ( s.jsonp !== false ) {
+ s.url += ( rquery.test( s.url ) ? "&" : "?" ) + s.jsonp + "=" + callbackName;
+ }
+
+ // Use data converter to retrieve json after script execution
+ s.converters[ "script json" ] = function() {
+ if ( !responseContainer ) {
+ jQuery.error( callbackName + " was not called" );
+ }
+ return responseContainer[ 0 ];
+ };
+
+ // Force json dataType
+ s.dataTypes[ 0 ] = "json";
+
+ // Install callback
+ overwritten = window[ callbackName ];
+ window[ callbackName ] = function() {
+ responseContainer = arguments;
+ };
+
+ // Clean-up function (fires after converters)
+ jqXHR.always( function() {
+
+ // If previous value didn't exist - remove it
+ if ( overwritten === undefined ) {
+ jQuery( window ).removeProp( callbackName );
+
+ // Otherwise restore preexisting value
+ } else {
+ window[ callbackName ] = overwritten;
+ }
+
+ // Save back as free
+ if ( s[ callbackName ] ) {
+
+ // Make sure that re-using the options doesn't screw things around
+ s.jsonpCallback = originalSettings.jsonpCallback;
+
+ // Save the callback name for future use
+ oldCallbacks.push( callbackName );
+ }
+
+ // Call if it was a function and we have a response
+ if ( responseContainer && isFunction( overwritten ) ) {
+ overwritten( responseContainer[ 0 ] );
+ }
+
+ responseContainer = overwritten = undefined;
+ } );
+
+ // Delegate to script
+ return "script";
+ }
+} );
+
+
+
+
+// Support: Safari 8 only
+// In Safari 8 documents created via document.implementation.createHTMLDocument
+// collapse sibling forms: the second one becomes a child of the first one.
+// Because of that, this security measure has to be disabled in Safari 8.
+// https://bugs.webkit.org/show_bug.cgi?id=137337
+support.createHTMLDocument = ( function() {
+ var body = document.implementation.createHTMLDocument( "" ).body;
+ body.innerHTML = "<form></form><form></form>";
+ return body.childNodes.length === 2;
+} )();
+
+
+// Argument "data" should be string of html
+// context (optional): If specified, the fragment will be created in this context,
+// defaults to document
+// keepScripts (optional): If true, will include scripts passed in the html string
+jQuery.parseHTML = function( data, context, keepScripts ) {
+ if ( typeof data !== "string" ) {
+ return [];
+ }
+ if ( typeof context === "boolean" ) {
+ keepScripts = context;
+ context = false;
+ }
+
+ var base, parsed, scripts;
+
+ if ( !context ) {
+
+ // Stop scripts or inline event handlers from being executed immediately
+ // by using document.implementation
+ if ( support.createHTMLDocument ) {
+ context = document.implementation.createHTMLDocument( "" );
+
+ // Set the base href for the created document
+ // so any parsed elements with URLs
+ // are based on the document's URL (gh-2965)
+ base = context.createElement( "base" );
+ base.href = document.location.href;
+ context.head.appendChild( base );
+ } else {
+ context = document;
+ }
+ }
+
+ parsed = rsingleTag.exec( data );
+ scripts = !keepScripts && [];
+
+ // Single tag
+ if ( parsed ) {
+ return [ context.createElement( parsed[ 1 ] ) ];
+ }
+
+ parsed = buildFragment( [ data ], context, scripts );
+
+ if ( scripts && scripts.length ) {
+ jQuery( scripts ).remove();
+ }
+
+ return jQuery.merge( [], parsed.childNodes );
+};
+
+
+/**
+ * Load a url into a page
+ */
+jQuery.fn.load = function( url, params, callback ) {
+ var selector, type, response,
+ self = this,
+ off = url.indexOf( " " );
+
+ if ( off > -1 ) {
+ selector = stripAndCollapse( url.slice( off ) );
+ url = url.slice( 0, off );
+ }
+
+ // If it's a function
+ if ( isFunction( params ) ) {
+
+ // We assume that it's the callback
+ callback = params;
+ params = undefined;
+
+ // Otherwise, build a param string
+ } else if ( params && typeof params === "object" ) {
+ type = "POST";
+ }
+
+ // If we have elements to modify, make the request
+ if ( self.length > 0 ) {
+ jQuery.ajax( {
+ url: url,
+
+ // If "type" variable is undefined, then "GET" method will be used.
+ // Make value of this field explicit since
+ // user can override it through ajaxSetup method
+ type: type || "GET",
+ dataType: "html",
+ data: params
+ } ).done( function( responseText ) {
+
+ // Save response for use in complete callback
+ response = arguments;
+
+ self.html( selector ?
+
+ // If a selector was specified, locate the right elements in a dummy div
+ // Exclude scripts to avoid IE 'Permission Denied' errors
+ jQuery( "<div>" ).append( jQuery.parseHTML( responseText ) ).find( selector ) :
+
+ // Otherwise use the full result
+ responseText );
+
+ // If the request succeeds, this function gets "data", "status", "jqXHR"
+ // but they are ignored because response was set above.
+ // If it fails, this function gets "jqXHR", "status", "error"
+ } ).always( callback && function( jqXHR, status ) {
+ self.each( function() {
+ callback.apply( this, response || [ jqXHR.responseText, status, jqXHR ] );
+ } );
+ } );
+ }
+
+ return this;
+};
+
+
+
+
+jQuery.expr.pseudos.animated = function( elem ) {
+ return jQuery.grep( jQuery.timers, function( fn ) {
+ return elem === fn.elem;
+ } ).length;
+};
+
+
+
+
+jQuery.offset = {
+ setOffset: function( elem, options, i ) {
+ var curPosition, curLeft, curCSSTop, curTop, curOffset, curCSSLeft, calculatePosition,
+ position = jQuery.css( elem, "position" ),
+ curElem = jQuery( elem ),
+ props = {};
+
+ // Set position first, in-case top/left are set even on static elem
+ if ( position === "static" ) {
+ elem.style.position = "relative";
+ }
+
+ curOffset = curElem.offset();
+ curCSSTop = jQuery.css( elem, "top" );
+ curCSSLeft = jQuery.css( elem, "left" );
+ calculatePosition = ( position === "absolute" || position === "fixed" ) &&
+ ( curCSSTop + curCSSLeft ).indexOf( "auto" ) > -1;
+
+ // Need to be able to calculate position if either
+ // top or left is auto and position is either absolute or fixed
+ if ( calculatePosition ) {
+ curPosition = curElem.position();
+ curTop = curPosition.top;
+ curLeft = curPosition.left;
+
+ } else {
+ curTop = parseFloat( curCSSTop ) || 0;
+ curLeft = parseFloat( curCSSLeft ) || 0;
+ }
+
+ if ( isFunction( options ) ) {
+
+ // Use jQuery.extend here to allow modification of coordinates argument (gh-1848)
+ options = options.call( elem, i, jQuery.extend( {}, curOffset ) );
+ }
+
+ if ( options.top != null ) {
+ props.top = ( options.top - curOffset.top ) + curTop;
+ }
+ if ( options.left != null ) {
+ props.left = ( options.left - curOffset.left ) + curLeft;
+ }
+
+ if ( "using" in options ) {
+ options.using.call( elem, props );
+
+ } else {
+ if ( typeof props.top === "number" ) {
+ props.top += "px";
+ }
+ if ( typeof props.left === "number" ) {
+ props.left += "px";
+ }
+ curElem.css( props );
+ }
+ }
+};
+
+jQuery.fn.extend( {
+
+ // offset() relates an element's border box to the document origin
+ offset: function( options ) {
+
+ // Preserve chaining for setter
+ if ( arguments.length ) {
+ return options === undefined ?
+ this :
+ this.each( function( i ) {
+ jQuery.offset.setOffset( this, options, i );
+ } );
+ }
+
+ var rect, win,
+ elem = this[ 0 ];
+
+ if ( !elem ) {
+ return;
+ }
+
+ // Return zeros for disconnected and hidden (display: none) elements (gh-2310)
+ // Support: IE <=11 only
+ // Running getBoundingClientRect on a
+ // disconnected node in IE throws an error
+ if ( !elem.getClientRects().length ) {
+ return { top: 0, left: 0 };
+ }
+
+ // Get document-relative position by adding viewport scroll to viewport-relative gBCR
+ rect = elem.getBoundingClientRect();
+ win = elem.ownerDocument.defaultView;
+ return {
+ top: rect.top + win.pageYOffset,
+ left: rect.left + win.pageXOffset
+ };
+ },
+
+ // position() relates an element's margin box to its offset parent's padding box
+ // This corresponds to the behavior of CSS absolute positioning
+ position: function() {
+ if ( !this[ 0 ] ) {
+ return;
+ }
+
+ var offsetParent, offset, doc,
+ elem = this[ 0 ],
+ parentOffset = { top: 0, left: 0 };
+
+ // position:fixed elements are offset from the viewport, which itself always has zero offset
+ if ( jQuery.css( elem, "position" ) === "fixed" ) {
+
+ // Assume position:fixed implies availability of getBoundingClientRect
+ offset = elem.getBoundingClientRect();
+
+ } else {
+ offset = this.offset();
+
+ // Account for the *real* offset parent, which can be the document or its root element
+ // when a statically positioned element is identified
+ doc = elem.ownerDocument;
+ offsetParent = elem.offsetParent || doc.documentElement;
+ while ( offsetParent &&
+ ( offsetParent === doc.body || offsetParent === doc.documentElement ) &&
+ jQuery.css( offsetParent, "position" ) === "static" ) {
+
+ offsetParent = offsetParent.parentNode;
+ }
+ if ( offsetParent && offsetParent !== elem && offsetParent.nodeType === 1 ) {
+
+ // Incorporate borders into its offset, since they are outside its content origin
+ parentOffset = jQuery( offsetParent ).offset();
+ parentOffset.top += jQuery.css( offsetParent, "borderTopWidth", true );
+ parentOffset.left += jQuery.css( offsetParent, "borderLeftWidth", true );
+ }
+ }
+
+ // Subtract parent offsets and element margins
+ return {
+ top: offset.top - parentOffset.top - jQuery.css( elem, "marginTop", true ),
+ left: offset.left - parentOffset.left - jQuery.css( elem, "marginLeft", true )
+ };
+ },
+
+ // This method will return documentElement in the following cases:
+ // 1) For the element inside the iframe without offsetParent, this method will return
+ // documentElement of the parent window
+ // 2) For the hidden or detached element
+ // 3) For body or html element, i.e. in case of the html node - it will return itself
+ //
+ // but those exceptions were never presented as a real life use-cases
+ // and might be considered as more preferable results.
+ //
+ // This logic, however, is not guaranteed and can change at any point in the future
+ offsetParent: function() {
+ return this.map( function() {
+ var offsetParent = this.offsetParent;
+
+ while ( offsetParent && jQuery.css( offsetParent, "position" ) === "static" ) {
+ offsetParent = offsetParent.offsetParent;
+ }
+
+ return offsetParent || documentElement;
+ } );
+ }
+} );
+
+// Create scrollLeft and scrollTop methods
+jQuery.each( { scrollLeft: "pageXOffset", scrollTop: "pageYOffset" }, function( method, prop ) {
+ var top = "pageYOffset" === prop;
+
+ jQuery.fn[ method ] = function( val ) {
+ return access( this, function( elem, method, val ) {
+
+ // Coalesce documents and windows
+ var win;
+ if ( isWindow( elem ) ) {
+ win = elem;
+ } else if ( elem.nodeType === 9 ) {
+ win = elem.defaultView;
+ }
+
+ if ( val === undefined ) {
+ return win ? win[ prop ] : elem[ method ];
+ }
+
+ if ( win ) {
+ win.scrollTo(
+ !top ? val : win.pageXOffset,
+ top ? val : win.pageYOffset
+ );
+
+ } else {
+ elem[ method ] = val;
+ }
+ }, method, val, arguments.length );
+ };
+} );
+
+// Support: Safari <=7 - 9.1, Chrome <=37 - 49
+// Add the top/left cssHooks using jQuery.fn.position
+// Webkit bug: https://bugs.webkit.org/show_bug.cgi?id=29084
+// Blink bug: https://bugs.chromium.org/p/chromium/issues/detail?id=589347
+// getComputedStyle returns percent when specified for top/left/bottom/right;
+// rather than make the css module depend on the offset module, just check for it here
+jQuery.each( [ "top", "left" ], function( _i, prop ) {
+ jQuery.cssHooks[ prop ] = addGetHookIf( support.pixelPosition,
+ function( elem, computed ) {
+ if ( computed ) {
+ computed = curCSS( elem, prop );
+
+ // If curCSS returns percentage, fallback to offset
+ return rnumnonpx.test( computed ) ?
+ jQuery( elem ).position()[ prop ] + "px" :
+ computed;
+ }
+ }
+ );
+} );
+
+
+// Create innerHeight, innerWidth, height, width, outerHeight and outerWidth methods
+jQuery.each( { Height: "height", Width: "width" }, function( name, type ) {
+ jQuery.each( { padding: "inner" + name, content: type, "": "outer" + name },
+ function( defaultExtra, funcName ) {
+
+ // Margin is only for outerHeight, outerWidth
+ jQuery.fn[ funcName ] = function( margin, value ) {
+ var chainable = arguments.length && ( defaultExtra || typeof margin !== "boolean" ),
+ extra = defaultExtra || ( margin === true || value === true ? "margin" : "border" );
+
+ return access( this, function( elem, type, value ) {
+ var doc;
+
+ if ( isWindow( elem ) ) {
+
+ // $( window ).outerWidth/Height return w/h including scrollbars (gh-1729)
+ return funcName.indexOf( "outer" ) === 0 ?
+ elem[ "inner" + name ] :
+ elem.document.documentElement[ "client" + name ];
+ }
+
+ // Get document width or height
+ if ( elem.nodeType === 9 ) {
+ doc = elem.documentElement;
+
+ // Either scroll[Width/Height] or offset[Width/Height] or client[Width/Height],
+ // whichever is greatest
+ return Math.max(
+ elem.body[ "scroll" + name ], doc[ "scroll" + name ],
+ elem.body[ "offset" + name ], doc[ "offset" + name ],
+ doc[ "client" + name ]
+ );
+ }
+
+ return value === undefined ?
+
+ // Get width or height on the element, requesting but not forcing parseFloat
+ jQuery.css( elem, type, extra ) :
+
+ // Set width or height on the element
+ jQuery.style( elem, type, value, extra );
+ }, type, chainable ? margin : undefined, chainable );
+ };
+ } );
+} );
+
+
+jQuery.each( [
+ "ajaxStart",
+ "ajaxStop",
+ "ajaxComplete",
+ "ajaxError",
+ "ajaxSuccess",
+ "ajaxSend"
+], function( _i, type ) {
+ jQuery.fn[ type ] = function( fn ) {
+ return this.on( type, fn );
+ };
+} );
+
+
+
+
+jQuery.fn.extend( {
+
+ bind: function( types, data, fn ) {
+ return this.on( types, null, data, fn );
+ },
+ unbind: function( types, fn ) {
+ return this.off( types, null, fn );
+ },
+
+ delegate: function( selector, types, data, fn ) {
+ return this.on( types, selector, data, fn );
+ },
+ undelegate: function( selector, types, fn ) {
+
+ // ( namespace ) or ( selector, types [, fn] )
+ return arguments.length === 1 ?
+ this.off( selector, "**" ) :
+ this.off( types, selector || "**", fn );
+ },
+
+ hover: function( fnOver, fnOut ) {
+ return this.mouseenter( fnOver ).mouseleave( fnOut || fnOver );
+ }
+} );
+
+jQuery.each( ( "blur focus focusin focusout resize scroll click dblclick " +
+ "mousedown mouseup mousemove mouseover mouseout mouseenter mouseleave " +
+ "change select submit keydown keypress keyup contextmenu" ).split( " " ),
+ function( _i, name ) {
+
+ // Handle event binding
+ jQuery.fn[ name ] = function( data, fn ) {
+ return arguments.length > 0 ?
+ this.on( name, null, data, fn ) :
+ this.trigger( name );
+ };
+ } );
+
+
+
+
+// Support: Android <=4.0 only
+// Make sure we trim BOM and NBSP
+var rtrim = /^[\s\uFEFF\xA0]+|[\s\uFEFF\xA0]+$/g;
+
+// Bind a function to a context, optionally partially applying any
+// arguments.
+// jQuery.proxy is deprecated to promote standards (specifically Function#bind)
+// However, it is not slated for removal any time soon
+jQuery.proxy = function( fn, context ) {
+ var tmp, args, proxy;
+
+ if ( typeof context === "string" ) {
+ tmp = fn[ context ];
+ context = fn;
+ fn = tmp;
+ }
+
+ // Quick check to determine if target is callable, in the spec
+ // this throws a TypeError, but we will just return undefined.
+ if ( !isFunction( fn ) ) {
+ return undefined;
+ }
+
+ // Simulated bind
+ args = slice.call( arguments, 2 );
+ proxy = function() {
+ return fn.apply( context || this, args.concat( slice.call( arguments ) ) );
+ };
+
+ // Set the guid of unique handler to the same of original handler, so it can be removed
+ proxy.guid = fn.guid = fn.guid || jQuery.guid++;
+
+ return proxy;
+};
+
+jQuery.holdReady = function( hold ) {
+ if ( hold ) {
+ jQuery.readyWait++;
+ } else {
+ jQuery.ready( true );
+ }
+};
+jQuery.isArray = Array.isArray;
+jQuery.parseJSON = JSON.parse;
+jQuery.nodeName = nodeName;
+jQuery.isFunction = isFunction;
+jQuery.isWindow = isWindow;
+jQuery.camelCase = camelCase;
+jQuery.type = toType;
+
+jQuery.now = Date.now;
+
+jQuery.isNumeric = function( obj ) {
+
+ // As of jQuery 3.0, isNumeric is limited to
+ // strings and numbers (primitives or objects)
+ // that can be coerced to finite numbers (gh-2662)
+ var type = jQuery.type( obj );
+ return ( type === "number" || type === "string" ) &&
+
+ // parseFloat NaNs numeric-cast false positives ("")
+ // ...but misinterprets leading-number strings, particularly hex literals ("0x...")
+ // subtraction forces infinities to NaN
+ !isNaN( obj - parseFloat( obj ) );
+};
+
+jQuery.trim = function( text ) {
+ return text == null ?
+ "" :
+ ( text + "" ).replace( rtrim, "" );
+};
+
+
+
+// Register as a named AMD module, since jQuery can be concatenated with other
+// files that may use define, but not via a proper concatenation script that
+// understands anonymous AMD modules. A named AMD is safest and most robust
+// way to register. Lowercase jquery is used because AMD module names are
+// derived from file names, and jQuery is normally delivered in a lowercase
+// file name. Do this after creating the global so that if an AMD module wants
+// to call noConflict to hide this version of jQuery, it will work.
+
+// Note that for maximum portability, libraries that are not jQuery should
+// declare themselves as anonymous modules, and avoid setting a global if an
+// AMD loader is present. jQuery is a special case. For more information, see
+// https://github.com/jrburke/requirejs/wiki/Updating-existing-libraries#wiki-anon
+
+if ( typeof define === "function" && define.amd ) {
+ define( "jquery", [], function() {
+ return jQuery;
+ } );
+}
+
+
+
+
+var
+
+ // Map over jQuery in case of overwrite
+ _jQuery = window.jQuery,
+
+ // Map over the $ in case of overwrite
+ _$ = window.$;
+
+jQuery.noConflict = function( deep ) {
+ if ( window.$ === jQuery ) {
+ window.$ = _$;
+ }
+
+ if ( deep && window.jQuery === jQuery ) {
+ window.jQuery = _jQuery;
+ }
+
+ return jQuery;
+};
+
+// Expose jQuery and $ identifiers, even in AMD
+// (#7102#comment:10, https://github.com/jquery/jquery/pull/557)
+// and CommonJS for browser emulators (#13566)
+if ( typeof noGlobal === "undefined" ) {
+ window.jQuery = window.$ = jQuery;
+}
+
+
+
+
+return jQuery;
+} );
diff --git a/docs/_build/html/_static/jquery.js b/docs/_build/html/_static/jquery.js
new file mode 100644
index 0000000000000000000000000000000000000000..b0614034ad3a95e4ae9f53c2b015eeb3e8d68bde
--- /dev/null
+++ b/docs/_build/html/_static/jquery.js
@@ -0,0 +1,2 @@
+/*! jQuery v3.5.1 | (c) JS Foundation and other contributors | jquery.org/license */
+!function(e,t){"use strict";"object"==typeof module&&"object"==typeof module.exports?module.exports=e.document?t(e,!0):function(e){if(!e.document)throw new Error("jQuery requires a window with a document");return t(e)}:t(e)}("undefined"!=typeof window?window:this,function(C,e){"use strict";var t=[],r=Object.getPrototypeOf,s=t.slice,g=t.flat?function(e){return t.flat.call(e)}:function(e){return t.concat.apply([],e)},u=t.push,i=t.indexOf,n={},o=n.toString,v=n.hasOwnProperty,a=v.toString,l=a.call(Object),y={},m=function(e){return"function"==typeof e&&"number"!=typeof e.nodeType},x=function(e){return null!=e&&e===e.window},E=C.document,c={type:!0,src:!0,nonce:!0,noModule:!0};function b(e,t,n){var r,i,o=(n=n||E).createElement("script");if(o.text=e,t)for(r in c)(i=t[r]||t.getAttribute&&t.getAttribute(r))&&o.setAttribute(r,i);n.head.appendChild(o).parentNode.removeChild(o)}function w(e){return null==e?e+"":"object"==typeof e||"function"==typeof e?n[o.call(e)]||"object":typeof e}var f="3.5.1",S=function(e,t){return new S.fn.init(e,t)};function p(e){var t=!!e&&"length"in e&&e.length,n=w(e);return!m(e)&&!x(e)&&("array"===n||0===t||"number"==typeof t&&0<t&&t-1 in e)}S.fn=S.prototype={jquery:f,constructor:S,length:0,toArray:function(){return s.call(this)},get:function(e){return null==e?s.call(this):e<0?this[e+this.length]:this[e]},pushStack:function(e){var t=S.merge(this.constructor(),e);return t.prevObject=this,t},each:function(e){return S.each(this,e)},map:function(n){return this.pushStack(S.map(this,function(e,t){return n.call(e,t,e)}))},slice:function(){return this.pushStack(s.apply(this,arguments))},first:function(){return this.eq(0)},last:function(){return this.eq(-1)},even:function(){return this.pushStack(S.grep(this,function(e,t){return(t+1)%2}))},odd:function(){return this.pushStack(S.grep(this,function(e,t){return t%2}))},eq:function(e){var t=this.length,n=+e+(e<0?t:0);return this.pushStack(0<=n&&n<t?[this[n]]:[])},end:function(){return this.prevObject||this.constructor()},push:u,sort:t.sort,splice:t.splice},S.extend=S.fn.extend=function(){var e,t,n,r,i,o,a=arguments[0]||{},s=1,u=arguments.length,l=!1;for("boolean"==typeof a&&(l=a,a=arguments[s]||{},s++),"object"==typeof a||m(a)||(a={}),s===u&&(a=this,s--);s<u;s++)if(null!=(e=arguments[s]))for(t in e)r=e[t],"__proto__"!==t&&a!==r&&(l&&r&&(S.isPlainObject(r)||(i=Array.isArray(r)))?(n=a[t],o=i&&!Array.isArray(n)?[]:i||S.isPlainObject(n)?n:{},i=!1,a[t]=S.extend(l,o,r)):void 0!==r&&(a[t]=r));return a},S.extend({expando:"jQuery"+(f+Math.random()).replace(/\D/g,""),isReady:!0,error:function(e){throw new Error(e)},noop:function(){},isPlainObject:function(e){var t,n;return!(!e||"[object Object]"!==o.call(e))&&(!(t=r(e))||"function"==typeof(n=v.call(t,"constructor")&&t.constructor)&&a.call(n)===l)},isEmptyObject:function(e){var t;for(t in e)return!1;return!0},globalEval:function(e,t,n){b(e,{nonce:t&&t.nonce},n)},each:function(e,t){var n,r=0;if(p(e)){for(n=e.length;r<n;r++)if(!1===t.call(e[r],r,e[r]))break}else for(r in e)if(!1===t.call(e[r],r,e[r]))break;return e},makeArray:function(e,t){var n=t||[];return null!=e&&(p(Object(e))?S.merge(n,"string"==typeof e?[e]:e):u.call(n,e)),n},inArray:function(e,t,n){return null==t?-1:i.call(t,e,n)},merge:function(e,t){for(var n=+t.length,r=0,i=e.length;r<n;r++)e[i++]=t[r];return e.length=i,e},grep:function(e,t,n){for(var r=[],i=0,o=e.length,a=!n;i<o;i++)!t(e[i],i)!==a&&r.push(e[i]);return r},map:function(e,t,n){var r,i,o=0,a=[];if(p(e))for(r=e.length;o<r;o++)null!=(i=t(e[o],o,n))&&a.push(i);else for(o in e)null!=(i=t(e[o],o,n))&&a.push(i);return g(a)},guid:1,support:y}),"function"==typeof Symbol&&(S.fn[Symbol.iterator]=t[Symbol.iterator]),S.each("Boolean Number String Function Array Date RegExp Object Error Symbol".split(" "),function(e,t){n["[object "+t+"]"]=t.toLowerCase()});var d=function(n){var e,d,b,o,i,h,f,g,w,u,l,T,C,a,E,v,s,c,y,S="sizzle"+1*new Date,p=n.document,k=0,r=0,m=ue(),x=ue(),A=ue(),N=ue(),D=function(e,t){return e===t&&(l=!0),0},j={}.hasOwnProperty,t=[],q=t.pop,L=t.push,H=t.push,O=t.slice,P=function(e,t){for(var n=0,r=e.length;n<r;n++)if(e[n]===t)return n;return-1},R="checked|selected|async|autofocus|autoplay|controls|defer|disabled|hidden|ismap|loop|multiple|open|readonly|required|scoped",M="[\\x20\\t\\r\\n\\f]",I="(?:\\\\[\\da-fA-F]{1,6}"+M+"?|\\\\[^\\r\\n\\f]|[\\w-]|[^\0-\\x7f])+",W="\\["+M+"*("+I+")(?:"+M+"*([*^$|!~]?=)"+M+"*(?:'((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\"|("+I+"))|)"+M+"*\\]",F=":("+I+")(?:\\((('((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\")|((?:\\\\.|[^\\\\()[\\]]|"+W+")*)|.*)\\)|)",B=new RegExp(M+"+","g"),$=new RegExp("^"+M+"+|((?:^|[^\\\\])(?:\\\\.)*)"+M+"+$","g"),_=new RegExp("^"+M+"*,"+M+"*"),z=new RegExp("^"+M+"*([>+~]|"+M+")"+M+"*"),U=new RegExp(M+"|>"),X=new RegExp(F),V=new RegExp("^"+I+"$"),G={ID:new RegExp("^#("+I+")"),CLASS:new RegExp("^\\.("+I+")"),TAG:new RegExp("^("+I+"|[*])"),ATTR:new RegExp("^"+W),PSEUDO:new RegExp("^"+F),CHILD:new RegExp("^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\("+M+"*(even|odd|(([+-]|)(\\d*)n|)"+M+"*(?:([+-]|)"+M+"*(\\d+)|))"+M+"*\\)|)","i"),bool:new RegExp("^(?:"+R+")$","i"),needsContext:new RegExp("^"+M+"*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\("+M+"*((?:-\\d)?\\d*)"+M+"*\\)|)(?=[^-]|$)","i")},Y=/HTML$/i,Q=/^(?:input|select|textarea|button)$/i,J=/^h\d$/i,K=/^[^{]+\{\s*\[native \w/,Z=/^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/,ee=/[+~]/,te=new RegExp("\\\\[\\da-fA-F]{1,6}"+M+"?|\\\\([^\\r\\n\\f])","g"),ne=function(e,t){var n="0x"+e.slice(1)-65536;return t||(n<0?String.fromCharCode(n+65536):String.fromCharCode(n>>10|55296,1023&n|56320))},re=/([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g,ie=function(e,t){return t?"\0"===e?"\ufffd":e.slice(0,-1)+"\\"+e.charCodeAt(e.length-1).toString(16)+" ":"\\"+e},oe=function(){T()},ae=be(function(e){return!0===e.disabled&&"fieldset"===e.nodeName.toLowerCase()},{dir:"parentNode",next:"legend"});try{H.apply(t=O.call(p.childNodes),p.childNodes),t[p.childNodes.length].nodeType}catch(e){H={apply:t.length?function(e,t){L.apply(e,O.call(t))}:function(e,t){var n=e.length,r=0;while(e[n++]=t[r++]);e.length=n-1}}}function se(t,e,n,r){var i,o,a,s,u,l,c,f=e&&e.ownerDocument,p=e?e.nodeType:9;if(n=n||[],"string"!=typeof t||!t||1!==p&&9!==p&&11!==p)return n;if(!r&&(T(e),e=e||C,E)){if(11!==p&&(u=Z.exec(t)))if(i=u[1]){if(9===p){if(!(a=e.getElementById(i)))return n;if(a.id===i)return n.push(a),n}else if(f&&(a=f.getElementById(i))&&y(e,a)&&a.id===i)return n.push(a),n}else{if(u[2])return H.apply(n,e.getElementsByTagName(t)),n;if((i=u[3])&&d.getElementsByClassName&&e.getElementsByClassName)return H.apply(n,e.getElementsByClassName(i)),n}if(d.qsa&&!N[t+" "]&&(!v||!v.test(t))&&(1!==p||"object"!==e.nodeName.toLowerCase())){if(c=t,f=e,1===p&&(U.test(t)||z.test(t))){(f=ee.test(t)&&ye(e.parentNode)||e)===e&&d.scope||((s=e.getAttribute("id"))?s=s.replace(re,ie):e.setAttribute("id",s=S)),o=(l=h(t)).length;while(o--)l[o]=(s?"#"+s:":scope")+" "+xe(l[o]);c=l.join(",")}try{return H.apply(n,f.querySelectorAll(c)),n}catch(e){N(t,!0)}finally{s===S&&e.removeAttribute("id")}}}return g(t.replace($,"$1"),e,n,r)}function ue(){var r=[];return function e(t,n){return r.push(t+" ")>b.cacheLength&&delete e[r.shift()],e[t+" "]=n}}function le(e){return e[S]=!0,e}function ce(e){var t=C.createElement("fieldset");try{return!!e(t)}catch(e){return!1}finally{t.parentNode&&t.parentNode.removeChild(t),t=null}}function fe(e,t){var n=e.split("|"),r=n.length;while(r--)b.attrHandle[n[r]]=t}function pe(e,t){var n=t&&e,r=n&&1===e.nodeType&&1===t.nodeType&&e.sourceIndex-t.sourceIndex;if(r)return r;if(n)while(n=n.nextSibling)if(n===t)return-1;return e?1:-1}function de(t){return function(e){return"input"===e.nodeName.toLowerCase()&&e.type===t}}function he(n){return function(e){var t=e.nodeName.toLowerCase();return("input"===t||"button"===t)&&e.type===n}}function ge(t){return function(e){return"form"in e?e.parentNode&&!1===e.disabled?"label"in e?"label"in e.parentNode?e.parentNode.disabled===t:e.disabled===t:e.isDisabled===t||e.isDisabled!==!t&&ae(e)===t:e.disabled===t:"label"in e&&e.disabled===t}}function ve(a){return le(function(o){return o=+o,le(function(e,t){var n,r=a([],e.length,o),i=r.length;while(i--)e[n=r[i]]&&(e[n]=!(t[n]=e[n]))})})}function ye(e){return e&&"undefined"!=typeof e.getElementsByTagName&&e}for(e in d=se.support={},i=se.isXML=function(e){var t=e.namespaceURI,n=(e.ownerDocument||e).documentElement;return!Y.test(t||n&&n.nodeName||"HTML")},T=se.setDocument=function(e){var t,n,r=e?e.ownerDocument||e:p;return r!=C&&9===r.nodeType&&r.documentElement&&(a=(C=r).documentElement,E=!i(C),p!=C&&(n=C.defaultView)&&n.top!==n&&(n.addEventListener?n.addEventListener("unload",oe,!1):n.attachEvent&&n.attachEvent("onunload",oe)),d.scope=ce(function(e){return a.appendChild(e).appendChild(C.createElement("div")),"undefined"!=typeof e.querySelectorAll&&!e.querySelectorAll(":scope fieldset div").length}),d.attributes=ce(function(e){return e.className="i",!e.getAttribute("className")}),d.getElementsByTagName=ce(function(e){return e.appendChild(C.createComment("")),!e.getElementsByTagName("*").length}),d.getElementsByClassName=K.test(C.getElementsByClassName),d.getById=ce(function(e){return a.appendChild(e).id=S,!C.getElementsByName||!C.getElementsByName(S).length}),d.getById?(b.filter.ID=function(e){var t=e.replace(te,ne);return function(e){return e.getAttribute("id")===t}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n=t.getElementById(e);return n?[n]:[]}}):(b.filter.ID=function(e){var n=e.replace(te,ne);return function(e){var t="undefined"!=typeof e.getAttributeNode&&e.getAttributeNode("id");return t&&t.value===n}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n,r,i,o=t.getElementById(e);if(o){if((n=o.getAttributeNode("id"))&&n.value===e)return[o];i=t.getElementsByName(e),r=0;while(o=i[r++])if((n=o.getAttributeNode("id"))&&n.value===e)return[o]}return[]}}),b.find.TAG=d.getElementsByTagName?function(e,t){return"undefined"!=typeof t.getElementsByTagName?t.getElementsByTagName(e):d.qsa?t.querySelectorAll(e):void 0}:function(e,t){var n,r=[],i=0,o=t.getElementsByTagName(e);if("*"===e){while(n=o[i++])1===n.nodeType&&r.push(n);return r}return o},b.find.CLASS=d.getElementsByClassName&&function(e,t){if("undefined"!=typeof t.getElementsByClassName&&E)return t.getElementsByClassName(e)},s=[],v=[],(d.qsa=K.test(C.querySelectorAll))&&(ce(function(e){var t;a.appendChild(e).innerHTML="<a id='"+S+"'></a><select id='"+S+"-\r\\' msallowcapture=''><option selected=''></option></select>",e.querySelectorAll("[msallowcapture^='']").length&&v.push("[*^$]="+M+"*(?:''|\"\")"),e.querySelectorAll("[selected]").length||v.push("\\["+M+"*(?:value|"+R+")"),e.querySelectorAll("[id~="+S+"-]").length||v.push("~="),(t=C.createElement("input")).setAttribute("name",""),e.appendChild(t),e.querySelectorAll("[name='']").length||v.push("\\["+M+"*name"+M+"*="+M+"*(?:''|\"\")"),e.querySelectorAll(":checked").length||v.push(":checked"),e.querySelectorAll("a#"+S+"+*").length||v.push(".#.+[+~]"),e.querySelectorAll("\\\f"),v.push("[\\r\\n\\f]")}),ce(function(e){e.innerHTML="<a href='' disabled='disabled'></a><select disabled='disabled'><option/></select>";var t=C.createElement("input");t.setAttribute("type","hidden"),e.appendChild(t).setAttribute("name","D"),e.querySelectorAll("[name=d]").length&&v.push("name"+M+"*[*^$|!~]?="),2!==e.querySelectorAll(":enabled").length&&v.push(":enabled",":disabled"),a.appendChild(e).disabled=!0,2!==e.querySelectorAll(":disabled").length&&v.push(":enabled",":disabled"),e.querySelectorAll("*,:x"),v.push(",.*:")})),(d.matchesSelector=K.test(c=a.matches||a.webkitMatchesSelector||a.mozMatchesSelector||a.oMatchesSelector||a.msMatchesSelector))&&ce(function(e){d.disconnectedMatch=c.call(e,"*"),c.call(e,"[s!='']:x"),s.push("!=",F)}),v=v.length&&new RegExp(v.join("|")),s=s.length&&new RegExp(s.join("|")),t=K.test(a.compareDocumentPosition),y=t||K.test(a.contains)?function(e,t){var n=9===e.nodeType?e.documentElement:e,r=t&&t.parentNode;return e===r||!(!r||1!==r.nodeType||!(n.contains?n.contains(r):e.compareDocumentPosition&&16&e.compareDocumentPosition(r)))}:function(e,t){if(t)while(t=t.parentNode)if(t===e)return!0;return!1},D=t?function(e,t){if(e===t)return l=!0,0;var n=!e.compareDocumentPosition-!t.compareDocumentPosition;return n||(1&(n=(e.ownerDocument||e)==(t.ownerDocument||t)?e.compareDocumentPosition(t):1)||!d.sortDetached&&t.compareDocumentPosition(e)===n?e==C||e.ownerDocument==p&&y(p,e)?-1:t==C||t.ownerDocument==p&&y(p,t)?1:u?P(u,e)-P(u,t):0:4&n?-1:1)}:function(e,t){if(e===t)return l=!0,0;var n,r=0,i=e.parentNode,o=t.parentNode,a=[e],s=[t];if(!i||!o)return e==C?-1:t==C?1:i?-1:o?1:u?P(u,e)-P(u,t):0;if(i===o)return pe(e,t);n=e;while(n=n.parentNode)a.unshift(n);n=t;while(n=n.parentNode)s.unshift(n);while(a[r]===s[r])r++;return r?pe(a[r],s[r]):a[r]==p?-1:s[r]==p?1:0}),C},se.matches=function(e,t){return se(e,null,null,t)},se.matchesSelector=function(e,t){if(T(e),d.matchesSelector&&E&&!N[t+" "]&&(!s||!s.test(t))&&(!v||!v.test(t)))try{var n=c.call(e,t);if(n||d.disconnectedMatch||e.document&&11!==e.document.nodeType)return n}catch(e){N(t,!0)}return 0<se(t,C,null,[e]).length},se.contains=function(e,t){return(e.ownerDocument||e)!=C&&T(e),y(e,t)},se.attr=function(e,t){(e.ownerDocument||e)!=C&&T(e);var n=b.attrHandle[t.toLowerCase()],r=n&&j.call(b.attrHandle,t.toLowerCase())?n(e,t,!E):void 0;return void 0!==r?r:d.attributes||!E?e.getAttribute(t):(r=e.getAttributeNode(t))&&r.specified?r.value:null},se.escape=function(e){return(e+"").replace(re,ie)},se.error=function(e){throw new Error("Syntax error, unrecognized expression: "+e)},se.uniqueSort=function(e){var t,n=[],r=0,i=0;if(l=!d.detectDuplicates,u=!d.sortStable&&e.slice(0),e.sort(D),l){while(t=e[i++])t===e[i]&&(r=n.push(i));while(r--)e.splice(n[r],1)}return u=null,e},o=se.getText=function(e){var t,n="",r=0,i=e.nodeType;if(i){if(1===i||9===i||11===i){if("string"==typeof e.textContent)return e.textContent;for(e=e.firstChild;e;e=e.nextSibling)n+=o(e)}else if(3===i||4===i)return e.nodeValue}else while(t=e[r++])n+=o(t);return n},(b=se.selectors={cacheLength:50,createPseudo:le,match:G,attrHandle:{},find:{},relative:{">":{dir:"parentNode",first:!0}," ":{dir:"parentNode"},"+":{dir:"previousSibling",first:!0},"~":{dir:"previousSibling"}},preFilter:{ATTR:function(e){return e[1]=e[1].replace(te,ne),e[3]=(e[3]||e[4]||e[5]||"").replace(te,ne),"~="===e[2]&&(e[3]=" "+e[3]+" "),e.slice(0,4)},CHILD:function(e){return e[1]=e[1].toLowerCase(),"nth"===e[1].slice(0,3)?(e[3]||se.error(e[0]),e[4]=+(e[4]?e[5]+(e[6]||1):2*("even"===e[3]||"odd"===e[3])),e[5]=+(e[7]+e[8]||"odd"===e[3])):e[3]&&se.error(e[0]),e},PSEUDO:function(e){var t,n=!e[6]&&e[2];return G.CHILD.test(e[0])?null:(e[3]?e[2]=e[4]||e[5]||"":n&&X.test(n)&&(t=h(n,!0))&&(t=n.indexOf(")",n.length-t)-n.length)&&(e[0]=e[0].slice(0,t),e[2]=n.slice(0,t)),e.slice(0,3))}},filter:{TAG:function(e){var t=e.replace(te,ne).toLowerCase();return"*"===e?function(){return!0}:function(e){return e.nodeName&&e.nodeName.toLowerCase()===t}},CLASS:function(e){var t=m[e+" "];return t||(t=new RegExp("(^|"+M+")"+e+"("+M+"|$)"))&&m(e,function(e){return t.test("string"==typeof e.className&&e.className||"undefined"!=typeof e.getAttribute&&e.getAttribute("class")||"")})},ATTR:function(n,r,i){return function(e){var t=se.attr(e,n);return null==t?"!="===r:!r||(t+="","="===r?t===i:"!="===r?t!==i:"^="===r?i&&0===t.indexOf(i):"*="===r?i&&-1<t.indexOf(i):"$="===r?i&&t.slice(-i.length)===i:"~="===r?-1<(" "+t.replace(B," ")+" ").indexOf(i):"|="===r&&(t===i||t.slice(0,i.length+1)===i+"-"))}},CHILD:function(h,e,t,g,v){var y="nth"!==h.slice(0,3),m="last"!==h.slice(-4),x="of-type"===e;return 1===g&&0===v?function(e){return!!e.parentNode}:function(e,t,n){var r,i,o,a,s,u,l=y!==m?"nextSibling":"previousSibling",c=e.parentNode,f=x&&e.nodeName.toLowerCase(),p=!n&&!x,d=!1;if(c){if(y){while(l){a=e;while(a=a[l])if(x?a.nodeName.toLowerCase()===f:1===a.nodeType)return!1;u=l="only"===h&&!u&&"nextSibling"}return!0}if(u=[m?c.firstChild:c.lastChild],m&&p){d=(s=(r=(i=(o=(a=c)[S]||(a[S]={}))[a.uniqueID]||(o[a.uniqueID]={}))[h]||[])[0]===k&&r[1])&&r[2],a=s&&c.childNodes[s];while(a=++s&&a&&a[l]||(d=s=0)||u.pop())if(1===a.nodeType&&++d&&a===e){i[h]=[k,s,d];break}}else if(p&&(d=s=(r=(i=(o=(a=e)[S]||(a[S]={}))[a.uniqueID]||(o[a.uniqueID]={}))[h]||[])[0]===k&&r[1]),!1===d)while(a=++s&&a&&a[l]||(d=s=0)||u.pop())if((x?a.nodeName.toLowerCase()===f:1===a.nodeType)&&++d&&(p&&((i=(o=a[S]||(a[S]={}))[a.uniqueID]||(o[a.uniqueID]={}))[h]=[k,d]),a===e))break;return(d-=v)===g||d%g==0&&0<=d/g}}},PSEUDO:function(e,o){var t,a=b.pseudos[e]||b.setFilters[e.toLowerCase()]||se.error("unsupported pseudo: "+e);return a[S]?a(o):1<a.length?(t=[e,e,"",o],b.setFilters.hasOwnProperty(e.toLowerCase())?le(function(e,t){var n,r=a(e,o),i=r.length;while(i--)e[n=P(e,r[i])]=!(t[n]=r[i])}):function(e){return a(e,0,t)}):a}},pseudos:{not:le(function(e){var r=[],i=[],s=f(e.replace($,"$1"));return s[S]?le(function(e,t,n,r){var i,o=s(e,null,r,[]),a=e.length;while(a--)(i=o[a])&&(e[a]=!(t[a]=i))}):function(e,t,n){return r[0]=e,s(r,null,n,i),r[0]=null,!i.pop()}}),has:le(function(t){return function(e){return 0<se(t,e).length}}),contains:le(function(t){return t=t.replace(te,ne),function(e){return-1<(e.textContent||o(e)).indexOf(t)}}),lang:le(function(n){return V.test(n||"")||se.error("unsupported lang: "+n),n=n.replace(te,ne).toLowerCase(),function(e){var t;do{if(t=E?e.lang:e.getAttribute("xml:lang")||e.getAttribute("lang"))return(t=t.toLowerCase())===n||0===t.indexOf(n+"-")}while((e=e.parentNode)&&1===e.nodeType);return!1}}),target:function(e){var t=n.location&&n.location.hash;return t&&t.slice(1)===e.id},root:function(e){return e===a},focus:function(e){return e===C.activeElement&&(!C.hasFocus||C.hasFocus())&&!!(e.type||e.href||~e.tabIndex)},enabled:ge(!1),disabled:ge(!0),checked:function(e){var t=e.nodeName.toLowerCase();return"input"===t&&!!e.checked||"option"===t&&!!e.selected},selected:function(e){return e.parentNode&&e.parentNode.selectedIndex,!0===e.selected},empty:function(e){for(e=e.firstChild;e;e=e.nextSibling)if(e.nodeType<6)return!1;return!0},parent:function(e){return!b.pseudos.empty(e)},header:function(e){return J.test(e.nodeName)},input:function(e){return Q.test(e.nodeName)},button:function(e){var t=e.nodeName.toLowerCase();return"input"===t&&"button"===e.type||"button"===t},text:function(e){var t;return"input"===e.nodeName.toLowerCase()&&"text"===e.type&&(null==(t=e.getAttribute("type"))||"text"===t.toLowerCase())},first:ve(function(){return[0]}),last:ve(function(e,t){return[t-1]}),eq:ve(function(e,t,n){return[n<0?n+t:n]}),even:ve(function(e,t){for(var n=0;n<t;n+=2)e.push(n);return e}),odd:ve(function(e,t){for(var n=1;n<t;n+=2)e.push(n);return e}),lt:ve(function(e,t,n){for(var r=n<0?n+t:t<n?t:n;0<=--r;)e.push(r);return e}),gt:ve(function(e,t,n){for(var r=n<0?n+t:n;++r<t;)e.push(r);return e})}}).pseudos.nth=b.pseudos.eq,{radio:!0,checkbox:!0,file:!0,password:!0,image:!0})b.pseudos[e]=de(e);for(e in{submit:!0,reset:!0})b.pseudos[e]=he(e);function me(){}function xe(e){for(var t=0,n=e.length,r="";t<n;t++)r+=e[t].value;return r}function be(s,e,t){var u=e.dir,l=e.next,c=l||u,f=t&&"parentNode"===c,p=r++;return e.first?function(e,t,n){while(e=e[u])if(1===e.nodeType||f)return s(e,t,n);return!1}:function(e,t,n){var r,i,o,a=[k,p];if(n){while(e=e[u])if((1===e.nodeType||f)&&s(e,t,n))return!0}else while(e=e[u])if(1===e.nodeType||f)if(i=(o=e[S]||(e[S]={}))[e.uniqueID]||(o[e.uniqueID]={}),l&&l===e.nodeName.toLowerCase())e=e[u]||e;else{if((r=i[c])&&r[0]===k&&r[1]===p)return a[2]=r[2];if((i[c]=a)[2]=s(e,t,n))return!0}return!1}}function we(i){return 1<i.length?function(e,t,n){var r=i.length;while(r--)if(!i[r](e,t,n))return!1;return!0}:i[0]}function Te(e,t,n,r,i){for(var o,a=[],s=0,u=e.length,l=null!=t;s<u;s++)(o=e[s])&&(n&&!n(o,r,i)||(a.push(o),l&&t.push(s)));return a}function Ce(d,h,g,v,y,e){return v&&!v[S]&&(v=Ce(v)),y&&!y[S]&&(y=Ce(y,e)),le(function(e,t,n,r){var i,o,a,s=[],u=[],l=t.length,c=e||function(e,t,n){for(var r=0,i=t.length;r<i;r++)se(e,t[r],n);return n}(h||"*",n.nodeType?[n]:n,[]),f=!d||!e&&h?c:Te(c,s,d,n,r),p=g?y||(e?d:l||v)?[]:t:f;if(g&&g(f,p,n,r),v){i=Te(p,u),v(i,[],n,r),o=i.length;while(o--)(a=i[o])&&(p[u[o]]=!(f[u[o]]=a))}if(e){if(y||d){if(y){i=[],o=p.length;while(o--)(a=p[o])&&i.push(f[o]=a);y(null,p=[],i,r)}o=p.length;while(o--)(a=p[o])&&-1<(i=y?P(e,a):s[o])&&(e[i]=!(t[i]=a))}}else p=Te(p===t?p.splice(l,p.length):p),y?y(null,t,p,r):H.apply(t,p)})}function Ee(e){for(var i,t,n,r=e.length,o=b.relative[e[0].type],a=o||b.relative[" "],s=o?1:0,u=be(function(e){return e===i},a,!0),l=be(function(e){return-1<P(i,e)},a,!0),c=[function(e,t,n){var r=!o&&(n||t!==w)||((i=t).nodeType?u(e,t,n):l(e,t,n));return i=null,r}];s<r;s++)if(t=b.relative[e[s].type])c=[be(we(c),t)];else{if((t=b.filter[e[s].type].apply(null,e[s].matches))[S]){for(n=++s;n<r;n++)if(b.relative[e[n].type])break;return Ce(1<s&&we(c),1<s&&xe(e.slice(0,s-1).concat({value:" "===e[s-2].type?"*":""})).replace($,"$1"),t,s<n&&Ee(e.slice(s,n)),n<r&&Ee(e=e.slice(n)),n<r&&xe(e))}c.push(t)}return we(c)}return me.prototype=b.filters=b.pseudos,b.setFilters=new me,h=se.tokenize=function(e,t){var n,r,i,o,a,s,u,l=x[e+" "];if(l)return t?0:l.slice(0);a=e,s=[],u=b.preFilter;while(a){for(o in n&&!(r=_.exec(a))||(r&&(a=a.slice(r[0].length)||a),s.push(i=[])),n=!1,(r=z.exec(a))&&(n=r.shift(),i.push({value:n,type:r[0].replace($," ")}),a=a.slice(n.length)),b.filter)!(r=G[o].exec(a))||u[o]&&!(r=u[o](r))||(n=r.shift(),i.push({value:n,type:o,matches:r}),a=a.slice(n.length));if(!n)break}return t?a.length:a?se.error(e):x(e,s).slice(0)},f=se.compile=function(e,t){var n,v,y,m,x,r,i=[],o=[],a=A[e+" "];if(!a){t||(t=h(e)),n=t.length;while(n--)(a=Ee(t[n]))[S]?i.push(a):o.push(a);(a=A(e,(v=o,m=0<(y=i).length,x=0<v.length,r=function(e,t,n,r,i){var o,a,s,u=0,l="0",c=e&&[],f=[],p=w,d=e||x&&b.find.TAG("*",i),h=k+=null==p?1:Math.random()||.1,g=d.length;for(i&&(w=t==C||t||i);l!==g&&null!=(o=d[l]);l++){if(x&&o){a=0,t||o.ownerDocument==C||(T(o),n=!E);while(s=v[a++])if(s(o,t||C,n)){r.push(o);break}i&&(k=h)}m&&((o=!s&&o)&&u--,e&&c.push(o))}if(u+=l,m&&l!==u){a=0;while(s=y[a++])s(c,f,t,n);if(e){if(0<u)while(l--)c[l]||f[l]||(f[l]=q.call(r));f=Te(f)}H.apply(r,f),i&&!e&&0<f.length&&1<u+y.length&&se.uniqueSort(r)}return i&&(k=h,w=p),c},m?le(r):r))).selector=e}return a},g=se.select=function(e,t,n,r){var i,o,a,s,u,l="function"==typeof e&&e,c=!r&&h(e=l.selector||e);if(n=n||[],1===c.length){if(2<(o=c[0]=c[0].slice(0)).length&&"ID"===(a=o[0]).type&&9===t.nodeType&&E&&b.relative[o[1].type]){if(!(t=(b.find.ID(a.matches[0].replace(te,ne),t)||[])[0]))return n;l&&(t=t.parentNode),e=e.slice(o.shift().value.length)}i=G.needsContext.test(e)?0:o.length;while(i--){if(a=o[i],b.relative[s=a.type])break;if((u=b.find[s])&&(r=u(a.matches[0].replace(te,ne),ee.test(o[0].type)&&ye(t.parentNode)||t))){if(o.splice(i,1),!(e=r.length&&xe(o)))return H.apply(n,r),n;break}}}return(l||f(e,c))(r,t,!E,n,!t||ee.test(e)&&ye(t.parentNode)||t),n},d.sortStable=S.split("").sort(D).join("")===S,d.detectDuplicates=!!l,T(),d.sortDetached=ce(function(e){return 1&e.compareDocumentPosition(C.createElement("fieldset"))}),ce(function(e){return e.innerHTML="<a href='#'></a>","#"===e.firstChild.getAttribute("href")})||fe("type|href|height|width",function(e,t,n){if(!n)return e.getAttribute(t,"type"===t.toLowerCase()?1:2)}),d.attributes&&ce(function(e){return e.innerHTML="<input/>",e.firstChild.setAttribute("value",""),""===e.firstChild.getAttribute("value")})||fe("value",function(e,t,n){if(!n&&"input"===e.nodeName.toLowerCase())return e.defaultValue}),ce(function(e){return null==e.getAttribute("disabled")})||fe(R,function(e,t,n){var r;if(!n)return!0===e[t]?t.toLowerCase():(r=e.getAttributeNode(t))&&r.specified?r.value:null}),se}(C);S.find=d,S.expr=d.selectors,S.expr[":"]=S.expr.pseudos,S.uniqueSort=S.unique=d.uniqueSort,S.text=d.getText,S.isXMLDoc=d.isXML,S.contains=d.contains,S.escapeSelector=d.escape;var h=function(e,t,n){var r=[],i=void 0!==n;while((e=e[t])&&9!==e.nodeType)if(1===e.nodeType){if(i&&S(e).is(n))break;r.push(e)}return r},T=function(e,t){for(var n=[];e;e=e.nextSibling)1===e.nodeType&&e!==t&&n.push(e);return n},k=S.expr.match.needsContext;function A(e,t){return e.nodeName&&e.nodeName.toLowerCase()===t.toLowerCase()}var N=/^<([a-z][^\/\0>:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i;function D(e,n,r){return m(n)?S.grep(e,function(e,t){return!!n.call(e,t,e)!==r}):n.nodeType?S.grep(e,function(e){return e===n!==r}):"string"!=typeof n?S.grep(e,function(e){return-1<i.call(n,e)!==r}):S.filter(n,e,r)}S.filter=function(e,t,n){var r=t[0];return n&&(e=":not("+e+")"),1===t.length&&1===r.nodeType?S.find.matchesSelector(r,e)?[r]:[]:S.find.matches(e,S.grep(t,function(e){return 1===e.nodeType}))},S.fn.extend({find:function(e){var t,n,r=this.length,i=this;if("string"!=typeof e)return this.pushStack(S(e).filter(function(){for(t=0;t<r;t++)if(S.contains(i[t],this))return!0}));for(n=this.pushStack([]),t=0;t<r;t++)S.find(e,i[t],n);return 1<r?S.uniqueSort(n):n},filter:function(e){return this.pushStack(D(this,e||[],!1))},not:function(e){return this.pushStack(D(this,e||[],!0))},is:function(e){return!!D(this,"string"==typeof e&&k.test(e)?S(e):e||[],!1).length}});var j,q=/^(?:\s*(<[\w\W]+>)[^>]*|#([\w-]+))$/;(S.fn.init=function(e,t,n){var r,i;if(!e)return this;if(n=n||j,"string"==typeof e){if(!(r="<"===e[0]&&">"===e[e.length-1]&&3<=e.length?[null,e,null]:q.exec(e))||!r[1]&&t)return!t||t.jquery?(t||n).find(e):this.constructor(t).find(e);if(r[1]){if(t=t instanceof S?t[0]:t,S.merge(this,S.parseHTML(r[1],t&&t.nodeType?t.ownerDocument||t:E,!0)),N.test(r[1])&&S.isPlainObject(t))for(r in t)m(this[r])?this[r](t[r]):this.attr(r,t[r]);return this}return(i=E.getElementById(r[2]))&&(this[0]=i,this.length=1),this}return e.nodeType?(this[0]=e,this.length=1,this):m(e)?void 0!==n.ready?n.ready(e):e(S):S.makeArray(e,this)}).prototype=S.fn,j=S(E);var L=/^(?:parents|prev(?:Until|All))/,H={children:!0,contents:!0,next:!0,prev:!0};function O(e,t){while((e=e[t])&&1!==e.nodeType);return e}S.fn.extend({has:function(e){var t=S(e,this),n=t.length;return this.filter(function(){for(var e=0;e<n;e++)if(S.contains(this,t[e]))return!0})},closest:function(e,t){var n,r=0,i=this.length,o=[],a="string"!=typeof e&&S(e);if(!k.test(e))for(;r<i;r++)for(n=this[r];n&&n!==t;n=n.parentNode)if(n.nodeType<11&&(a?-1<a.index(n):1===n.nodeType&&S.find.matchesSelector(n,e))){o.push(n);break}return this.pushStack(1<o.length?S.uniqueSort(o):o)},index:function(e){return e?"string"==typeof e?i.call(S(e),this[0]):i.call(this,e.jquery?e[0]:e):this[0]&&this[0].parentNode?this.first().prevAll().length:-1},add:function(e,t){return this.pushStack(S.uniqueSort(S.merge(this.get(),S(e,t))))},addBack:function(e){return this.add(null==e?this.prevObject:this.prevObject.filter(e))}}),S.each({parent:function(e){var t=e.parentNode;return t&&11!==t.nodeType?t:null},parents:function(e){return h(e,"parentNode")},parentsUntil:function(e,t,n){return h(e,"parentNode",n)},next:function(e){return O(e,"nextSibling")},prev:function(e){return O(e,"previousSibling")},nextAll:function(e){return h(e,"nextSibling")},prevAll:function(e){return h(e,"previousSibling")},nextUntil:function(e,t,n){return h(e,"nextSibling",n)},prevUntil:function(e,t,n){return h(e,"previousSibling",n)},siblings:function(e){return T((e.parentNode||{}).firstChild,e)},children:function(e){return T(e.firstChild)},contents:function(e){return null!=e.contentDocument&&r(e.contentDocument)?e.contentDocument:(A(e,"template")&&(e=e.content||e),S.merge([],e.childNodes))}},function(r,i){S.fn[r]=function(e,t){var n=S.map(this,i,e);return"Until"!==r.slice(-5)&&(t=e),t&&"string"==typeof t&&(n=S.filter(t,n)),1<this.length&&(H[r]||S.uniqueSort(n),L.test(r)&&n.reverse()),this.pushStack(n)}});var P=/[^\x20\t\r\n\f]+/g;function R(e){return e}function M(e){throw e}function I(e,t,n,r){var i;try{e&&m(i=e.promise)?i.call(e).done(t).fail(n):e&&m(i=e.then)?i.call(e,t,n):t.apply(void 0,[e].slice(r))}catch(e){n.apply(void 0,[e])}}S.Callbacks=function(r){var e,n;r="string"==typeof r?(e=r,n={},S.each(e.match(P)||[],function(e,t){n[t]=!0}),n):S.extend({},r);var i,t,o,a,s=[],u=[],l=-1,c=function(){for(a=a||r.once,o=i=!0;u.length;l=-1){t=u.shift();while(++l<s.length)!1===s[l].apply(t[0],t[1])&&r.stopOnFalse&&(l=s.length,t=!1)}r.memory||(t=!1),i=!1,a&&(s=t?[]:"")},f={add:function(){return s&&(t&&!i&&(l=s.length-1,u.push(t)),function n(e){S.each(e,function(e,t){m(t)?r.unique&&f.has(t)||s.push(t):t&&t.length&&"string"!==w(t)&&n(t)})}(arguments),t&&!i&&c()),this},remove:function(){return S.each(arguments,function(e,t){var n;while(-1<(n=S.inArray(t,s,n)))s.splice(n,1),n<=l&&l--}),this},has:function(e){return e?-1<S.inArray(e,s):0<s.length},empty:function(){return s&&(s=[]),this},disable:function(){return a=u=[],s=t="",this},disabled:function(){return!s},lock:function(){return a=u=[],t||i||(s=t=""),this},locked:function(){return!!a},fireWith:function(e,t){return a||(t=[e,(t=t||[]).slice?t.slice():t],u.push(t),i||c()),this},fire:function(){return f.fireWith(this,arguments),this},fired:function(){return!!o}};return f},S.extend({Deferred:function(e){var o=[["notify","progress",S.Callbacks("memory"),S.Callbacks("memory"),2],["resolve","done",S.Callbacks("once memory"),S.Callbacks("once memory"),0,"resolved"],["reject","fail",S.Callbacks("once memory"),S.Callbacks("once memory"),1,"rejected"]],i="pending",a={state:function(){return i},always:function(){return s.done(arguments).fail(arguments),this},"catch":function(e){return a.then(null,e)},pipe:function(){var i=arguments;return S.Deferred(function(r){S.each(o,function(e,t){var n=m(i[t[4]])&&i[t[4]];s[t[1]](function(){var e=n&&n.apply(this,arguments);e&&m(e.promise)?e.promise().progress(r.notify).done(r.resolve).fail(r.reject):r[t[0]+"With"](this,n?[e]:arguments)})}),i=null}).promise()},then:function(t,n,r){var u=0;function l(i,o,a,s){return function(){var n=this,r=arguments,e=function(){var e,t;if(!(i<u)){if((e=a.apply(n,r))===o.promise())throw new TypeError("Thenable self-resolution");t=e&&("object"==typeof e||"function"==typeof e)&&e.then,m(t)?s?t.call(e,l(u,o,R,s),l(u,o,M,s)):(u++,t.call(e,l(u,o,R,s),l(u,o,M,s),l(u,o,R,o.notifyWith))):(a!==R&&(n=void 0,r=[e]),(s||o.resolveWith)(n,r))}},t=s?e:function(){try{e()}catch(e){S.Deferred.exceptionHook&&S.Deferred.exceptionHook(e,t.stackTrace),u<=i+1&&(a!==M&&(n=void 0,r=[e]),o.rejectWith(n,r))}};i?t():(S.Deferred.getStackHook&&(t.stackTrace=S.Deferred.getStackHook()),C.setTimeout(t))}}return S.Deferred(function(e){o[0][3].add(l(0,e,m(r)?r:R,e.notifyWith)),o[1][3].add(l(0,e,m(t)?t:R)),o[2][3].add(l(0,e,m(n)?n:M))}).promise()},promise:function(e){return null!=e?S.extend(e,a):a}},s={};return S.each(o,function(e,t){var n=t[2],r=t[5];a[t[1]]=n.add,r&&n.add(function(){i=r},o[3-e][2].disable,o[3-e][3].disable,o[0][2].lock,o[0][3].lock),n.add(t[3].fire),s[t[0]]=function(){return s[t[0]+"With"](this===s?void 0:this,arguments),this},s[t[0]+"With"]=n.fireWith}),a.promise(s),e&&e.call(s,s),s},when:function(e){var n=arguments.length,t=n,r=Array(t),i=s.call(arguments),o=S.Deferred(),a=function(t){return function(e){r[t]=this,i[t]=1<arguments.length?s.call(arguments):e,--n||o.resolveWith(r,i)}};if(n<=1&&(I(e,o.done(a(t)).resolve,o.reject,!n),"pending"===o.state()||m(i[t]&&i[t].then)))return o.then();while(t--)I(i[t],a(t),o.reject);return o.promise()}});var W=/^(Eval|Internal|Range|Reference|Syntax|Type|URI)Error$/;S.Deferred.exceptionHook=function(e,t){C.console&&C.console.warn&&e&&W.test(e.name)&&C.console.warn("jQuery.Deferred exception: "+e.message,e.stack,t)},S.readyException=function(e){C.setTimeout(function(){throw e})};var F=S.Deferred();function B(){E.removeEventListener("DOMContentLoaded",B),C.removeEventListener("load",B),S.ready()}S.fn.ready=function(e){return F.then(e)["catch"](function(e){S.readyException(e)}),this},S.extend({isReady:!1,readyWait:1,ready:function(e){(!0===e?--S.readyWait:S.isReady)||(S.isReady=!0)!==e&&0<--S.readyWait||F.resolveWith(E,[S])}}),S.ready.then=F.then,"complete"===E.readyState||"loading"!==E.readyState&&!E.documentElement.doScroll?C.setTimeout(S.ready):(E.addEventListener("DOMContentLoaded",B),C.addEventListener("load",B));var $=function(e,t,n,r,i,o,a){var s=0,u=e.length,l=null==n;if("object"===w(n))for(s in i=!0,n)$(e,t,s,n[s],!0,o,a);else if(void 0!==r&&(i=!0,m(r)||(a=!0),l&&(a?(t.call(e,r),t=null):(l=t,t=function(e,t,n){return l.call(S(e),n)})),t))for(;s<u;s++)t(e[s],n,a?r:r.call(e[s],s,t(e[s],n)));return i?e:l?t.call(e):u?t(e[0],n):o},_=/^-ms-/,z=/-([a-z])/g;function U(e,t){return t.toUpperCase()}function X(e){return e.replace(_,"ms-").replace(z,U)}var V=function(e){return 1===e.nodeType||9===e.nodeType||!+e.nodeType};function G(){this.expando=S.expando+G.uid++}G.uid=1,G.prototype={cache:function(e){var t=e[this.expando];return t||(t={},V(e)&&(e.nodeType?e[this.expando]=t:Object.defineProperty(e,this.expando,{value:t,configurable:!0}))),t},set:function(e,t,n){var r,i=this.cache(e);if("string"==typeof t)i[X(t)]=n;else for(r in t)i[X(r)]=t[r];return i},get:function(e,t){return void 0===t?this.cache(e):e[this.expando]&&e[this.expando][X(t)]},access:function(e,t,n){return void 0===t||t&&"string"==typeof t&&void 0===n?this.get(e,t):(this.set(e,t,n),void 0!==n?n:t)},remove:function(e,t){var n,r=e[this.expando];if(void 0!==r){if(void 0!==t){n=(t=Array.isArray(t)?t.map(X):(t=X(t))in r?[t]:t.match(P)||[]).length;while(n--)delete r[t[n]]}(void 0===t||S.isEmptyObject(r))&&(e.nodeType?e[this.expando]=void 0:delete e[this.expando])}},hasData:function(e){var t=e[this.expando];return void 0!==t&&!S.isEmptyObject(t)}};var Y=new G,Q=new G,J=/^(?:\{[\w\W]*\}|\[[\w\W]*\])$/,K=/[A-Z]/g;function Z(e,t,n){var r,i;if(void 0===n&&1===e.nodeType)if(r="data-"+t.replace(K,"-$&").toLowerCase(),"string"==typeof(n=e.getAttribute(r))){try{n="true"===(i=n)||"false"!==i&&("null"===i?null:i===+i+""?+i:J.test(i)?JSON.parse(i):i)}catch(e){}Q.set(e,t,n)}else n=void 0;return n}S.extend({hasData:function(e){return Q.hasData(e)||Y.hasData(e)},data:function(e,t,n){return Q.access(e,t,n)},removeData:function(e,t){Q.remove(e,t)},_data:function(e,t,n){return Y.access(e,t,n)},_removeData:function(e,t){Y.remove(e,t)}}),S.fn.extend({data:function(n,e){var t,r,i,o=this[0],a=o&&o.attributes;if(void 0===n){if(this.length&&(i=Q.get(o),1===o.nodeType&&!Y.get(o,"hasDataAttrs"))){t=a.length;while(t--)a[t]&&0===(r=a[t].name).indexOf("data-")&&(r=X(r.slice(5)),Z(o,r,i[r]));Y.set(o,"hasDataAttrs",!0)}return i}return"object"==typeof n?this.each(function(){Q.set(this,n)}):$(this,function(e){var t;if(o&&void 0===e)return void 0!==(t=Q.get(o,n))?t:void 0!==(t=Z(o,n))?t:void 0;this.each(function(){Q.set(this,n,e)})},null,e,1<arguments.length,null,!0)},removeData:function(e){return this.each(function(){Q.remove(this,e)})}}),S.extend({queue:function(e,t,n){var r;if(e)return t=(t||"fx")+"queue",r=Y.get(e,t),n&&(!r||Array.isArray(n)?r=Y.access(e,t,S.makeArray(n)):r.push(n)),r||[]},dequeue:function(e,t){t=t||"fx";var n=S.queue(e,t),r=n.length,i=n.shift(),o=S._queueHooks(e,t);"inprogress"===i&&(i=n.shift(),r--),i&&("fx"===t&&n.unshift("inprogress"),delete o.stop,i.call(e,function(){S.dequeue(e,t)},o)),!r&&o&&o.empty.fire()},_queueHooks:function(e,t){var n=t+"queueHooks";return Y.get(e,n)||Y.access(e,n,{empty:S.Callbacks("once memory").add(function(){Y.remove(e,[t+"queue",n])})})}}),S.fn.extend({queue:function(t,n){var e=2;return"string"!=typeof t&&(n=t,t="fx",e--),arguments.length<e?S.queue(this[0],t):void 0===n?this:this.each(function(){var e=S.queue(this,t,n);S._queueHooks(this,t),"fx"===t&&"inprogress"!==e[0]&&S.dequeue(this,t)})},dequeue:function(e){return this.each(function(){S.dequeue(this,e)})},clearQueue:function(e){return this.queue(e||"fx",[])},promise:function(e,t){var n,r=1,i=S.Deferred(),o=this,a=this.length,s=function(){--r||i.resolveWith(o,[o])};"string"!=typeof e&&(t=e,e=void 0),e=e||"fx";while(a--)(n=Y.get(o[a],e+"queueHooks"))&&n.empty&&(r++,n.empty.add(s));return s(),i.promise(t)}});var ee=/[+-]?(?:\d*\.|)\d+(?:[eE][+-]?\d+|)/.source,te=new RegExp("^(?:([+-])=|)("+ee+")([a-z%]*)$","i"),ne=["Top","Right","Bottom","Left"],re=E.documentElement,ie=function(e){return S.contains(e.ownerDocument,e)},oe={composed:!0};re.getRootNode&&(ie=function(e){return S.contains(e.ownerDocument,e)||e.getRootNode(oe)===e.ownerDocument});var ae=function(e,t){return"none"===(e=t||e).style.display||""===e.style.display&&ie(e)&&"none"===S.css(e,"display")};function se(e,t,n,r){var i,o,a=20,s=r?function(){return r.cur()}:function(){return S.css(e,t,"")},u=s(),l=n&&n[3]||(S.cssNumber[t]?"":"px"),c=e.nodeType&&(S.cssNumber[t]||"px"!==l&&+u)&&te.exec(S.css(e,t));if(c&&c[3]!==l){u/=2,l=l||c[3],c=+u||1;while(a--)S.style(e,t,c+l),(1-o)*(1-(o=s()/u||.5))<=0&&(a=0),c/=o;c*=2,S.style(e,t,c+l),n=n||[]}return n&&(c=+c||+u||0,i=n[1]?c+(n[1]+1)*n[2]:+n[2],r&&(r.unit=l,r.start=c,r.end=i)),i}var ue={};function le(e,t){for(var n,r,i,o,a,s,u,l=[],c=0,f=e.length;c<f;c++)(r=e[c]).style&&(n=r.style.display,t?("none"===n&&(l[c]=Y.get(r,"display")||null,l[c]||(r.style.display="")),""===r.style.display&&ae(r)&&(l[c]=(u=a=o=void 0,a=(i=r).ownerDocument,s=i.nodeName,(u=ue[s])||(o=a.body.appendChild(a.createElement(s)),u=S.css(o,"display"),o.parentNode.removeChild(o),"none"===u&&(u="block"),ue[s]=u)))):"none"!==n&&(l[c]="none",Y.set(r,"display",n)));for(c=0;c<f;c++)null!=l[c]&&(e[c].style.display=l[c]);return e}S.fn.extend({show:function(){return le(this,!0)},hide:function(){return le(this)},toggle:function(e){return"boolean"==typeof e?e?this.show():this.hide():this.each(function(){ae(this)?S(this).show():S(this).hide()})}});var ce,fe,pe=/^(?:checkbox|radio)$/i,de=/<([a-z][^\/\0>\x20\t\r\n\f]*)/i,he=/^$|^module$|\/(?:java|ecma)script/i;ce=E.createDocumentFragment().appendChild(E.createElement("div")),(fe=E.createElement("input")).setAttribute("type","radio"),fe.setAttribute("checked","checked"),fe.setAttribute("name","t"),ce.appendChild(fe),y.checkClone=ce.cloneNode(!0).cloneNode(!0).lastChild.checked,ce.innerHTML="<textarea>x</textarea>",y.noCloneChecked=!!ce.cloneNode(!0).lastChild.defaultValue,ce.innerHTML="<option></option>",y.option=!!ce.lastChild;var ge={thead:[1,"<table>","</table>"],col:[2,"<table><colgroup>","</colgroup></table>"],tr:[2,"<table><tbody>","</tbody></table>"],td:[3,"<table><tbody><tr>","</tr></tbody></table>"],_default:[0,"",""]};function ve(e,t){var n;return n="undefined"!=typeof e.getElementsByTagName?e.getElementsByTagName(t||"*"):"undefined"!=typeof e.querySelectorAll?e.querySelectorAll(t||"*"):[],void 0===t||t&&A(e,t)?S.merge([e],n):n}function ye(e,t){for(var n=0,r=e.length;n<r;n++)Y.set(e[n],"globalEval",!t||Y.get(t[n],"globalEval"))}ge.tbody=ge.tfoot=ge.colgroup=ge.caption=ge.thead,ge.th=ge.td,y.option||(ge.optgroup=ge.option=[1,"<select multiple='multiple'>","</select>"]);var me=/<|&#?\w+;/;function xe(e,t,n,r,i){for(var o,a,s,u,l,c,f=t.createDocumentFragment(),p=[],d=0,h=e.length;d<h;d++)if((o=e[d])||0===o)if("object"===w(o))S.merge(p,o.nodeType?[o]:o);else if(me.test(o)){a=a||f.appendChild(t.createElement("div")),s=(de.exec(o)||["",""])[1].toLowerCase(),u=ge[s]||ge._default,a.innerHTML=u[1]+S.htmlPrefilter(o)+u[2],c=u[0];while(c--)a=a.lastChild;S.merge(p,a.childNodes),(a=f.firstChild).textContent=""}else p.push(t.createTextNode(o));f.textContent="",d=0;while(o=p[d++])if(r&&-1<S.inArray(o,r))i&&i.push(o);else if(l=ie(o),a=ve(f.appendChild(o),"script"),l&&ye(a),n){c=0;while(o=a[c++])he.test(o.type||"")&&n.push(o)}return f}var be=/^key/,we=/^(?:mouse|pointer|contextmenu|drag|drop)|click/,Te=/^([^.]*)(?:\.(.+)|)/;function Ce(){return!0}function Ee(){return!1}function Se(e,t){return e===function(){try{return E.activeElement}catch(e){}}()==("focus"===t)}function ke(e,t,n,r,i,o){var a,s;if("object"==typeof t){for(s in"string"!=typeof n&&(r=r||n,n=void 0),t)ke(e,s,n,r,t[s],o);return e}if(null==r&&null==i?(i=n,r=n=void 0):null==i&&("string"==typeof n?(i=r,r=void 0):(i=r,r=n,n=void 0)),!1===i)i=Ee;else if(!i)return e;return 1===o&&(a=i,(i=function(e){return S().off(e),a.apply(this,arguments)}).guid=a.guid||(a.guid=S.guid++)),e.each(function(){S.event.add(this,t,i,r,n)})}function Ae(e,i,o){o?(Y.set(e,i,!1),S.event.add(e,i,{namespace:!1,handler:function(e){var t,n,r=Y.get(this,i);if(1&e.isTrigger&&this[i]){if(r.length)(S.event.special[i]||{}).delegateType&&e.stopPropagation();else if(r=s.call(arguments),Y.set(this,i,r),t=o(this,i),this[i](),r!==(n=Y.get(this,i))||t?Y.set(this,i,!1):n={},r!==n)return e.stopImmediatePropagation(),e.preventDefault(),n.value}else r.length&&(Y.set(this,i,{value:S.event.trigger(S.extend(r[0],S.Event.prototype),r.slice(1),this)}),e.stopImmediatePropagation())}})):void 0===Y.get(e,i)&&S.event.add(e,i,Ce)}S.event={global:{},add:function(t,e,n,r,i){var o,a,s,u,l,c,f,p,d,h,g,v=Y.get(t);if(V(t)){n.handler&&(n=(o=n).handler,i=o.selector),i&&S.find.matchesSelector(re,i),n.guid||(n.guid=S.guid++),(u=v.events)||(u=v.events=Object.create(null)),(a=v.handle)||(a=v.handle=function(e){return"undefined"!=typeof S&&S.event.triggered!==e.type?S.event.dispatch.apply(t,arguments):void 0}),l=(e=(e||"").match(P)||[""]).length;while(l--)d=g=(s=Te.exec(e[l])||[])[1],h=(s[2]||"").split(".").sort(),d&&(f=S.event.special[d]||{},d=(i?f.delegateType:f.bindType)||d,f=S.event.special[d]||{},c=S.extend({type:d,origType:g,data:r,handler:n,guid:n.guid,selector:i,needsContext:i&&S.expr.match.needsContext.test(i),namespace:h.join(".")},o),(p=u[d])||((p=u[d]=[]).delegateCount=0,f.setup&&!1!==f.setup.call(t,r,h,a)||t.addEventListener&&t.addEventListener(d,a)),f.add&&(f.add.call(t,c),c.handler.guid||(c.handler.guid=n.guid)),i?p.splice(p.delegateCount++,0,c):p.push(c),S.event.global[d]=!0)}},remove:function(e,t,n,r,i){var o,a,s,u,l,c,f,p,d,h,g,v=Y.hasData(e)&&Y.get(e);if(v&&(u=v.events)){l=(t=(t||"").match(P)||[""]).length;while(l--)if(d=g=(s=Te.exec(t[l])||[])[1],h=(s[2]||"").split(".").sort(),d){f=S.event.special[d]||{},p=u[d=(r?f.delegateType:f.bindType)||d]||[],s=s[2]&&new RegExp("(^|\\.)"+h.join("\\.(?:.*\\.|)")+"(\\.|$)"),a=o=p.length;while(o--)c=p[o],!i&&g!==c.origType||n&&n.guid!==c.guid||s&&!s.test(c.namespace)||r&&r!==c.selector&&("**"!==r||!c.selector)||(p.splice(o,1),c.selector&&p.delegateCount--,f.remove&&f.remove.call(e,c));a&&!p.length&&(f.teardown&&!1!==f.teardown.call(e,h,v.handle)||S.removeEvent(e,d,v.handle),delete u[d])}else for(d in u)S.event.remove(e,d+t[l],n,r,!0);S.isEmptyObject(u)&&Y.remove(e,"handle events")}},dispatch:function(e){var t,n,r,i,o,a,s=new Array(arguments.length),u=S.event.fix(e),l=(Y.get(this,"events")||Object.create(null))[u.type]||[],c=S.event.special[u.type]||{};for(s[0]=u,t=1;t<arguments.length;t++)s[t]=arguments[t];if(u.delegateTarget=this,!c.preDispatch||!1!==c.preDispatch.call(this,u)){a=S.event.handlers.call(this,u,l),t=0;while((i=a[t++])&&!u.isPropagationStopped()){u.currentTarget=i.elem,n=0;while((o=i.handlers[n++])&&!u.isImmediatePropagationStopped())u.rnamespace&&!1!==o.namespace&&!u.rnamespace.test(o.namespace)||(u.handleObj=o,u.data=o.data,void 0!==(r=((S.event.special[o.origType]||{}).handle||o.handler).apply(i.elem,s))&&!1===(u.result=r)&&(u.preventDefault(),u.stopPropagation()))}return c.postDispatch&&c.postDispatch.call(this,u),u.result}},handlers:function(e,t){var n,r,i,o,a,s=[],u=t.delegateCount,l=e.target;if(u&&l.nodeType&&!("click"===e.type&&1<=e.button))for(;l!==this;l=l.parentNode||this)if(1===l.nodeType&&("click"!==e.type||!0!==l.disabled)){for(o=[],a={},n=0;n<u;n++)void 0===a[i=(r=t[n]).selector+" "]&&(a[i]=r.needsContext?-1<S(i,this).index(l):S.find(i,this,null,[l]).length),a[i]&&o.push(r);o.length&&s.push({elem:l,handlers:o})}return l=this,u<t.length&&s.push({elem:l,handlers:t.slice(u)}),s},addProp:function(t,e){Object.defineProperty(S.Event.prototype,t,{enumerable:!0,configurable:!0,get:m(e)?function(){if(this.originalEvent)return e(this.originalEvent)}:function(){if(this.originalEvent)return this.originalEvent[t]},set:function(e){Object.defineProperty(this,t,{enumerable:!0,configurable:!0,writable:!0,value:e})}})},fix:function(e){return e[S.expando]?e:new S.Event(e)},special:{load:{noBubble:!0},click:{setup:function(e){var t=this||e;return pe.test(t.type)&&t.click&&A(t,"input")&&Ae(t,"click",Ce),!1},trigger:function(e){var t=this||e;return pe.test(t.type)&&t.click&&A(t,"input")&&Ae(t,"click"),!0},_default:function(e){var t=e.target;return pe.test(t.type)&&t.click&&A(t,"input")&&Y.get(t,"click")||A(t,"a")}},beforeunload:{postDispatch:function(e){void 0!==e.result&&e.originalEvent&&(e.originalEvent.returnValue=e.result)}}}},S.removeEvent=function(e,t,n){e.removeEventListener&&e.removeEventListener(t,n)},S.Event=function(e,t){if(!(this instanceof S.Event))return new S.Event(e,t);e&&e.type?(this.originalEvent=e,this.type=e.type,this.isDefaultPrevented=e.defaultPrevented||void 0===e.defaultPrevented&&!1===e.returnValue?Ce:Ee,this.target=e.target&&3===e.target.nodeType?e.target.parentNode:e.target,this.currentTarget=e.currentTarget,this.relatedTarget=e.relatedTarget):this.type=e,t&&S.extend(this,t),this.timeStamp=e&&e.timeStamp||Date.now(),this[S.expando]=!0},S.Event.prototype={constructor:S.Event,isDefaultPrevented:Ee,isPropagationStopped:Ee,isImmediatePropagationStopped:Ee,isSimulated:!1,preventDefault:function(){var e=this.originalEvent;this.isDefaultPrevented=Ce,e&&!this.isSimulated&&e.preventDefault()},stopPropagation:function(){var e=this.originalEvent;this.isPropagationStopped=Ce,e&&!this.isSimulated&&e.stopPropagation()},stopImmediatePropagation:function(){var e=this.originalEvent;this.isImmediatePropagationStopped=Ce,e&&!this.isSimulated&&e.stopImmediatePropagation(),this.stopPropagation()}},S.each({altKey:!0,bubbles:!0,cancelable:!0,changedTouches:!0,ctrlKey:!0,detail:!0,eventPhase:!0,metaKey:!0,pageX:!0,pageY:!0,shiftKey:!0,view:!0,"char":!0,code:!0,charCode:!0,key:!0,keyCode:!0,button:!0,buttons:!0,clientX:!0,clientY:!0,offsetX:!0,offsetY:!0,pointerId:!0,pointerType:!0,screenX:!0,screenY:!0,targetTouches:!0,toElement:!0,touches:!0,which:function(e){var t=e.button;return null==e.which&&be.test(e.type)?null!=e.charCode?e.charCode:e.keyCode:!e.which&&void 0!==t&&we.test(e.type)?1&t?1:2&t?3:4&t?2:0:e.which}},S.event.addProp),S.each({focus:"focusin",blur:"focusout"},function(e,t){S.event.special[e]={setup:function(){return Ae(this,e,Se),!1},trigger:function(){return Ae(this,e),!0},delegateType:t}}),S.each({mouseenter:"mouseover",mouseleave:"mouseout",pointerenter:"pointerover",pointerleave:"pointerout"},function(e,i){S.event.special[e]={delegateType:i,bindType:i,handle:function(e){var t,n=e.relatedTarget,r=e.handleObj;return n&&(n===this||S.contains(this,n))||(e.type=r.origType,t=r.handler.apply(this,arguments),e.type=i),t}}}),S.fn.extend({on:function(e,t,n,r){return ke(this,e,t,n,r)},one:function(e,t,n,r){return ke(this,e,t,n,r,1)},off:function(e,t,n){var r,i;if(e&&e.preventDefault&&e.handleObj)return r=e.handleObj,S(e.delegateTarget).off(r.namespace?r.origType+"."+r.namespace:r.origType,r.selector,r.handler),this;if("object"==typeof e){for(i in e)this.off(i,t,e[i]);return this}return!1!==t&&"function"!=typeof t||(n=t,t=void 0),!1===n&&(n=Ee),this.each(function(){S.event.remove(this,e,n,t)})}});var Ne=/<script|<style|<link/i,De=/checked\s*(?:[^=]|=\s*.checked.)/i,je=/^\s*<!(?:\[CDATA\[|--)|(?:\]\]|--)>\s*$/g;function qe(e,t){return A(e,"table")&&A(11!==t.nodeType?t:t.firstChild,"tr")&&S(e).children("tbody")[0]||e}function Le(e){return e.type=(null!==e.getAttribute("type"))+"/"+e.type,e}function He(e){return"true/"===(e.type||"").slice(0,5)?e.type=e.type.slice(5):e.removeAttribute("type"),e}function Oe(e,t){var n,r,i,o,a,s;if(1===t.nodeType){if(Y.hasData(e)&&(s=Y.get(e).events))for(i in Y.remove(t,"handle events"),s)for(n=0,r=s[i].length;n<r;n++)S.event.add(t,i,s[i][n]);Q.hasData(e)&&(o=Q.access(e),a=S.extend({},o),Q.set(t,a))}}function Pe(n,r,i,o){r=g(r);var e,t,a,s,u,l,c=0,f=n.length,p=f-1,d=r[0],h=m(d);if(h||1<f&&"string"==typeof d&&!y.checkClone&&De.test(d))return n.each(function(e){var t=n.eq(e);h&&(r[0]=d.call(this,e,t.html())),Pe(t,r,i,o)});if(f&&(t=(e=xe(r,n[0].ownerDocument,!1,n,o)).firstChild,1===e.childNodes.length&&(e=t),t||o)){for(s=(a=S.map(ve(e,"script"),Le)).length;c<f;c++)u=e,c!==p&&(u=S.clone(u,!0,!0),s&&S.merge(a,ve(u,"script"))),i.call(n[c],u,c);if(s)for(l=a[a.length-1].ownerDocument,S.map(a,He),c=0;c<s;c++)u=a[c],he.test(u.type||"")&&!Y.access(u,"globalEval")&&S.contains(l,u)&&(u.src&&"module"!==(u.type||"").toLowerCase()?S._evalUrl&&!u.noModule&&S._evalUrl(u.src,{nonce:u.nonce||u.getAttribute("nonce")},l):b(u.textContent.replace(je,""),u,l))}return n}function Re(e,t,n){for(var r,i=t?S.filter(t,e):e,o=0;null!=(r=i[o]);o++)n||1!==r.nodeType||S.cleanData(ve(r)),r.parentNode&&(n&&ie(r)&&ye(ve(r,"script")),r.parentNode.removeChild(r));return e}S.extend({htmlPrefilter:function(e){return e},clone:function(e,t,n){var r,i,o,a,s,u,l,c=e.cloneNode(!0),f=ie(e);if(!(y.noCloneChecked||1!==e.nodeType&&11!==e.nodeType||S.isXMLDoc(e)))for(a=ve(c),r=0,i=(o=ve(e)).length;r<i;r++)s=o[r],u=a[r],void 0,"input"===(l=u.nodeName.toLowerCase())&&pe.test(s.type)?u.checked=s.checked:"input"!==l&&"textarea"!==l||(u.defaultValue=s.defaultValue);if(t)if(n)for(o=o||ve(e),a=a||ve(c),r=0,i=o.length;r<i;r++)Oe(o[r],a[r]);else Oe(e,c);return 0<(a=ve(c,"script")).length&&ye(a,!f&&ve(e,"script")),c},cleanData:function(e){for(var t,n,r,i=S.event.special,o=0;void 0!==(n=e[o]);o++)if(V(n)){if(t=n[Y.expando]){if(t.events)for(r in t.events)i[r]?S.event.remove(n,r):S.removeEvent(n,r,t.handle);n[Y.expando]=void 0}n[Q.expando]&&(n[Q.expando]=void 0)}}}),S.fn.extend({detach:function(e){return Re(this,e,!0)},remove:function(e){return Re(this,e)},text:function(e){return $(this,function(e){return void 0===e?S.text(this):this.empty().each(function(){1!==this.nodeType&&11!==this.nodeType&&9!==this.nodeType||(this.textContent=e)})},null,e,arguments.length)},append:function(){return Pe(this,arguments,function(e){1!==this.nodeType&&11!==this.nodeType&&9!==this.nodeType||qe(this,e).appendChild(e)})},prepend:function(){return Pe(this,arguments,function(e){if(1===this.nodeType||11===this.nodeType||9===this.nodeType){var t=qe(this,e);t.insertBefore(e,t.firstChild)}})},before:function(){return Pe(this,arguments,function(e){this.parentNode&&this.parentNode.insertBefore(e,this)})},after:function(){return Pe(this,arguments,function(e){this.parentNode&&this.parentNode.insertBefore(e,this.nextSibling)})},empty:function(){for(var e,t=0;null!=(e=this[t]);t++)1===e.nodeType&&(S.cleanData(ve(e,!1)),e.textContent="");return this},clone:function(e,t){return e=null!=e&&e,t=null==t?e:t,this.map(function(){return S.clone(this,e,t)})},html:function(e){return $(this,function(e){var t=this[0]||{},n=0,r=this.length;if(void 0===e&&1===t.nodeType)return t.innerHTML;if("string"==typeof e&&!Ne.test(e)&&!ge[(de.exec(e)||["",""])[1].toLowerCase()]){e=S.htmlPrefilter(e);try{for(;n<r;n++)1===(t=this[n]||{}).nodeType&&(S.cleanData(ve(t,!1)),t.innerHTML=e);t=0}catch(e){}}t&&this.empty().append(e)},null,e,arguments.length)},replaceWith:function(){var n=[];return Pe(this,arguments,function(e){var t=this.parentNode;S.inArray(this,n)<0&&(S.cleanData(ve(this)),t&&t.replaceChild(e,this))},n)}}),S.each({appendTo:"append",prependTo:"prepend",insertBefore:"before",insertAfter:"after",replaceAll:"replaceWith"},function(e,a){S.fn[e]=function(e){for(var t,n=[],r=S(e),i=r.length-1,o=0;o<=i;o++)t=o===i?this:this.clone(!0),S(r[o])[a](t),u.apply(n,t.get());return this.pushStack(n)}});var Me=new RegExp("^("+ee+")(?!px)[a-z%]+$","i"),Ie=function(e){var t=e.ownerDocument.defaultView;return t&&t.opener||(t=C),t.getComputedStyle(e)},We=function(e,t,n){var r,i,o={};for(i in t)o[i]=e.style[i],e.style[i]=t[i];for(i in r=n.call(e),t)e.style[i]=o[i];return r},Fe=new RegExp(ne.join("|"),"i");function Be(e,t,n){var r,i,o,a,s=e.style;return(n=n||Ie(e))&&(""!==(a=n.getPropertyValue(t)||n[t])||ie(e)||(a=S.style(e,t)),!y.pixelBoxStyles()&&Me.test(a)&&Fe.test(t)&&(r=s.width,i=s.minWidth,o=s.maxWidth,s.minWidth=s.maxWidth=s.width=a,a=n.width,s.width=r,s.minWidth=i,s.maxWidth=o)),void 0!==a?a+"":a}function $e(e,t){return{get:function(){if(!e())return(this.get=t).apply(this,arguments);delete this.get}}}!function(){function e(){if(l){u.style.cssText="position:absolute;left:-11111px;width:60px;margin-top:1px;padding:0;border:0",l.style.cssText="position:relative;display:block;box-sizing:border-box;overflow:scroll;margin:auto;border:1px;padding:1px;width:60%;top:1%",re.appendChild(u).appendChild(l);var e=C.getComputedStyle(l);n="1%"!==e.top,s=12===t(e.marginLeft),l.style.right="60%",o=36===t(e.right),r=36===t(e.width),l.style.position="absolute",i=12===t(l.offsetWidth/3),re.removeChild(u),l=null}}function t(e){return Math.round(parseFloat(e))}var n,r,i,o,a,s,u=E.createElement("div"),l=E.createElement("div");l.style&&(l.style.backgroundClip="content-box",l.cloneNode(!0).style.backgroundClip="",y.clearCloneStyle="content-box"===l.style.backgroundClip,S.extend(y,{boxSizingReliable:function(){return e(),r},pixelBoxStyles:function(){return e(),o},pixelPosition:function(){return e(),n},reliableMarginLeft:function(){return e(),s},scrollboxSize:function(){return e(),i},reliableTrDimensions:function(){var e,t,n,r;return null==a&&(e=E.createElement("table"),t=E.createElement("tr"),n=E.createElement("div"),e.style.cssText="position:absolute;left:-11111px",t.style.height="1px",n.style.height="9px",re.appendChild(e).appendChild(t).appendChild(n),r=C.getComputedStyle(t),a=3<parseInt(r.height),re.removeChild(e)),a}}))}();var _e=["Webkit","Moz","ms"],ze=E.createElement("div").style,Ue={};function Xe(e){var t=S.cssProps[e]||Ue[e];return t||(e in ze?e:Ue[e]=function(e){var t=e[0].toUpperCase()+e.slice(1),n=_e.length;while(n--)if((e=_e[n]+t)in ze)return e}(e)||e)}var Ve=/^(none|table(?!-c[ea]).+)/,Ge=/^--/,Ye={position:"absolute",visibility:"hidden",display:"block"},Qe={letterSpacing:"0",fontWeight:"400"};function Je(e,t,n){var r=te.exec(t);return r?Math.max(0,r[2]-(n||0))+(r[3]||"px"):t}function Ke(e,t,n,r,i,o){var a="width"===t?1:0,s=0,u=0;if(n===(r?"border":"content"))return 0;for(;a<4;a+=2)"margin"===n&&(u+=S.css(e,n+ne[a],!0,i)),r?("content"===n&&(u-=S.css(e,"padding"+ne[a],!0,i)),"margin"!==n&&(u-=S.css(e,"border"+ne[a]+"Width",!0,i))):(u+=S.css(e,"padding"+ne[a],!0,i),"padding"!==n?u+=S.css(e,"border"+ne[a]+"Width",!0,i):s+=S.css(e,"border"+ne[a]+"Width",!0,i));return!r&&0<=o&&(u+=Math.max(0,Math.ceil(e["offset"+t[0].toUpperCase()+t.slice(1)]-o-u-s-.5))||0),u}function Ze(e,t,n){var r=Ie(e),i=(!y.boxSizingReliable()||n)&&"border-box"===S.css(e,"boxSizing",!1,r),o=i,a=Be(e,t,r),s="offset"+t[0].toUpperCase()+t.slice(1);if(Me.test(a)){if(!n)return a;a="auto"}return(!y.boxSizingReliable()&&i||!y.reliableTrDimensions()&&A(e,"tr")||"auto"===a||!parseFloat(a)&&"inline"===S.css(e,"display",!1,r))&&e.getClientRects().length&&(i="border-box"===S.css(e,"boxSizing",!1,r),(o=s in e)&&(a=e[s])),(a=parseFloat(a)||0)+Ke(e,t,n||(i?"border":"content"),o,r,a)+"px"}function et(e,t,n,r,i){return new et.prototype.init(e,t,n,r,i)}S.extend({cssHooks:{opacity:{get:function(e,t){if(t){var n=Be(e,"opacity");return""===n?"1":n}}}},cssNumber:{animationIterationCount:!0,columnCount:!0,fillOpacity:!0,flexGrow:!0,flexShrink:!0,fontWeight:!0,gridArea:!0,gridColumn:!0,gridColumnEnd:!0,gridColumnStart:!0,gridRow:!0,gridRowEnd:!0,gridRowStart:!0,lineHeight:!0,opacity:!0,order:!0,orphans:!0,widows:!0,zIndex:!0,zoom:!0},cssProps:{},style:function(e,t,n,r){if(e&&3!==e.nodeType&&8!==e.nodeType&&e.style){var i,o,a,s=X(t),u=Ge.test(t),l=e.style;if(u||(t=Xe(s)),a=S.cssHooks[t]||S.cssHooks[s],void 0===n)return a&&"get"in a&&void 0!==(i=a.get(e,!1,r))?i:l[t];"string"===(o=typeof n)&&(i=te.exec(n))&&i[1]&&(n=se(e,t,i),o="number"),null!=n&&n==n&&("number"!==o||u||(n+=i&&i[3]||(S.cssNumber[s]?"":"px")),y.clearCloneStyle||""!==n||0!==t.indexOf("background")||(l[t]="inherit"),a&&"set"in a&&void 0===(n=a.set(e,n,r))||(u?l.setProperty(t,n):l[t]=n))}},css:function(e,t,n,r){var i,o,a,s=X(t);return Ge.test(t)||(t=Xe(s)),(a=S.cssHooks[t]||S.cssHooks[s])&&"get"in a&&(i=a.get(e,!0,n)),void 0===i&&(i=Be(e,t,r)),"normal"===i&&t in Qe&&(i=Qe[t]),""===n||n?(o=parseFloat(i),!0===n||isFinite(o)?o||0:i):i}}),S.each(["height","width"],function(e,u){S.cssHooks[u]={get:function(e,t,n){if(t)return!Ve.test(S.css(e,"display"))||e.getClientRects().length&&e.getBoundingClientRect().width?Ze(e,u,n):We(e,Ye,function(){return Ze(e,u,n)})},set:function(e,t,n){var r,i=Ie(e),o=!y.scrollboxSize()&&"absolute"===i.position,a=(o||n)&&"border-box"===S.css(e,"boxSizing",!1,i),s=n?Ke(e,u,n,a,i):0;return a&&o&&(s-=Math.ceil(e["offset"+u[0].toUpperCase()+u.slice(1)]-parseFloat(i[u])-Ke(e,u,"border",!1,i)-.5)),s&&(r=te.exec(t))&&"px"!==(r[3]||"px")&&(e.style[u]=t,t=S.css(e,u)),Je(0,t,s)}}}),S.cssHooks.marginLeft=$e(y.reliableMarginLeft,function(e,t){if(t)return(parseFloat(Be(e,"marginLeft"))||e.getBoundingClientRect().left-We(e,{marginLeft:0},function(){return e.getBoundingClientRect().left}))+"px"}),S.each({margin:"",padding:"",border:"Width"},function(i,o){S.cssHooks[i+o]={expand:function(e){for(var t=0,n={},r="string"==typeof e?e.split(" "):[e];t<4;t++)n[i+ne[t]+o]=r[t]||r[t-2]||r[0];return n}},"margin"!==i&&(S.cssHooks[i+o].set=Je)}),S.fn.extend({css:function(e,t){return $(this,function(e,t,n){var r,i,o={},a=0;if(Array.isArray(t)){for(r=Ie(e),i=t.length;a<i;a++)o[t[a]]=S.css(e,t[a],!1,r);return o}return void 0!==n?S.style(e,t,n):S.css(e,t)},e,t,1<arguments.length)}}),((S.Tween=et).prototype={constructor:et,init:function(e,t,n,r,i,o){this.elem=e,this.prop=n,this.easing=i||S.easing._default,this.options=t,this.start=this.now=this.cur(),this.end=r,this.unit=o||(S.cssNumber[n]?"":"px")},cur:function(){var e=et.propHooks[this.prop];return e&&e.get?e.get(this):et.propHooks._default.get(this)},run:function(e){var t,n=et.propHooks[this.prop];return this.options.duration?this.pos=t=S.easing[this.easing](e,this.options.duration*e,0,1,this.options.duration):this.pos=t=e,this.now=(this.end-this.start)*t+this.start,this.options.step&&this.options.step.call(this.elem,this.now,this),n&&n.set?n.set(this):et.propHooks._default.set(this),this}}).init.prototype=et.prototype,(et.propHooks={_default:{get:function(e){var t;return 1!==e.elem.nodeType||null!=e.elem[e.prop]&&null==e.elem.style[e.prop]?e.elem[e.prop]:(t=S.css(e.elem,e.prop,""))&&"auto"!==t?t:0},set:function(e){S.fx.step[e.prop]?S.fx.step[e.prop](e):1!==e.elem.nodeType||!S.cssHooks[e.prop]&&null==e.elem.style[Xe(e.prop)]?e.elem[e.prop]=e.now:S.style(e.elem,e.prop,e.now+e.unit)}}}).scrollTop=et.propHooks.scrollLeft={set:function(e){e.elem.nodeType&&e.elem.parentNode&&(e.elem[e.prop]=e.now)}},S.easing={linear:function(e){return e},swing:function(e){return.5-Math.cos(e*Math.PI)/2},_default:"swing"},S.fx=et.prototype.init,S.fx.step={};var tt,nt,rt,it,ot=/^(?:toggle|show|hide)$/,at=/queueHooks$/;function st(){nt&&(!1===E.hidden&&C.requestAnimationFrame?C.requestAnimationFrame(st):C.setTimeout(st,S.fx.interval),S.fx.tick())}function ut(){return C.setTimeout(function(){tt=void 0}),tt=Date.now()}function lt(e,t){var n,r=0,i={height:e};for(t=t?1:0;r<4;r+=2-t)i["margin"+(n=ne[r])]=i["padding"+n]=e;return t&&(i.opacity=i.width=e),i}function ct(e,t,n){for(var r,i=(ft.tweeners[t]||[]).concat(ft.tweeners["*"]),o=0,a=i.length;o<a;o++)if(r=i[o].call(n,t,e))return r}function ft(o,e,t){var n,a,r=0,i=ft.prefilters.length,s=S.Deferred().always(function(){delete u.elem}),u=function(){if(a)return!1;for(var e=tt||ut(),t=Math.max(0,l.startTime+l.duration-e),n=1-(t/l.duration||0),r=0,i=l.tweens.length;r<i;r++)l.tweens[r].run(n);return s.notifyWith(o,[l,n,t]),n<1&&i?t:(i||s.notifyWith(o,[l,1,0]),s.resolveWith(o,[l]),!1)},l=s.promise({elem:o,props:S.extend({},e),opts:S.extend(!0,{specialEasing:{},easing:S.easing._default},t),originalProperties:e,originalOptions:t,startTime:tt||ut(),duration:t.duration,tweens:[],createTween:function(e,t){var n=S.Tween(o,l.opts,e,t,l.opts.specialEasing[e]||l.opts.easing);return l.tweens.push(n),n},stop:function(e){var t=0,n=e?l.tweens.length:0;if(a)return this;for(a=!0;t<n;t++)l.tweens[t].run(1);return e?(s.notifyWith(o,[l,1,0]),s.resolveWith(o,[l,e])):s.rejectWith(o,[l,e]),this}}),c=l.props;for(!function(e,t){var n,r,i,o,a;for(n in e)if(i=t[r=X(n)],o=e[n],Array.isArray(o)&&(i=o[1],o=e[n]=o[0]),n!==r&&(e[r]=o,delete e[n]),(a=S.cssHooks[r])&&"expand"in a)for(n in o=a.expand(o),delete e[r],o)n in e||(e[n]=o[n],t[n]=i);else t[r]=i}(c,l.opts.specialEasing);r<i;r++)if(n=ft.prefilters[r].call(l,o,c,l.opts))return m(n.stop)&&(S._queueHooks(l.elem,l.opts.queue).stop=n.stop.bind(n)),n;return S.map(c,ct,l),m(l.opts.start)&&l.opts.start.call(o,l),l.progress(l.opts.progress).done(l.opts.done,l.opts.complete).fail(l.opts.fail).always(l.opts.always),S.fx.timer(S.extend(u,{elem:o,anim:l,queue:l.opts.queue})),l}S.Animation=S.extend(ft,{tweeners:{"*":[function(e,t){var n=this.createTween(e,t);return se(n.elem,e,te.exec(t),n),n}]},tweener:function(e,t){m(e)?(t=e,e=["*"]):e=e.match(P);for(var n,r=0,i=e.length;r<i;r++)n=e[r],ft.tweeners[n]=ft.tweeners[n]||[],ft.tweeners[n].unshift(t)},prefilters:[function(e,t,n){var r,i,o,a,s,u,l,c,f="width"in t||"height"in t,p=this,d={},h=e.style,g=e.nodeType&&ae(e),v=Y.get(e,"fxshow");for(r in n.queue||(null==(a=S._queueHooks(e,"fx")).unqueued&&(a.unqueued=0,s=a.empty.fire,a.empty.fire=function(){a.unqueued||s()}),a.unqueued++,p.always(function(){p.always(function(){a.unqueued--,S.queue(e,"fx").length||a.empty.fire()})})),t)if(i=t[r],ot.test(i)){if(delete t[r],o=o||"toggle"===i,i===(g?"hide":"show")){if("show"!==i||!v||void 0===v[r])continue;g=!0}d[r]=v&&v[r]||S.style(e,r)}if((u=!S.isEmptyObject(t))||!S.isEmptyObject(d))for(r in f&&1===e.nodeType&&(n.overflow=[h.overflow,h.overflowX,h.overflowY],null==(l=v&&v.display)&&(l=Y.get(e,"display")),"none"===(c=S.css(e,"display"))&&(l?c=l:(le([e],!0),l=e.style.display||l,c=S.css(e,"display"),le([e]))),("inline"===c||"inline-block"===c&&null!=l)&&"none"===S.css(e,"float")&&(u||(p.done(function(){h.display=l}),null==l&&(c=h.display,l="none"===c?"":c)),h.display="inline-block")),n.overflow&&(h.overflow="hidden",p.always(function(){h.overflow=n.overflow[0],h.overflowX=n.overflow[1],h.overflowY=n.overflow[2]})),u=!1,d)u||(v?"hidden"in v&&(g=v.hidden):v=Y.access(e,"fxshow",{display:l}),o&&(v.hidden=!g),g&&le([e],!0),p.done(function(){for(r in g||le([e]),Y.remove(e,"fxshow"),d)S.style(e,r,d[r])})),u=ct(g?v[r]:0,r,p),r in v||(v[r]=u.start,g&&(u.end=u.start,u.start=0))}],prefilter:function(e,t){t?ft.prefilters.unshift(e):ft.prefilters.push(e)}}),S.speed=function(e,t,n){var r=e&&"object"==typeof e?S.extend({},e):{complete:n||!n&&t||m(e)&&e,duration:e,easing:n&&t||t&&!m(t)&&t};return S.fx.off?r.duration=0:"number"!=typeof r.duration&&(r.duration in S.fx.speeds?r.duration=S.fx.speeds[r.duration]:r.duration=S.fx.speeds._default),null!=r.queue&&!0!==r.queue||(r.queue="fx"),r.old=r.complete,r.complete=function(){m(r.old)&&r.old.call(this),r.queue&&S.dequeue(this,r.queue)},r},S.fn.extend({fadeTo:function(e,t,n,r){return this.filter(ae).css("opacity",0).show().end().animate({opacity:t},e,n,r)},animate:function(t,e,n,r){var i=S.isEmptyObject(t),o=S.speed(e,n,r),a=function(){var e=ft(this,S.extend({},t),o);(i||Y.get(this,"finish"))&&e.stop(!0)};return a.finish=a,i||!1===o.queue?this.each(a):this.queue(o.queue,a)},stop:function(i,e,o){var a=function(e){var t=e.stop;delete e.stop,t(o)};return"string"!=typeof i&&(o=e,e=i,i=void 0),e&&this.queue(i||"fx",[]),this.each(function(){var e=!0,t=null!=i&&i+"queueHooks",n=S.timers,r=Y.get(this);if(t)r[t]&&r[t].stop&&a(r[t]);else for(t in r)r[t]&&r[t].stop&&at.test(t)&&a(r[t]);for(t=n.length;t--;)n[t].elem!==this||null!=i&&n[t].queue!==i||(n[t].anim.stop(o),e=!1,n.splice(t,1));!e&&o||S.dequeue(this,i)})},finish:function(a){return!1!==a&&(a=a||"fx"),this.each(function(){var e,t=Y.get(this),n=t[a+"queue"],r=t[a+"queueHooks"],i=S.timers,o=n?n.length:0;for(t.finish=!0,S.queue(this,a,[]),r&&r.stop&&r.stop.call(this,!0),e=i.length;e--;)i[e].elem===this&&i[e].queue===a&&(i[e].anim.stop(!0),i.splice(e,1));for(e=0;e<o;e++)n[e]&&n[e].finish&&n[e].finish.call(this);delete t.finish})}}),S.each(["toggle","show","hide"],function(e,r){var i=S.fn[r];S.fn[r]=function(e,t,n){return null==e||"boolean"==typeof e?i.apply(this,arguments):this.animate(lt(r,!0),e,t,n)}}),S.each({slideDown:lt("show"),slideUp:lt("hide"),slideToggle:lt("toggle"),fadeIn:{opacity:"show"},fadeOut:{opacity:"hide"},fadeToggle:{opacity:"toggle"}},function(e,r){S.fn[e]=function(e,t,n){return this.animate(r,e,t,n)}}),S.timers=[],S.fx.tick=function(){var e,t=0,n=S.timers;for(tt=Date.now();t<n.length;t++)(e=n[t])()||n[t]!==e||n.splice(t--,1);n.length||S.fx.stop(),tt=void 0},S.fx.timer=function(e){S.timers.push(e),S.fx.start()},S.fx.interval=13,S.fx.start=function(){nt||(nt=!0,st())},S.fx.stop=function(){nt=null},S.fx.speeds={slow:600,fast:200,_default:400},S.fn.delay=function(r,e){return r=S.fx&&S.fx.speeds[r]||r,e=e||"fx",this.queue(e,function(e,t){var n=C.setTimeout(e,r);t.stop=function(){C.clearTimeout(n)}})},rt=E.createElement("input"),it=E.createElement("select").appendChild(E.createElement("option")),rt.type="checkbox",y.checkOn=""!==rt.value,y.optSelected=it.selected,(rt=E.createElement("input")).value="t",rt.type="radio",y.radioValue="t"===rt.value;var pt,dt=S.expr.attrHandle;S.fn.extend({attr:function(e,t){return $(this,S.attr,e,t,1<arguments.length)},removeAttr:function(e){return this.each(function(){S.removeAttr(this,e)})}}),S.extend({attr:function(e,t,n){var r,i,o=e.nodeType;if(3!==o&&8!==o&&2!==o)return"undefined"==typeof e.getAttribute?S.prop(e,t,n):(1===o&&S.isXMLDoc(e)||(i=S.attrHooks[t.toLowerCase()]||(S.expr.match.bool.test(t)?pt:void 0)),void 0!==n?null===n?void S.removeAttr(e,t):i&&"set"in i&&void 0!==(r=i.set(e,n,t))?r:(e.setAttribute(t,n+""),n):i&&"get"in i&&null!==(r=i.get(e,t))?r:null==(r=S.find.attr(e,t))?void 0:r)},attrHooks:{type:{set:function(e,t){if(!y.radioValue&&"radio"===t&&A(e,"input")){var n=e.value;return e.setAttribute("type",t),n&&(e.value=n),t}}}},removeAttr:function(e,t){var n,r=0,i=t&&t.match(P);if(i&&1===e.nodeType)while(n=i[r++])e.removeAttribute(n)}}),pt={set:function(e,t,n){return!1===t?S.removeAttr(e,n):e.setAttribute(n,n),n}},S.each(S.expr.match.bool.source.match(/\w+/g),function(e,t){var a=dt[t]||S.find.attr;dt[t]=function(e,t,n){var r,i,o=t.toLowerCase();return n||(i=dt[o],dt[o]=r,r=null!=a(e,t,n)?o:null,dt[o]=i),r}});var ht=/^(?:input|select|textarea|button)$/i,gt=/^(?:a|area)$/i;function vt(e){return(e.match(P)||[]).join(" ")}function yt(e){return e.getAttribute&&e.getAttribute("class")||""}function mt(e){return Array.isArray(e)?e:"string"==typeof e&&e.match(P)||[]}S.fn.extend({prop:function(e,t){return $(this,S.prop,e,t,1<arguments.length)},removeProp:function(e){return this.each(function(){delete this[S.propFix[e]||e]})}}),S.extend({prop:function(e,t,n){var r,i,o=e.nodeType;if(3!==o&&8!==o&&2!==o)return 1===o&&S.isXMLDoc(e)||(t=S.propFix[t]||t,i=S.propHooks[t]),void 0!==n?i&&"set"in i&&void 0!==(r=i.set(e,n,t))?r:e[t]=n:i&&"get"in i&&null!==(r=i.get(e,t))?r:e[t]},propHooks:{tabIndex:{get:function(e){var t=S.find.attr(e,"tabindex");return t?parseInt(t,10):ht.test(e.nodeName)||gt.test(e.nodeName)&&e.href?0:-1}}},propFix:{"for":"htmlFor","class":"className"}}),y.optSelected||(S.propHooks.selected={get:function(e){var t=e.parentNode;return t&&t.parentNode&&t.parentNode.selectedIndex,null},set:function(e){var t=e.parentNode;t&&(t.selectedIndex,t.parentNode&&t.parentNode.selectedIndex)}}),S.each(["tabIndex","readOnly","maxLength","cellSpacing","cellPadding","rowSpan","colSpan","useMap","frameBorder","contentEditable"],function(){S.propFix[this.toLowerCase()]=this}),S.fn.extend({addClass:function(t){var e,n,r,i,o,a,s,u=0;if(m(t))return this.each(function(e){S(this).addClass(t.call(this,e,yt(this)))});if((e=mt(t)).length)while(n=this[u++])if(i=yt(n),r=1===n.nodeType&&" "+vt(i)+" "){a=0;while(o=e[a++])r.indexOf(" "+o+" ")<0&&(r+=o+" ");i!==(s=vt(r))&&n.setAttribute("class",s)}return this},removeClass:function(t){var e,n,r,i,o,a,s,u=0;if(m(t))return this.each(function(e){S(this).removeClass(t.call(this,e,yt(this)))});if(!arguments.length)return this.attr("class","");if((e=mt(t)).length)while(n=this[u++])if(i=yt(n),r=1===n.nodeType&&" "+vt(i)+" "){a=0;while(o=e[a++])while(-1<r.indexOf(" "+o+" "))r=r.replace(" "+o+" "," ");i!==(s=vt(r))&&n.setAttribute("class",s)}return this},toggleClass:function(i,t){var o=typeof i,a="string"===o||Array.isArray(i);return"boolean"==typeof t&&a?t?this.addClass(i):this.removeClass(i):m(i)?this.each(function(e){S(this).toggleClass(i.call(this,e,yt(this),t),t)}):this.each(function(){var e,t,n,r;if(a){t=0,n=S(this),r=mt(i);while(e=r[t++])n.hasClass(e)?n.removeClass(e):n.addClass(e)}else void 0!==i&&"boolean"!==o||((e=yt(this))&&Y.set(this,"__className__",e),this.setAttribute&&this.setAttribute("class",e||!1===i?"":Y.get(this,"__className__")||""))})},hasClass:function(e){var t,n,r=0;t=" "+e+" ";while(n=this[r++])if(1===n.nodeType&&-1<(" "+vt(yt(n))+" ").indexOf(t))return!0;return!1}});var xt=/\r/g;S.fn.extend({val:function(n){var r,e,i,t=this[0];return arguments.length?(i=m(n),this.each(function(e){var t;1===this.nodeType&&(null==(t=i?n.call(this,e,S(this).val()):n)?t="":"number"==typeof t?t+="":Array.isArray(t)&&(t=S.map(t,function(e){return null==e?"":e+""})),(r=S.valHooks[this.type]||S.valHooks[this.nodeName.toLowerCase()])&&"set"in r&&void 0!==r.set(this,t,"value")||(this.value=t))})):t?(r=S.valHooks[t.type]||S.valHooks[t.nodeName.toLowerCase()])&&"get"in r&&void 0!==(e=r.get(t,"value"))?e:"string"==typeof(e=t.value)?e.replace(xt,""):null==e?"":e:void 0}}),S.extend({valHooks:{option:{get:function(e){var t=S.find.attr(e,"value");return null!=t?t:vt(S.text(e))}},select:{get:function(e){var t,n,r,i=e.options,o=e.selectedIndex,a="select-one"===e.type,s=a?null:[],u=a?o+1:i.length;for(r=o<0?u:a?o:0;r<u;r++)if(((n=i[r]).selected||r===o)&&!n.disabled&&(!n.parentNode.disabled||!A(n.parentNode,"optgroup"))){if(t=S(n).val(),a)return t;s.push(t)}return s},set:function(e,t){var n,r,i=e.options,o=S.makeArray(t),a=i.length;while(a--)((r=i[a]).selected=-1<S.inArray(S.valHooks.option.get(r),o))&&(n=!0);return n||(e.selectedIndex=-1),o}}}}),S.each(["radio","checkbox"],function(){S.valHooks[this]={set:function(e,t){if(Array.isArray(t))return e.checked=-1<S.inArray(S(e).val(),t)}},y.checkOn||(S.valHooks[this].get=function(e){return null===e.getAttribute("value")?"on":e.value})}),y.focusin="onfocusin"in C;var bt=/^(?:focusinfocus|focusoutblur)$/,wt=function(e){e.stopPropagation()};S.extend(S.event,{trigger:function(e,t,n,r){var i,o,a,s,u,l,c,f,p=[n||E],d=v.call(e,"type")?e.type:e,h=v.call(e,"namespace")?e.namespace.split("."):[];if(o=f=a=n=n||E,3!==n.nodeType&&8!==n.nodeType&&!bt.test(d+S.event.triggered)&&(-1<d.indexOf(".")&&(d=(h=d.split(".")).shift(),h.sort()),u=d.indexOf(":")<0&&"on"+d,(e=e[S.expando]?e:new S.Event(d,"object"==typeof e&&e)).isTrigger=r?2:3,e.namespace=h.join("."),e.rnamespace=e.namespace?new RegExp("(^|\\.)"+h.join("\\.(?:.*\\.|)")+"(\\.|$)"):null,e.result=void 0,e.target||(e.target=n),t=null==t?[e]:S.makeArray(t,[e]),c=S.event.special[d]||{},r||!c.trigger||!1!==c.trigger.apply(n,t))){if(!r&&!c.noBubble&&!x(n)){for(s=c.delegateType||d,bt.test(s+d)||(o=o.parentNode);o;o=o.parentNode)p.push(o),a=o;a===(n.ownerDocument||E)&&p.push(a.defaultView||a.parentWindow||C)}i=0;while((o=p[i++])&&!e.isPropagationStopped())f=o,e.type=1<i?s:c.bindType||d,(l=(Y.get(o,"events")||Object.create(null))[e.type]&&Y.get(o,"handle"))&&l.apply(o,t),(l=u&&o[u])&&l.apply&&V(o)&&(e.result=l.apply(o,t),!1===e.result&&e.preventDefault());return e.type=d,r||e.isDefaultPrevented()||c._default&&!1!==c._default.apply(p.pop(),t)||!V(n)||u&&m(n[d])&&!x(n)&&((a=n[u])&&(n[u]=null),S.event.triggered=d,e.isPropagationStopped()&&f.addEventListener(d,wt),n[d](),e.isPropagationStopped()&&f.removeEventListener(d,wt),S.event.triggered=void 0,a&&(n[u]=a)),e.result}},simulate:function(e,t,n){var r=S.extend(new S.Event,n,{type:e,isSimulated:!0});S.event.trigger(r,null,t)}}),S.fn.extend({trigger:function(e,t){return this.each(function(){S.event.trigger(e,t,this)})},triggerHandler:function(e,t){var n=this[0];if(n)return S.event.trigger(e,t,n,!0)}}),y.focusin||S.each({focus:"focusin",blur:"focusout"},function(n,r){var i=function(e){S.event.simulate(r,e.target,S.event.fix(e))};S.event.special[r]={setup:function(){var e=this.ownerDocument||this.document||this,t=Y.access(e,r);t||e.addEventListener(n,i,!0),Y.access(e,r,(t||0)+1)},teardown:function(){var e=this.ownerDocument||this.document||this,t=Y.access(e,r)-1;t?Y.access(e,r,t):(e.removeEventListener(n,i,!0),Y.remove(e,r))}}});var Tt=C.location,Ct={guid:Date.now()},Et=/\?/;S.parseXML=function(e){var t;if(!e||"string"!=typeof e)return null;try{t=(new C.DOMParser).parseFromString(e,"text/xml")}catch(e){t=void 0}return t&&!t.getElementsByTagName("parsererror").length||S.error("Invalid XML: "+e),t};var St=/\[\]$/,kt=/\r?\n/g,At=/^(?:submit|button|image|reset|file)$/i,Nt=/^(?:input|select|textarea|keygen)/i;function Dt(n,e,r,i){var t;if(Array.isArray(e))S.each(e,function(e,t){r||St.test(n)?i(n,t):Dt(n+"["+("object"==typeof t&&null!=t?e:"")+"]",t,r,i)});else if(r||"object"!==w(e))i(n,e);else for(t in e)Dt(n+"["+t+"]",e[t],r,i)}S.param=function(e,t){var n,r=[],i=function(e,t){var n=m(t)?t():t;r[r.length]=encodeURIComponent(e)+"="+encodeURIComponent(null==n?"":n)};if(null==e)return"";if(Array.isArray(e)||e.jquery&&!S.isPlainObject(e))S.each(e,function(){i(this.name,this.value)});else for(n in e)Dt(n,e[n],t,i);return r.join("&")},S.fn.extend({serialize:function(){return S.param(this.serializeArray())},serializeArray:function(){return this.map(function(){var e=S.prop(this,"elements");return e?S.makeArray(e):this}).filter(function(){var e=this.type;return this.name&&!S(this).is(":disabled")&&Nt.test(this.nodeName)&&!At.test(e)&&(this.checked||!pe.test(e))}).map(function(e,t){var n=S(this).val();return null==n?null:Array.isArray(n)?S.map(n,function(e){return{name:t.name,value:e.replace(kt,"\r\n")}}):{name:t.name,value:n.replace(kt,"\r\n")}}).get()}});var jt=/%20/g,qt=/#.*$/,Lt=/([?&])_=[^&]*/,Ht=/^(.*?):[ \t]*([^\r\n]*)$/gm,Ot=/^(?:GET|HEAD)$/,Pt=/^\/\//,Rt={},Mt={},It="*/".concat("*"),Wt=E.createElement("a");function Ft(o){return function(e,t){"string"!=typeof e&&(t=e,e="*");var n,r=0,i=e.toLowerCase().match(P)||[];if(m(t))while(n=i[r++])"+"===n[0]?(n=n.slice(1)||"*",(o[n]=o[n]||[]).unshift(t)):(o[n]=o[n]||[]).push(t)}}function Bt(t,i,o,a){var s={},u=t===Mt;function l(e){var r;return s[e]=!0,S.each(t[e]||[],function(e,t){var n=t(i,o,a);return"string"!=typeof n||u||s[n]?u?!(r=n):void 0:(i.dataTypes.unshift(n),l(n),!1)}),r}return l(i.dataTypes[0])||!s["*"]&&l("*")}function $t(e,t){var n,r,i=S.ajaxSettings.flatOptions||{};for(n in t)void 0!==t[n]&&((i[n]?e:r||(r={}))[n]=t[n]);return r&&S.extend(!0,e,r),e}Wt.href=Tt.href,S.extend({active:0,lastModified:{},etag:{},ajaxSettings:{url:Tt.href,type:"GET",isLocal:/^(?:about|app|app-storage|.+-extension|file|res|widget):$/.test(Tt.protocol),global:!0,processData:!0,async:!0,contentType:"application/x-www-form-urlencoded; charset=UTF-8",accepts:{"*":It,text:"text/plain",html:"text/html",xml:"application/xml, text/xml",json:"application/json, text/javascript"},contents:{xml:/\bxml\b/,html:/\bhtml/,json:/\bjson\b/},responseFields:{xml:"responseXML",text:"responseText",json:"responseJSON"},converters:{"* text":String,"text html":!0,"text json":JSON.parse,"text xml":S.parseXML},flatOptions:{url:!0,context:!0}},ajaxSetup:function(e,t){return t?$t($t(e,S.ajaxSettings),t):$t(S.ajaxSettings,e)},ajaxPrefilter:Ft(Rt),ajaxTransport:Ft(Mt),ajax:function(e,t){"object"==typeof e&&(t=e,e=void 0),t=t||{};var c,f,p,n,d,r,h,g,i,o,v=S.ajaxSetup({},t),y=v.context||v,m=v.context&&(y.nodeType||y.jquery)?S(y):S.event,x=S.Deferred(),b=S.Callbacks("once memory"),w=v.statusCode||{},a={},s={},u="canceled",T={readyState:0,getResponseHeader:function(e){var t;if(h){if(!n){n={};while(t=Ht.exec(p))n[t[1].toLowerCase()+" "]=(n[t[1].toLowerCase()+" "]||[]).concat(t[2])}t=n[e.toLowerCase()+" "]}return null==t?null:t.join(", ")},getAllResponseHeaders:function(){return h?p:null},setRequestHeader:function(e,t){return null==h&&(e=s[e.toLowerCase()]=s[e.toLowerCase()]||e,a[e]=t),this},overrideMimeType:function(e){return null==h&&(v.mimeType=e),this},statusCode:function(e){var t;if(e)if(h)T.always(e[T.status]);else for(t in e)w[t]=[w[t],e[t]];return this},abort:function(e){var t=e||u;return c&&c.abort(t),l(0,t),this}};if(x.promise(T),v.url=((e||v.url||Tt.href)+"").replace(Pt,Tt.protocol+"//"),v.type=t.method||t.type||v.method||v.type,v.dataTypes=(v.dataType||"*").toLowerCase().match(P)||[""],null==v.crossDomain){r=E.createElement("a");try{r.href=v.url,r.href=r.href,v.crossDomain=Wt.protocol+"//"+Wt.host!=r.protocol+"//"+r.host}catch(e){v.crossDomain=!0}}if(v.data&&v.processData&&"string"!=typeof v.data&&(v.data=S.param(v.data,v.traditional)),Bt(Rt,v,t,T),h)return T;for(i in(g=S.event&&v.global)&&0==S.active++&&S.event.trigger("ajaxStart"),v.type=v.type.toUpperCase(),v.hasContent=!Ot.test(v.type),f=v.url.replace(qt,""),v.hasContent?v.data&&v.processData&&0===(v.contentType||"").indexOf("application/x-www-form-urlencoded")&&(v.data=v.data.replace(jt,"+")):(o=v.url.slice(f.length),v.data&&(v.processData||"string"==typeof v.data)&&(f+=(Et.test(f)?"&":"?")+v.data,delete v.data),!1===v.cache&&(f=f.replace(Lt,"$1"),o=(Et.test(f)?"&":"?")+"_="+Ct.guid+++o),v.url=f+o),v.ifModified&&(S.lastModified[f]&&T.setRequestHeader("If-Modified-Since",S.lastModified[f]),S.etag[f]&&T.setRequestHeader("If-None-Match",S.etag[f])),(v.data&&v.hasContent&&!1!==v.contentType||t.contentType)&&T.setRequestHeader("Content-Type",v.contentType),T.setRequestHeader("Accept",v.dataTypes[0]&&v.accepts[v.dataTypes[0]]?v.accepts[v.dataTypes[0]]+("*"!==v.dataTypes[0]?", "+It+"; q=0.01":""):v.accepts["*"]),v.headers)T.setRequestHeader(i,v.headers[i]);if(v.beforeSend&&(!1===v.beforeSend.call(y,T,v)||h))return T.abort();if(u="abort",b.add(v.complete),T.done(v.success),T.fail(v.error),c=Bt(Mt,v,t,T)){if(T.readyState=1,g&&m.trigger("ajaxSend",[T,v]),h)return T;v.async&&0<v.timeout&&(d=C.setTimeout(function(){T.abort("timeout")},v.timeout));try{h=!1,c.send(a,l)}catch(e){if(h)throw e;l(-1,e)}}else l(-1,"No Transport");function l(e,t,n,r){var i,o,a,s,u,l=t;h||(h=!0,d&&C.clearTimeout(d),c=void 0,p=r||"",T.readyState=0<e?4:0,i=200<=e&&e<300||304===e,n&&(s=function(e,t,n){var r,i,o,a,s=e.contents,u=e.dataTypes;while("*"===u[0])u.shift(),void 0===r&&(r=e.mimeType||t.getResponseHeader("Content-Type"));if(r)for(i in s)if(s[i]&&s[i].test(r)){u.unshift(i);break}if(u[0]in n)o=u[0];else{for(i in n){if(!u[0]||e.converters[i+" "+u[0]]){o=i;break}a||(a=i)}o=o||a}if(o)return o!==u[0]&&u.unshift(o),n[o]}(v,T,n)),!i&&-1<S.inArray("script",v.dataTypes)&&(v.converters["text script"]=function(){}),s=function(e,t,n,r){var i,o,a,s,u,l={},c=e.dataTypes.slice();if(c[1])for(a in e.converters)l[a.toLowerCase()]=e.converters[a];o=c.shift();while(o)if(e.responseFields[o]&&(n[e.responseFields[o]]=t),!u&&r&&e.dataFilter&&(t=e.dataFilter(t,e.dataType)),u=o,o=c.shift())if("*"===o)o=u;else if("*"!==u&&u!==o){if(!(a=l[u+" "+o]||l["* "+o]))for(i in l)if((s=i.split(" "))[1]===o&&(a=l[u+" "+s[0]]||l["* "+s[0]])){!0===a?a=l[i]:!0!==l[i]&&(o=s[0],c.unshift(s[1]));break}if(!0!==a)if(a&&e["throws"])t=a(t);else try{t=a(t)}catch(e){return{state:"parsererror",error:a?e:"No conversion from "+u+" to "+o}}}return{state:"success",data:t}}(v,s,T,i),i?(v.ifModified&&((u=T.getResponseHeader("Last-Modified"))&&(S.lastModified[f]=u),(u=T.getResponseHeader("etag"))&&(S.etag[f]=u)),204===e||"HEAD"===v.type?l="nocontent":304===e?l="notmodified":(l=s.state,o=s.data,i=!(a=s.error))):(a=l,!e&&l||(l="error",e<0&&(e=0))),T.status=e,T.statusText=(t||l)+"",i?x.resolveWith(y,[o,l,T]):x.rejectWith(y,[T,l,a]),T.statusCode(w),w=void 0,g&&m.trigger(i?"ajaxSuccess":"ajaxError",[T,v,i?o:a]),b.fireWith(y,[T,l]),g&&(m.trigger("ajaxComplete",[T,v]),--S.active||S.event.trigger("ajaxStop")))}return T},getJSON:function(e,t,n){return S.get(e,t,n,"json")},getScript:function(e,t){return S.get(e,void 0,t,"script")}}),S.each(["get","post"],function(e,i){S[i]=function(e,t,n,r){return m(t)&&(r=r||n,n=t,t=void 0),S.ajax(S.extend({url:e,type:i,dataType:r,data:t,success:n},S.isPlainObject(e)&&e))}}),S.ajaxPrefilter(function(e){var t;for(t in e.headers)"content-type"===t.toLowerCase()&&(e.contentType=e.headers[t]||"")}),S._evalUrl=function(e,t,n){return S.ajax({url:e,type:"GET",dataType:"script",cache:!0,async:!1,global:!1,converters:{"text script":function(){}},dataFilter:function(e){S.globalEval(e,t,n)}})},S.fn.extend({wrapAll:function(e){var t;return this[0]&&(m(e)&&(e=e.call(this[0])),t=S(e,this[0].ownerDocument).eq(0).clone(!0),this[0].parentNode&&t.insertBefore(this[0]),t.map(function(){var e=this;while(e.firstElementChild)e=e.firstElementChild;return e}).append(this)),this},wrapInner:function(n){return m(n)?this.each(function(e){S(this).wrapInner(n.call(this,e))}):this.each(function(){var e=S(this),t=e.contents();t.length?t.wrapAll(n):e.append(n)})},wrap:function(t){var n=m(t);return this.each(function(e){S(this).wrapAll(n?t.call(this,e):t)})},unwrap:function(e){return this.parent(e).not("body").each(function(){S(this).replaceWith(this.childNodes)}),this}}),S.expr.pseudos.hidden=function(e){return!S.expr.pseudos.visible(e)},S.expr.pseudos.visible=function(e){return!!(e.offsetWidth||e.offsetHeight||e.getClientRects().length)},S.ajaxSettings.xhr=function(){try{return new C.XMLHttpRequest}catch(e){}};var _t={0:200,1223:204},zt=S.ajaxSettings.xhr();y.cors=!!zt&&"withCredentials"in zt,y.ajax=zt=!!zt,S.ajaxTransport(function(i){var o,a;if(y.cors||zt&&!i.crossDomain)return{send:function(e,t){var n,r=i.xhr();if(r.open(i.type,i.url,i.async,i.username,i.password),i.xhrFields)for(n in i.xhrFields)r[n]=i.xhrFields[n];for(n in i.mimeType&&r.overrideMimeType&&r.overrideMimeType(i.mimeType),i.crossDomain||e["X-Requested-With"]||(e["X-Requested-With"]="XMLHttpRequest"),e)r.setRequestHeader(n,e[n]);o=function(e){return function(){o&&(o=a=r.onload=r.onerror=r.onabort=r.ontimeout=r.onreadystatechange=null,"abort"===e?r.abort():"error"===e?"number"!=typeof r.status?t(0,"error"):t(r.status,r.statusText):t(_t[r.status]||r.status,r.statusText,"text"!==(r.responseType||"text")||"string"!=typeof r.responseText?{binary:r.response}:{text:r.responseText},r.getAllResponseHeaders()))}},r.onload=o(),a=r.onerror=r.ontimeout=o("error"),void 0!==r.onabort?r.onabort=a:r.onreadystatechange=function(){4===r.readyState&&C.setTimeout(function(){o&&a()})},o=o("abort");try{r.send(i.hasContent&&i.data||null)}catch(e){if(o)throw e}},abort:function(){o&&o()}}}),S.ajaxPrefilter(function(e){e.crossDomain&&(e.contents.script=!1)}),S.ajaxSetup({accepts:{script:"text/javascript, application/javascript, application/ecmascript, application/x-ecmascript"},contents:{script:/\b(?:java|ecma)script\b/},converters:{"text script":function(e){return S.globalEval(e),e}}}),S.ajaxPrefilter("script",function(e){void 0===e.cache&&(e.cache=!1),e.crossDomain&&(e.type="GET")}),S.ajaxTransport("script",function(n){var r,i;if(n.crossDomain||n.scriptAttrs)return{send:function(e,t){r=S("<script>").attr(n.scriptAttrs||{}).prop({charset:n.scriptCharset,src:n.url}).on("load error",i=function(e){r.remove(),i=null,e&&t("error"===e.type?404:200,e.type)}),E.head.appendChild(r[0])},abort:function(){i&&i()}}});var Ut,Xt=[],Vt=/(=)\?(?=&|$)|\?\?/;S.ajaxSetup({jsonp:"callback",jsonpCallback:function(){var e=Xt.pop()||S.expando+"_"+Ct.guid++;return this[e]=!0,e}}),S.ajaxPrefilter("json jsonp",function(e,t,n){var r,i,o,a=!1!==e.jsonp&&(Vt.test(e.url)?"url":"string"==typeof e.data&&0===(e.contentType||"").indexOf("application/x-www-form-urlencoded")&&Vt.test(e.data)&&"data");if(a||"jsonp"===e.dataTypes[0])return r=e.jsonpCallback=m(e.jsonpCallback)?e.jsonpCallback():e.jsonpCallback,a?e[a]=e[a].replace(Vt,"$1"+r):!1!==e.jsonp&&(e.url+=(Et.test(e.url)?"&":"?")+e.jsonp+"="+r),e.converters["script json"]=function(){return o||S.error(r+" was not called"),o[0]},e.dataTypes[0]="json",i=C[r],C[r]=function(){o=arguments},n.always(function(){void 0===i?S(C).removeProp(r):C[r]=i,e[r]&&(e.jsonpCallback=t.jsonpCallback,Xt.push(r)),o&&m(i)&&i(o[0]),o=i=void 0}),"script"}),y.createHTMLDocument=((Ut=E.implementation.createHTMLDocument("").body).innerHTML="<form></form><form></form>",2===Ut.childNodes.length),S.parseHTML=function(e,t,n){return"string"!=typeof e?[]:("boolean"==typeof t&&(n=t,t=!1),t||(y.createHTMLDocument?((r=(t=E.implementation.createHTMLDocument("")).createElement("base")).href=E.location.href,t.head.appendChild(r)):t=E),o=!n&&[],(i=N.exec(e))?[t.createElement(i[1])]:(i=xe([e],t,o),o&&o.length&&S(o).remove(),S.merge([],i.childNodes)));var r,i,o},S.fn.load=function(e,t,n){var r,i,o,a=this,s=e.indexOf(" ");return-1<s&&(r=vt(e.slice(s)),e=e.slice(0,s)),m(t)?(n=t,t=void 0):t&&"object"==typeof t&&(i="POST"),0<a.length&&S.ajax({url:e,type:i||"GET",dataType:"html",data:t}).done(function(e){o=arguments,a.html(r?S("<div>").append(S.parseHTML(e)).find(r):e)}).always(n&&function(e,t){a.each(function(){n.apply(this,o||[e.responseText,t,e])})}),this},S.expr.pseudos.animated=function(t){return S.grep(S.timers,function(e){return t===e.elem}).length},S.offset={setOffset:function(e,t,n){var r,i,o,a,s,u,l=S.css(e,"position"),c=S(e),f={};"static"===l&&(e.style.position="relative"),s=c.offset(),o=S.css(e,"top"),u=S.css(e,"left"),("absolute"===l||"fixed"===l)&&-1<(o+u).indexOf("auto")?(a=(r=c.position()).top,i=r.left):(a=parseFloat(o)||0,i=parseFloat(u)||0),m(t)&&(t=t.call(e,n,S.extend({},s))),null!=t.top&&(f.top=t.top-s.top+a),null!=t.left&&(f.left=t.left-s.left+i),"using"in t?t.using.call(e,f):("number"==typeof f.top&&(f.top+="px"),"number"==typeof f.left&&(f.left+="px"),c.css(f))}},S.fn.extend({offset:function(t){if(arguments.length)return void 0===t?this:this.each(function(e){S.offset.setOffset(this,t,e)});var e,n,r=this[0];return r?r.getClientRects().length?(e=r.getBoundingClientRect(),n=r.ownerDocument.defaultView,{top:e.top+n.pageYOffset,left:e.left+n.pageXOffset}):{top:0,left:0}:void 0},position:function(){if(this[0]){var e,t,n,r=this[0],i={top:0,left:0};if("fixed"===S.css(r,"position"))t=r.getBoundingClientRect();else{t=this.offset(),n=r.ownerDocument,e=r.offsetParent||n.documentElement;while(e&&(e===n.body||e===n.documentElement)&&"static"===S.css(e,"position"))e=e.parentNode;e&&e!==r&&1===e.nodeType&&((i=S(e).offset()).top+=S.css(e,"borderTopWidth",!0),i.left+=S.css(e,"borderLeftWidth",!0))}return{top:t.top-i.top-S.css(r,"marginTop",!0),left:t.left-i.left-S.css(r,"marginLeft",!0)}}},offsetParent:function(){return this.map(function(){var e=this.offsetParent;while(e&&"static"===S.css(e,"position"))e=e.offsetParent;return e||re})}}),S.each({scrollLeft:"pageXOffset",scrollTop:"pageYOffset"},function(t,i){var o="pageYOffset"===i;S.fn[t]=function(e){return $(this,function(e,t,n){var r;if(x(e)?r=e:9===e.nodeType&&(r=e.defaultView),void 0===n)return r?r[i]:e[t];r?r.scrollTo(o?r.pageXOffset:n,o?n:r.pageYOffset):e[t]=n},t,e,arguments.length)}}),S.each(["top","left"],function(e,n){S.cssHooks[n]=$e(y.pixelPosition,function(e,t){if(t)return t=Be(e,n),Me.test(t)?S(e).position()[n]+"px":t})}),S.each({Height:"height",Width:"width"},function(a,s){S.each({padding:"inner"+a,content:s,"":"outer"+a},function(r,o){S.fn[o]=function(e,t){var n=arguments.length&&(r||"boolean"!=typeof e),i=r||(!0===e||!0===t?"margin":"border");return $(this,function(e,t,n){var r;return x(e)?0===o.indexOf("outer")?e["inner"+a]:e.document.documentElement["client"+a]:9===e.nodeType?(r=e.documentElement,Math.max(e.body["scroll"+a],r["scroll"+a],e.body["offset"+a],r["offset"+a],r["client"+a])):void 0===n?S.css(e,t,i):S.style(e,t,n,i)},s,n?e:void 0,n)}})}),S.each(["ajaxStart","ajaxStop","ajaxComplete","ajaxError","ajaxSuccess","ajaxSend"],function(e,t){S.fn[t]=function(e){return this.on(t,e)}}),S.fn.extend({bind:function(e,t,n){return this.on(e,null,t,n)},unbind:function(e,t){return this.off(e,null,t)},delegate:function(e,t,n,r){return this.on(t,e,n,r)},undelegate:function(e,t,n){return 1===arguments.length?this.off(e,"**"):this.off(t,e||"**",n)},hover:function(e,t){return this.mouseenter(e).mouseleave(t||e)}}),S.each("blur focus focusin focusout resize scroll click dblclick mousedown mouseup mousemove mouseover mouseout mouseenter mouseleave change select submit keydown keypress keyup contextmenu".split(" "),function(e,n){S.fn[n]=function(e,t){return 0<arguments.length?this.on(n,null,e,t):this.trigger(n)}});var Gt=/^[\s\uFEFF\xA0]+|[\s\uFEFF\xA0]+$/g;S.proxy=function(e,t){var n,r,i;if("string"==typeof t&&(n=e[t],t=e,e=n),m(e))return r=s.call(arguments,2),(i=function(){return e.apply(t||this,r.concat(s.call(arguments)))}).guid=e.guid=e.guid||S.guid++,i},S.holdReady=function(e){e?S.readyWait++:S.ready(!0)},S.isArray=Array.isArray,S.parseJSON=JSON.parse,S.nodeName=A,S.isFunction=m,S.isWindow=x,S.camelCase=X,S.type=w,S.now=Date.now,S.isNumeric=function(e){var t=S.type(e);return("number"===t||"string"===t)&&!isNaN(e-parseFloat(e))},S.trim=function(e){return null==e?"":(e+"").replace(Gt,"")},"function"==typeof define&&define.amd&&define("jquery",[],function(){return S});var Yt=C.jQuery,Qt=C.$;return S.noConflict=function(e){return C.$===S&&(C.$=Qt),e&&C.jQuery===S&&(C.jQuery=Yt),S},"undefined"==typeof e&&(C.jQuery=C.$=S),S});
diff --git a/docs/_build/html/_static/language_data.js b/docs/_build/html/_static/language_data.js
new file mode 100644
index 0000000000000000000000000000000000000000..863704b310d1539241ef20e26ccce6af27f0ffce
--- /dev/null
+++ b/docs/_build/html/_static/language_data.js
@@ -0,0 +1,297 @@
+/*
+ * language_data.js
+ * ~~~~~~~~~~~~~~~~
+ *
+ * This script contains the language-specific data used by searchtools.js,
+ * namely the list of stopwords, stemmer, scorer and splitter.
+ *
+ * :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS.
+ * :license: BSD, see LICENSE for details.
+ *
+ */
+
+var stopwords = ["a","and","are","as","at","be","but","by","for","if","in","into","is","it","near","no","not","of","on","or","such","that","the","their","then","there","these","they","this","to","was","will","with"];
+
+
+/* Non-minified version is copied as a separate JS file, is available */
+
+/**
+ * Porter Stemmer
+ */
+var Stemmer = function() {
+
+ var step2list = {
+ ational: 'ate',
+ tional: 'tion',
+ enci: 'ence',
+ anci: 'ance',
+ izer: 'ize',
+ bli: 'ble',
+ alli: 'al',
+ entli: 'ent',
+ eli: 'e',
+ ousli: 'ous',
+ ization: 'ize',
+ ation: 'ate',
+ ator: 'ate',
+ alism: 'al',
+ iveness: 'ive',
+ fulness: 'ful',
+ ousness: 'ous',
+ aliti: 'al',
+ iviti: 'ive',
+ biliti: 'ble',
+ logi: 'log'
+ };
+
+ var step3list = {
+ icate: 'ic',
+ ative: '',
+ alize: 'al',
+ iciti: 'ic',
+ ical: 'ic',
+ ful: '',
+ ness: ''
+ };
+
+ var c = "[^aeiou]"; // consonant
+ var v = "[aeiouy]"; // vowel
+ var C = c + "[^aeiouy]*"; // consonant sequence
+ var V = v + "[aeiou]*"; // vowel sequence
+
+ var mgr0 = "^(" + C + ")?" + V + C; // [C]VC... is m>0
+ var meq1 = "^(" + C + ")?" + V + C + "(" + V + ")?$"; // [C]VC[V] is m=1
+ var mgr1 = "^(" + C + ")?" + V + C + V + C; // [C]VCVC... is m>1
+ var s_v = "^(" + C + ")?" + v; // vowel in stem
+
+ this.stemWord = function (w) {
+ var stem;
+ var suffix;
+ var firstch;
+ var origword = w;
+
+ if (w.length < 3)
+ return w;
+
+ var re;
+ var re2;
+ var re3;
+ var re4;
+
+ firstch = w.substr(0,1);
+ if (firstch == "y")
+ w = firstch.toUpperCase() + w.substr(1);
+
+ // Step 1a
+ re = /^(.+?)(ss|i)es$/;
+ re2 = /^(.+?)([^s])s$/;
+
+ if (re.test(w))
+ w = w.replace(re,"$1$2");
+ else if (re2.test(w))
+ w = w.replace(re2,"$1$2");
+
+ // Step 1b
+ re = /^(.+?)eed$/;
+ re2 = /^(.+?)(ed|ing)$/;
+ if (re.test(w)) {
+ var fp = re.exec(w);
+ re = new RegExp(mgr0);
+ if (re.test(fp[1])) {
+ re = /.$/;
+ w = w.replace(re,"");
+ }
+ }
+ else if (re2.test(w)) {
+ var fp = re2.exec(w);
+ stem = fp[1];
+ re2 = new RegExp(s_v);
+ if (re2.test(stem)) {
+ w = stem;
+ re2 = /(at|bl|iz)$/;
+ re3 = new RegExp("([^aeiouylsz])\\1$");
+ re4 = new RegExp("^" + C + v + "[^aeiouwxy]$");
+ if (re2.test(w))
+ w = w + "e";
+ else if (re3.test(w)) {
+ re = /.$/;
+ w = w.replace(re,"");
+ }
+ else if (re4.test(w))
+ w = w + "e";
+ }
+ }
+
+ // Step 1c
+ re = /^(.+?)y$/;
+ if (re.test(w)) {
+ var fp = re.exec(w);
+ stem = fp[1];
+ re = new RegExp(s_v);
+ if (re.test(stem))
+ w = stem + "i";
+ }
+
+ // Step 2
+ re = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/;
+ if (re.test(w)) {
+ var fp = re.exec(w);
+ stem = fp[1];
+ suffix = fp[2];
+ re = new RegExp(mgr0);
+ if (re.test(stem))
+ w = stem + step2list[suffix];
+ }
+
+ // Step 3
+ re = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/;
+ if (re.test(w)) {
+ var fp = re.exec(w);
+ stem = fp[1];
+ suffix = fp[2];
+ re = new RegExp(mgr0);
+ if (re.test(stem))
+ w = stem + step3list[suffix];
+ }
+
+ // Step 4
+ re = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/;
+ re2 = /^(.+?)(s|t)(ion)$/;
+ if (re.test(w)) {
+ var fp = re.exec(w);
+ stem = fp[1];
+ re = new RegExp(mgr1);
+ if (re.test(stem))
+ w = stem;
+ }
+ else if (re2.test(w)) {
+ var fp = re2.exec(w);
+ stem = fp[1] + fp[2];
+ re2 = new RegExp(mgr1);
+ if (re2.test(stem))
+ w = stem;
+ }
+
+ // Step 5
+ re = /^(.+?)e$/;
+ if (re.test(w)) {
+ var fp = re.exec(w);
+ stem = fp[1];
+ re = new RegExp(mgr1);
+ re2 = new RegExp(meq1);
+ re3 = new RegExp("^" + C + v + "[^aeiouwxy]$");
+ if (re.test(stem) || (re2.test(stem) && !(re3.test(stem))))
+ w = stem;
+ }
+ re = /ll$/;
+ re2 = new RegExp(mgr1);
+ if (re.test(w) && re2.test(w)) {
+ re = /.$/;
+ w = w.replace(re,"");
+ }
+
+ // and turn initial Y back to y
+ if (firstch == "y")
+ w = firstch.toLowerCase() + w.substr(1);
+ return w;
+ }
+}
+
+
+
+
+var splitChars = (function() {
+ var result = {};
+ var singles = [96, 180, 187, 191, 215, 247, 749, 885, 903, 907, 909, 930, 1014, 1648,
+ 1748, 1809, 2416, 2473, 2481, 2526, 2601, 2609, 2612, 2615, 2653, 2702,
+ 2706, 2729, 2737, 2740, 2857, 2865, 2868, 2910, 2928, 2948, 2961, 2971,
+ 2973, 3085, 3089, 3113, 3124, 3213, 3217, 3241, 3252, 3295, 3341, 3345,
+ 3369, 3506, 3516, 3633, 3715, 3721, 3736, 3744, 3748, 3750, 3756, 3761,
+ 3781, 3912, 4239, 4347, 4681, 4695, 4697, 4745, 4785, 4799, 4801, 4823,
+ 4881, 5760, 5901, 5997, 6313, 7405, 8024, 8026, 8028, 8030, 8117, 8125,
+ 8133, 8181, 8468, 8485, 8487, 8489, 8494, 8527, 11311, 11359, 11687, 11695,
+ 11703, 11711, 11719, 11727, 11735, 12448, 12539, 43010, 43014, 43019, 43587,
+ 43696, 43713, 64286, 64297, 64311, 64317, 64319, 64322, 64325, 65141];
+ var i, j, start, end;
+ for (i = 0; i < singles.length; i++) {
+ result[singles[i]] = true;
+ }
+ var ranges = [[0, 47], [58, 64], [91, 94], [123, 169], [171, 177], [182, 184], [706, 709],
+ [722, 735], [741, 747], [751, 879], [888, 889], [894, 901], [1154, 1161],
+ [1318, 1328], [1367, 1368], [1370, 1376], [1416, 1487], [1515, 1519], [1523, 1568],
+ [1611, 1631], [1642, 1645], [1750, 1764], [1767, 1773], [1789, 1790], [1792, 1807],
+ [1840, 1868], [1958, 1968], [1970, 1983], [2027, 2035], [2038, 2041], [2043, 2047],
+ [2070, 2073], [2075, 2083], [2085, 2087], [2089, 2307], [2362, 2364], [2366, 2383],
+ [2385, 2391], [2402, 2405], [2419, 2424], [2432, 2436], [2445, 2446], [2449, 2450],
+ [2483, 2485], [2490, 2492], [2494, 2509], [2511, 2523], [2530, 2533], [2546, 2547],
+ [2554, 2564], [2571, 2574], [2577, 2578], [2618, 2648], [2655, 2661], [2672, 2673],
+ [2677, 2692], [2746, 2748], [2750, 2767], [2769, 2783], [2786, 2789], [2800, 2820],
+ [2829, 2830], [2833, 2834], [2874, 2876], [2878, 2907], [2914, 2917], [2930, 2946],
+ [2955, 2957], [2966, 2968], [2976, 2978], [2981, 2983], [2987, 2989], [3002, 3023],
+ [3025, 3045], [3059, 3076], [3130, 3132], [3134, 3159], [3162, 3167], [3170, 3173],
+ [3184, 3191], [3199, 3204], [3258, 3260], [3262, 3293], [3298, 3301], [3312, 3332],
+ [3386, 3388], [3390, 3423], [3426, 3429], [3446, 3449], [3456, 3460], [3479, 3481],
+ [3518, 3519], [3527, 3584], [3636, 3647], [3655, 3663], [3674, 3712], [3717, 3718],
+ [3723, 3724], [3726, 3731], [3752, 3753], [3764, 3772], [3774, 3775], [3783, 3791],
+ [3802, 3803], [3806, 3839], [3841, 3871], [3892, 3903], [3949, 3975], [3980, 4095],
+ [4139, 4158], [4170, 4175], [4182, 4185], [4190, 4192], [4194, 4196], [4199, 4205],
+ [4209, 4212], [4226, 4237], [4250, 4255], [4294, 4303], [4349, 4351], [4686, 4687],
+ [4702, 4703], [4750, 4751], [4790, 4791], [4806, 4807], [4886, 4887], [4955, 4968],
+ [4989, 4991], [5008, 5023], [5109, 5120], [5741, 5742], [5787, 5791], [5867, 5869],
+ [5873, 5887], [5906, 5919], [5938, 5951], [5970, 5983], [6001, 6015], [6068, 6102],
+ [6104, 6107], [6109, 6111], [6122, 6127], [6138, 6159], [6170, 6175], [6264, 6271],
+ [6315, 6319], [6390, 6399], [6429, 6469], [6510, 6511], [6517, 6527], [6572, 6592],
+ [6600, 6607], [6619, 6655], [6679, 6687], [6741, 6783], [6794, 6799], [6810, 6822],
+ [6824, 6916], [6964, 6980], [6988, 6991], [7002, 7042], [7073, 7085], [7098, 7167],
+ [7204, 7231], [7242, 7244], [7294, 7400], [7410, 7423], [7616, 7679], [7958, 7959],
+ [7966, 7967], [8006, 8007], [8014, 8015], [8062, 8063], [8127, 8129], [8141, 8143],
+ [8148, 8149], [8156, 8159], [8173, 8177], [8189, 8303], [8306, 8307], [8314, 8318],
+ [8330, 8335], [8341, 8449], [8451, 8454], [8456, 8457], [8470, 8472], [8478, 8483],
+ [8506, 8507], [8512, 8516], [8522, 8525], [8586, 9311], [9372, 9449], [9472, 10101],
+ [10132, 11263], [11493, 11498], [11503, 11516], [11518, 11519], [11558, 11567],
+ [11622, 11630], [11632, 11647], [11671, 11679], [11743, 11822], [11824, 12292],
+ [12296, 12320], [12330, 12336], [12342, 12343], [12349, 12352], [12439, 12444],
+ [12544, 12548], [12590, 12592], [12687, 12689], [12694, 12703], [12728, 12783],
+ [12800, 12831], [12842, 12880], [12896, 12927], [12938, 12976], [12992, 13311],
+ [19894, 19967], [40908, 40959], [42125, 42191], [42238, 42239], [42509, 42511],
+ [42540, 42559], [42592, 42593], [42607, 42622], [42648, 42655], [42736, 42774],
+ [42784, 42785], [42889, 42890], [42893, 43002], [43043, 43055], [43062, 43071],
+ [43124, 43137], [43188, 43215], [43226, 43249], [43256, 43258], [43260, 43263],
+ [43302, 43311], [43335, 43359], [43389, 43395], [43443, 43470], [43482, 43519],
+ [43561, 43583], [43596, 43599], [43610, 43615], [43639, 43641], [43643, 43647],
+ [43698, 43700], [43703, 43704], [43710, 43711], [43715, 43738], [43742, 43967],
+ [44003, 44015], [44026, 44031], [55204, 55215], [55239, 55242], [55292, 55295],
+ [57344, 63743], [64046, 64047], [64110, 64111], [64218, 64255], [64263, 64274],
+ [64280, 64284], [64434, 64466], [64830, 64847], [64912, 64913], [64968, 65007],
+ [65020, 65135], [65277, 65295], [65306, 65312], [65339, 65344], [65371, 65381],
+ [65471, 65473], [65480, 65481], [65488, 65489], [65496, 65497]];
+ for (i = 0; i < ranges.length; i++) {
+ start = ranges[i][0];
+ end = ranges[i][1];
+ for (j = start; j <= end; j++) {
+ result[j] = true;
+ }
+ }
+ return result;
+})();
+
+function splitQuery(query) {
+ var result = [];
+ var start = -1;
+ for (var i = 0; i < query.length; i++) {
+ if (splitChars[query.charCodeAt(i)]) {
+ if (start !== -1) {
+ result.push(query.slice(start, i));
+ start = -1;
+ }
+ } else if (start === -1) {
+ start = i;
+ }
+ }
+ if (start !== -1) {
+ result.push(query.slice(start));
+ }
+ return result;
+}
+
+
diff --git a/docs/_build/html/_static/minus.png b/docs/_build/html/_static/minus.png
new file mode 100644
index 0000000000000000000000000000000000000000..d96755fdaf8bb2214971e0db9c1fd3077d7c419d
Binary files /dev/null and b/docs/_build/html/_static/minus.png differ
diff --git a/docs/_build/html/_static/plus.png b/docs/_build/html/_static/plus.png
new file mode 100644
index 0000000000000000000000000000000000000000..7107cec93a979b9a5f64843235a16651d563ce2d
Binary files /dev/null and b/docs/_build/html/_static/plus.png differ
diff --git a/docs/_build/html/_static/pygments.css b/docs/_build/html/_static/pygments.css
new file mode 100644
index 0000000000000000000000000000000000000000..691aeb82d0057a353637453f168872571a8e5328
--- /dev/null
+++ b/docs/_build/html/_static/pygments.css
@@ -0,0 +1,74 @@
+pre { line-height: 125%; }
+td.linenos .normal { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; }
+span.linenos { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; }
+td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
+span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
+.highlight .hll { background-color: #ffffcc }
+.highlight { background: #eeffcc; }
+.highlight .c { color: #408090; font-style: italic } /* Comment */
+.highlight .err { border: 1px solid #FF0000 } /* Error */
+.highlight .k { color: #007020; font-weight: bold } /* Keyword */
+.highlight .o { color: #666666 } /* Operator */
+.highlight .ch { color: #408090; font-style: italic } /* Comment.Hashbang */
+.highlight .cm { color: #408090; font-style: italic } /* Comment.Multiline */
+.highlight .cp { color: #007020 } /* Comment.Preproc */
+.highlight .cpf { color: #408090; font-style: italic } /* Comment.PreprocFile */
+.highlight .c1 { color: #408090; font-style: italic } /* Comment.Single */
+.highlight .cs { color: #408090; background-color: #fff0f0 } /* Comment.Special */
+.highlight .gd { color: #A00000 } /* Generic.Deleted */
+.highlight .ge { font-style: italic } /* Generic.Emph */
+.highlight .gr { color: #FF0000 } /* Generic.Error */
+.highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */
+.highlight .gi { color: #00A000 } /* Generic.Inserted */
+.highlight .go { color: #333333 } /* Generic.Output */
+.highlight .gp { color: #c65d09; font-weight: bold } /* Generic.Prompt */
+.highlight .gs { font-weight: bold } /* Generic.Strong */
+.highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */
+.highlight .gt { color: #0044DD } /* Generic.Traceback */
+.highlight .kc { color: #007020; font-weight: bold } /* Keyword.Constant */
+.highlight .kd { color: #007020; font-weight: bold } /* Keyword.Declaration */
+.highlight .kn { color: #007020; font-weight: bold } /* Keyword.Namespace */
+.highlight .kp { color: #007020 } /* Keyword.Pseudo */
+.highlight .kr { color: #007020; font-weight: bold } /* Keyword.Reserved */
+.highlight .kt { color: #902000 } /* Keyword.Type */
+.highlight .m { color: #208050 } /* Literal.Number */
+.highlight .s { color: #4070a0 } /* Literal.String */
+.highlight .na { color: #4070a0 } /* Name.Attribute */
+.highlight .nb { color: #007020 } /* Name.Builtin */
+.highlight .nc { color: #0e84b5; font-weight: bold } /* Name.Class */
+.highlight .no { color: #60add5 } /* Name.Constant */
+.highlight .nd { color: #555555; font-weight: bold } /* Name.Decorator */
+.highlight .ni { color: #d55537; font-weight: bold } /* Name.Entity */
+.highlight .ne { color: #007020 } /* Name.Exception */
+.highlight .nf { color: #06287e } /* Name.Function */
+.highlight .nl { color: #002070; font-weight: bold } /* Name.Label */
+.highlight .nn { color: #0e84b5; font-weight: bold } /* Name.Namespace */
+.highlight .nt { color: #062873; font-weight: bold } /* Name.Tag */
+.highlight .nv { color: #bb60d5 } /* Name.Variable */
+.highlight .ow { color: #007020; font-weight: bold } /* Operator.Word */
+.highlight .w { color: #bbbbbb } /* Text.Whitespace */
+.highlight .mb { color: #208050 } /* Literal.Number.Bin */
+.highlight .mf { color: #208050 } /* Literal.Number.Float */
+.highlight .mh { color: #208050 } /* Literal.Number.Hex */
+.highlight .mi { color: #208050 } /* Literal.Number.Integer */
+.highlight .mo { color: #208050 } /* Literal.Number.Oct */
+.highlight .sa { color: #4070a0 } /* Literal.String.Affix */
+.highlight .sb { color: #4070a0 } /* Literal.String.Backtick */
+.highlight .sc { color: #4070a0 } /* Literal.String.Char */
+.highlight .dl { color: #4070a0 } /* Literal.String.Delimiter */
+.highlight .sd { color: #4070a0; font-style: italic } /* Literal.String.Doc */
+.highlight .s2 { color: #4070a0 } /* Literal.String.Double */
+.highlight .se { color: #4070a0; font-weight: bold } /* Literal.String.Escape */
+.highlight .sh { color: #4070a0 } /* Literal.String.Heredoc */
+.highlight .si { color: #70a0d0; font-style: italic } /* Literal.String.Interpol */
+.highlight .sx { color: #c65d09 } /* Literal.String.Other */
+.highlight .sr { color: #235388 } /* Literal.String.Regex */
+.highlight .s1 { color: #4070a0 } /* Literal.String.Single */
+.highlight .ss { color: #517918 } /* Literal.String.Symbol */
+.highlight .bp { color: #007020 } /* Name.Builtin.Pseudo */
+.highlight .fm { color: #06287e } /* Name.Function.Magic */
+.highlight .vc { color: #bb60d5 } /* Name.Variable.Class */
+.highlight .vg { color: #bb60d5 } /* Name.Variable.Global */
+.highlight .vi { color: #bb60d5 } /* Name.Variable.Instance */
+.highlight .vm { color: #bb60d5 } /* Name.Variable.Magic */
+.highlight .il { color: #208050 } /* Literal.Number.Integer.Long */
\ No newline at end of file
diff --git a/docs/_build/html/_static/searchtools.js b/docs/_build/html/_static/searchtools.js
new file mode 100644
index 0000000000000000000000000000000000000000..002e9c4a20fb408e3cd2fd4edb11726364675c80
--- /dev/null
+++ b/docs/_build/html/_static/searchtools.js
@@ -0,0 +1,529 @@
+/*
+ * searchtools.js
+ * ~~~~~~~~~~~~~~~~
+ *
+ * Sphinx JavaScript utilities for the full-text search.
+ *
+ * :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS.
+ * :license: BSD, see LICENSE for details.
+ *
+ */
+
+if (!Scorer) {
+ /**
+ * Simple result scoring code.
+ */
+ var Scorer = {
+ // Implement the following function to further tweak the score for each result
+ // The function takes a result array [filename, title, anchor, descr, score]
+ // and returns the new score.
+ /*
+ score: function(result) {
+ return result[4];
+ },
+ */
+
+ // query matches the full name of an object
+ objNameMatch: 11,
+ // or matches in the last dotted part of the object name
+ objPartialMatch: 6,
+ // Additive scores depending on the priority of the object
+ objPrio: {0: 15, // used to be importantResults
+ 1: 5, // used to be objectResults
+ 2: -5}, // used to be unimportantResults
+ // Used when the priority is not in the mapping.
+ objPrioDefault: 0,
+
+ // query found in title
+ title: 15,
+ partialTitle: 7,
+ // query found in terms
+ term: 5,
+ partialTerm: 2
+ };
+}
+
+if (!splitQuery) {
+ function splitQuery(query) {
+ return query.split(/\s+/);
+ }
+}
+
+/**
+ * Search Module
+ */
+var Search = {
+
+ _index : null,
+ _queued_query : null,
+ _pulse_status : -1,
+
+ htmlToText : function(htmlString) {
+ var virtualDocument = document.implementation.createHTMLDocument('virtual');
+ var htmlElement = $(htmlString, virtualDocument);
+ htmlElement.find('.headerlink').remove();
+ docContent = htmlElement.find('[role=main]')[0];
+ if(docContent === undefined) {
+ console.warn("Content block not found. Sphinx search tries to obtain it " +
+ "via '[role=main]'. Could you check your theme or template.");
+ return "";
+ }
+ return docContent.textContent || docContent.innerText;
+ },
+
+ init : function() {
+ var params = $.getQueryParameters();
+ if (params.q) {
+ var query = params.q[0];
+ $('input[name="q"]')[0].value = query;
+ this.performSearch(query);
+ }
+ },
+
+ loadIndex : function(url) {
+ $.ajax({type: "GET", url: url, data: null,
+ dataType: "script", cache: true,
+ complete: function(jqxhr, textstatus) {
+ if (textstatus != "success") {
+ document.getElementById("searchindexloader").src = url;
+ }
+ }});
+ },
+
+ setIndex : function(index) {
+ var q;
+ this._index = index;
+ if ((q = this._queued_query) !== null) {
+ this._queued_query = null;
+ Search.query(q);
+ }
+ },
+
+ hasIndex : function() {
+ return this._index !== null;
+ },
+
+ deferQuery : function(query) {
+ this._queued_query = query;
+ },
+
+ stopPulse : function() {
+ this._pulse_status = 0;
+ },
+
+ startPulse : function() {
+ if (this._pulse_status >= 0)
+ return;
+ function pulse() {
+ var i;
+ Search._pulse_status = (Search._pulse_status + 1) % 4;
+ var dotString = '';
+ for (i = 0; i < Search._pulse_status; i++)
+ dotString += '.';
+ Search.dots.text(dotString);
+ if (Search._pulse_status > -1)
+ window.setTimeout(pulse, 500);
+ }
+ pulse();
+ },
+
+ /**
+ * perform a search for something (or wait until index is loaded)
+ */
+ performSearch : function(query) {
+ // create the required interface elements
+ this.out = $('#search-results');
+ this.title = $('<h2>' + _('Searching') + '</h2>').appendTo(this.out);
+ this.dots = $('<span></span>').appendTo(this.title);
+ this.status = $('<p class="search-summary"> </p>').appendTo(this.out);
+ this.output = $('<ul class="search"/>').appendTo(this.out);
+
+ $('#search-progress').text(_('Preparing search...'));
+ this.startPulse();
+
+ // index already loaded, the browser was quick!
+ if (this.hasIndex())
+ this.query(query);
+ else
+ this.deferQuery(query);
+ },
+
+ /**
+ * execute search (requires search index to be loaded)
+ */
+ query : function(query) {
+ var i;
+
+ // stem the searchterms and add them to the correct list
+ var stemmer = new Stemmer();
+ var searchterms = [];
+ var excluded = [];
+ var hlterms = [];
+ var tmp = splitQuery(query);
+ var objectterms = [];
+ for (i = 0; i < tmp.length; i++) {
+ if (tmp[i] !== "") {
+ objectterms.push(tmp[i].toLowerCase());
+ }
+
+ if ($u.indexOf(stopwords, tmp[i].toLowerCase()) != -1 || tmp[i] === "") {
+ // skip this "word"
+ continue;
+ }
+ // stem the word
+ var word = stemmer.stemWord(tmp[i].toLowerCase());
+ // prevent stemmer from cutting word smaller than two chars
+ if(word.length < 3 && tmp[i].length >= 3) {
+ word = tmp[i];
+ }
+ var toAppend;
+ // select the correct list
+ if (word[0] == '-') {
+ toAppend = excluded;
+ word = word.substr(1);
+ }
+ else {
+ toAppend = searchterms;
+ hlterms.push(tmp[i].toLowerCase());
+ }
+ // only add if not already in the list
+ if (!$u.contains(toAppend, word))
+ toAppend.push(word);
+ }
+ var highlightstring = '?highlight=' + $.urlencode(hlterms.join(" "));
+
+ // console.debug('SEARCH: searching for:');
+ // console.info('required: ', searchterms);
+ // console.info('excluded: ', excluded);
+
+ // prepare search
+ var terms = this._index.terms;
+ var titleterms = this._index.titleterms;
+
+ // array of [filename, title, anchor, descr, score]
+ var results = [];
+ $('#search-progress').empty();
+
+ // lookup as object
+ for (i = 0; i < objectterms.length; i++) {
+ var others = [].concat(objectterms.slice(0, i),
+ objectterms.slice(i+1, objectterms.length));
+ results = results.concat(this.performObjectSearch(objectterms[i], others));
+ }
+
+ // lookup as search terms in fulltext
+ results = results.concat(this.performTermsSearch(searchterms, excluded, terms, titleterms));
+
+ // let the scorer override scores with a custom scoring function
+ if (Scorer.score) {
+ for (i = 0; i < results.length; i++)
+ results[i][4] = Scorer.score(results[i]);
+ }
+
+ // now sort the results by score (in opposite order of appearance, since the
+ // display function below uses pop() to retrieve items) and then
+ // alphabetically
+ results.sort(function(a, b) {
+ var left = a[4];
+ var right = b[4];
+ if (left > right) {
+ return 1;
+ } else if (left < right) {
+ return -1;
+ } else {
+ // same score: sort alphabetically
+ left = a[1].toLowerCase();
+ right = b[1].toLowerCase();
+ return (left > right) ? -1 : ((left < right) ? 1 : 0);
+ }
+ });
+
+ // for debugging
+ //Search.lastresults = results.slice(); // a copy
+ //console.info('search results:', Search.lastresults);
+
+ // print the results
+ var resultCount = results.length;
+ function displayNextItem() {
+ // results left, load the summary and display it
+ if (results.length) {
+ var item = results.pop();
+ var listItem = $('<li></li>');
+ var requestUrl = "";
+ var linkUrl = "";
+ if (DOCUMENTATION_OPTIONS.BUILDER === 'dirhtml') {
+ // dirhtml builder
+ var dirname = item[0] + '/';
+ if (dirname.match(/\/index\/$/)) {
+ dirname = dirname.substring(0, dirname.length-6);
+ } else if (dirname == 'index/') {
+ dirname = '';
+ }
+ requestUrl = DOCUMENTATION_OPTIONS.URL_ROOT + dirname;
+ linkUrl = requestUrl;
+
+ } else {
+ // normal html builders
+ requestUrl = DOCUMENTATION_OPTIONS.URL_ROOT + item[0] + DOCUMENTATION_OPTIONS.FILE_SUFFIX;
+ linkUrl = item[0] + DOCUMENTATION_OPTIONS.LINK_SUFFIX;
+ }
+ listItem.append($('<a/>').attr('href',
+ linkUrl +
+ highlightstring + item[2]).html(item[1]));
+ if (item[3]) {
+ listItem.append($('<span> (' + item[3] + ')</span>'));
+ Search.output.append(listItem);
+ setTimeout(function() {
+ displayNextItem();
+ }, 5);
+ } else if (DOCUMENTATION_OPTIONS.HAS_SOURCE) {
+ $.ajax({url: requestUrl,
+ dataType: "text",
+ complete: function(jqxhr, textstatus) {
+ var data = jqxhr.responseText;
+ if (data !== '' && data !== undefined) {
+ var summary = Search.makeSearchSummary(data, searchterms, hlterms);
+ if (summary) {
+ listItem.append(summary);
+ }
+ }
+ Search.output.append(listItem);
+ setTimeout(function() {
+ displayNextItem();
+ }, 5);
+ }});
+ } else {
+ // no source available, just display title
+ Search.output.append(listItem);
+ setTimeout(function() {
+ displayNextItem();
+ }, 5);
+ }
+ }
+ // search finished, update title and status message
+ else {
+ Search.stopPulse();
+ Search.title.text(_('Search Results'));
+ if (!resultCount)
+ Search.status.text(_('Your search did not match any documents. Please make sure that all words are spelled correctly and that you\'ve selected enough categories.'));
+ else
+ Search.status.text(_('Search finished, found %s page(s) matching the search query.').replace('%s', resultCount));
+ Search.status.fadeIn(500);
+ }
+ }
+ displayNextItem();
+ },
+
+ /**
+ * search for object names
+ */
+ performObjectSearch : function(object, otherterms) {
+ var filenames = this._index.filenames;
+ var docnames = this._index.docnames;
+ var objects = this._index.objects;
+ var objnames = this._index.objnames;
+ var titles = this._index.titles;
+
+ var i;
+ var results = [];
+
+ for (var prefix in objects) {
+ for (var iMatch = 0; iMatch != objects[prefix].length; ++iMatch) {
+ var match = objects[prefix][iMatch];
+ var name = match[4];
+ var fullname = (prefix ? prefix + '.' : '') + name;
+ var fullnameLower = fullname.toLowerCase()
+ if (fullnameLower.indexOf(object) > -1) {
+ var score = 0;
+ var parts = fullnameLower.split('.');
+ // check for different match types: exact matches of full name or
+ // "last name" (i.e. last dotted part)
+ if (fullnameLower == object || parts[parts.length - 1] == object) {
+ score += Scorer.objNameMatch;
+ // matches in last name
+ } else if (parts[parts.length - 1].indexOf(object) > -1) {
+ score += Scorer.objPartialMatch;
+ }
+ var objname = objnames[match[1]][2];
+ var title = titles[match[0]];
+ // If more than one term searched for, we require other words to be
+ // found in the name/title/description
+ if (otherterms.length > 0) {
+ var haystack = (prefix + ' ' + name + ' ' +
+ objname + ' ' + title).toLowerCase();
+ var allfound = true;
+ for (i = 0; i < otherterms.length; i++) {
+ if (haystack.indexOf(otherterms[i]) == -1) {
+ allfound = false;
+ break;
+ }
+ }
+ if (!allfound) {
+ continue;
+ }
+ }
+ var descr = objname + _(', in ') + title;
+
+ var anchor = match[3];
+ if (anchor === '')
+ anchor = fullname;
+ else if (anchor == '-')
+ anchor = objnames[match[1]][1] + '-' + fullname;
+ // add custom score for some objects according to scorer
+ if (Scorer.objPrio.hasOwnProperty(match[2])) {
+ score += Scorer.objPrio[match[2]];
+ } else {
+ score += Scorer.objPrioDefault;
+ }
+ results.push([docnames[match[0]], fullname, '#'+anchor, descr, score, filenames[match[0]]]);
+ }
+ }
+ }
+
+ return results;
+ },
+
+ /**
+ * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions
+ */
+ escapeRegExp : function(string) {
+ return string.replace(/[.*+\-?^${}()|[\]\\]/g, '\\$&'); // $& means the whole matched string
+ },
+
+ /**
+ * search for full-text terms in the index
+ */
+ performTermsSearch : function(searchterms, excluded, terms, titleterms) {
+ var docnames = this._index.docnames;
+ var filenames = this._index.filenames;
+ var titles = this._index.titles;
+
+ var i, j, file;
+ var fileMap = {};
+ var scoreMap = {};
+ var results = [];
+
+ // perform the search on the required terms
+ for (i = 0; i < searchterms.length; i++) {
+ var word = searchterms[i];
+ var files = [];
+ var _o = [
+ {files: terms[word], score: Scorer.term},
+ {files: titleterms[word], score: Scorer.title}
+ ];
+ // add support for partial matches
+ if (word.length > 2) {
+ var word_regex = this.escapeRegExp(word);
+ for (var w in terms) {
+ if (w.match(word_regex) && !terms[word]) {
+ _o.push({files: terms[w], score: Scorer.partialTerm})
+ }
+ }
+ for (var w in titleterms) {
+ if (w.match(word_regex) && !titleterms[word]) {
+ _o.push({files: titleterms[w], score: Scorer.partialTitle})
+ }
+ }
+ }
+
+ // no match but word was a required one
+ if ($u.every(_o, function(o){return o.files === undefined;})) {
+ break;
+ }
+ // found search word in contents
+ $u.each(_o, function(o) {
+ var _files = o.files;
+ if (_files === undefined)
+ return
+
+ if (_files.length === undefined)
+ _files = [_files];
+ files = files.concat(_files);
+
+ // set score for the word in each file to Scorer.term
+ for (j = 0; j < _files.length; j++) {
+ file = _files[j];
+ if (!(file in scoreMap))
+ scoreMap[file] = {};
+ scoreMap[file][word] = o.score;
+ }
+ });
+
+ // create the mapping
+ for (j = 0; j < files.length; j++) {
+ file = files[j];
+ if (file in fileMap && fileMap[file].indexOf(word) === -1)
+ fileMap[file].push(word);
+ else
+ fileMap[file] = [word];
+ }
+ }
+
+ // now check if the files don't contain excluded terms
+ for (file in fileMap) {
+ var valid = true;
+
+ // check if all requirements are matched
+ var filteredTermCount = // as search terms with length < 3 are discarded: ignore
+ searchterms.filter(function(term){return term.length > 2}).length
+ if (
+ fileMap[file].length != searchterms.length &&
+ fileMap[file].length != filteredTermCount
+ ) continue;
+
+ // ensure that none of the excluded terms is in the search result
+ for (i = 0; i < excluded.length; i++) {
+ if (terms[excluded[i]] == file ||
+ titleterms[excluded[i]] == file ||
+ $u.contains(terms[excluded[i]] || [], file) ||
+ $u.contains(titleterms[excluded[i]] || [], file)) {
+ valid = false;
+ break;
+ }
+ }
+
+ // if we have still a valid result we can add it to the result list
+ if (valid) {
+ // select one (max) score for the file.
+ // for better ranking, we should calculate ranking by using words statistics like basic tf-idf...
+ var score = $u.max($u.map(fileMap[file], function(w){return scoreMap[file][w]}));
+ results.push([docnames[file], titles[file], '', null, score, filenames[file]]);
+ }
+ }
+ return results;
+ },
+
+ /**
+ * helper function to return a node containing the
+ * search summary for a given text. keywords is a list
+ * of stemmed words, hlwords is the list of normal, unstemmed
+ * words. the first one is used to find the occurrence, the
+ * latter for highlighting it.
+ */
+ makeSearchSummary : function(htmlText, keywords, hlwords) {
+ var text = Search.htmlToText(htmlText);
+ if (text == "") {
+ return null;
+ }
+ var textLower = text.toLowerCase();
+ var start = 0;
+ $.each(keywords, function() {
+ var i = textLower.indexOf(this.toLowerCase());
+ if (i > -1)
+ start = i;
+ });
+ start = Math.max(start - 120, 0);
+ var excerpt = ((start > 0) ? '...' : '') +
+ $.trim(text.substr(start, 240)) +
+ ((start + 240 - text.length) ? '...' : '');
+ var rv = $('<p class="context"></p>').text(excerpt);
+ $.each(hlwords, function() {
+ rv = rv.highlightText(this, 'highlighted');
+ });
+ return rv;
+ }
+};
+
+$(document).ready(function() {
+ Search.init();
+});
diff --git a/docs/_build/html/_static/underscore-1.13.1.js b/docs/_build/html/_static/underscore-1.13.1.js
new file mode 100644
index 0000000000000000000000000000000000000000..ffd77af9648a47d389f2d6976d4aa1c44d7ce7ce
--- /dev/null
+++ b/docs/_build/html/_static/underscore-1.13.1.js
@@ -0,0 +1,2042 @@
+(function (global, factory) {
+ typeof exports === 'object' && typeof module !== 'undefined' ? module.exports = factory() :
+ typeof define === 'function' && define.amd ? define('underscore', factory) :
+ (global = typeof globalThis !== 'undefined' ? globalThis : global || self, (function () {
+ var current = global._;
+ var exports = global._ = factory();
+ exports.noConflict = function () { global._ = current; return exports; };
+ }()));
+}(this, (function () {
+ // Underscore.js 1.13.1
+ // https://underscorejs.org
+ // (c) 2009-2021 Jeremy Ashkenas, Julian Gonggrijp, and DocumentCloud and Investigative Reporters & Editors
+ // Underscore may be freely distributed under the MIT license.
+
+ // Current version.
+ var VERSION = '1.13.1';
+
+ // Establish the root object, `window` (`self`) in the browser, `global`
+ // on the server, or `this` in some virtual machines. We use `self`
+ // instead of `window` for `WebWorker` support.
+ var root = typeof self == 'object' && self.self === self && self ||
+ typeof global == 'object' && global.global === global && global ||
+ Function('return this')() ||
+ {};
+
+ // Save bytes in the minified (but not gzipped) version:
+ var ArrayProto = Array.prototype, ObjProto = Object.prototype;
+ var SymbolProto = typeof Symbol !== 'undefined' ? Symbol.prototype : null;
+
+ // Create quick reference variables for speed access to core prototypes.
+ var push = ArrayProto.push,
+ slice = ArrayProto.slice,
+ toString = ObjProto.toString,
+ hasOwnProperty = ObjProto.hasOwnProperty;
+
+ // Modern feature detection.
+ var supportsArrayBuffer = typeof ArrayBuffer !== 'undefined',
+ supportsDataView = typeof DataView !== 'undefined';
+
+ // All **ECMAScript 5+** native function implementations that we hope to use
+ // are declared here.
+ var nativeIsArray = Array.isArray,
+ nativeKeys = Object.keys,
+ nativeCreate = Object.create,
+ nativeIsView = supportsArrayBuffer && ArrayBuffer.isView;
+
+ // Create references to these builtin functions because we override them.
+ var _isNaN = isNaN,
+ _isFinite = isFinite;
+
+ // Keys in IE < 9 that won't be iterated by `for key in ...` and thus missed.
+ var hasEnumBug = !{toString: null}.propertyIsEnumerable('toString');
+ var nonEnumerableProps = ['valueOf', 'isPrototypeOf', 'toString',
+ 'propertyIsEnumerable', 'hasOwnProperty', 'toLocaleString'];
+
+ // The largest integer that can be represented exactly.
+ var MAX_ARRAY_INDEX = Math.pow(2, 53) - 1;
+
+ // Some functions take a variable number of arguments, or a few expected
+ // arguments at the beginning and then a variable number of values to operate
+ // on. This helper accumulates all remaining arguments past the function’s
+ // argument length (or an explicit `startIndex`), into an array that becomes
+ // the last argument. Similar to ES6’s "rest parameter".
+ function restArguments(func, startIndex) {
+ startIndex = startIndex == null ? func.length - 1 : +startIndex;
+ return function() {
+ var length = Math.max(arguments.length - startIndex, 0),
+ rest = Array(length),
+ index = 0;
+ for (; index < length; index++) {
+ rest[index] = arguments[index + startIndex];
+ }
+ switch (startIndex) {
+ case 0: return func.call(this, rest);
+ case 1: return func.call(this, arguments[0], rest);
+ case 2: return func.call(this, arguments[0], arguments[1], rest);
+ }
+ var args = Array(startIndex + 1);
+ for (index = 0; index < startIndex; index++) {
+ args[index] = arguments[index];
+ }
+ args[startIndex] = rest;
+ return func.apply(this, args);
+ };
+ }
+
+ // Is a given variable an object?
+ function isObject(obj) {
+ var type = typeof obj;
+ return type === 'function' || type === 'object' && !!obj;
+ }
+
+ // Is a given value equal to null?
+ function isNull(obj) {
+ return obj === null;
+ }
+
+ // Is a given variable undefined?
+ function isUndefined(obj) {
+ return obj === void 0;
+ }
+
+ // Is a given value a boolean?
+ function isBoolean(obj) {
+ return obj === true || obj === false || toString.call(obj) === '[object Boolean]';
+ }
+
+ // Is a given value a DOM element?
+ function isElement(obj) {
+ return !!(obj && obj.nodeType === 1);
+ }
+
+ // Internal function for creating a `toString`-based type tester.
+ function tagTester(name) {
+ var tag = '[object ' + name + ']';
+ return function(obj) {
+ return toString.call(obj) === tag;
+ };
+ }
+
+ var isString = tagTester('String');
+
+ var isNumber = tagTester('Number');
+
+ var isDate = tagTester('Date');
+
+ var isRegExp = tagTester('RegExp');
+
+ var isError = tagTester('Error');
+
+ var isSymbol = tagTester('Symbol');
+
+ var isArrayBuffer = tagTester('ArrayBuffer');
+
+ var isFunction = tagTester('Function');
+
+ // Optimize `isFunction` if appropriate. Work around some `typeof` bugs in old
+ // v8, IE 11 (#1621), Safari 8 (#1929), and PhantomJS (#2236).
+ var nodelist = root.document && root.document.childNodes;
+ if (typeof /./ != 'function' && typeof Int8Array != 'object' && typeof nodelist != 'function') {
+ isFunction = function(obj) {
+ return typeof obj == 'function' || false;
+ };
+ }
+
+ var isFunction$1 = isFunction;
+
+ var hasObjectTag = tagTester('Object');
+
+ // In IE 10 - Edge 13, `DataView` has string tag `'[object Object]'`.
+ // In IE 11, the most common among them, this problem also applies to
+ // `Map`, `WeakMap` and `Set`.
+ var hasStringTagBug = (
+ supportsDataView && hasObjectTag(new DataView(new ArrayBuffer(8)))
+ ),
+ isIE11 = (typeof Map !== 'undefined' && hasObjectTag(new Map));
+
+ var isDataView = tagTester('DataView');
+
+ // In IE 10 - Edge 13, we need a different heuristic
+ // to determine whether an object is a `DataView`.
+ function ie10IsDataView(obj) {
+ return obj != null && isFunction$1(obj.getInt8) && isArrayBuffer(obj.buffer);
+ }
+
+ var isDataView$1 = (hasStringTagBug ? ie10IsDataView : isDataView);
+
+ // Is a given value an array?
+ // Delegates to ECMA5's native `Array.isArray`.
+ var isArray = nativeIsArray || tagTester('Array');
+
+ // Internal function to check whether `key` is an own property name of `obj`.
+ function has$1(obj, key) {
+ return obj != null && hasOwnProperty.call(obj, key);
+ }
+
+ var isArguments = tagTester('Arguments');
+
+ // Define a fallback version of the method in browsers (ahem, IE < 9), where
+ // there isn't any inspectable "Arguments" type.
+ (function() {
+ if (!isArguments(arguments)) {
+ isArguments = function(obj) {
+ return has$1(obj, 'callee');
+ };
+ }
+ }());
+
+ var isArguments$1 = isArguments;
+
+ // Is a given object a finite number?
+ function isFinite$1(obj) {
+ return !isSymbol(obj) && _isFinite(obj) && !isNaN(parseFloat(obj));
+ }
+
+ // Is the given value `NaN`?
+ function isNaN$1(obj) {
+ return isNumber(obj) && _isNaN(obj);
+ }
+
+ // Predicate-generating function. Often useful outside of Underscore.
+ function constant(value) {
+ return function() {
+ return value;
+ };
+ }
+
+ // Common internal logic for `isArrayLike` and `isBufferLike`.
+ function createSizePropertyCheck(getSizeProperty) {
+ return function(collection) {
+ var sizeProperty = getSizeProperty(collection);
+ return typeof sizeProperty == 'number' && sizeProperty >= 0 && sizeProperty <= MAX_ARRAY_INDEX;
+ }
+ }
+
+ // Internal helper to generate a function to obtain property `key` from `obj`.
+ function shallowProperty(key) {
+ return function(obj) {
+ return obj == null ? void 0 : obj[key];
+ };
+ }
+
+ // Internal helper to obtain the `byteLength` property of an object.
+ var getByteLength = shallowProperty('byteLength');
+
+ // Internal helper to determine whether we should spend extensive checks against
+ // `ArrayBuffer` et al.
+ var isBufferLike = createSizePropertyCheck(getByteLength);
+
+ // Is a given value a typed array?
+ var typedArrayPattern = /\[object ((I|Ui)nt(8|16|32)|Float(32|64)|Uint8Clamped|Big(I|Ui)nt64)Array\]/;
+ function isTypedArray(obj) {
+ // `ArrayBuffer.isView` is the most future-proof, so use it when available.
+ // Otherwise, fall back on the above regular expression.
+ return nativeIsView ? (nativeIsView(obj) && !isDataView$1(obj)) :
+ isBufferLike(obj) && typedArrayPattern.test(toString.call(obj));
+ }
+
+ var isTypedArray$1 = supportsArrayBuffer ? isTypedArray : constant(false);
+
+ // Internal helper to obtain the `length` property of an object.
+ var getLength = shallowProperty('length');
+
+ // Internal helper to create a simple lookup structure.
+ // `collectNonEnumProps` used to depend on `_.contains`, but this led to
+ // circular imports. `emulatedSet` is a one-off solution that only works for
+ // arrays of strings.
+ function emulatedSet(keys) {
+ var hash = {};
+ for (var l = keys.length, i = 0; i < l; ++i) hash[keys[i]] = true;
+ return {
+ contains: function(key) { return hash[key]; },
+ push: function(key) {
+ hash[key] = true;
+ return keys.push(key);
+ }
+ };
+ }
+
+ // Internal helper. Checks `keys` for the presence of keys in IE < 9 that won't
+ // be iterated by `for key in ...` and thus missed. Extends `keys` in place if
+ // needed.
+ function collectNonEnumProps(obj, keys) {
+ keys = emulatedSet(keys);
+ var nonEnumIdx = nonEnumerableProps.length;
+ var constructor = obj.constructor;
+ var proto = isFunction$1(constructor) && constructor.prototype || ObjProto;
+
+ // Constructor is a special case.
+ var prop = 'constructor';
+ if (has$1(obj, prop) && !keys.contains(prop)) keys.push(prop);
+
+ while (nonEnumIdx--) {
+ prop = nonEnumerableProps[nonEnumIdx];
+ if (prop in obj && obj[prop] !== proto[prop] && !keys.contains(prop)) {
+ keys.push(prop);
+ }
+ }
+ }
+
+ // Retrieve the names of an object's own properties.
+ // Delegates to **ECMAScript 5**'s native `Object.keys`.
+ function keys(obj) {
+ if (!isObject(obj)) return [];
+ if (nativeKeys) return nativeKeys(obj);
+ var keys = [];
+ for (var key in obj) if (has$1(obj, key)) keys.push(key);
+ // Ahem, IE < 9.
+ if (hasEnumBug) collectNonEnumProps(obj, keys);
+ return keys;
+ }
+
+ // Is a given array, string, or object empty?
+ // An "empty" object has no enumerable own-properties.
+ function isEmpty(obj) {
+ if (obj == null) return true;
+ // Skip the more expensive `toString`-based type checks if `obj` has no
+ // `.length`.
+ var length = getLength(obj);
+ if (typeof length == 'number' && (
+ isArray(obj) || isString(obj) || isArguments$1(obj)
+ )) return length === 0;
+ return getLength(keys(obj)) === 0;
+ }
+
+ // Returns whether an object has a given set of `key:value` pairs.
+ function isMatch(object, attrs) {
+ var _keys = keys(attrs), length = _keys.length;
+ if (object == null) return !length;
+ var obj = Object(object);
+ for (var i = 0; i < length; i++) {
+ var key = _keys[i];
+ if (attrs[key] !== obj[key] || !(key in obj)) return false;
+ }
+ return true;
+ }
+
+ // If Underscore is called as a function, it returns a wrapped object that can
+ // be used OO-style. This wrapper holds altered versions of all functions added
+ // through `_.mixin`. Wrapped objects may be chained.
+ function _$1(obj) {
+ if (obj instanceof _$1) return obj;
+ if (!(this instanceof _$1)) return new _$1(obj);
+ this._wrapped = obj;
+ }
+
+ _$1.VERSION = VERSION;
+
+ // Extracts the result from a wrapped and chained object.
+ _$1.prototype.value = function() {
+ return this._wrapped;
+ };
+
+ // Provide unwrapping proxies for some methods used in engine operations
+ // such as arithmetic and JSON stringification.
+ _$1.prototype.valueOf = _$1.prototype.toJSON = _$1.prototype.value;
+
+ _$1.prototype.toString = function() {
+ return String(this._wrapped);
+ };
+
+ // Internal function to wrap or shallow-copy an ArrayBuffer,
+ // typed array or DataView to a new view, reusing the buffer.
+ function toBufferView(bufferSource) {
+ return new Uint8Array(
+ bufferSource.buffer || bufferSource,
+ bufferSource.byteOffset || 0,
+ getByteLength(bufferSource)
+ );
+ }
+
+ // We use this string twice, so give it a name for minification.
+ var tagDataView = '[object DataView]';
+
+ // Internal recursive comparison function for `_.isEqual`.
+ function eq(a, b, aStack, bStack) {
+ // Identical objects are equal. `0 === -0`, but they aren't identical.
+ // See the [Harmony `egal` proposal](https://wiki.ecmascript.org/doku.php?id=harmony:egal).
+ if (a === b) return a !== 0 || 1 / a === 1 / b;
+ // `null` or `undefined` only equal to itself (strict comparison).
+ if (a == null || b == null) return false;
+ // `NaN`s are equivalent, but non-reflexive.
+ if (a !== a) return b !== b;
+ // Exhaust primitive checks
+ var type = typeof a;
+ if (type !== 'function' && type !== 'object' && typeof b != 'object') return false;
+ return deepEq(a, b, aStack, bStack);
+ }
+
+ // Internal recursive comparison function for `_.isEqual`.
+ function deepEq(a, b, aStack, bStack) {
+ // Unwrap any wrapped objects.
+ if (a instanceof _$1) a = a._wrapped;
+ if (b instanceof _$1) b = b._wrapped;
+ // Compare `[[Class]]` names.
+ var className = toString.call(a);
+ if (className !== toString.call(b)) return false;
+ // Work around a bug in IE 10 - Edge 13.
+ if (hasStringTagBug && className == '[object Object]' && isDataView$1(a)) {
+ if (!isDataView$1(b)) return false;
+ className = tagDataView;
+ }
+ switch (className) {
+ // These types are compared by value.
+ case '[object RegExp]':
+ // RegExps are coerced to strings for comparison (Note: '' + /a/i === '/a/i')
+ case '[object String]':
+ // Primitives and their corresponding object wrappers are equivalent; thus, `"5"` is
+ // equivalent to `new String("5")`.
+ return '' + a === '' + b;
+ case '[object Number]':
+ // `NaN`s are equivalent, but non-reflexive.
+ // Object(NaN) is equivalent to NaN.
+ if (+a !== +a) return +b !== +b;
+ // An `egal` comparison is performed for other numeric values.
+ return +a === 0 ? 1 / +a === 1 / b : +a === +b;
+ case '[object Date]':
+ case '[object Boolean]':
+ // Coerce dates and booleans to numeric primitive values. Dates are compared by their
+ // millisecond representations. Note that invalid dates with millisecond representations
+ // of `NaN` are not equivalent.
+ return +a === +b;
+ case '[object Symbol]':
+ return SymbolProto.valueOf.call(a) === SymbolProto.valueOf.call(b);
+ case '[object ArrayBuffer]':
+ case tagDataView:
+ // Coerce to typed array so we can fall through.
+ return deepEq(toBufferView(a), toBufferView(b), aStack, bStack);
+ }
+
+ var areArrays = className === '[object Array]';
+ if (!areArrays && isTypedArray$1(a)) {
+ var byteLength = getByteLength(a);
+ if (byteLength !== getByteLength(b)) return false;
+ if (a.buffer === b.buffer && a.byteOffset === b.byteOffset) return true;
+ areArrays = true;
+ }
+ if (!areArrays) {
+ if (typeof a != 'object' || typeof b != 'object') return false;
+
+ // Objects with different constructors are not equivalent, but `Object`s or `Array`s
+ // from different frames are.
+ var aCtor = a.constructor, bCtor = b.constructor;
+ if (aCtor !== bCtor && !(isFunction$1(aCtor) && aCtor instanceof aCtor &&
+ isFunction$1(bCtor) && bCtor instanceof bCtor)
+ && ('constructor' in a && 'constructor' in b)) {
+ return false;
+ }
+ }
+ // Assume equality for cyclic structures. The algorithm for detecting cyclic
+ // structures is adapted from ES 5.1 section 15.12.3, abstract operation `JO`.
+
+ // Initializing stack of traversed objects.
+ // It's done here since we only need them for objects and arrays comparison.
+ aStack = aStack || [];
+ bStack = bStack || [];
+ var length = aStack.length;
+ while (length--) {
+ // Linear search. Performance is inversely proportional to the number of
+ // unique nested structures.
+ if (aStack[length] === a) return bStack[length] === b;
+ }
+
+ // Add the first object to the stack of traversed objects.
+ aStack.push(a);
+ bStack.push(b);
+
+ // Recursively compare objects and arrays.
+ if (areArrays) {
+ // Compare array lengths to determine if a deep comparison is necessary.
+ length = a.length;
+ if (length !== b.length) return false;
+ // Deep compare the contents, ignoring non-numeric properties.
+ while (length--) {
+ if (!eq(a[length], b[length], aStack, bStack)) return false;
+ }
+ } else {
+ // Deep compare objects.
+ var _keys = keys(a), key;
+ length = _keys.length;
+ // Ensure that both objects contain the same number of properties before comparing deep equality.
+ if (keys(b).length !== length) return false;
+ while (length--) {
+ // Deep compare each member
+ key = _keys[length];
+ if (!(has$1(b, key) && eq(a[key], b[key], aStack, bStack))) return false;
+ }
+ }
+ // Remove the first object from the stack of traversed objects.
+ aStack.pop();
+ bStack.pop();
+ return true;
+ }
+
+ // Perform a deep comparison to check if two objects are equal.
+ function isEqual(a, b) {
+ return eq(a, b);
+ }
+
+ // Retrieve all the enumerable property names of an object.
+ function allKeys(obj) {
+ if (!isObject(obj)) return [];
+ var keys = [];
+ for (var key in obj) keys.push(key);
+ // Ahem, IE < 9.
+ if (hasEnumBug) collectNonEnumProps(obj, keys);
+ return keys;
+ }
+
+ // Since the regular `Object.prototype.toString` type tests don't work for
+ // some types in IE 11, we use a fingerprinting heuristic instead, based
+ // on the methods. It's not great, but it's the best we got.
+ // The fingerprint method lists are defined below.
+ function ie11fingerprint(methods) {
+ var length = getLength(methods);
+ return function(obj) {
+ if (obj == null) return false;
+ // `Map`, `WeakMap` and `Set` have no enumerable keys.
+ var keys = allKeys(obj);
+ if (getLength(keys)) return false;
+ for (var i = 0; i < length; i++) {
+ if (!isFunction$1(obj[methods[i]])) return false;
+ }
+ // If we are testing against `WeakMap`, we need to ensure that
+ // `obj` doesn't have a `forEach` method in order to distinguish
+ // it from a regular `Map`.
+ return methods !== weakMapMethods || !isFunction$1(obj[forEachName]);
+ };
+ }
+
+ // In the interest of compact minification, we write
+ // each string in the fingerprints only once.
+ var forEachName = 'forEach',
+ hasName = 'has',
+ commonInit = ['clear', 'delete'],
+ mapTail = ['get', hasName, 'set'];
+
+ // `Map`, `WeakMap` and `Set` each have slightly different
+ // combinations of the above sublists.
+ var mapMethods = commonInit.concat(forEachName, mapTail),
+ weakMapMethods = commonInit.concat(mapTail),
+ setMethods = ['add'].concat(commonInit, forEachName, hasName);
+
+ var isMap = isIE11 ? ie11fingerprint(mapMethods) : tagTester('Map');
+
+ var isWeakMap = isIE11 ? ie11fingerprint(weakMapMethods) : tagTester('WeakMap');
+
+ var isSet = isIE11 ? ie11fingerprint(setMethods) : tagTester('Set');
+
+ var isWeakSet = tagTester('WeakSet');
+
+ // Retrieve the values of an object's properties.
+ function values(obj) {
+ var _keys = keys(obj);
+ var length = _keys.length;
+ var values = Array(length);
+ for (var i = 0; i < length; i++) {
+ values[i] = obj[_keys[i]];
+ }
+ return values;
+ }
+
+ // Convert an object into a list of `[key, value]` pairs.
+ // The opposite of `_.object` with one argument.
+ function pairs(obj) {
+ var _keys = keys(obj);
+ var length = _keys.length;
+ var pairs = Array(length);
+ for (var i = 0; i < length; i++) {
+ pairs[i] = [_keys[i], obj[_keys[i]]];
+ }
+ return pairs;
+ }
+
+ // Invert the keys and values of an object. The values must be serializable.
+ function invert(obj) {
+ var result = {};
+ var _keys = keys(obj);
+ for (var i = 0, length = _keys.length; i < length; i++) {
+ result[obj[_keys[i]]] = _keys[i];
+ }
+ return result;
+ }
+
+ // Return a sorted list of the function names available on the object.
+ function functions(obj) {
+ var names = [];
+ for (var key in obj) {
+ if (isFunction$1(obj[key])) names.push(key);
+ }
+ return names.sort();
+ }
+
+ // An internal function for creating assigner functions.
+ function createAssigner(keysFunc, defaults) {
+ return function(obj) {
+ var length = arguments.length;
+ if (defaults) obj = Object(obj);
+ if (length < 2 || obj == null) return obj;
+ for (var index = 1; index < length; index++) {
+ var source = arguments[index],
+ keys = keysFunc(source),
+ l = keys.length;
+ for (var i = 0; i < l; i++) {
+ var key = keys[i];
+ if (!defaults || obj[key] === void 0) obj[key] = source[key];
+ }
+ }
+ return obj;
+ };
+ }
+
+ // Extend a given object with all the properties in passed-in object(s).
+ var extend = createAssigner(allKeys);
+
+ // Assigns a given object with all the own properties in the passed-in
+ // object(s).
+ // (https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object/assign)
+ var extendOwn = createAssigner(keys);
+
+ // Fill in a given object with default properties.
+ var defaults = createAssigner(allKeys, true);
+
+ // Create a naked function reference for surrogate-prototype-swapping.
+ function ctor() {
+ return function(){};
+ }
+
+ // An internal function for creating a new object that inherits from another.
+ function baseCreate(prototype) {
+ if (!isObject(prototype)) return {};
+ if (nativeCreate) return nativeCreate(prototype);
+ var Ctor = ctor();
+ Ctor.prototype = prototype;
+ var result = new Ctor;
+ Ctor.prototype = null;
+ return result;
+ }
+
+ // Creates an object that inherits from the given prototype object.
+ // If additional properties are provided then they will be added to the
+ // created object.
+ function create(prototype, props) {
+ var result = baseCreate(prototype);
+ if (props) extendOwn(result, props);
+ return result;
+ }
+
+ // Create a (shallow-cloned) duplicate of an object.
+ function clone(obj) {
+ if (!isObject(obj)) return obj;
+ return isArray(obj) ? obj.slice() : extend({}, obj);
+ }
+
+ // Invokes `interceptor` with the `obj` and then returns `obj`.
+ // The primary purpose of this method is to "tap into" a method chain, in
+ // order to perform operations on intermediate results within the chain.
+ function tap(obj, interceptor) {
+ interceptor(obj);
+ return obj;
+ }
+
+ // Normalize a (deep) property `path` to array.
+ // Like `_.iteratee`, this function can be customized.
+ function toPath$1(path) {
+ return isArray(path) ? path : [path];
+ }
+ _$1.toPath = toPath$1;
+
+ // Internal wrapper for `_.toPath` to enable minification.
+ // Similar to `cb` for `_.iteratee`.
+ function toPath(path) {
+ return _$1.toPath(path);
+ }
+
+ // Internal function to obtain a nested property in `obj` along `path`.
+ function deepGet(obj, path) {
+ var length = path.length;
+ for (var i = 0; i < length; i++) {
+ if (obj == null) return void 0;
+ obj = obj[path[i]];
+ }
+ return length ? obj : void 0;
+ }
+
+ // Get the value of the (deep) property on `path` from `object`.
+ // If any property in `path` does not exist or if the value is
+ // `undefined`, return `defaultValue` instead.
+ // The `path` is normalized through `_.toPath`.
+ function get(object, path, defaultValue) {
+ var value = deepGet(object, toPath(path));
+ return isUndefined(value) ? defaultValue : value;
+ }
+
+ // Shortcut function for checking if an object has a given property directly on
+ // itself (in other words, not on a prototype). Unlike the internal `has`
+ // function, this public version can also traverse nested properties.
+ function has(obj, path) {
+ path = toPath(path);
+ var length = path.length;
+ for (var i = 0; i < length; i++) {
+ var key = path[i];
+ if (!has$1(obj, key)) return false;
+ obj = obj[key];
+ }
+ return !!length;
+ }
+
+ // Keep the identity function around for default iteratees.
+ function identity(value) {
+ return value;
+ }
+
+ // Returns a predicate for checking whether an object has a given set of
+ // `key:value` pairs.
+ function matcher(attrs) {
+ attrs = extendOwn({}, attrs);
+ return function(obj) {
+ return isMatch(obj, attrs);
+ };
+ }
+
+ // Creates a function that, when passed an object, will traverse that object’s
+ // properties down the given `path`, specified as an array of keys or indices.
+ function property(path) {
+ path = toPath(path);
+ return function(obj) {
+ return deepGet(obj, path);
+ };
+ }
+
+ // Internal function that returns an efficient (for current engines) version
+ // of the passed-in callback, to be repeatedly applied in other Underscore
+ // functions.
+ function optimizeCb(func, context, argCount) {
+ if (context === void 0) return func;
+ switch (argCount == null ? 3 : argCount) {
+ case 1: return function(value) {
+ return func.call(context, value);
+ };
+ // The 2-argument case is omitted because we’re not using it.
+ case 3: return function(value, index, collection) {
+ return func.call(context, value, index, collection);
+ };
+ case 4: return function(accumulator, value, index, collection) {
+ return func.call(context, accumulator, value, index, collection);
+ };
+ }
+ return function() {
+ return func.apply(context, arguments);
+ };
+ }
+
+ // An internal function to generate callbacks that can be applied to each
+ // element in a collection, returning the desired result — either `_.identity`,
+ // an arbitrary callback, a property matcher, or a property accessor.
+ function baseIteratee(value, context, argCount) {
+ if (value == null) return identity;
+ if (isFunction$1(value)) return optimizeCb(value, context, argCount);
+ if (isObject(value) && !isArray(value)) return matcher(value);
+ return property(value);
+ }
+
+ // External wrapper for our callback generator. Users may customize
+ // `_.iteratee` if they want additional predicate/iteratee shorthand styles.
+ // This abstraction hides the internal-only `argCount` argument.
+ function iteratee(value, context) {
+ return baseIteratee(value, context, Infinity);
+ }
+ _$1.iteratee = iteratee;
+
+ // The function we call internally to generate a callback. It invokes
+ // `_.iteratee` if overridden, otherwise `baseIteratee`.
+ function cb(value, context, argCount) {
+ if (_$1.iteratee !== iteratee) return _$1.iteratee(value, context);
+ return baseIteratee(value, context, argCount);
+ }
+
+ // Returns the results of applying the `iteratee` to each element of `obj`.
+ // In contrast to `_.map` it returns an object.
+ function mapObject(obj, iteratee, context) {
+ iteratee = cb(iteratee, context);
+ var _keys = keys(obj),
+ length = _keys.length,
+ results = {};
+ for (var index = 0; index < length; index++) {
+ var currentKey = _keys[index];
+ results[currentKey] = iteratee(obj[currentKey], currentKey, obj);
+ }
+ return results;
+ }
+
+ // Predicate-generating function. Often useful outside of Underscore.
+ function noop(){}
+
+ // Generates a function for a given object that returns a given property.
+ function propertyOf(obj) {
+ if (obj == null) return noop;
+ return function(path) {
+ return get(obj, path);
+ };
+ }
+
+ // Run a function **n** times.
+ function times(n, iteratee, context) {
+ var accum = Array(Math.max(0, n));
+ iteratee = optimizeCb(iteratee, context, 1);
+ for (var i = 0; i < n; i++) accum[i] = iteratee(i);
+ return accum;
+ }
+
+ // Return a random integer between `min` and `max` (inclusive).
+ function random(min, max) {
+ if (max == null) {
+ max = min;
+ min = 0;
+ }
+ return min + Math.floor(Math.random() * (max - min + 1));
+ }
+
+ // A (possibly faster) way to get the current timestamp as an integer.
+ var now = Date.now || function() {
+ return new Date().getTime();
+ };
+
+ // Internal helper to generate functions for escaping and unescaping strings
+ // to/from HTML interpolation.
+ function createEscaper(map) {
+ var escaper = function(match) {
+ return map[match];
+ };
+ // Regexes for identifying a key that needs to be escaped.
+ var source = '(?:' + keys(map).join('|') + ')';
+ var testRegexp = RegExp(source);
+ var replaceRegexp = RegExp(source, 'g');
+ return function(string) {
+ string = string == null ? '' : '' + string;
+ return testRegexp.test(string) ? string.replace(replaceRegexp, escaper) : string;
+ };
+ }
+
+ // Internal list of HTML entities for escaping.
+ var escapeMap = {
+ '&': '&',
+ '<': '<',
+ '>': '>',
+ '"': '"',
+ "'": ''',
+ '`': '`'
+ };
+
+ // Function for escaping strings to HTML interpolation.
+ var _escape = createEscaper(escapeMap);
+
+ // Internal list of HTML entities for unescaping.
+ var unescapeMap = invert(escapeMap);
+
+ // Function for unescaping strings from HTML interpolation.
+ var _unescape = createEscaper(unescapeMap);
+
+ // By default, Underscore uses ERB-style template delimiters. Change the
+ // following template settings to use alternative delimiters.
+ var templateSettings = _$1.templateSettings = {
+ evaluate: /<%([\s\S]+?)%>/g,
+ interpolate: /<%=([\s\S]+?)%>/g,
+ escape: /<%-([\s\S]+?)%>/g
+ };
+
+ // When customizing `_.templateSettings`, if you don't want to define an
+ // interpolation, evaluation or escaping regex, we need one that is
+ // guaranteed not to match.
+ var noMatch = /(.)^/;
+
+ // Certain characters need to be escaped so that they can be put into a
+ // string literal.
+ var escapes = {
+ "'": "'",
+ '\\': '\\',
+ '\r': 'r',
+ '\n': 'n',
+ '\u2028': 'u2028',
+ '\u2029': 'u2029'
+ };
+
+ var escapeRegExp = /\\|'|\r|\n|\u2028|\u2029/g;
+
+ function escapeChar(match) {
+ return '\\' + escapes[match];
+ }
+
+ // In order to prevent third-party code injection through
+ // `_.templateSettings.variable`, we test it against the following regular
+ // expression. It is intentionally a bit more liberal than just matching valid
+ // identifiers, but still prevents possible loopholes through defaults or
+ // destructuring assignment.
+ var bareIdentifier = /^\s*(\w|\$)+\s*$/;
+
+ // JavaScript micro-templating, similar to John Resig's implementation.
+ // Underscore templating handles arbitrary delimiters, preserves whitespace,
+ // and correctly escapes quotes within interpolated code.
+ // NB: `oldSettings` only exists for backwards compatibility.
+ function template(text, settings, oldSettings) {
+ if (!settings && oldSettings) settings = oldSettings;
+ settings = defaults({}, settings, _$1.templateSettings);
+
+ // Combine delimiters into one regular expression via alternation.
+ var matcher = RegExp([
+ (settings.escape || noMatch).source,
+ (settings.interpolate || noMatch).source,
+ (settings.evaluate || noMatch).source
+ ].join('|') + '|$', 'g');
+
+ // Compile the template source, escaping string literals appropriately.
+ var index = 0;
+ var source = "__p+='";
+ text.replace(matcher, function(match, escape, interpolate, evaluate, offset) {
+ source += text.slice(index, offset).replace(escapeRegExp, escapeChar);
+ index = offset + match.length;
+
+ if (escape) {
+ source += "'+\n((__t=(" + escape + "))==null?'':_.escape(__t))+\n'";
+ } else if (interpolate) {
+ source += "'+\n((__t=(" + interpolate + "))==null?'':__t)+\n'";
+ } else if (evaluate) {
+ source += "';\n" + evaluate + "\n__p+='";
+ }
+
+ // Adobe VMs need the match returned to produce the correct offset.
+ return match;
+ });
+ source += "';\n";
+
+ var argument = settings.variable;
+ if (argument) {
+ // Insure against third-party code injection. (CVE-2021-23358)
+ if (!bareIdentifier.test(argument)) throw new Error(
+ 'variable is not a bare identifier: ' + argument
+ );
+ } else {
+ // If a variable is not specified, place data values in local scope.
+ source = 'with(obj||{}){\n' + source + '}\n';
+ argument = 'obj';
+ }
+
+ source = "var __t,__p='',__j=Array.prototype.join," +
+ "print=function(){__p+=__j.call(arguments,'');};\n" +
+ source + 'return __p;\n';
+
+ var render;
+ try {
+ render = new Function(argument, '_', source);
+ } catch (e) {
+ e.source = source;
+ throw e;
+ }
+
+ var template = function(data) {
+ return render.call(this, data, _$1);
+ };
+
+ // Provide the compiled source as a convenience for precompilation.
+ template.source = 'function(' + argument + '){\n' + source + '}';
+
+ return template;
+ }
+
+ // Traverses the children of `obj` along `path`. If a child is a function, it
+ // is invoked with its parent as context. Returns the value of the final
+ // child, or `fallback` if any child is undefined.
+ function result(obj, path, fallback) {
+ path = toPath(path);
+ var length = path.length;
+ if (!length) {
+ return isFunction$1(fallback) ? fallback.call(obj) : fallback;
+ }
+ for (var i = 0; i < length; i++) {
+ var prop = obj == null ? void 0 : obj[path[i]];
+ if (prop === void 0) {
+ prop = fallback;
+ i = length; // Ensure we don't continue iterating.
+ }
+ obj = isFunction$1(prop) ? prop.call(obj) : prop;
+ }
+ return obj;
+ }
+
+ // Generate a unique integer id (unique within the entire client session).
+ // Useful for temporary DOM ids.
+ var idCounter = 0;
+ function uniqueId(prefix) {
+ var id = ++idCounter + '';
+ return prefix ? prefix + id : id;
+ }
+
+ // Start chaining a wrapped Underscore object.
+ function chain(obj) {
+ var instance = _$1(obj);
+ instance._chain = true;
+ return instance;
+ }
+
+ // Internal function to execute `sourceFunc` bound to `context` with optional
+ // `args`. Determines whether to execute a function as a constructor or as a
+ // normal function.
+ function executeBound(sourceFunc, boundFunc, context, callingContext, args) {
+ if (!(callingContext instanceof boundFunc)) return sourceFunc.apply(context, args);
+ var self = baseCreate(sourceFunc.prototype);
+ var result = sourceFunc.apply(self, args);
+ if (isObject(result)) return result;
+ return self;
+ }
+
+ // Partially apply a function by creating a version that has had some of its
+ // arguments pre-filled, without changing its dynamic `this` context. `_` acts
+ // as a placeholder by default, allowing any combination of arguments to be
+ // pre-filled. Set `_.partial.placeholder` for a custom placeholder argument.
+ var partial = restArguments(function(func, boundArgs) {
+ var placeholder = partial.placeholder;
+ var bound = function() {
+ var position = 0, length = boundArgs.length;
+ var args = Array(length);
+ for (var i = 0; i < length; i++) {
+ args[i] = boundArgs[i] === placeholder ? arguments[position++] : boundArgs[i];
+ }
+ while (position < arguments.length) args.push(arguments[position++]);
+ return executeBound(func, bound, this, this, args);
+ };
+ return bound;
+ });
+
+ partial.placeholder = _$1;
+
+ // Create a function bound to a given object (assigning `this`, and arguments,
+ // optionally).
+ var bind = restArguments(function(func, context, args) {
+ if (!isFunction$1(func)) throw new TypeError('Bind must be called on a function');
+ var bound = restArguments(function(callArgs) {
+ return executeBound(func, bound, context, this, args.concat(callArgs));
+ });
+ return bound;
+ });
+
+ // Internal helper for collection methods to determine whether a collection
+ // should be iterated as an array or as an object.
+ // Related: https://people.mozilla.org/~jorendorff/es6-draft.html#sec-tolength
+ // Avoids a very nasty iOS 8 JIT bug on ARM-64. #2094
+ var isArrayLike = createSizePropertyCheck(getLength);
+
+ // Internal implementation of a recursive `flatten` function.
+ function flatten$1(input, depth, strict, output) {
+ output = output || [];
+ if (!depth && depth !== 0) {
+ depth = Infinity;
+ } else if (depth <= 0) {
+ return output.concat(input);
+ }
+ var idx = output.length;
+ for (var i = 0, length = getLength(input); i < length; i++) {
+ var value = input[i];
+ if (isArrayLike(value) && (isArray(value) || isArguments$1(value))) {
+ // Flatten current level of array or arguments object.
+ if (depth > 1) {
+ flatten$1(value, depth - 1, strict, output);
+ idx = output.length;
+ } else {
+ var j = 0, len = value.length;
+ while (j < len) output[idx++] = value[j++];
+ }
+ } else if (!strict) {
+ output[idx++] = value;
+ }
+ }
+ return output;
+ }
+
+ // Bind a number of an object's methods to that object. Remaining arguments
+ // are the method names to be bound. Useful for ensuring that all callbacks
+ // defined on an object belong to it.
+ var bindAll = restArguments(function(obj, keys) {
+ keys = flatten$1(keys, false, false);
+ var index = keys.length;
+ if (index < 1) throw new Error('bindAll must be passed function names');
+ while (index--) {
+ var key = keys[index];
+ obj[key] = bind(obj[key], obj);
+ }
+ return obj;
+ });
+
+ // Memoize an expensive function by storing its results.
+ function memoize(func, hasher) {
+ var memoize = function(key) {
+ var cache = memoize.cache;
+ var address = '' + (hasher ? hasher.apply(this, arguments) : key);
+ if (!has$1(cache, address)) cache[address] = func.apply(this, arguments);
+ return cache[address];
+ };
+ memoize.cache = {};
+ return memoize;
+ }
+
+ // Delays a function for the given number of milliseconds, and then calls
+ // it with the arguments supplied.
+ var delay = restArguments(function(func, wait, args) {
+ return setTimeout(function() {
+ return func.apply(null, args);
+ }, wait);
+ });
+
+ // Defers a function, scheduling it to run after the current call stack has
+ // cleared.
+ var defer = partial(delay, _$1, 1);
+
+ // Returns a function, that, when invoked, will only be triggered at most once
+ // during a given window of time. Normally, the throttled function will run
+ // as much as it can, without ever going more than once per `wait` duration;
+ // but if you'd like to disable the execution on the leading edge, pass
+ // `{leading: false}`. To disable execution on the trailing edge, ditto.
+ function throttle(func, wait, options) {
+ var timeout, context, args, result;
+ var previous = 0;
+ if (!options) options = {};
+
+ var later = function() {
+ previous = options.leading === false ? 0 : now();
+ timeout = null;
+ result = func.apply(context, args);
+ if (!timeout) context = args = null;
+ };
+
+ var throttled = function() {
+ var _now = now();
+ if (!previous && options.leading === false) previous = _now;
+ var remaining = wait - (_now - previous);
+ context = this;
+ args = arguments;
+ if (remaining <= 0 || remaining > wait) {
+ if (timeout) {
+ clearTimeout(timeout);
+ timeout = null;
+ }
+ previous = _now;
+ result = func.apply(context, args);
+ if (!timeout) context = args = null;
+ } else if (!timeout && options.trailing !== false) {
+ timeout = setTimeout(later, remaining);
+ }
+ return result;
+ };
+
+ throttled.cancel = function() {
+ clearTimeout(timeout);
+ previous = 0;
+ timeout = context = args = null;
+ };
+
+ return throttled;
+ }
+
+ // When a sequence of calls of the returned function ends, the argument
+ // function is triggered. The end of a sequence is defined by the `wait`
+ // parameter. If `immediate` is passed, the argument function will be
+ // triggered at the beginning of the sequence instead of at the end.
+ function debounce(func, wait, immediate) {
+ var timeout, previous, args, result, context;
+
+ var later = function() {
+ var passed = now() - previous;
+ if (wait > passed) {
+ timeout = setTimeout(later, wait - passed);
+ } else {
+ timeout = null;
+ if (!immediate) result = func.apply(context, args);
+ // This check is needed because `func` can recursively invoke `debounced`.
+ if (!timeout) args = context = null;
+ }
+ };
+
+ var debounced = restArguments(function(_args) {
+ context = this;
+ args = _args;
+ previous = now();
+ if (!timeout) {
+ timeout = setTimeout(later, wait);
+ if (immediate) result = func.apply(context, args);
+ }
+ return result;
+ });
+
+ debounced.cancel = function() {
+ clearTimeout(timeout);
+ timeout = args = context = null;
+ };
+
+ return debounced;
+ }
+
+ // Returns the first function passed as an argument to the second,
+ // allowing you to adjust arguments, run code before and after, and
+ // conditionally execute the original function.
+ function wrap(func, wrapper) {
+ return partial(wrapper, func);
+ }
+
+ // Returns a negated version of the passed-in predicate.
+ function negate(predicate) {
+ return function() {
+ return !predicate.apply(this, arguments);
+ };
+ }
+
+ // Returns a function that is the composition of a list of functions, each
+ // consuming the return value of the function that follows.
+ function compose() {
+ var args = arguments;
+ var start = args.length - 1;
+ return function() {
+ var i = start;
+ var result = args[start].apply(this, arguments);
+ while (i--) result = args[i].call(this, result);
+ return result;
+ };
+ }
+
+ // Returns a function that will only be executed on and after the Nth call.
+ function after(times, func) {
+ return function() {
+ if (--times < 1) {
+ return func.apply(this, arguments);
+ }
+ };
+ }
+
+ // Returns a function that will only be executed up to (but not including) the
+ // Nth call.
+ function before(times, func) {
+ var memo;
+ return function() {
+ if (--times > 0) {
+ memo = func.apply(this, arguments);
+ }
+ if (times <= 1) func = null;
+ return memo;
+ };
+ }
+
+ // Returns a function that will be executed at most one time, no matter how
+ // often you call it. Useful for lazy initialization.
+ var once = partial(before, 2);
+
+ // Returns the first key on an object that passes a truth test.
+ function findKey(obj, predicate, context) {
+ predicate = cb(predicate, context);
+ var _keys = keys(obj), key;
+ for (var i = 0, length = _keys.length; i < length; i++) {
+ key = _keys[i];
+ if (predicate(obj[key], key, obj)) return key;
+ }
+ }
+
+ // Internal function to generate `_.findIndex` and `_.findLastIndex`.
+ function createPredicateIndexFinder(dir) {
+ return function(array, predicate, context) {
+ predicate = cb(predicate, context);
+ var length = getLength(array);
+ var index = dir > 0 ? 0 : length - 1;
+ for (; index >= 0 && index < length; index += dir) {
+ if (predicate(array[index], index, array)) return index;
+ }
+ return -1;
+ };
+ }
+
+ // Returns the first index on an array-like that passes a truth test.
+ var findIndex = createPredicateIndexFinder(1);
+
+ // Returns the last index on an array-like that passes a truth test.
+ var findLastIndex = createPredicateIndexFinder(-1);
+
+ // Use a comparator function to figure out the smallest index at which
+ // an object should be inserted so as to maintain order. Uses binary search.
+ function sortedIndex(array, obj, iteratee, context) {
+ iteratee = cb(iteratee, context, 1);
+ var value = iteratee(obj);
+ var low = 0, high = getLength(array);
+ while (low < high) {
+ var mid = Math.floor((low + high) / 2);
+ if (iteratee(array[mid]) < value) low = mid + 1; else high = mid;
+ }
+ return low;
+ }
+
+ // Internal function to generate the `_.indexOf` and `_.lastIndexOf` functions.
+ function createIndexFinder(dir, predicateFind, sortedIndex) {
+ return function(array, item, idx) {
+ var i = 0, length = getLength(array);
+ if (typeof idx == 'number') {
+ if (dir > 0) {
+ i = idx >= 0 ? idx : Math.max(idx + length, i);
+ } else {
+ length = idx >= 0 ? Math.min(idx + 1, length) : idx + length + 1;
+ }
+ } else if (sortedIndex && idx && length) {
+ idx = sortedIndex(array, item);
+ return array[idx] === item ? idx : -1;
+ }
+ if (item !== item) {
+ idx = predicateFind(slice.call(array, i, length), isNaN$1);
+ return idx >= 0 ? idx + i : -1;
+ }
+ for (idx = dir > 0 ? i : length - 1; idx >= 0 && idx < length; idx += dir) {
+ if (array[idx] === item) return idx;
+ }
+ return -1;
+ };
+ }
+
+ // Return the position of the first occurrence of an item in an array,
+ // or -1 if the item is not included in the array.
+ // If the array is large and already in sort order, pass `true`
+ // for **isSorted** to use binary search.
+ var indexOf = createIndexFinder(1, findIndex, sortedIndex);
+
+ // Return the position of the last occurrence of an item in an array,
+ // or -1 if the item is not included in the array.
+ var lastIndexOf = createIndexFinder(-1, findLastIndex);
+
+ // Return the first value which passes a truth test.
+ function find(obj, predicate, context) {
+ var keyFinder = isArrayLike(obj) ? findIndex : findKey;
+ var key = keyFinder(obj, predicate, context);
+ if (key !== void 0 && key !== -1) return obj[key];
+ }
+
+ // Convenience version of a common use case of `_.find`: getting the first
+ // object containing specific `key:value` pairs.
+ function findWhere(obj, attrs) {
+ return find(obj, matcher(attrs));
+ }
+
+ // The cornerstone for collection functions, an `each`
+ // implementation, aka `forEach`.
+ // Handles raw objects in addition to array-likes. Treats all
+ // sparse array-likes as if they were dense.
+ function each(obj, iteratee, context) {
+ iteratee = optimizeCb(iteratee, context);
+ var i, length;
+ if (isArrayLike(obj)) {
+ for (i = 0, length = obj.length; i < length; i++) {
+ iteratee(obj[i], i, obj);
+ }
+ } else {
+ var _keys = keys(obj);
+ for (i = 0, length = _keys.length; i < length; i++) {
+ iteratee(obj[_keys[i]], _keys[i], obj);
+ }
+ }
+ return obj;
+ }
+
+ // Return the results of applying the iteratee to each element.
+ function map(obj, iteratee, context) {
+ iteratee = cb(iteratee, context);
+ var _keys = !isArrayLike(obj) && keys(obj),
+ length = (_keys || obj).length,
+ results = Array(length);
+ for (var index = 0; index < length; index++) {
+ var currentKey = _keys ? _keys[index] : index;
+ results[index] = iteratee(obj[currentKey], currentKey, obj);
+ }
+ return results;
+ }
+
+ // Internal helper to create a reducing function, iterating left or right.
+ function createReduce(dir) {
+ // Wrap code that reassigns argument variables in a separate function than
+ // the one that accesses `arguments.length` to avoid a perf hit. (#1991)
+ var reducer = function(obj, iteratee, memo, initial) {
+ var _keys = !isArrayLike(obj) && keys(obj),
+ length = (_keys || obj).length,
+ index = dir > 0 ? 0 : length - 1;
+ if (!initial) {
+ memo = obj[_keys ? _keys[index] : index];
+ index += dir;
+ }
+ for (; index >= 0 && index < length; index += dir) {
+ var currentKey = _keys ? _keys[index] : index;
+ memo = iteratee(memo, obj[currentKey], currentKey, obj);
+ }
+ return memo;
+ };
+
+ return function(obj, iteratee, memo, context) {
+ var initial = arguments.length >= 3;
+ return reducer(obj, optimizeCb(iteratee, context, 4), memo, initial);
+ };
+ }
+
+ // **Reduce** builds up a single result from a list of values, aka `inject`,
+ // or `foldl`.
+ var reduce = createReduce(1);
+
+ // The right-associative version of reduce, also known as `foldr`.
+ var reduceRight = createReduce(-1);
+
+ // Return all the elements that pass a truth test.
+ function filter(obj, predicate, context) {
+ var results = [];
+ predicate = cb(predicate, context);
+ each(obj, function(value, index, list) {
+ if (predicate(value, index, list)) results.push(value);
+ });
+ return results;
+ }
+
+ // Return all the elements for which a truth test fails.
+ function reject(obj, predicate, context) {
+ return filter(obj, negate(cb(predicate)), context);
+ }
+
+ // Determine whether all of the elements pass a truth test.
+ function every(obj, predicate, context) {
+ predicate = cb(predicate, context);
+ var _keys = !isArrayLike(obj) && keys(obj),
+ length = (_keys || obj).length;
+ for (var index = 0; index < length; index++) {
+ var currentKey = _keys ? _keys[index] : index;
+ if (!predicate(obj[currentKey], currentKey, obj)) return false;
+ }
+ return true;
+ }
+
+ // Determine if at least one element in the object passes a truth test.
+ function some(obj, predicate, context) {
+ predicate = cb(predicate, context);
+ var _keys = !isArrayLike(obj) && keys(obj),
+ length = (_keys || obj).length;
+ for (var index = 0; index < length; index++) {
+ var currentKey = _keys ? _keys[index] : index;
+ if (predicate(obj[currentKey], currentKey, obj)) return true;
+ }
+ return false;
+ }
+
+ // Determine if the array or object contains a given item (using `===`).
+ function contains(obj, item, fromIndex, guard) {
+ if (!isArrayLike(obj)) obj = values(obj);
+ if (typeof fromIndex != 'number' || guard) fromIndex = 0;
+ return indexOf(obj, item, fromIndex) >= 0;
+ }
+
+ // Invoke a method (with arguments) on every item in a collection.
+ var invoke = restArguments(function(obj, path, args) {
+ var contextPath, func;
+ if (isFunction$1(path)) {
+ func = path;
+ } else {
+ path = toPath(path);
+ contextPath = path.slice(0, -1);
+ path = path[path.length - 1];
+ }
+ return map(obj, function(context) {
+ var method = func;
+ if (!method) {
+ if (contextPath && contextPath.length) {
+ context = deepGet(context, contextPath);
+ }
+ if (context == null) return void 0;
+ method = context[path];
+ }
+ return method == null ? method : method.apply(context, args);
+ });
+ });
+
+ // Convenience version of a common use case of `_.map`: fetching a property.
+ function pluck(obj, key) {
+ return map(obj, property(key));
+ }
+
+ // Convenience version of a common use case of `_.filter`: selecting only
+ // objects containing specific `key:value` pairs.
+ function where(obj, attrs) {
+ return filter(obj, matcher(attrs));
+ }
+
+ // Return the maximum element (or element-based computation).
+ function max(obj, iteratee, context) {
+ var result = -Infinity, lastComputed = -Infinity,
+ value, computed;
+ if (iteratee == null || typeof iteratee == 'number' && typeof obj[0] != 'object' && obj != null) {
+ obj = isArrayLike(obj) ? obj : values(obj);
+ for (var i = 0, length = obj.length; i < length; i++) {
+ value = obj[i];
+ if (value != null && value > result) {
+ result = value;
+ }
+ }
+ } else {
+ iteratee = cb(iteratee, context);
+ each(obj, function(v, index, list) {
+ computed = iteratee(v, index, list);
+ if (computed > lastComputed || computed === -Infinity && result === -Infinity) {
+ result = v;
+ lastComputed = computed;
+ }
+ });
+ }
+ return result;
+ }
+
+ // Return the minimum element (or element-based computation).
+ function min(obj, iteratee, context) {
+ var result = Infinity, lastComputed = Infinity,
+ value, computed;
+ if (iteratee == null || typeof iteratee == 'number' && typeof obj[0] != 'object' && obj != null) {
+ obj = isArrayLike(obj) ? obj : values(obj);
+ for (var i = 0, length = obj.length; i < length; i++) {
+ value = obj[i];
+ if (value != null && value < result) {
+ result = value;
+ }
+ }
+ } else {
+ iteratee = cb(iteratee, context);
+ each(obj, function(v, index, list) {
+ computed = iteratee(v, index, list);
+ if (computed < lastComputed || computed === Infinity && result === Infinity) {
+ result = v;
+ lastComputed = computed;
+ }
+ });
+ }
+ return result;
+ }
+
+ // Sample **n** random values from a collection using the modern version of the
+ // [Fisher-Yates shuffle](https://en.wikipedia.org/wiki/Fisher–Yates_shuffle).
+ // If **n** is not specified, returns a single random element.
+ // The internal `guard` argument allows it to work with `_.map`.
+ function sample(obj, n, guard) {
+ if (n == null || guard) {
+ if (!isArrayLike(obj)) obj = values(obj);
+ return obj[random(obj.length - 1)];
+ }
+ var sample = isArrayLike(obj) ? clone(obj) : values(obj);
+ var length = getLength(sample);
+ n = Math.max(Math.min(n, length), 0);
+ var last = length - 1;
+ for (var index = 0; index < n; index++) {
+ var rand = random(index, last);
+ var temp = sample[index];
+ sample[index] = sample[rand];
+ sample[rand] = temp;
+ }
+ return sample.slice(0, n);
+ }
+
+ // Shuffle a collection.
+ function shuffle(obj) {
+ return sample(obj, Infinity);
+ }
+
+ // Sort the object's values by a criterion produced by an iteratee.
+ function sortBy(obj, iteratee, context) {
+ var index = 0;
+ iteratee = cb(iteratee, context);
+ return pluck(map(obj, function(value, key, list) {
+ return {
+ value: value,
+ index: index++,
+ criteria: iteratee(value, key, list)
+ };
+ }).sort(function(left, right) {
+ var a = left.criteria;
+ var b = right.criteria;
+ if (a !== b) {
+ if (a > b || a === void 0) return 1;
+ if (a < b || b === void 0) return -1;
+ }
+ return left.index - right.index;
+ }), 'value');
+ }
+
+ // An internal function used for aggregate "group by" operations.
+ function group(behavior, partition) {
+ return function(obj, iteratee, context) {
+ var result = partition ? [[], []] : {};
+ iteratee = cb(iteratee, context);
+ each(obj, function(value, index) {
+ var key = iteratee(value, index, obj);
+ behavior(result, value, key);
+ });
+ return result;
+ };
+ }
+
+ // Groups the object's values by a criterion. Pass either a string attribute
+ // to group by, or a function that returns the criterion.
+ var groupBy = group(function(result, value, key) {
+ if (has$1(result, key)) result[key].push(value); else result[key] = [value];
+ });
+
+ // Indexes the object's values by a criterion, similar to `_.groupBy`, but for
+ // when you know that your index values will be unique.
+ var indexBy = group(function(result, value, key) {
+ result[key] = value;
+ });
+
+ // Counts instances of an object that group by a certain criterion. Pass
+ // either a string attribute to count by, or a function that returns the
+ // criterion.
+ var countBy = group(function(result, value, key) {
+ if (has$1(result, key)) result[key]++; else result[key] = 1;
+ });
+
+ // Split a collection into two arrays: one whose elements all pass the given
+ // truth test, and one whose elements all do not pass the truth test.
+ var partition = group(function(result, value, pass) {
+ result[pass ? 0 : 1].push(value);
+ }, true);
+
+ // Safely create a real, live array from anything iterable.
+ var reStrSymbol = /[^\ud800-\udfff]|[\ud800-\udbff][\udc00-\udfff]|[\ud800-\udfff]/g;
+ function toArray(obj) {
+ if (!obj) return [];
+ if (isArray(obj)) return slice.call(obj);
+ if (isString(obj)) {
+ // Keep surrogate pair characters together.
+ return obj.match(reStrSymbol);
+ }
+ if (isArrayLike(obj)) return map(obj, identity);
+ return values(obj);
+ }
+
+ // Return the number of elements in a collection.
+ function size(obj) {
+ if (obj == null) return 0;
+ return isArrayLike(obj) ? obj.length : keys(obj).length;
+ }
+
+ // Internal `_.pick` helper function to determine whether `key` is an enumerable
+ // property name of `obj`.
+ function keyInObj(value, key, obj) {
+ return key in obj;
+ }
+
+ // Return a copy of the object only containing the allowed properties.
+ var pick = restArguments(function(obj, keys) {
+ var result = {}, iteratee = keys[0];
+ if (obj == null) return result;
+ if (isFunction$1(iteratee)) {
+ if (keys.length > 1) iteratee = optimizeCb(iteratee, keys[1]);
+ keys = allKeys(obj);
+ } else {
+ iteratee = keyInObj;
+ keys = flatten$1(keys, false, false);
+ obj = Object(obj);
+ }
+ for (var i = 0, length = keys.length; i < length; i++) {
+ var key = keys[i];
+ var value = obj[key];
+ if (iteratee(value, key, obj)) result[key] = value;
+ }
+ return result;
+ });
+
+ // Return a copy of the object without the disallowed properties.
+ var omit = restArguments(function(obj, keys) {
+ var iteratee = keys[0], context;
+ if (isFunction$1(iteratee)) {
+ iteratee = negate(iteratee);
+ if (keys.length > 1) context = keys[1];
+ } else {
+ keys = map(flatten$1(keys, false, false), String);
+ iteratee = function(value, key) {
+ return !contains(keys, key);
+ };
+ }
+ return pick(obj, iteratee, context);
+ });
+
+ // Returns everything but the last entry of the array. Especially useful on
+ // the arguments object. Passing **n** will return all the values in
+ // the array, excluding the last N.
+ function initial(array, n, guard) {
+ return slice.call(array, 0, Math.max(0, array.length - (n == null || guard ? 1 : n)));
+ }
+
+ // Get the first element of an array. Passing **n** will return the first N
+ // values in the array. The **guard** check allows it to work with `_.map`.
+ function first(array, n, guard) {
+ if (array == null || array.length < 1) return n == null || guard ? void 0 : [];
+ if (n == null || guard) return array[0];
+ return initial(array, array.length - n);
+ }
+
+ // Returns everything but the first entry of the `array`. Especially useful on
+ // the `arguments` object. Passing an **n** will return the rest N values in the
+ // `array`.
+ function rest(array, n, guard) {
+ return slice.call(array, n == null || guard ? 1 : n);
+ }
+
+ // Get the last element of an array. Passing **n** will return the last N
+ // values in the array.
+ function last(array, n, guard) {
+ if (array == null || array.length < 1) return n == null || guard ? void 0 : [];
+ if (n == null || guard) return array[array.length - 1];
+ return rest(array, Math.max(0, array.length - n));
+ }
+
+ // Trim out all falsy values from an array.
+ function compact(array) {
+ return filter(array, Boolean);
+ }
+
+ // Flatten out an array, either recursively (by default), or up to `depth`.
+ // Passing `true` or `false` as `depth` means `1` or `Infinity`, respectively.
+ function flatten(array, depth) {
+ return flatten$1(array, depth, false);
+ }
+
+ // Take the difference between one array and a number of other arrays.
+ // Only the elements present in just the first array will remain.
+ var difference = restArguments(function(array, rest) {
+ rest = flatten$1(rest, true, true);
+ return filter(array, function(value){
+ return !contains(rest, value);
+ });
+ });
+
+ // Return a version of the array that does not contain the specified value(s).
+ var without = restArguments(function(array, otherArrays) {
+ return difference(array, otherArrays);
+ });
+
+ // Produce a duplicate-free version of the array. If the array has already
+ // been sorted, you have the option of using a faster algorithm.
+ // The faster algorithm will not work with an iteratee if the iteratee
+ // is not a one-to-one function, so providing an iteratee will disable
+ // the faster algorithm.
+ function uniq(array, isSorted, iteratee, context) {
+ if (!isBoolean(isSorted)) {
+ context = iteratee;
+ iteratee = isSorted;
+ isSorted = false;
+ }
+ if (iteratee != null) iteratee = cb(iteratee, context);
+ var result = [];
+ var seen = [];
+ for (var i = 0, length = getLength(array); i < length; i++) {
+ var value = array[i],
+ computed = iteratee ? iteratee(value, i, array) : value;
+ if (isSorted && !iteratee) {
+ if (!i || seen !== computed) result.push(value);
+ seen = computed;
+ } else if (iteratee) {
+ if (!contains(seen, computed)) {
+ seen.push(computed);
+ result.push(value);
+ }
+ } else if (!contains(result, value)) {
+ result.push(value);
+ }
+ }
+ return result;
+ }
+
+ // Produce an array that contains the union: each distinct element from all of
+ // the passed-in arrays.
+ var union = restArguments(function(arrays) {
+ return uniq(flatten$1(arrays, true, true));
+ });
+
+ // Produce an array that contains every item shared between all the
+ // passed-in arrays.
+ function intersection(array) {
+ var result = [];
+ var argsLength = arguments.length;
+ for (var i = 0, length = getLength(array); i < length; i++) {
+ var item = array[i];
+ if (contains(result, item)) continue;
+ var j;
+ for (j = 1; j < argsLength; j++) {
+ if (!contains(arguments[j], item)) break;
+ }
+ if (j === argsLength) result.push(item);
+ }
+ return result;
+ }
+
+ // Complement of zip. Unzip accepts an array of arrays and groups
+ // each array's elements on shared indices.
+ function unzip(array) {
+ var length = array && max(array, getLength).length || 0;
+ var result = Array(length);
+
+ for (var index = 0; index < length; index++) {
+ result[index] = pluck(array, index);
+ }
+ return result;
+ }
+
+ // Zip together multiple lists into a single array -- elements that share
+ // an index go together.
+ var zip = restArguments(unzip);
+
+ // Converts lists into objects. Pass either a single array of `[key, value]`
+ // pairs, or two parallel arrays of the same length -- one of keys, and one of
+ // the corresponding values. Passing by pairs is the reverse of `_.pairs`.
+ function object(list, values) {
+ var result = {};
+ for (var i = 0, length = getLength(list); i < length; i++) {
+ if (values) {
+ result[list[i]] = values[i];
+ } else {
+ result[list[i][0]] = list[i][1];
+ }
+ }
+ return result;
+ }
+
+ // Generate an integer Array containing an arithmetic progression. A port of
+ // the native Python `range()` function. See
+ // [the Python documentation](https://docs.python.org/library/functions.html#range).
+ function range(start, stop, step) {
+ if (stop == null) {
+ stop = start || 0;
+ start = 0;
+ }
+ if (!step) {
+ step = stop < start ? -1 : 1;
+ }
+
+ var length = Math.max(Math.ceil((stop - start) / step), 0);
+ var range = Array(length);
+
+ for (var idx = 0; idx < length; idx++, start += step) {
+ range[idx] = start;
+ }
+
+ return range;
+ }
+
+ // Chunk a single array into multiple arrays, each containing `count` or fewer
+ // items.
+ function chunk(array, count) {
+ if (count == null || count < 1) return [];
+ var result = [];
+ var i = 0, length = array.length;
+ while (i < length) {
+ result.push(slice.call(array, i, i += count));
+ }
+ return result;
+ }
+
+ // Helper function to continue chaining intermediate results.
+ function chainResult(instance, obj) {
+ return instance._chain ? _$1(obj).chain() : obj;
+ }
+
+ // Add your own custom functions to the Underscore object.
+ function mixin(obj) {
+ each(functions(obj), function(name) {
+ var func = _$1[name] = obj[name];
+ _$1.prototype[name] = function() {
+ var args = [this._wrapped];
+ push.apply(args, arguments);
+ return chainResult(this, func.apply(_$1, args));
+ };
+ });
+ return _$1;
+ }
+
+ // Add all mutator `Array` functions to the wrapper.
+ each(['pop', 'push', 'reverse', 'shift', 'sort', 'splice', 'unshift'], function(name) {
+ var method = ArrayProto[name];
+ _$1.prototype[name] = function() {
+ var obj = this._wrapped;
+ if (obj != null) {
+ method.apply(obj, arguments);
+ if ((name === 'shift' || name === 'splice') && obj.length === 0) {
+ delete obj[0];
+ }
+ }
+ return chainResult(this, obj);
+ };
+ });
+
+ // Add all accessor `Array` functions to the wrapper.
+ each(['concat', 'join', 'slice'], function(name) {
+ var method = ArrayProto[name];
+ _$1.prototype[name] = function() {
+ var obj = this._wrapped;
+ if (obj != null) obj = method.apply(obj, arguments);
+ return chainResult(this, obj);
+ };
+ });
+
+ // Named Exports
+
+ var allExports = {
+ __proto__: null,
+ VERSION: VERSION,
+ restArguments: restArguments,
+ isObject: isObject,
+ isNull: isNull,
+ isUndefined: isUndefined,
+ isBoolean: isBoolean,
+ isElement: isElement,
+ isString: isString,
+ isNumber: isNumber,
+ isDate: isDate,
+ isRegExp: isRegExp,
+ isError: isError,
+ isSymbol: isSymbol,
+ isArrayBuffer: isArrayBuffer,
+ isDataView: isDataView$1,
+ isArray: isArray,
+ isFunction: isFunction$1,
+ isArguments: isArguments$1,
+ isFinite: isFinite$1,
+ isNaN: isNaN$1,
+ isTypedArray: isTypedArray$1,
+ isEmpty: isEmpty,
+ isMatch: isMatch,
+ isEqual: isEqual,
+ isMap: isMap,
+ isWeakMap: isWeakMap,
+ isSet: isSet,
+ isWeakSet: isWeakSet,
+ keys: keys,
+ allKeys: allKeys,
+ values: values,
+ pairs: pairs,
+ invert: invert,
+ functions: functions,
+ methods: functions,
+ extend: extend,
+ extendOwn: extendOwn,
+ assign: extendOwn,
+ defaults: defaults,
+ create: create,
+ clone: clone,
+ tap: tap,
+ get: get,
+ has: has,
+ mapObject: mapObject,
+ identity: identity,
+ constant: constant,
+ noop: noop,
+ toPath: toPath$1,
+ property: property,
+ propertyOf: propertyOf,
+ matcher: matcher,
+ matches: matcher,
+ times: times,
+ random: random,
+ now: now,
+ escape: _escape,
+ unescape: _unescape,
+ templateSettings: templateSettings,
+ template: template,
+ result: result,
+ uniqueId: uniqueId,
+ chain: chain,
+ iteratee: iteratee,
+ partial: partial,
+ bind: bind,
+ bindAll: bindAll,
+ memoize: memoize,
+ delay: delay,
+ defer: defer,
+ throttle: throttle,
+ debounce: debounce,
+ wrap: wrap,
+ negate: negate,
+ compose: compose,
+ after: after,
+ before: before,
+ once: once,
+ findKey: findKey,
+ findIndex: findIndex,
+ findLastIndex: findLastIndex,
+ sortedIndex: sortedIndex,
+ indexOf: indexOf,
+ lastIndexOf: lastIndexOf,
+ find: find,
+ detect: find,
+ findWhere: findWhere,
+ each: each,
+ forEach: each,
+ map: map,
+ collect: map,
+ reduce: reduce,
+ foldl: reduce,
+ inject: reduce,
+ reduceRight: reduceRight,
+ foldr: reduceRight,
+ filter: filter,
+ select: filter,
+ reject: reject,
+ every: every,
+ all: every,
+ some: some,
+ any: some,
+ contains: contains,
+ includes: contains,
+ include: contains,
+ invoke: invoke,
+ pluck: pluck,
+ where: where,
+ max: max,
+ min: min,
+ shuffle: shuffle,
+ sample: sample,
+ sortBy: sortBy,
+ groupBy: groupBy,
+ indexBy: indexBy,
+ countBy: countBy,
+ partition: partition,
+ toArray: toArray,
+ size: size,
+ pick: pick,
+ omit: omit,
+ first: first,
+ head: first,
+ take: first,
+ initial: initial,
+ last: last,
+ rest: rest,
+ tail: rest,
+ drop: rest,
+ compact: compact,
+ flatten: flatten,
+ without: without,
+ uniq: uniq,
+ unique: uniq,
+ union: union,
+ intersection: intersection,
+ difference: difference,
+ unzip: unzip,
+ transpose: unzip,
+ zip: zip,
+ object: object,
+ range: range,
+ chunk: chunk,
+ mixin: mixin,
+ 'default': _$1
+ };
+
+ // Default Export
+
+ // Add all of the Underscore functions to the wrapper object.
+ var _ = mixin(allExports);
+ // Legacy Node.js API.
+ _._ = _;
+
+ return _;
+
+})));
+//# sourceMappingURL=underscore-umd.js.map
diff --git a/docs/_build/html/_static/underscore.js b/docs/_build/html/_static/underscore.js
new file mode 100644
index 0000000000000000000000000000000000000000..cf177d4285ab55fbc16406a5ec827b80e7eecd53
--- /dev/null
+++ b/docs/_build/html/_static/underscore.js
@@ -0,0 +1,6 @@
+!function(n,r){"object"==typeof exports&&"undefined"!=typeof module?module.exports=r():"function"==typeof define&&define.amd?define("underscore",r):(n="undefined"!=typeof globalThis?globalThis:n||self,function(){var t=n._,e=n._=r();e.noConflict=function(){return n._=t,e}}())}(this,(function(){
+// Underscore.js 1.13.1
+// https://underscorejs.org
+// (c) 2009-2021 Jeremy Ashkenas, Julian Gonggrijp, and DocumentCloud and Investigative Reporters & Editors
+// Underscore may be freely distributed under the MIT license.
+var n="1.13.1",r="object"==typeof self&&self.self===self&&self||"object"==typeof global&&global.global===global&&global||Function("return this")()||{},t=Array.prototype,e=Object.prototype,u="undefined"!=typeof Symbol?Symbol.prototype:null,o=t.push,i=t.slice,a=e.toString,f=e.hasOwnProperty,c="undefined"!=typeof ArrayBuffer,l="undefined"!=typeof DataView,s=Array.isArray,p=Object.keys,v=Object.create,h=c&&ArrayBuffer.isView,y=isNaN,d=isFinite,g=!{toString:null}.propertyIsEnumerable("toString"),b=["valueOf","isPrototypeOf","toString","propertyIsEnumerable","hasOwnProperty","toLocaleString"],m=Math.pow(2,53)-1;function j(n,r){return r=null==r?n.length-1:+r,function(){for(var t=Math.max(arguments.length-r,0),e=Array(t),u=0;u<t;u++)e[u]=arguments[u+r];switch(r){case 0:return n.call(this,e);case 1:return n.call(this,arguments[0],e);case 2:return n.call(this,arguments[0],arguments[1],e)}var o=Array(r+1);for(u=0;u<r;u++)o[u]=arguments[u];return o[r]=e,n.apply(this,o)}}function _(n){var r=typeof n;return"function"===r||"object"===r&&!!n}function w(n){return void 0===n}function A(n){return!0===n||!1===n||"[object Boolean]"===a.call(n)}function x(n){var r="[object "+n+"]";return function(n){return a.call(n)===r}}var S=x("String"),O=x("Number"),M=x("Date"),E=x("RegExp"),B=x("Error"),N=x("Symbol"),I=x("ArrayBuffer"),T=x("Function"),k=r.document&&r.document.childNodes;"function"!=typeof/./&&"object"!=typeof Int8Array&&"function"!=typeof k&&(T=function(n){return"function"==typeof n||!1});var D=T,R=x("Object"),F=l&&R(new DataView(new ArrayBuffer(8))),V="undefined"!=typeof Map&&R(new Map),P=x("DataView");var q=F?function(n){return null!=n&&D(n.getInt8)&&I(n.buffer)}:P,U=s||x("Array");function W(n,r){return null!=n&&f.call(n,r)}var z=x("Arguments");!function(){z(arguments)||(z=function(n){return W(n,"callee")})}();var L=z;function $(n){return O(n)&&y(n)}function C(n){return function(){return n}}function K(n){return function(r){var t=n(r);return"number"==typeof t&&t>=0&&t<=m}}function J(n){return function(r){return null==r?void 0:r[n]}}var G=J("byteLength"),H=K(G),Q=/\[object ((I|Ui)nt(8|16|32)|Float(32|64)|Uint8Clamped|Big(I|Ui)nt64)Array\]/;var X=c?function(n){return h?h(n)&&!q(n):H(n)&&Q.test(a.call(n))}:C(!1),Y=J("length");function Z(n,r){r=function(n){for(var r={},t=n.length,e=0;e<t;++e)r[n[e]]=!0;return{contains:function(n){return r[n]},push:function(t){return r[t]=!0,n.push(t)}}}(r);var t=b.length,u=n.constructor,o=D(u)&&u.prototype||e,i="constructor";for(W(n,i)&&!r.contains(i)&&r.push(i);t--;)(i=b[t])in n&&n[i]!==o[i]&&!r.contains(i)&&r.push(i)}function nn(n){if(!_(n))return[];if(p)return p(n);var r=[];for(var t in n)W(n,t)&&r.push(t);return g&&Z(n,r),r}function rn(n,r){var t=nn(r),e=t.length;if(null==n)return!e;for(var u=Object(n),o=0;o<e;o++){var i=t[o];if(r[i]!==u[i]||!(i in u))return!1}return!0}function tn(n){return n instanceof tn?n:this instanceof tn?void(this._wrapped=n):new tn(n)}function en(n){return new Uint8Array(n.buffer||n,n.byteOffset||0,G(n))}tn.VERSION=n,tn.prototype.value=function(){return this._wrapped},tn.prototype.valueOf=tn.prototype.toJSON=tn.prototype.value,tn.prototype.toString=function(){return String(this._wrapped)};var un="[object DataView]";function on(n,r,t,e){if(n===r)return 0!==n||1/n==1/r;if(null==n||null==r)return!1;if(n!=n)return r!=r;var o=typeof n;return("function"===o||"object"===o||"object"==typeof r)&&function n(r,t,e,o){r instanceof tn&&(r=r._wrapped);t instanceof tn&&(t=t._wrapped);var i=a.call(r);if(i!==a.call(t))return!1;if(F&&"[object Object]"==i&&q(r)){if(!q(t))return!1;i=un}switch(i){case"[object RegExp]":case"[object String]":return""+r==""+t;case"[object Number]":return+r!=+r?+t!=+t:0==+r?1/+r==1/t:+r==+t;case"[object Date]":case"[object Boolean]":return+r==+t;case"[object Symbol]":return u.valueOf.call(r)===u.valueOf.call(t);case"[object ArrayBuffer]":case un:return n(en(r),en(t),e,o)}var f="[object Array]"===i;if(!f&&X(r)){if(G(r)!==G(t))return!1;if(r.buffer===t.buffer&&r.byteOffset===t.byteOffset)return!0;f=!0}if(!f){if("object"!=typeof r||"object"!=typeof t)return!1;var c=r.constructor,l=t.constructor;if(c!==l&&!(D(c)&&c instanceof c&&D(l)&&l instanceof l)&&"constructor"in r&&"constructor"in t)return!1}o=o||[];var s=(e=e||[]).length;for(;s--;)if(e[s]===r)return o[s]===t;if(e.push(r),o.push(t),f){if((s=r.length)!==t.length)return!1;for(;s--;)if(!on(r[s],t[s],e,o))return!1}else{var p,v=nn(r);if(s=v.length,nn(t).length!==s)return!1;for(;s--;)if(p=v[s],!W(t,p)||!on(r[p],t[p],e,o))return!1}return e.pop(),o.pop(),!0}(n,r,t,e)}function an(n){if(!_(n))return[];var r=[];for(var t in n)r.push(t);return g&&Z(n,r),r}function fn(n){var r=Y(n);return function(t){if(null==t)return!1;var e=an(t);if(Y(e))return!1;for(var u=0;u<r;u++)if(!D(t[n[u]]))return!1;return n!==hn||!D(t[cn])}}var cn="forEach",ln="has",sn=["clear","delete"],pn=["get",ln,"set"],vn=sn.concat(cn,pn),hn=sn.concat(pn),yn=["add"].concat(sn,cn,ln),dn=V?fn(vn):x("Map"),gn=V?fn(hn):x("WeakMap"),bn=V?fn(yn):x("Set"),mn=x("WeakSet");function jn(n){for(var r=nn(n),t=r.length,e=Array(t),u=0;u<t;u++)e[u]=n[r[u]];return e}function _n(n){for(var r={},t=nn(n),e=0,u=t.length;e<u;e++)r[n[t[e]]]=t[e];return r}function wn(n){var r=[];for(var t in n)D(n[t])&&r.push(t);return r.sort()}function An(n,r){return function(t){var e=arguments.length;if(r&&(t=Object(t)),e<2||null==t)return t;for(var u=1;u<e;u++)for(var o=arguments[u],i=n(o),a=i.length,f=0;f<a;f++){var c=i[f];r&&void 0!==t[c]||(t[c]=o[c])}return t}}var xn=An(an),Sn=An(nn),On=An(an,!0);function Mn(n){if(!_(n))return{};if(v)return v(n);var r=function(){};r.prototype=n;var t=new r;return r.prototype=null,t}function En(n){return _(n)?U(n)?n.slice():xn({},n):n}function Bn(n){return U(n)?n:[n]}function Nn(n){return tn.toPath(n)}function In(n,r){for(var t=r.length,e=0;e<t;e++){if(null==n)return;n=n[r[e]]}return t?n:void 0}function Tn(n,r,t){var e=In(n,Nn(r));return w(e)?t:e}function kn(n){return n}function Dn(n){return n=Sn({},n),function(r){return rn(r,n)}}function Rn(n){return n=Nn(n),function(r){return In(r,n)}}function Fn(n,r,t){if(void 0===r)return n;switch(null==t?3:t){case 1:return function(t){return n.call(r,t)};case 3:return function(t,e,u){return n.call(r,t,e,u)};case 4:return function(t,e,u,o){return n.call(r,t,e,u,o)}}return function(){return n.apply(r,arguments)}}function Vn(n,r,t){return null==n?kn:D(n)?Fn(n,r,t):_(n)&&!U(n)?Dn(n):Rn(n)}function Pn(n,r){return Vn(n,r,1/0)}function qn(n,r,t){return tn.iteratee!==Pn?tn.iteratee(n,r):Vn(n,r,t)}function Un(){}function Wn(n,r){return null==r&&(r=n,n=0),n+Math.floor(Math.random()*(r-n+1))}tn.toPath=Bn,tn.iteratee=Pn;var zn=Date.now||function(){return(new Date).getTime()};function Ln(n){var r=function(r){return n[r]},t="(?:"+nn(n).join("|")+")",e=RegExp(t),u=RegExp(t,"g");return function(n){return n=null==n?"":""+n,e.test(n)?n.replace(u,r):n}}var $n={"&":"&","<":"<",">":">",'"':""","'":"'","`":"`"},Cn=Ln($n),Kn=Ln(_n($n)),Jn=tn.templateSettings={evaluate:/<%([\s\S]+?)%>/g,interpolate:/<%=([\s\S]+?)%>/g,escape:/<%-([\s\S]+?)%>/g},Gn=/(.)^/,Hn={"'":"'","\\":"\\","\r":"r","\n":"n","\u2028":"u2028","\u2029":"u2029"},Qn=/\\|'|\r|\n|\u2028|\u2029/g;function Xn(n){return"\\"+Hn[n]}var Yn=/^\s*(\w|\$)+\s*$/;var Zn=0;function nr(n,r,t,e,u){if(!(e instanceof r))return n.apply(t,u);var o=Mn(n.prototype),i=n.apply(o,u);return _(i)?i:o}var rr=j((function(n,r){var t=rr.placeholder,e=function(){for(var u=0,o=r.length,i=Array(o),a=0;a<o;a++)i[a]=r[a]===t?arguments[u++]:r[a];for(;u<arguments.length;)i.push(arguments[u++]);return nr(n,e,this,this,i)};return e}));rr.placeholder=tn;var tr=j((function(n,r,t){if(!D(n))throw new TypeError("Bind must be called on a function");var e=j((function(u){return nr(n,e,r,this,t.concat(u))}));return e})),er=K(Y);function ur(n,r,t,e){if(e=e||[],r||0===r){if(r<=0)return e.concat(n)}else r=1/0;for(var u=e.length,o=0,i=Y(n);o<i;o++){var a=n[o];if(er(a)&&(U(a)||L(a)))if(r>1)ur(a,r-1,t,e),u=e.length;else for(var f=0,c=a.length;f<c;)e[u++]=a[f++];else t||(e[u++]=a)}return e}var or=j((function(n,r){var t=(r=ur(r,!1,!1)).length;if(t<1)throw new Error("bindAll must be passed function names");for(;t--;){var e=r[t];n[e]=tr(n[e],n)}return n}));var ir=j((function(n,r,t){return setTimeout((function(){return n.apply(null,t)}),r)})),ar=rr(ir,tn,1);function fr(n){return function(){return!n.apply(this,arguments)}}function cr(n,r){var t;return function(){return--n>0&&(t=r.apply(this,arguments)),n<=1&&(r=null),t}}var lr=rr(cr,2);function sr(n,r,t){r=qn(r,t);for(var e,u=nn(n),o=0,i=u.length;o<i;o++)if(r(n[e=u[o]],e,n))return e}function pr(n){return function(r,t,e){t=qn(t,e);for(var u=Y(r),o=n>0?0:u-1;o>=0&&o<u;o+=n)if(t(r[o],o,r))return o;return-1}}var vr=pr(1),hr=pr(-1);function yr(n,r,t,e){for(var u=(t=qn(t,e,1))(r),o=0,i=Y(n);o<i;){var a=Math.floor((o+i)/2);t(n[a])<u?o=a+1:i=a}return o}function dr(n,r,t){return function(e,u,o){var a=0,f=Y(e);if("number"==typeof o)n>0?a=o>=0?o:Math.max(o+f,a):f=o>=0?Math.min(o+1,f):o+f+1;else if(t&&o&&f)return e[o=t(e,u)]===u?o:-1;if(u!=u)return(o=r(i.call(e,a,f),$))>=0?o+a:-1;for(o=n>0?a:f-1;o>=0&&o<f;o+=n)if(e[o]===u)return o;return-1}}var gr=dr(1,vr,yr),br=dr(-1,hr);function mr(n,r,t){var e=(er(n)?vr:sr)(n,r,t);if(void 0!==e&&-1!==e)return n[e]}function jr(n,r,t){var e,u;if(r=Fn(r,t),er(n))for(e=0,u=n.length;e<u;e++)r(n[e],e,n);else{var o=nn(n);for(e=0,u=o.length;e<u;e++)r(n[o[e]],o[e],n)}return n}function _r(n,r,t){r=qn(r,t);for(var e=!er(n)&&nn(n),u=(e||n).length,o=Array(u),i=0;i<u;i++){var a=e?e[i]:i;o[i]=r(n[a],a,n)}return o}function wr(n){var r=function(r,t,e,u){var o=!er(r)&&nn(r),i=(o||r).length,a=n>0?0:i-1;for(u||(e=r[o?o[a]:a],a+=n);a>=0&&a<i;a+=n){var f=o?o[a]:a;e=t(e,r[f],f,r)}return e};return function(n,t,e,u){var o=arguments.length>=3;return r(n,Fn(t,u,4),e,o)}}var Ar=wr(1),xr=wr(-1);function Sr(n,r,t){var e=[];return r=qn(r,t),jr(n,(function(n,t,u){r(n,t,u)&&e.push(n)})),e}function Or(n,r,t){r=qn(r,t);for(var e=!er(n)&&nn(n),u=(e||n).length,o=0;o<u;o++){var i=e?e[o]:o;if(!r(n[i],i,n))return!1}return!0}function Mr(n,r,t){r=qn(r,t);for(var e=!er(n)&&nn(n),u=(e||n).length,o=0;o<u;o++){var i=e?e[o]:o;if(r(n[i],i,n))return!0}return!1}function Er(n,r,t,e){return er(n)||(n=jn(n)),("number"!=typeof t||e)&&(t=0),gr(n,r,t)>=0}var Br=j((function(n,r,t){var e,u;return D(r)?u=r:(r=Nn(r),e=r.slice(0,-1),r=r[r.length-1]),_r(n,(function(n){var o=u;if(!o){if(e&&e.length&&(n=In(n,e)),null==n)return;o=n[r]}return null==o?o:o.apply(n,t)}))}));function Nr(n,r){return _r(n,Rn(r))}function Ir(n,r,t){var e,u,o=-1/0,i=-1/0;if(null==r||"number"==typeof r&&"object"!=typeof n[0]&&null!=n)for(var a=0,f=(n=er(n)?n:jn(n)).length;a<f;a++)null!=(e=n[a])&&e>o&&(o=e);else r=qn(r,t),jr(n,(function(n,t,e){((u=r(n,t,e))>i||u===-1/0&&o===-1/0)&&(o=n,i=u)}));return o}function Tr(n,r,t){if(null==r||t)return er(n)||(n=jn(n)),n[Wn(n.length-1)];var e=er(n)?En(n):jn(n),u=Y(e);r=Math.max(Math.min(r,u),0);for(var o=u-1,i=0;i<r;i++){var a=Wn(i,o),f=e[i];e[i]=e[a],e[a]=f}return e.slice(0,r)}function kr(n,r){return function(t,e,u){var o=r?[[],[]]:{};return e=qn(e,u),jr(t,(function(r,u){var i=e(r,u,t);n(o,r,i)})),o}}var Dr=kr((function(n,r,t){W(n,t)?n[t].push(r):n[t]=[r]})),Rr=kr((function(n,r,t){n[t]=r})),Fr=kr((function(n,r,t){W(n,t)?n[t]++:n[t]=1})),Vr=kr((function(n,r,t){n[t?0:1].push(r)}),!0),Pr=/[^\ud800-\udfff]|[\ud800-\udbff][\udc00-\udfff]|[\ud800-\udfff]/g;function qr(n,r,t){return r in t}var Ur=j((function(n,r){var t={},e=r[0];if(null==n)return t;D(e)?(r.length>1&&(e=Fn(e,r[1])),r=an(n)):(e=qr,r=ur(r,!1,!1),n=Object(n));for(var u=0,o=r.length;u<o;u++){var i=r[u],a=n[i];e(a,i,n)&&(t[i]=a)}return t})),Wr=j((function(n,r){var t,e=r[0];return D(e)?(e=fr(e),r.length>1&&(t=r[1])):(r=_r(ur(r,!1,!1),String),e=function(n,t){return!Er(r,t)}),Ur(n,e,t)}));function zr(n,r,t){return i.call(n,0,Math.max(0,n.length-(null==r||t?1:r)))}function Lr(n,r,t){return null==n||n.length<1?null==r||t?void 0:[]:null==r||t?n[0]:zr(n,n.length-r)}function $r(n,r,t){return i.call(n,null==r||t?1:r)}var Cr=j((function(n,r){return r=ur(r,!0,!0),Sr(n,(function(n){return!Er(r,n)}))})),Kr=j((function(n,r){return Cr(n,r)}));function Jr(n,r,t,e){A(r)||(e=t,t=r,r=!1),null!=t&&(t=qn(t,e));for(var u=[],o=[],i=0,a=Y(n);i<a;i++){var f=n[i],c=t?t(f,i,n):f;r&&!t?(i&&o===c||u.push(f),o=c):t?Er(o,c)||(o.push(c),u.push(f)):Er(u,f)||u.push(f)}return u}var Gr=j((function(n){return Jr(ur(n,!0,!0))}));function Hr(n){for(var r=n&&Ir(n,Y).length||0,t=Array(r),e=0;e<r;e++)t[e]=Nr(n,e);return t}var Qr=j(Hr);function Xr(n,r){return n._chain?tn(r).chain():r}function Yr(n){return jr(wn(n),(function(r){var t=tn[r]=n[r];tn.prototype[r]=function(){var n=[this._wrapped];return o.apply(n,arguments),Xr(this,t.apply(tn,n))}})),tn}jr(["pop","push","reverse","shift","sort","splice","unshift"],(function(n){var r=t[n];tn.prototype[n]=function(){var t=this._wrapped;return null!=t&&(r.apply(t,arguments),"shift"!==n&&"splice"!==n||0!==t.length||delete t[0]),Xr(this,t)}})),jr(["concat","join","slice"],(function(n){var r=t[n];tn.prototype[n]=function(){var n=this._wrapped;return null!=n&&(n=r.apply(n,arguments)),Xr(this,n)}}));var Zr=Yr({__proto__:null,VERSION:n,restArguments:j,isObject:_,isNull:function(n){return null===n},isUndefined:w,isBoolean:A,isElement:function(n){return!(!n||1!==n.nodeType)},isString:S,isNumber:O,isDate:M,isRegExp:E,isError:B,isSymbol:N,isArrayBuffer:I,isDataView:q,isArray:U,isFunction:D,isArguments:L,isFinite:function(n){return!N(n)&&d(n)&&!isNaN(parseFloat(n))},isNaN:$,isTypedArray:X,isEmpty:function(n){if(null==n)return!0;var r=Y(n);return"number"==typeof r&&(U(n)||S(n)||L(n))?0===r:0===Y(nn(n))},isMatch:rn,isEqual:function(n,r){return on(n,r)},isMap:dn,isWeakMap:gn,isSet:bn,isWeakSet:mn,keys:nn,allKeys:an,values:jn,pairs:function(n){for(var r=nn(n),t=r.length,e=Array(t),u=0;u<t;u++)e[u]=[r[u],n[r[u]]];return e},invert:_n,functions:wn,methods:wn,extend:xn,extendOwn:Sn,assign:Sn,defaults:On,create:function(n,r){var t=Mn(n);return r&&Sn(t,r),t},clone:En,tap:function(n,r){return r(n),n},get:Tn,has:function(n,r){for(var t=(r=Nn(r)).length,e=0;e<t;e++){var u=r[e];if(!W(n,u))return!1;n=n[u]}return!!t},mapObject:function(n,r,t){r=qn(r,t);for(var e=nn(n),u=e.length,o={},i=0;i<u;i++){var a=e[i];o[a]=r(n[a],a,n)}return o},identity:kn,constant:C,noop:Un,toPath:Bn,property:Rn,propertyOf:function(n){return null==n?Un:function(r){return Tn(n,r)}},matcher:Dn,matches:Dn,times:function(n,r,t){var e=Array(Math.max(0,n));r=Fn(r,t,1);for(var u=0;u<n;u++)e[u]=r(u);return e},random:Wn,now:zn,escape:Cn,unescape:Kn,templateSettings:Jn,template:function(n,r,t){!r&&t&&(r=t),r=On({},r,tn.templateSettings);var e=RegExp([(r.escape||Gn).source,(r.interpolate||Gn).source,(r.evaluate||Gn).source].join("|")+"|$","g"),u=0,o="__p+='";n.replace(e,(function(r,t,e,i,a){return o+=n.slice(u,a).replace(Qn,Xn),u=a+r.length,t?o+="'+\n((__t=("+t+"))==null?'':_.escape(__t))+\n'":e?o+="'+\n((__t=("+e+"))==null?'':__t)+\n'":i&&(o+="';\n"+i+"\n__p+='"),r})),o+="';\n";var i,a=r.variable;if(a){if(!Yn.test(a))throw new Error("variable is not a bare identifier: "+a)}else o="with(obj||{}){\n"+o+"}\n",a="obj";o="var __t,__p='',__j=Array.prototype.join,"+"print=function(){__p+=__j.call(arguments,'');};\n"+o+"return __p;\n";try{i=new Function(a,"_",o)}catch(n){throw n.source=o,n}var f=function(n){return i.call(this,n,tn)};return f.source="function("+a+"){\n"+o+"}",f},result:function(n,r,t){var e=(r=Nn(r)).length;if(!e)return D(t)?t.call(n):t;for(var u=0;u<e;u++){var o=null==n?void 0:n[r[u]];void 0===o&&(o=t,u=e),n=D(o)?o.call(n):o}return n},uniqueId:function(n){var r=++Zn+"";return n?n+r:r},chain:function(n){var r=tn(n);return r._chain=!0,r},iteratee:Pn,partial:rr,bind:tr,bindAll:or,memoize:function(n,r){var t=function(e){var u=t.cache,o=""+(r?r.apply(this,arguments):e);return W(u,o)||(u[o]=n.apply(this,arguments)),u[o]};return t.cache={},t},delay:ir,defer:ar,throttle:function(n,r,t){var e,u,o,i,a=0;t||(t={});var f=function(){a=!1===t.leading?0:zn(),e=null,i=n.apply(u,o),e||(u=o=null)},c=function(){var c=zn();a||!1!==t.leading||(a=c);var l=r-(c-a);return u=this,o=arguments,l<=0||l>r?(e&&(clearTimeout(e),e=null),a=c,i=n.apply(u,o),e||(u=o=null)):e||!1===t.trailing||(e=setTimeout(f,l)),i};return c.cancel=function(){clearTimeout(e),a=0,e=u=o=null},c},debounce:function(n,r,t){var e,u,o,i,a,f=function(){var c=zn()-u;r>c?e=setTimeout(f,r-c):(e=null,t||(i=n.apply(a,o)),e||(o=a=null))},c=j((function(c){return a=this,o=c,u=zn(),e||(e=setTimeout(f,r),t&&(i=n.apply(a,o))),i}));return c.cancel=function(){clearTimeout(e),e=o=a=null},c},wrap:function(n,r){return rr(r,n)},negate:fr,compose:function(){var n=arguments,r=n.length-1;return function(){for(var t=r,e=n[r].apply(this,arguments);t--;)e=n[t].call(this,e);return e}},after:function(n,r){return function(){if(--n<1)return r.apply(this,arguments)}},before:cr,once:lr,findKey:sr,findIndex:vr,findLastIndex:hr,sortedIndex:yr,indexOf:gr,lastIndexOf:br,find:mr,detect:mr,findWhere:function(n,r){return mr(n,Dn(r))},each:jr,forEach:jr,map:_r,collect:_r,reduce:Ar,foldl:Ar,inject:Ar,reduceRight:xr,foldr:xr,filter:Sr,select:Sr,reject:function(n,r,t){return Sr(n,fr(qn(r)),t)},every:Or,all:Or,some:Mr,any:Mr,contains:Er,includes:Er,include:Er,invoke:Br,pluck:Nr,where:function(n,r){return Sr(n,Dn(r))},max:Ir,min:function(n,r,t){var e,u,o=1/0,i=1/0;if(null==r||"number"==typeof r&&"object"!=typeof n[0]&&null!=n)for(var a=0,f=(n=er(n)?n:jn(n)).length;a<f;a++)null!=(e=n[a])&&e<o&&(o=e);else r=qn(r,t),jr(n,(function(n,t,e){((u=r(n,t,e))<i||u===1/0&&o===1/0)&&(o=n,i=u)}));return o},shuffle:function(n){return Tr(n,1/0)},sample:Tr,sortBy:function(n,r,t){var e=0;return r=qn(r,t),Nr(_r(n,(function(n,t,u){return{value:n,index:e++,criteria:r(n,t,u)}})).sort((function(n,r){var t=n.criteria,e=r.criteria;if(t!==e){if(t>e||void 0===t)return 1;if(t<e||void 0===e)return-1}return n.index-r.index})),"value")},groupBy:Dr,indexBy:Rr,countBy:Fr,partition:Vr,toArray:function(n){return n?U(n)?i.call(n):S(n)?n.match(Pr):er(n)?_r(n,kn):jn(n):[]},size:function(n){return null==n?0:er(n)?n.length:nn(n).length},pick:Ur,omit:Wr,first:Lr,head:Lr,take:Lr,initial:zr,last:function(n,r,t){return null==n||n.length<1?null==r||t?void 0:[]:null==r||t?n[n.length-1]:$r(n,Math.max(0,n.length-r))},rest:$r,tail:$r,drop:$r,compact:function(n){return Sr(n,Boolean)},flatten:function(n,r){return ur(n,r,!1)},without:Kr,uniq:Jr,unique:Jr,union:Gr,intersection:function(n){for(var r=[],t=arguments.length,e=0,u=Y(n);e<u;e++){var o=n[e];if(!Er(r,o)){var i;for(i=1;i<t&&Er(arguments[i],o);i++);i===t&&r.push(o)}}return r},difference:Cr,unzip:Hr,transpose:Hr,zip:Qr,object:function(n,r){for(var t={},e=0,u=Y(n);e<u;e++)r?t[n[e]]=r[e]:t[n[e][0]]=n[e][1];return t},range:function(n,r,t){null==r&&(r=n||0,n=0),t||(t=r<n?-1:1);for(var e=Math.max(Math.ceil((r-n)/t),0),u=Array(e),o=0;o<e;o++,n+=t)u[o]=n;return u},chunk:function(n,r){if(null==r||r<1)return[];for(var t=[],e=0,u=n.length;e<u;)t.push(i.call(n,e,e+=r));return t},mixin:Yr,default:tn});return Zr._=Zr,Zr}));
\ No newline at end of file
diff --git a/docs/_build/html/about.html b/docs/_build/html/about.html
new file mode 100644
index 0000000000000000000000000000000000000000..baeeeca768b6c8f9c0e93de95ccc21d2fc5b917d
--- /dev/null
+++ b/docs/_build/html/about.html
@@ -0,0 +1,159 @@
+
+
+<!doctype html>
+
+<html lang="en">
+ <head>
+ <meta charset="utf-8" />
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
+
+ <title>About WaveVal — WaveVal documentation</title>
+ <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
+ <link rel="stylesheet" type="text/css" href="_static/bizstyle.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 src="_static/bizstyle.js"></script>
+ <link rel="author" title="About these documents" href="#" />
+ <link rel="index" title="Index" href="genindex.html" />
+ <link rel="search" title="Search" href="search.html" />
+ <link rel="next" title="Validation workflow" href="quickstart.html" />
+ <link rel="prev" title="WaveVal: Wave Model Validation" href="index.html" />
+ <meta name="viewport" content="width=device-width,initial-scale=1.0" />
+ <!--[if lt IE 9]>
+ <script src="_static/css3-mediaqueries.js"></script>
+ <![endif]-->
+ </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="quickstart.html" title="Validation workflow"
+ accesskey="N">next</a> |</li>
+ <li class="right" >
+ <a href="index.html" title="WaveVal: Wave Model Validation"
+ accesskey="P">previous</a> |</li>
+ <li class="nav-item nav-item-0"><a href="index.html">WaveVal documentation</a> »</li>
+ <li class="nav-item nav-item-this"><a href="">About WaveVal</a></li>
+ </ul>
+ </div>
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body" role="main">
+
+ <section id="about-waveval">
+<span id="aboutwaveval"></span><h1>About WaveVal<a class="headerlink" href="#about-waveval" title="Permalink to this headline">¶</a></h1>
+<p>The general motivation for this package is the validation of numerical wave simulation models against observed <em>in situ</em>
+wavebuoy measurements. The focus is on standard integrated wave parameters that are generated from spectral moments.
+Data readers have been constructed for records archived in the netCDF4 format following published format conventions. A
+generic netCDF class is included to allow the development of readers for data archived using different data conventions.
+The validataion process has been modularised to allow the automated validation of a long-term hindcast model archive
+against a large set of buoy data across the model domain. Methods for matching the model data extracts to the a specific
+buoy record are include. The data matching requires suffcient information in the model extracts to link a given extract
+record to a specific buoy location.</p>
+<p>The WaveVal code is developed and maintained by the IES, School of Engineering, at The University of Edinburgh, UK.</p>
+<section id="licence">
+<h2>Licence<a class="headerlink" href="#licence" title="Permalink to this headline">¶</a></h2>
+<p>© 2022. University of Edinburgh. All rights reserved. This software was produced for The University of Edinburgh under the
+OCEANERA-NET COFUND ResourceCode project (EC/GA #731200), funded by Scottish Enterprise. All rights in the software are
+reserved by the University of Edinburgh. The University of Edinburgh is granted, for itself and others acting on its behalf,
+a nonexclusive, paid-up, irrevocable worldwide licence in this material to reproduce, prepare derivative works, distribute
+copies to the public, perform publicly and display publicly, and to permit others to do so.</p>
+<p>This software is open source under the BSD-3 Licence. Redistribution and use in source and binary forms, with or without
+modification, is permitted provided that the following conditions are met:</p>
+<ol class="arabic simple">
+<li><p>Redistributions of source code must retain the above copyright notice, this list of conditions and the following
+disclaimer.</p></li>
+<li><p>Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following
+disclaimer in the documentation and/or other materials provided with the distribution.</p></li>
+<li><p>Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote
+products derived from this software without specific prior written permission.</p></li>
+</ol>
+<p><strong>Disclaimer</strong></p>
+<p>THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS†AND ANY EXPRESS OR IMPLIED WARRANTIES,
+INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
+ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.</p>
+</section>
+</section>
+
+
+ <div class="clearer"></div>
+ </div>
+ </div>
+ </div>
+ <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+ <div class="sphinxsidebarwrapper">
+ <h3><a href="index.html">Table of Contents</a></h3>
+ <ul>
+<li><a class="reference internal" href="#">About WaveVal</a><ul>
+<li><a class="reference internal" href="#licence">Licence</a></li>
+</ul>
+</li>
+</ul>
+
+ <h4>Previous topic</h4>
+ <p class="topless"><a href="index.html"
+ title="previous chapter">WaveVal: Wave Model Validation</a></p>
+ <h4>Next topic</h4>
+ <p class="topless"><a href="quickstart.html"
+ title="next chapter">Validation workflow</a></p>
+ <div role="note" aria-label="source link">
+ <h3>This Page</h3>
+ <ul class="this-page-menu">
+ <li><a href="_sources/about.rst.txt"
+ rel="nofollow">Show Source</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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
+ <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="quickstart.html" title="Validation workflow"
+ >next</a> |</li>
+ <li class="right" >
+ <a href="index.html" title="WaveVal: Wave Model Validation"
+ >previous</a> |</li>
+ <li class="nav-item nav-item-0"><a href="index.html">WaveVal documentation</a> »</li>
+ <li class="nav-item nav-item-this"><a href="">About WaveVal</a></li>
+ </ul>
+ </div>
+ <div class="footer" role="contentinfo">
+ © Copyright 2022.
+ Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 4.3.0.
+ </div>
+ </body>
+</html>
\ No newline at end of file
diff --git a/docs/_build/html/automate.html b/docs/_build/html/automate.html
new file mode 100644
index 0000000000000000000000000000000000000000..9b94d1ac224230f71ae880c38dc0a13228e3ae8d
--- /dev/null
+++ b/docs/_build/html/automate.html
@@ -0,0 +1,623 @@
+
+
+<!doctype html>
+
+<html lang="en">
+ <head>
+ <meta charset="utf-8" />
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
+
+ <title>Batch Processing - (IFREMER Datarmor HPC) — WaveVal documentation</title>
+ <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
+ <link rel="stylesheet" type="text/css" href="_static/bizstyle.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 src="_static/bizstyle.js"></script>
+ <link rel="author" title="About these documents" href="about.html" />
+ <link rel="index" title="Index" href="genindex.html" />
+ <link rel="search" title="Search" href="search.html" />
+ <link rel="next" title="External data archives" href="data_access.html" />
+ <link rel="prev" title="Examples" href="examples.html" />
+ <meta name="viewport" content="width=device-width,initial-scale=1.0" />
+ <!--[if lt IE 9]>
+ <script src="_static/css3-mediaqueries.js"></script>
+ <![endif]-->
+ </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="data_access.html" title="External data archives"
+ accesskey="N">next</a> |</li>
+ <li class="right" >
+ <a href="examples.html" title="Examples"
+ accesskey="P">previous</a> |</li>
+ <li class="nav-item nav-item-0"><a href="index.html">WaveVal documentation</a> »</li>
+ <li class="nav-item nav-item-this"><a href="">Batch Processing - (IFREMER Datarmor HPC)</a></li>
+ </ul>
+ </div>
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body" role="main">
+
+ <section id="batch-processing-ifremer-datarmor-hpc">
+<span id="batch"></span><h1>Batch Processing - (IFREMER Datarmor HPC)<a class="headerlink" href="#batch-processing-ifremer-datarmor-hpc" title="Permalink to this headline">¶</a></h1>
+<p>The <a class="reference external" href="https://resourcecode.ifremer.fr/">ResourceCode</a> hindcast archive has been developed using the <a class="reference external" href="https://wwz-ifremer-fr.translate.goog/L-institut?_x_tr_sl=fr&_x_tr_tl=en&_x_tr_hl=en&_x_tr_pto=sc">IFREMER</a> <a class="reference external" href="https://wwz-ifremer-fr.translate.goog/Recherche/Infrastructures-de-recherche/Infrastructures-numeriques/Pole-de-Calcul-et-de-Donnees-pour-la-Mer?_x_tr_sl=fr&_x_tr_tl=en&_x_tr_hl=en&_x_tr_pto=sc">Datarmor</a> HPC services.
+The hindcast data set was validated using the <a class="reference external" href="https://git.ecdf.ed.ac.uk/uoe-ies-open-tools/waveval">WaveVal</a> tools implemented on Datarmor. This page
+provides information on how to set up and run the <a class="reference external" href="https://git.ecdf.ed.ac.uk/uoe-ies-open-tools/waveval">WaveVal</a> tools on Datarmor, and how to generate
+and run a set of PBS batch jobs to automate the validation process. To use the Datarmor HPC service
+the user requires an IFREMER intranet login account, and an extranet login to remotely access the
+services.</p>
+<p>Useful information on using the Datarmor services can be found at
+<a class="reference external" href="https://m.davidmkaplan.fr/cluster/cluster-use-instructions.html">https://m.davidmkaplan.fr/cluster/cluster-use-instructions.html</a>.</p>
+<p>The methods described here should port to any HPC systems that supports the python anaconda environment and
+runs a PBS job submission service.</p>
+<section id="setup-conda-environment">
+<h2>Setup conda environment<a class="headerlink" href="#setup-conda-environment" title="Permalink to this headline">¶</a></h2>
+<p>Access to Datarmor is via login node. On this node the user enters a bash shell by default. The anaconda
+python interface is accessed by changing to a conda shell using:</p>
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ <span class="nb">source</span> /appli/anaconda/latest/etc/profile.d/conda.csh
+</pre></div>
+</div>
+<p>Then the local conda runtime configuration file ( ~/.condarc ) needs to be created containg the following lines:</p>
+<div class="literal-block-wrapper docutils container" id="id1">
+<div class="code-block-caption"><span class="caption-text">.condarc</span><a class="headerlink" href="#id1" title="Permalink to this code">¶</a></div>
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>envs_dirs:
+- <span class="nv">$DATAWORK</span>/conda-env
+- /appli/conda-env
+- /appli/conda-env/2.7
+- /appli/conda-env/3.6
+pkgs_dirs:
+- <span class="nv">$DATAWORK</span>/conda/pkgs
+</pre></div>
+</div>
+</div>
+<p>This file needs to be in the root of the users home directory. It can be created using any suitable text
+editor (<em>e.g.</em> vi, nano, <em>etc.</em>).</p>
+<p>Once the ~/.condarc file exists, a conda enviroment can be created including the python packages required
+to run the validation tools. For the ResourceCode hindcast validation the conda environment <code class="docutils literal notranslate"><span class="pre">buoyvalid</span></code> was created
+using the command:</p>
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ conda create --name buoyvalid
+</pre></div>
+</div>
+<p>where the option –name is used to set the name of the conda enviroment created.</p>
+<p>To check that the conda environment was generated use the command:</p>
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ conda info --envs
+</pre></div>
+</div>
+<p>The required python packages can be added to the <code class="docutils literal notranslate"><span class="pre">buoyvalid</span></code> conda environment as follows:</p>
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ conda install --name buoyvalid numpy
+$ conda install --name buoyvalid netCDF4
+$ conda install --name buoyvalid astropy
+$ conda install --name buoyvalid matplotlib
+$ conda install --name buoyvalid cartopy
+$ conda install --name buoyvalid spyder
+$ conda config --add channels conda-forge
+$ conda install --name buoyvalid cartopy_offlinedata
+</pre></div>
+</div>
+<p>To use the conda environment it needs to be activated using the command:</p>
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ conda activate buoyvalid
+</pre></div>
+</div>
+<p>Similarly, to close the conda environment use the command:</p>
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ conda deactivate
+</pre></div>
+</div>
+</section>
+<section id="construct-validation-process-scripts">
+<h2>Construct validation process scripts<a class="headerlink" href="#construct-validation-process-scripts" title="Permalink to this headline">¶</a></h2>
+<p>The processing script needs to be constructed in such a way that it can be called from a PBS batch
+job script and option parameters can be passed to control how what the process does. The script
+<code class="docutils literal notranslate"><span class="pre">datarmor_insitutac_validate.py</span></code> was used to process the ResourceCode hindcast data set against the
+<a class="reference external" href="https://marine.copernicus.eu/">CMEMS</a> <a class="reference external" href="http://www.marineinsitu.eu/dashboard/">InsituTAC</a> wavebuoy data archive. The main function is called when this python script is run,
+and the optinal parameters are parsed prior to calling the validation process. This script is designed
+to process a single wavebuoy location, the information about the buoy is taken from a record in a CSV
+file that provides a full set of unique model/wavebuoy data matches for a specific year and month,
+<em>i.e.</em> each record in the CSV file corresponds to a unique wavebuoy.</p>
+<div class="literal-block-wrapper docutils container" id="id2">
+<div class="code-block-caption"><span class="caption-text">datarmor_insitutac_validate.py</span><a class="headerlink" href="#id2" title="Permalink to this code">¶</a></div>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="ch">#!/usr/bin/env python3</span>
+<span class="c1"># -*- coding: utf-8 -*-</span>
+
+<span class="c1"># ----------------------------------------------------------------------------</span>
+<span class="c1"># IMPORT PACKAGE DEPENDENCIES</span>
+<span class="c1"># ----------------------------------------------------------------------------</span>
+<span class="kn">import</span> <span class="nn">sys</span>
+<span class="kn">import</span> <span class="nn">os</span>
+<span class="kn">import</span> <span class="nn">getopt</span>
+<span class="kn">from</span> <span class="nn">waveval.MatchUpDatabase</span> <span class="kn">import</span> <span class="n">csv2tuples</span><span class="p">,</span> <span class="n">mapRecord</span>
+<span class="kn">from</span> <span class="nn">waveval.Validation</span> <span class="kn">import</span> <span class="n">validate_records</span><span class="p">,</span> <span class="n">save_tabulated_results</span>
+
+</pre></div>
+</div>
+</div>
+<p>The header of the script sets the shebang line to idenfiy the program required to run the script, and
+imports the required modules and module functions.</p>
+<p>The first part of the main function parses the user input options used to control the process.
+There are three required parameters:</p>
+<blockquote>
+<div><table class="docutils align-default">
+<colgroup>
+<col style="width: 15%" />
+<col style="width: 85%" />
+</colgroup>
+<thead>
+<tr class="row-odd"><th class="head"><p>Option</p></th>
+<th class="head"><p>Description</p></th>
+</tr>
+</thead>
+<tbody>
+<tr class="row-even"><td><p>-p, --path</p></td>
+<td><p>Path for validation results output</p></td>
+</tr>
+<tr class="row-odd"><td><p>-f, --file</p></td>
+<td><p>CSV file of dat match records, <strong>this must be in the directory defined by --path</strong></p></td>
+</tr>
+<tr class="row-even"><td><p>-n, --recnum</p></td>
+<td><p>Record number in the CSV file to process</p></td>
+</tr>
+</tbody>
+</table>
+</div></blockquote>
+<p>and three optional parameters:</p>
+<blockquote>
+<div><table class="docutils align-default">
+<colgroup>
+<col style="width: 27%" />
+<col style="width: 55%" />
+<col style="width: 18%" />
+</colgroup>
+<thead>
+<tr class="row-odd"><th class="head"><p>Option</p></th>
+<th class="head"><p>Description</p></th>
+<th class="head"><p>Default</p></th>
+</tr>
+</thead>
+<tbody>
+<tr class="row-even"><td><p>--minYear</p></td>
+<td><p>Minimum year to process</p></td>
+<td><p>1994</p></td>
+</tr>
+<tr class="row-odd"><td><p>--maxYear</p></td>
+<td><p>Maximum year to process</p></td>
+<td><p>2019</p></td>
+</tr>
+<tr class="row-even"><td><p>--genPlots</p></td>
+<td><p>Generate plots flag</p></td>
+<td><p>False</p></td>
+</tr>
+</tbody>
+</table>
+</div></blockquote>
+<div class="admonition note">
+<p class="admonition-title">Note</p>
+<p>The minimum year <strong>must not be less than</strong> the first year in the model hindcast archive, and the
+maximum year <strong>must not be greater than</strong> the last year in the model hindcast archive.</p>
+</div>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1">#--------------------------------------------------------------------------</span>
+<span class="c1"># MAIN PROCESS</span>
+<span class="c1">#--------------------------------------------------------------------------</span>
+
+<span class="k">def</span> <span class="nf">main</span><span class="p">(</span><span class="n">argv</span><span class="p">):</span>
+
+ <span class="n">minYear</span> <span class="o">=</span> <span class="mi">1994</span>
+ <span class="n">maxYear</span> <span class="o">=</span> <span class="mi">2019</span>
+ <span class="n">genPlots</span> <span class="o">=</span> <span class="kc">False</span>
+
+ <span class="k">try</span><span class="p">:</span>
+ <span class="n">opts</span><span class="p">,</span> <span class="n">args</span> <span class="o">=</span> <span class="n">getopt</span><span class="o">.</span><span class="n">getopt</span><span class="p">(</span><span class="n">argv</span><span class="p">,</span><span class="s1">'hp:f:n:'</span><span class="p">,[</span><span class="s2">"--path"</span><span class="p">,</span><span class="s2">"--fname="</span><span class="p">,</span>
+ <span class="s2">"--recnum"</span><span class="p">,</span><span class="s2">"minYear="</span><span class="p">,</span>
+ <span class="s2">"maxYear="</span><span class="p">,</span><span class="s2">"genPlots="</span><span class="p">])</span>
+ <span class="k">except</span> <span class="n">getopt</span><span class="o">.</span><span class="n">GetoptError</span><span class="p">:</span>
+ <span class="nb">print</span><span class="p">(</span><span class="s1">'python3 datarmor_insitutac_validate.py -p <path> -f <fname> -n <recnum>'</span><span class="p">)</span>
+ <span class="n">sys</span><span class="o">.</span><span class="n">exit</span><span class="p">(</span><span class="mi">4</span><span class="p">)</span>
+ <span class="k">if</span> <span class="n">opts</span> <span class="o">==</span> <span class="p">[]:</span>
+ <span class="nb">print</span><span class="p">(</span><span class="s1">'python3 datarmor_insitutac_validate.py -p <path> -f <fname> -n <recnum>'</span><span class="p">)</span>
+ <span class="n">sys</span><span class="o">.</span><span class="n">exit</span><span class="p">(</span><span class="mi">4</span><span class="p">)</span>
+ <span class="k">for</span> <span class="n">opt</span><span class="p">,</span> <span class="n">arg</span> <span class="ow">in</span> <span class="n">opts</span><span class="p">:</span>
+ <span class="nb">print</span><span class="p">(</span><span class="n">opt</span><span class="p">,</span><span class="n">arg</span><span class="p">)</span>
+ <span class="k">if</span> <span class="n">opt</span> <span class="o">==</span> <span class="s1">'-h'</span><span class="p">:</span>
+ <span class="nb">print</span><span class="p">(</span><span class="s1">'python3 datarmor_insitutac_validate.py -p <path> -f <fname> -n <recnum>'</span><span class="p">)</span>
+ <span class="n">sys</span><span class="o">.</span><span class="n">exit</span><span class="p">()</span>
+ <span class="k">elif</span> <span class="n">opt</span> <span class="ow">in</span> <span class="p">(</span><span class="s2">"-p"</span><span class="p">,</span><span class="s2">"--path"</span><span class="p">):</span>
+ <span class="n">dat_path</span> <span class="o">=</span> <span class="n">arg</span>
+ <span class="k">elif</span> <span class="n">opt</span> <span class="ow">in</span> <span class="p">(</span><span class="s2">"-f"</span><span class="p">,</span><span class="s2">"--fname"</span><span class="p">):</span>
+ <span class="n">rec_file</span> <span class="o">=</span> <span class="n">arg</span>
+ <span class="k">elif</span> <span class="n">opt</span> <span class="ow">in</span> <span class="p">(</span><span class="s2">"-n"</span><span class="p">,</span><span class="s2">"--recnum"</span><span class="p">):</span>
+ <span class="n">recNum</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">arg</span><span class="p">)</span>
+ <span class="k">elif</span> <span class="n">opt</span> <span class="ow">in</span> <span class="p">(</span><span class="s2">"--minYear"</span><span class="p">):</span>
+ <span class="n">minYear</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">arg</span><span class="p">)</span>
+ <span class="k">elif</span> <span class="n">opt</span> <span class="ow">in</span> <span class="p">(</span><span class="s2">"--maxYear"</span><span class="p">):</span>
+ <span class="n">maxYear</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">arg</span><span class="p">)</span>
+ <span class="k">elif</span> <span class="n">opt</span> <span class="ow">in</span> <span class="p">(</span><span class="s2">"--genPlots"</span><span class="p">):</span>
+ <span class="k">if</span> <span class="n">arg</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">upper</span><span class="p">()</span> <span class="o">==</span> <span class="s2">"T"</span><span class="p">:</span>
+ <span class="n">genPlots</span> <span class="o">=</span> <span class="kc">True</span>
+
+</pre></div>
+</div>
+<p>Once the input parameters are parsed, the input record list CSV file is converted to a list of tuples
+for processing by the <a class="reference internal" href="Validation.html#module-Validation"><span class="std std-ref">Validation</span></a> module, the requested year range is set, and the wave data
+format defined.</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="c1"># =================== Get Records to Process =============================</span>
+ <span class="n">rec_list</span> <span class="o">=</span> <span class="n">csv2tuples</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">dat_path</span><span class="p">,</span><span class="n">rec_file</span><span class="p">))</span>
+
+ <span class="n">rec</span> <span class="o">=</span> <span class="n">rec_list</span><span class="p">[</span><span class="n">recNum</span><span class="p">]</span>
+ <span class="n">yearBgn</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">rec</span><span class="p">[</span><span class="mi">6</span><span class="p">]</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">'-'</span><span class="p">)[</span><span class="mi">0</span><span class="p">])</span>
+ <span class="k">if</span> <span class="n">yearBgn</span> <span class="o"><</span> <span class="n">minYear</span><span class="p">:</span>
+ <span class="n">yearBgn</span> <span class="o">=</span> <span class="n">minYear</span>
+ <span class="n">yearEnd</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">rec</span><span class="p">[</span><span class="mi">7</span><span class="p">]</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">'-'</span><span class="p">)[</span><span class="mi">0</span><span class="p">])</span>
+ <span class="k">if</span> <span class="n">yearEnd</span> <span class="o">></span> <span class="n">maxYear</span><span class="p">:</span>
+ <span class="n">yearEnd</span> <span class="o">=</span> <span class="n">maxYear</span>
+ <span class="n">records</span> <span class="o">=</span> <span class="n">mapRecord</span><span class="p">(</span><span class="n">yearBgn</span><span class="p">,</span><span class="n">yearEnd</span><span class="p">,</span><span class="n">rec</span><span class="p">)</span>
+ <span class="n">platform</span> <span class="o">=</span> <span class="n">records</span><span class="p">[</span><span class="mi">0</span><span class="p">][</span><span class="mi">8</span><span class="p">]</span>
+
+ <span class="n">buoyFmt</span> <span class="o">=</span> <span class="s1">'InSituTAC'</span>
+
+</pre></div>
+</div>
+<p>Next the wave parameters to be processed are select using an index list based on the following values:</p>
+<blockquote>
+<div><table class="docutils align-default">
+<colgroup>
+<col style="width: 17%" />
+<col style="width: 83%" />
+</colgroup>
+<thead>
+<tr class="row-odd"><th class="head"><p>Index</p></th>
+<th class="head"><p>Integrated Wave Parameter</p></th>
+</tr>
+</thead>
+<tbody>
+<tr class="row-even"><td><p>0</p></td>
+<td><p>Hm0 - Significant wave height</p></td>
+</tr>
+<tr class="row-odd"><td><p>1</p></td>
+<td><p>Tp - Peak wave period</p></td>
+</tr>
+<tr class="row-even"><td><p>2</p></td>
+<td><p>Tm02 - Mean zero-crossing wave period</p></td>
+</tr>
+<tr class="row-odd"><td><p>3</p></td>
+<td><p>Dir - Peak wave direction</p></td>
+</tr>
+<tr class="row-even"><td><p>4</p></td>
+<td><p>Spr - Peak wave directional spreading</p></td>
+</tr>
+</tbody>
+</table>
+</div></blockquote>
+<p>Each integrated wave parameter is processed separately, so the selected parameters are processed in a loop.</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="c1"># ========================= Process Record ==============================</span>
+ <span class="c1"># Choose fields to process</span>
+ <span class="n">fields</span> <span class="o">=</span> <span class="p">[</span><span class="mi">0</span><span class="p">,</span><span class="mi">1</span><span class="p">,</span><span class="mi">3</span><span class="p">,</span><span class="mi">4</span><span class="p">]</span>
+
+ <span class="k">for</span> <span class="n">field</span> <span class="ow">in</span> <span class="n">fields</span><span class="p">:</span>
+ <span class="c1"># Get internal variable name string</span>
+ <span class="k">if</span> <span class="n">field</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
+ <span class="n">oVarName</span> <span class="o">=</span> <span class="s1">'Hm0'</span> <span class="c1"># Significant wave height</span>
+ <span class="k">if</span> <span class="n">field</span> <span class="o">==</span> <span class="mi">1</span><span class="p">:</span>
+ <span class="n">oVarName</span> <span class="o">=</span> <span class="s1">'Tp'</span> <span class="c1"># Peak wave period</span>
+ <span class="k">if</span> <span class="n">field</span> <span class="o">==</span> <span class="mi">2</span><span class="p">:</span>
+ <span class="n">oVarName</span> <span class="o">=</span> <span class="s1">'Tm02'</span> <span class="c1"># Mean zero crossing period</span>
+ <span class="k">if</span> <span class="n">field</span> <span class="o">==</span> <span class="mi">3</span><span class="p">:</span>
+ <span class="n">oVarName</span> <span class="o">=</span> <span class="s1">'Dir'</span> <span class="c1"># Wave direction</span>
+ <span class="k">if</span> <span class="n">field</span> <span class="o">==</span> <span class="mi">4</span><span class="p">:</span>
+ <span class="n">oVarName</span> <span class="o">=</span> <span class="s1">'Spr'</span> <span class="c1"># Wave directional spreading</span>
+
+</pre></div>
+</div>
+<p>The selected wave parameters then need to be mapped to the corresponding netCDF variable names within
+the model and wavebuoy data files. The model variable name is set in the variable <code class="docutils literal notranslate"><span class="pre">mVarName</span></code> and takes a single string value, the wavebuoy variable names are set in the list variable <code class="docutils literal notranslate"><span class="pre">varOptions</span></code>. There are a range of similar wave parameters in the buoy data that could be used in place of the preferred variables, the list allows these to be used if the preferred is not available.</p>
+<div class="admonition note">
+<p class="admonition-title">Note</p>
+<p>It is recommended that the user only take the preferred wavebuoy variables for validation purposes.
+[VHM0, VTPK, VTM02, VPED, VPSP].</p>
+<p>The WaveWatch III model ouputs peak and zero-crossing frequencies, these are converted to periods
+during the record processing stage.</p>
+</div>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="c1"># Set MDB variable names</span>
+ <span class="k">if</span> <span class="n">oVarName</span> <span class="o">==</span> <span class="s1">'Hm0'</span><span class="p">:</span>
+ <span class="n">mVarName</span> <span class="o">=</span> <span class="s1">'hs'</span>
+ <span class="n">varOptions</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'VHM0'</span><span class="p">]</span>
+ <span class="k">elif</span> <span class="n">oVarName</span> <span class="o">==</span> <span class="s1">'Tp'</span><span class="p">:</span>
+ <span class="n">mVarName</span> <span class="o">=</span> <span class="s1">'fp'</span>
+ <span class="n">varOptions</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'VTPK'</span><span class="p">]</span>
+ <span class="k">elif</span> <span class="n">oVarName</span> <span class="o">==</span> <span class="s1">'Tm02'</span><span class="p">:</span>
+ <span class="n">mVarName</span> <span class="o">=</span> <span class="s1">'f02'</span>
+ <span class="n">varOptions</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'VTM02'</span><span class="p">]</span>
+ <span class="k">elif</span> <span class="n">oVarName</span> <span class="o">==</span> <span class="s1">'Dir'</span><span class="p">:</span>
+ <span class="n">mVarName</span> <span class="o">=</span> <span class="s1">'dir'</span>
+ <span class="n">varOptions</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'VPED'</span><span class="p">]</span>
+ <span class="k">elif</span> <span class="n">oVarName</span> <span class="o">==</span> <span class="s1">'Spr'</span><span class="p">:</span>
+ <span class="n">mVarName</span> <span class="o">=</span> <span class="s1">'spr'</span>
+ <span class="n">varOptions</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'VPSP'</span><span class="p">]</span>
+
+</pre></div>
+</div>
+<p>The final steps are to calculate the validation statistics by calling <a class="reference internal" href="Validation.html#Validation.validate_records" title="Validation.validate_records"><code class="xref py py-func docutils literal notranslate"><span class="pre">Validation.validate_records()</span></code></a>. This returns
+a count of the number of validations returned (<code class="docutils literal notranslate"><span class="pre">n_valid</span></code>) and a dictionary structure (<code class="docutils literal notranslate"><span class="pre">valid_stats</span></code>) containing the
+validation results. If there is at least one validation result, then the results are saved to both an ASCII and a binary
+file for post-procesing. A separate record is produced for each integrated wave parameter for the current wavebuoy being
+processed.</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="c1"># ================== Generate Validation Stats ===========================</span>
+ <span class="n">plot_results</span> <span class="o">=</span> <span class="n">genPlots</span>
+ <span class="n">n_valid</span><span class="p">,</span> <span class="n">valid_stats</span> <span class="o">=</span> <span class="n">validate_records</span><span class="p">(</span><span class="n">records</span><span class="p">,</span>
+ <span class="n">buoyFmt</span><span class="p">,</span> <span class="n">platform</span><span class="p">,</span>
+ <span class="n">mVarName</span><span class="p">,</span> <span class="n">varOptions</span><span class="p">,</span>
+ <span class="n">oVarName</span><span class="p">,</span>
+ <span class="n">dat_path</span><span class="p">,</span>
+ <span class="n">plot_results</span><span class="p">)</span>
+
+ <span class="c1"># ================== Save Tabulated Results ===========================</span>
+ <span class="k">if</span> <span class="n">n_valid</span> <span class="o">></span> <span class="mi">0</span><span class="p">:</span>
+ <span class="n">save_tabulated_results</span><span class="p">(</span><span class="n">valid_stats</span><span class="p">,</span> <span class="n">platform</span><span class="p">,</span> <span class="n">oVarName</span><span class="p">,</span> <span class="n">dat_path</span><span class="p">)</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="nb">print</span><span class="p">(</span><span class="s1">'No validations statistics generated from match up records.'</span><span class="p">)</span>
+
+</pre></div>
+</div>
+<p>The interface section allows the script to be run from the command line or to be called from within another script. This feature is used to automate the processing of a large number of wavebuoy locations using the methods described in the following section.</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1">#--------------------------------------------------------------------------</span>
+<span class="c1"># INTERFACE</span>
+<span class="c1">#--------------------------------------------------------------------------</span>
+<span class="k">if</span> <span class="vm">__name__</span> <span class="o">==</span> <span class="s2">"__main__"</span><span class="p">:</span>
+ <span class="n">main</span><span class="p">(</span><span class="n">sys</span><span class="o">.</span><span class="n">argv</span><span class="p">[</span><span class="mi">1</span><span class="p">:])</span>
+</pre></div>
+</div>
+<p>To run the script from the command line use:</p>
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ python3 datarmor_insitutac_validate.py -p path/to/output/directory -f records_file.csv -n record_nmber
+</pre></div>
+</div>
+<p>e.g.</p>
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ python3 datarmor_insitutac_validate.py -p ../data/VALIDATION/RSCD_v3 -f validation_site.csv -n <span class="m">9</span>
+</pre></div>
+</div>
+<p>will write the output to the absolute directory <code class="docutils literal notranslate"><span class="pre">../data/VALIDATION/RSCD_v3</span></code>, the input file containing the list of
+unique model/observation matches is <code class="docutils literal notranslate"><span class="pre">validation_sites.csv</span></code>, and record number 9 is to be processed (it must be
+remembered that python counts from 0 not 1, <em>i.e.</em> -n 0 processes the first record in the file, -n 9 processes the
+10 <sup>th</sup> record in the file).</p>
+<div class="admonition note">
+<p class="admonition-title">Note</p>
+<p>For this script to be callable from another function its permissions need to be set to executable,
+<em>e.g.</em> apply <code class="docutils literal notranslate"><span class="pre">chmod</span> <span class="pre">a+x</span> <span class="pre">datarmor_insitutac_validate.py</span></code> to the script.</p>
+</div>
+</section>
+<section id="generate-pbs-job-scripts-and-submit-to-queue">
+<h2>Generate PBS job scripts and submit to queue<a class="headerlink" href="#generate-pbs-job-scripts-and-submit-to-queue" title="Permalink to this headline">¶</a></h2>
+<p>To run the <code class="docutils literal notranslate"><span class="pre">datarmor_insitutac_validate.py</span></code> processing script on a Datarmor processing node it needs to be submitted
+to the job queue using a qsub call. The <code class="docutils literal notranslate"><span class="pre">datarmor_insitutac_validate.py</span></code> needs to be run in an anaconda shell environment, so this needs to be set up in the script submitted by the qsub call. Within the script the compute node
+resources need to be requested (<em>i.e.</em> the amount of memory required and the time required to run the process). It should be noted that if insufficient resources or walltime are requested the job will end without completion, so it pays to over-estimate the resource requirements, to avoid needing to rerun a process.</p>
+<p>To automate the processing of a large number of wavebuoys, a separate PBS script is required. The approcach taken to
+facillitate this is to define a base PBD script that contains the common components, and can be modified to provide the specific information for each job.</p>
+<p>The following PBS job script (<code class="docutils literal notranslate"><span class="pre">base_insitutac.pbs</span></code>) was used as the basis for generating the individual job submissions:</p>
+<div class="literal-block-wrapper docutils container" id="id3">
+<div class="code-block-caption"><span class="caption-text">base_insitutac.pbs</span><a class="headerlink" href="#id3" title="Permalink to this code">¶</a></div>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="linenos">1</span><span class="ch">#!/bin/csh -e</span>
+<span class="linenos">2</span>
+<span class="linenos">3</span><span class="c1">#PBS -l mem=5G</span>
+<span class="linenos">4</span><span class="c1">#PBS -l walltime=02:00:00</span>
+<span class="linenos">5</span>
+<span class="linenos">6</span><span class="n">source</span> <span class="o">/</span><span class="n">appli</span><span class="o">/</span><span class="n">anaconda</span><span class="o">/</span><span class="n">latest</span><span class="o">/</span><span class="n">etc</span><span class="o">/</span><span class="n">profile</span><span class="o">.</span><span class="n">d</span><span class="o">/</span><span class="n">conda</span><span class="o">.</span><span class="n">csh</span>
+<span class="linenos">7</span><span class="n">conda</span> <span class="n">activate</span> <span class="n">buoyvalid</span>
+<span class="linenos">8</span><span class="n">cd</span> <span class="o">/</span><span class="n">home1</span><span class="o">/</span><span class="n">datawork</span><span class="o">/</span><span class="n">USER</span><span class="o">/</span><span class="n">pycode</span>
+<span class="linenos">9</span><span class="n">python3</span> <span class="n">datarmor_insitutac_validate</span><span class="o">.</span><span class="n">py</span> <span class="o">-</span><span class="n">p</span> <span class="o">/</span><span class="n">home1</span><span class="o">/</span><span class="n">datawork</span><span class="o">/</span><span class="n">USER</span><span class="o">/</span><span class="n">VALIDATION</span><span class="o">/</span><span class="n">RSCD_v3</span> <span class="o">-</span><span class="n">f</span> <span class="n">insitutac_validation_sites</span><span class="o">.</span><span class="n">csv</span>
+</pre></div>
+</div>
+</div>
+<p>Line 1 sets the shell environment, lines 3 and 4 request the compute node resources, line 6 changes to a conda shell,
+line 7 activates the conda environment <code class="docutils literal notranslate"><span class="pre">buoyvalid</span></code> (as described above), line 8 changes to the location of the python
+scripts on the users datawork space, and line 9 gives the common components of the call to run the
+<code class="docutils literal notranslate"><span class="pre">datarmor_insitutac_validate.py</span></code> script. Line 9 is missing the required -n input option, so this will return an error
+if submitted as is. The following script used to generate the PBS jobs adds the required record number to the call.</p>
+<div class="admonition note">
+<p class="admonition-title">Note</p>
+<p>The conda environment <strong>buoyvalid</strong> needs to be replaced with the environment you have set up.</p>
+<p>You must replace <strong>USER</strong> must be with your user name, <strong>pycode</strong> with the location of your python scripts,
+<strong>VALIDATION/RSCD_v3</strong> with the location you want the results to be output too, and <strong>validation_sites.csv</strong> with the
+name of the CSV file used for input.</p>
+<p>The output directory must exist, and the records CSV file must exist in the output directory.</p>
+</div>
+<p>The script <code class="docutils literal notranslate"><span class="pre">generate_validation_batch_jobs.py</span></code> is used to generate and submit a PBS job for records in the CSV matched
+data records file. The default PBS script <code class="docutils literal notranslate"><span class="pre">base_insitutac.pbs</span></code>, described above, is modified to match the record being
+processed. It is assumed that each record in the CSV file represents a unique wavebuoy, the data processing script called
+generates the set of separate year/month records required for processing a given buoy.</p>
+<p>The only line in <code class="docutils literal notranslate"><span class="pre">base_insitutac.pbs</span></code> that needs to be modified is the last line which calls python processing script;
+the record number to be processed is added as in input option to the call. A new PBS job script is generated with the record number appended, then submitted to the job queue using the <code class="docutils literal notranslate"><span class="pre">qsub</span></code> command.</p>
+<p>A subset of the records can be processed by setting the <code class="docutils literal notranslate"><span class="pre">start_rec</span></code> and <code class="docutils literal notranslate"><span class="pre">num_recs</span></code> values in this script before running it. The <code class="docutils literal notranslate"><span class="pre">num_recs</span></code> must not be greater than the number of records in the CSV file. This feature can be used to re-run processes that failed.</p>
+<div class="literal-block-wrapper docutils container" id="id4">
+<div class="code-block-caption"><span class="caption-text">generate_validation_batch_jobs.py</span><a class="headerlink" href="#id4" title="Permalink to this code">¶</a></div>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="linenos"> 1</span><span class="ch">#!/usr/bin/env python3</span>
+<span class="linenos"> 2</span><span class="c1"># -*- coding: utf-8 -*-</span>
+<span class="linenos"> 3</span>
+<span class="linenos"> 4</span><span class="kn">import</span> <span class="nn">os</span>
+<span class="linenos"> 5</span>
+<span class="linenos"> 6</span><span class="n">start_rec</span> <span class="o">=</span> <span class="mi">0</span>
+<span class="linenos"> 7</span><span class="n">num_recs</span> <span class="o">=</span> <span class="mi">154</span>
+<span class="linenos"> 8</span><span class="n">baseFile</span> <span class="o">=</span> <span class="s1">'base_insitutac.pbs'</span>
+<span class="linenos"> 9</span>
+<span class="linenos">10</span><span class="k">for</span> <span class="n">irec</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">start_rec</span><span class="p">,</span> <span class="n">num_recs</span><span class="p">):</span>
+<span class="linenos">11</span> <span class="n">inFile</span> <span class="o">=</span> <span class="nb">open</span><span class="p">(</span><span class="n">baseFile</span><span class="p">,</span><span class="s1">'r'</span><span class="p">)</span>
+<span class="linenos">12</span> <span class="n">ofname</span> <span class="o">=</span> <span class="s1">'insitutac_job_'</span><span class="o">+</span><span class="nb">str</span><span class="p">(</span><span class="n">irec</span><span class="p">)</span><span class="o">.</span><span class="n">zfill</span><span class="p">(</span><span class="mi">3</span><span class="p">)</span><span class="o">+</span><span class="s1">'.pbs'</span>
+<span class="linenos">13</span> <span class="n">outFile</span> <span class="o">=</span> <span class="nb">open</span><span class="p">(</span><span class="n">ofname</span><span class="p">,</span><span class="s1">'w'</span><span class="p">)</span>
+<span class="linenos">14</span> <span class="k">for</span> <span class="n">astr</span> <span class="ow">in</span> <span class="n">inFile</span><span class="p">:</span>
+<span class="linenos">15</span> <span class="k">if</span> <span class="s1">'python3'</span> <span class="ow">in</span> <span class="n">astr</span><span class="p">:</span>
+<span class="linenos">16</span> <span class="n">astr</span> <span class="o">=</span> <span class="n">astr</span><span class="o">.</span><span class="n">strip</span><span class="p">(</span><span class="s1">'</span><span class="se">\n</span><span class="s1">'</span><span class="p">)</span><span class="o">+</span><span class="s1">' -n '</span><span class="o">+</span><span class="nb">str</span><span class="p">(</span><span class="n">irec</span><span class="p">)</span><span class="o">+</span><span class="s1">'</span><span class="se">\n</span><span class="s1">'</span>
+<span class="linenos">17</span> <span class="n">outFile</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">astr</span><span class="p">)</span>
+<span class="linenos">18</span> <span class="n">inFile</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
+<span class="linenos">19</span> <span class="n">outFile</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
+<span class="linenos">20</span> <span class="n">procstr</span> <span class="o">=</span> <span class="s1">'qsub '</span><span class="o">+</span><span class="n">ofname</span>
+<span class="linenos">21</span> <span class="n">os</span><span class="o">.</span><span class="n">system</span><span class="p">(</span><span class="n">procstr</span><span class="p">)</span>
+</pre></div>
+</div>
+</div>
+</section>
+<section id="post-process-validation-results">
+<h2>Post-process validation results<a class="headerlink" href="#post-process-validation-results" title="Permalink to this headline">¶</a></h2>
+<div class="literal-block-wrapper docutils container" id="id5">
+<div class="code-block-caption"><span class="caption-text">process_insitutac_stats.py</span><a class="headerlink" href="#id5" title="Permalink to this code">¶</a></div>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="linenos"> 1</span><span class="ch">#!/usr/bin/env python3</span>
+<span class="linenos"> 2</span><span class="c1"># -*- coding: utf-8 -*-</span>
+<span class="linenos"> 3</span>
+<span class="linenos"> 4</span><span class="c1"># ----------------------------------------------------------------------------</span>
+<span class="linenos"> 5</span><span class="c1"># IMPORT PACKAGE DEPENDENCIES</span>
+<span class="linenos"> 6</span><span class="c1"># ----------------------------------------------------------------------------</span>
+<span class="linenos"> 7</span><span class="c1"># Standard Python Dependencies</span>
+<span class="linenos"> 8</span><span class="c1"># Non-Standard Python Dependencies</span>
+<span class="linenos"> 9</span><span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
+<span class="linenos">10</span><span class="c1"># Local Module Dependencies</span>
+<span class="linenos">11</span><span class="kn">from</span> <span class="nn">waveval.MatchUpDatabase</span> <span class="kn">import</span> <span class="n">csv2tuples</span>
+<span class="linenos">12</span><span class="kn">from</span> <span class="nn">waveval.WaveStats</span> <span class="kn">import</span> <span class="n">get_buoy_locations</span>
+<span class="linenos">13</span><span class="kn">from</span> <span class="nn">waveval.WaveStats</span> <span class="kn">import</span> <span class="n">get_parameter_stats_global</span>
+<span class="linenos">14</span><span class="kn">from</span> <span class="nn">waveval.WaveStats</span> <span class="kn">import</span> <span class="n">get_parameter_stats_by_buoy</span>
+<span class="linenos">15</span><span class="kn">from</span> <span class="nn">waveval.Graphics</span> <span class="kn">import</span> <span class="n">Regional_Weighted</span>
+<span class="linenos">16</span><span class="c1"># Other Dependencies</span>
+<span class="linenos">17</span>
+<span class="linenos">18</span><span class="c1"># ----------------------------------------------------------------------------</span>
+<span class="linenos">19</span><span class="c1"># GLOBAL VARIABLES</span>
+<span class="linenos">20</span><span class="c1"># ----------------------------------------------------------------------------</span>
+<span class="linenos">21</span><span class="n">paramStr</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'Hm0'</span><span class="p">,</span><span class="s1">'Tp'</span><span class="p">,</span><span class="s1">'Tm02'</span><span class="p">,</span><span class="s1">'Dir'</span><span class="p">,</span><span class="s1">'Spr'</span><span class="p">]</span>
+<span class="linenos">22</span><span class="n">metricStr</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'R'</span><span class="p">,</span><span class="s1">'MB'</span><span class="p">,</span><span class="s1">'NMB'</span><span class="p">,</span><span class="s1">'MAE'</span><span class="p">,</span><span class="s1">'NMAE'</span><span class="p">,</span><span class="s1">'RMSE'</span><span class="p">,</span><span class="s1">'NRMSE'</span><span class="p">,</span><span class="s1">'SI'</span><span class="p">]</span>
+<span class="linenos">23</span>
+<span class="linenos">24</span><span class="c1">#--------------------------------------------------------------------------</span>
+<span class="linenos">25</span><span class="c1"># MAIN PROCESS</span>
+<span class="linenos">26</span><span class="c1">#--------------------------------------------------------------------------</span>
+<span class="linenos">27</span>
+<span class="linenos">28</span><span class="n">dpath</span> <span class="o">=</span> <span class="s1">'E:/ResourceCode/Data/VALIDATION/RSCD_v3/INSITUTAC'</span>
+<span class="linenos">29</span><span class="n">ppath</span> <span class="o">=</span> <span class="s1">'E:/ResourceCode/Data/VALIDATION/RSCD_v3/WAVEVAL/MAPS'</span>
+<span class="linenos">30</span><span class="n">pfnam</span> <span class="o">=</span> <span class="s1">'INSITUTAC_TS_'</span>
+<span class="linenos">31</span>
+<span class="linenos">32</span><span class="n">paramStr</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'Hm0'</span><span class="p">,</span><span class="s1">'Tp'</span><span class="p">]</span>
+<span class="linenos">33</span><span class="n">metricStr</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'R'</span><span class="p">,</span><span class="s1">'NMB'</span><span class="p">,</span><span class="s1">'NRMSE'</span><span class="p">]</span>
+<span class="linenos">34</span><span class="n">savePlot</span> <span class="o">=</span> <span class="kc">True</span>
+<span class="linenos">35</span>
+<span class="linenos">36</span><span class="k">for</span> <span class="n">param</span> <span class="ow">in</span> <span class="n">paramStr</span><span class="p">:</span>
+<span class="linenos">37</span> <span class="nb">print</span><span class="p">(</span><span class="s1">'PARAMETER: '</span><span class="o">+</span><span class="n">param</span><span class="p">)</span>
+<span class="linenos">38</span> <span class="n">get_parameter_stats_global</span><span class="p">(</span><span class="n">dpath</span><span class="p">,</span> <span class="n">param</span><span class="p">,</span> <span class="n">metricStr</span><span class="p">)</span>
+<span class="linenos">39</span>
+<span class="linenos">40</span><span class="n">recfile</span> <span class="o">=</span> <span class="s1">'E:/ResourceCode/Data/VALIDATION/RSCD_v3/rscd_2017_matchup_v03.csv'</span>
+<span class="linenos">41</span><span class="n">records</span> <span class="o">=</span> <span class="n">csv2tuples</span><span class="p">(</span><span class="n">recfile</span><span class="p">)</span>
+<span class="linenos">42</span><span class="n">buoyLoc</span> <span class="o">=</span> <span class="n">get_buoy_locations</span><span class="p">(</span><span class="n">records</span><span class="p">)</span>
+<span class="linenos">43</span>
+<span class="linenos">44</span><span class="n">lat</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">asarray</span><span class="p">(</span><span class="n">buoyLoc</span><span class="p">[</span><span class="s1">'latitude'</span><span class="p">],</span><span class="n">dtype</span><span class="o">=</span><span class="nb">float</span><span class="p">)</span>
+<span class="linenos">45</span><span class="n">lon</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">asarray</span><span class="p">(</span><span class="n">buoyLoc</span><span class="p">[</span><span class="s1">'longitude'</span><span class="p">],</span><span class="n">dtype</span><span class="o">=</span><span class="nb">float</span><span class="p">)</span>
+<span class="linenos">46</span><span class="n">platforms</span> <span class="o">=</span> <span class="n">buoyLoc</span><span class="p">[</span><span class="s1">'platform'</span><span class="p">]</span>
+<span class="linenos">47</span>
+<span class="linenos">48</span><span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">platforms</span><span class="p">)):</span>
+<span class="linenos">49</span> <span class="n">platforms</span><span class="p">[</span><span class="n">i</span><span class="p">]</span> <span class="o">=</span> <span class="n">platforms</span><span class="p">[</span><span class="n">i</span><span class="p">]</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span>
+<span class="linenos">50</span>
+<span class="linenos">51</span><span class="k">for</span> <span class="n">param</span> <span class="ow">in</span> <span class="n">paramStr</span><span class="p">:</span>
+<span class="linenos">52</span>
+<span class="linenos">53</span> <span class="k">for</span> <span class="n">metric</span> <span class="ow">in</span> <span class="n">metricStr</span><span class="p">:</span>
+<span class="linenos">54</span>
+<span class="linenos">55</span> <span class="n">stats</span> <span class="o">=</span> <span class="n">get_parameter_stats_by_buoy</span><span class="p">(</span><span class="n">dpath</span><span class="p">,</span> <span class="n">param</span><span class="p">,</span> <span class="n">metric</span><span class="p">)</span>
+<span class="linenos">56</span>
+<span class="linenos">57</span> <span class="n">pfrm</span> <span class="o">=</span> <span class="n">stats</span><span class="p">[</span><span class="s1">'platform'</span><span class="p">]</span>
+<span class="linenos">58</span> <span class="n">wght</span> <span class="o">=</span> <span class="n">stats</span><span class="p">[</span><span class="s1">'mean'</span><span class="p">]</span>
+<span class="linenos">59</span> <span class="n">dom</span> <span class="o">=</span> <span class="p">[</span><span class="o">-</span><span class="mi">15</span><span class="p">,</span> <span class="mi">15</span><span class="p">,</span> <span class="mi">35</span><span class="p">,</span> <span class="mi">70</span><span class="p">]</span>
+<span class="linenos">60</span> <span class="n">pltTitle</span> <span class="o">=</span> <span class="s1">'IN SITU TAC (TS): Parameter: '</span><span class="o">+</span><span class="n">param</span><span class="o">+</span><span class="s1">', Metric: '</span><span class="o">+</span><span class="n">metric</span>
+<span class="linenos">61</span>
+<span class="linenos">62</span> <span class="n">idx</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">zeros</span><span class="p">((</span><span class="nb">len</span><span class="p">(</span><span class="n">pfrm</span><span class="p">),),</span> <span class="n">dtype</span><span class="o">=</span><span class="nb">int</span><span class="p">)</span>
+<span class="linenos">63</span> <span class="k">for</span> <span class="n">i</span><span class="p">,</span><span class="n">p</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">pfrm</span><span class="p">):</span>
+<span class="linenos">64</span> <span class="k">try</span><span class="p">:</span>
+<span class="linenos">65</span> <span class="n">indx</span> <span class="o">=</span> <span class="n">platforms</span><span class="o">.</span><span class="n">index</span><span class="p">(</span><span class="n">p</span><span class="p">)</span>
+<span class="linenos">66</span> <span class="k">except</span><span class="p">:</span>
+<span class="linenos">67</span> <span class="k">continue</span>
+<span class="linenos">68</span> <span class="n">idx</span><span class="p">[</span><span class="n">i</span><span class="p">]</span> <span class="o">=</span> <span class="n">indx</span>
+<span class="linenos">69</span> <span class="k">if</span> <span class="n">metric</span> <span class="ow">in</span> <span class="p">[</span><span class="s1">'R'</span><span class="p">]:</span>
+<span class="linenos">70</span> <span class="n">clims</span> <span class="o">=</span> <span class="p">[</span><span class="mf">0.0</span><span class="p">,</span> <span class="mf">1.0</span><span class="p">]</span>
+<span class="linenos">71</span> <span class="k">elif</span> <span class="n">metric</span> <span class="ow">in</span> <span class="p">[</span><span class="s1">'NMB'</span><span class="p">,</span> <span class="s1">'NMAE'</span><span class="p">,</span> <span class="s1">'NRMSE'</span><span class="p">,</span> <span class="s1">'SI'</span><span class="p">]:</span>
+<span class="linenos">72</span> <span class="n">clims</span> <span class="o">=</span> <span class="p">[</span><span class="mf">0.0</span><span class="p">,</span> <span class="mi">100</span><span class="p">]</span>
+<span class="linenos">73</span> <span class="k">else</span><span class="p">:</span>
+<span class="linenos">74</span> <span class="n">clims</span> <span class="o">=</span> <span class="p">[</span><span class="kc">None</span><span class="p">]</span>
+<span class="linenos">75</span> <span class="n">pname</span> <span class="o">=</span> <span class="n">pfnam</span><span class="o">+</span><span class="n">param</span><span class="o">+</span><span class="s1">'_'</span><span class="o">+</span><span class="n">metric</span><span class="o">+</span><span class="s1">'_by_buoy'</span>
+<span class="linenos">76</span> <span class="n">Regional_Weighted</span><span class="p">(</span><span class="nb">list</span><span class="p">(</span><span class="n">lat</span><span class="p">[</span><span class="n">idx</span><span class="p">]),</span> <span class="nb">list</span><span class="p">(</span><span class="n">lon</span><span class="p">[</span><span class="n">idx</span><span class="p">]),</span> <span class="n">wght</span><span class="p">,</span> <span class="n">dom</span><span class="p">,</span> <span class="n">clims</span><span class="p">,</span>
+<span class="linenos">77</span> <span class="n">pltTitle</span><span class="p">,</span> <span class="n">ppath</span><span class="p">,</span> <span class="n">pname</span><span class="p">,</span> <span class="n">savePlot</span><span class="p">)</span>
+<span class="linenos">78</span>
+</pre></div>
+</div>
+</div>
+</section>
+</section>
+
+
+ <div class="clearer"></div>
+ </div>
+ </div>
+ </div>
+ <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+ <div class="sphinxsidebarwrapper">
+ <h3><a href="index.html">Table of Contents</a></h3>
+ <ul>
+<li><a class="reference internal" href="#">Batch Processing - (IFREMER Datarmor HPC)</a><ul>
+<li><a class="reference internal" href="#setup-conda-environment">Setup conda environment</a></li>
+<li><a class="reference internal" href="#construct-validation-process-scripts">Construct validation process scripts</a></li>
+<li><a class="reference internal" href="#generate-pbs-job-scripts-and-submit-to-queue">Generate PBS job scripts and submit to queue</a></li>
+<li><a class="reference internal" href="#post-process-validation-results">Post-process validation results</a></li>
+</ul>
+</li>
+</ul>
+
+ <h4>Previous topic</h4>
+ <p class="topless"><a href="examples.html"
+ title="previous chapter">Examples</a></p>
+ <h4>Next topic</h4>
+ <p class="topless"><a href="data_access.html"
+ title="next chapter">External data archives</a></p>
+ <div role="note" aria-label="source link">
+ <h3>This Page</h3>
+ <ul class="this-page-menu">
+ <li><a href="_sources/automate.rst.txt"
+ rel="nofollow">Show Source</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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
+ <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="data_access.html" title="External data archives"
+ >next</a> |</li>
+ <li class="right" >
+ <a href="examples.html" title="Examples"
+ >previous</a> |</li>
+ <li class="nav-item nav-item-0"><a href="index.html">WaveVal documentation</a> »</li>
+ <li class="nav-item nav-item-this"><a href="">Batch Processing - (IFREMER Datarmor HPC)</a></li>
+ </ul>
+ </div>
+ <div class="footer" role="contentinfo">
+ © Copyright 2022.
+ Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 4.3.0.
+ </div>
+ </body>
+</html>
\ No newline at end of file
diff --git a/docs/_build/html/data_access.html b/docs/_build/html/data_access.html
new file mode 100644
index 0000000000000000000000000000000000000000..838192bbc9912d7cfb99e2d5d1677a468630d8b8
--- /dev/null
+++ b/docs/_build/html/data_access.html
@@ -0,0 +1,130 @@
+
+
+<!doctype html>
+
+<html lang="en">
+ <head>
+ <meta charset="utf-8" />
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
+
+ <title>External data archives — WaveVal documentation</title>
+ <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
+ <link rel="stylesheet" type="text/css" href="_static/bizstyle.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 src="_static/bizstyle.js"></script>
+ <link rel="author" title="About these documents" href="about.html" />
+ <link rel="index" title="Index" href="genindex.html" />
+ <link rel="search" title="Search" href="search.html" />
+ <link rel="next" title="Validation" href="Validation.html" />
+ <link rel="prev" title="Batch Processing - (IFREMER Datarmor HPC)" href="automate.html" />
+ <meta name="viewport" content="width=device-width,initial-scale=1.0" />
+ <!--[if lt IE 9]>
+ <script src="_static/css3-mediaqueries.js"></script>
+ <![endif]-->
+ </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="Validation.html" title="Validation"
+ accesskey="N">next</a> |</li>
+ <li class="right" >
+ <a href="automate.html" title="Batch Processing - (IFREMER Datarmor HPC)"
+ accesskey="P">previous</a> |</li>
+ <li class="nav-item nav-item-0"><a href="index.html">WaveVal documentation</a> »</li>
+ <li class="nav-item nav-item-this"><a href="">External data archives</a></li>
+ </ul>
+ </div>
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body" role="main">
+
+ <section id="external-data-archives">
+<h1>External data archives<a class="headerlink" href="#external-data-archives" title="Permalink to this headline">¶</a></h1>
+<section id="cmems-copernicus-marine-service">
+<h2><a class="reference external" href="https://marine.copernicus.eu/">CMEMS</a> - Copernicus Marine Service<a class="headerlink" href="#cmems-copernicus-marine-service" title="Permalink to this headline">¶</a></h2>
+<p>CMEMS data can be obtained from <a class="reference external" href="http://www.marineinsitu.eu/dashboard/">http://www.marineinsitu.eu/dashboard/</a>.
+You have to register before the data can be download,
+see <a class="reference external" href="http://www.marineinsitu.eu/access-data/">http://www.marineinsitu.eu/access-data/</a> for details on registration.</p>
+</section>
+</section>
+
+
+ <div class="clearer"></div>
+ </div>
+ </div>
+ </div>
+ <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+ <div class="sphinxsidebarwrapper">
+ <h3><a href="index.html">Table of Contents</a></h3>
+ <ul>
+<li><a class="reference internal" href="#">External data archives</a><ul>
+<li><a class="reference internal" href="#cmems-copernicus-marine-service">CMEMS - Copernicus Marine Service</a></li>
+</ul>
+</li>
+</ul>
+
+ <h4>Previous topic</h4>
+ <p class="topless"><a href="automate.html"
+ title="previous chapter">Batch Processing - (IFREMER Datarmor HPC)</a></p>
+ <h4>Next topic</h4>
+ <p class="topless"><a href="Validation.html"
+ title="next chapter">Validation</a></p>
+ <div role="note" aria-label="source link">
+ <h3>This Page</h3>
+ <ul class="this-page-menu">
+ <li><a href="_sources/data_access.rst.txt"
+ rel="nofollow">Show Source</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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
+ <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="Validation.html" title="Validation"
+ >next</a> |</li>
+ <li class="right" >
+ <a href="automate.html" title="Batch Processing - (IFREMER Datarmor HPC)"
+ >previous</a> |</li>
+ <li class="nav-item nav-item-0"><a href="index.html">WaveVal documentation</a> »</li>
+ <li class="nav-item nav-item-this"><a href="">External data archives</a></li>
+ </ul>
+ </div>
+ <div class="footer" role="contentinfo">
+ © Copyright 2022.
+ Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 4.3.0.
+ </div>
+ </body>
+</html>
\ No newline at end of file
diff --git a/docs/_build/html/examples.html b/docs/_build/html/examples.html
new file mode 100644
index 0000000000000000000000000000000000000000..1ee626a70fb1a83b4341e363ea9a0593e1806462
--- /dev/null
+++ b/docs/_build/html/examples.html
@@ -0,0 +1,280 @@
+
+
+<!doctype html>
+
+<html lang="en">
+ <head>
+ <meta charset="utf-8" />
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
+
+ <title>Examples — WaveVal documentation</title>
+ <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
+ <link rel="stylesheet" type="text/css" href="_static/bizstyle.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 src="_static/bizstyle.js"></script>
+ <link rel="author" title="About these documents" href="about.html" />
+ <link rel="index" title="Index" href="genindex.html" />
+ <link rel="search" title="Search" href="search.html" />
+ <link rel="next" title="Batch Processing - (IFREMER Datarmor HPC)" href="automate.html" />
+ <link rel="prev" title="WaveVal internal data formats" href="formats.html" />
+ <meta name="viewport" content="width=device-width,initial-scale=1.0" />
+ <!--[if lt IE 9]>
+ <script src="_static/css3-mediaqueries.js"></script>
+ <![endif]-->
+ </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="automate.html" title="Batch Processing - (IFREMER Datarmor HPC)"
+ accesskey="N">next</a> |</li>
+ <li class="right" >
+ <a href="formats.html" title="WaveVal internal data formats"
+ accesskey="P">previous</a> |</li>
+ <li class="nav-item nav-item-0"><a href="index.html">WaveVal documentation</a> »</li>
+ <li class="nav-item nav-item-this"><a href="">Examples</a></li>
+ </ul>
+ </div>
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body" role="main">
+
+ <section id="examples">
+<h1>Examples<a class="headerlink" href="#examples" title="Permalink to this headline">¶</a></h1>
+<p>Current example code is located on GitLab: <a class="reference external" href="https://git.ecdf.ed.ac.uk/uoe-ies-open-tools/WaveVal/tree/main/examples">WaveVal examples</a>.</p>
+<p>The example scripts demonstrate how the <a class="reference external" href="https://git.ecdf.ed.ac.uk/uoe-ies-open-tools/rcode_tools">WaveVal</a> tools can be used to process a set of <a class="reference external" href="https://resourcecode.ifremer.fr/">ResourceCode</a> hindcast model
+data extracts against <a class="reference external" href="http://www.marineinsitu.eu/dashboard/">CMEMS InSituTAC</a> wavebuoy data. The data for these example cases are included in the <code class="docutils literal notranslate"><span class="pre">./examples/data</span></code> subdirectory. The model extract data are in <code class="docutils literal notranslate"><span class="pre">./data/RSCD_HINDCAST/2017</span></code> and the corresponding wavebuoy
+data are in the <code class="docutils literal notranslate"><span class="pre">./data/INSITU_GLO_WAVE/MO</span></code> subdirectory. For <code class="docutils literal notranslate"><span class="pre">Example</span> <span class="pre">1</span></code> and <code class="docutils literal notranslate"><span class="pre">Example</span> <span class="pre">2</span></code> the 1-D frequency spectra
+data store in the <code class="docutils literal notranslate"><span class="pre">/FREQ_NC</span></code> subdirectory within each month directories (<em>e.g.</em> <code class="docutils literal notranslate"><span class="pre">./data/RSCD_HINDCAST/2017/01/FREQ_NC</span></code>
+contains the 1-D spectral data for January 2017).</p>
+<p><code class="docutils literal notranslate"><span class="pre">Example</span> <span class="pre">1</span></code> shows how to create a matchup database for a set of model and wavebuoy records and how to convert the
+database records to a CSV file that can be used by the <a class="reference internal" href="Validation.html#module-Validation"><span class="std std-ref">Validation</span></a> module.</p>
+<p><code class="docutils literal notranslate"><span class="pre">Example</span> <span class="pre">2</span></code> shows how to generate validation statistics for the records in a CSV input file. This example uses the output
+from Example 1, but the corresponding file is included in the <code class="docutils literal notranslate"><span class="pre">./data/MATCHUPDB</span></code> subdirectory.</p>
+<div class="admonition note">
+<p class="admonition-title">Note</p>
+<p>The example scripts use absolute paths, so the examples must be run from within the <code class="docutils literal notranslate"><span class="pre">./examples</span></code> subdirectory.</p>
+</div>
+<section id="example-1-create-a-matchup-database">
+<h2>Example 1: Create a matchup database<a class="headerlink" href="#example-1-create-a-matchup-database" title="Permalink to this headline">¶</a></h2>
+<div class="literal-block-wrapper docutils container" id="id1">
+<div class="code-block-caption"><span class="caption-text">rscd_tools_example_01_matchupdb.py</span><a class="headerlink" href="#id1" title="Permalink to this code">¶</a></div>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="linenos"> 1</span><span class="ch">#!/usr/bin/env python3</span>
+<span class="linenos"> 2</span><span class="c1"># -*- coding: utf-8 -*-</span>
+<span class="linenos"> 3</span>
+<span class="linenos"> 4</span><span class="c1"># ----------------------------------------------------------------------------</span>
+<span class="linenos"> 5</span><span class="c1"># IMPORTS</span>
+<span class="linenos"> 6</span><span class="c1"># ----------------------------------------------------------------------------</span>
+<span class="linenos"> 7</span><span class="kn">from</span> <span class="nn">waveval</span> <span class="kn">import</span> <span class="n">MatchUpDatabase</span> <span class="k">as</span> <span class="n">mdb</span>
+<span class="linenos"> 8</span>
+<span class="linenos"> 9</span><span class="c1"># ----------------------------------------------------------------------------</span>
+<span class="linenos">10</span><span class="c1"># Exampl 1: Build Match Up Database</span>
+<span class="linenos">11</span><span class="c1"># ----------------------------------------------------------------------------</span>
+<span class="linenos">12</span>
+<span class="linenos">13</span><span class="c1"># ========================= Define Database ===============================</span>
+<span class="linenos">14</span><span class="n">db_path</span> <span class="o">=</span> <span class="s1">'./data/MATCHUPDB'</span>
+<span class="linenos">15</span><span class="n">db_name</span> <span class="o">=</span> <span class="s1">'rscd_matchup'</span>
+<span class="linenos">16</span>
+<span class="linenos">17</span><span class="c1"># ==================== Construct File Filter ==============================</span>
+<span class="linenos">18</span><span class="n">scover</span> <span class="o">=</span> <span class="n">mdb</span><span class="o">.</span><span class="n">spatialCoverage</span><span class="p">(</span><span class="mf">36.00104</span><span class="p">,</span> <span class="mf">62.99896</span><span class="p">,</span> <span class="o">-</span><span class="mf">11.998958</span><span class="p">,</span> <span class="mf">13.489299</span><span class="p">)</span>
+<span class="linenos">19</span><span class="n">bfilt</span> <span class="o">=</span> <span class="n">mdb</span><span class="o">.</span><span class="n">recordFilter</span><span class="p">([</span><span class="n">scover</span><span class="p">])</span>
+<span class="linenos">20</span>
+<span class="linenos">21</span><span class="c1"># ===================== Construct Match-up Database =======================</span>
+<span class="linenos">22</span><span class="n">modDataPath</span> <span class="o">=</span> <span class="s1">'./data/RSCD_HINDCAST/2017'</span>
+<span class="linenos">23</span><span class="n">modDataset</span> <span class="o">=</span> <span class="s1">'FREQ_NC'</span>
+<span class="linenos">24</span><span class="n">months</span> <span class="o">=</span> <span class="p">[]</span>
+<span class="linenos">25</span>
+<span class="linenos">26</span><span class="n">obsDataPath</span> <span class="o">=</span> <span class="s1">'./data/INSITU_GLO_WAVE/MO'</span>
+<span class="linenos">27</span><span class="n">obsDataset</span> <span class="o">=</span> <span class="s1">'TS'</span>
+<span class="linenos">28</span><span class="n">obsDataFmt</span> <span class="o">=</span> <span class="s1">'InSituTAC'</span>
+<span class="linenos">29</span>
+<span class="linenos">30</span><span class="n">rscd_cnt</span><span class="p">,</span> <span class="n">buoy_cnt</span> <span class="o">=</span> <span class="n">mdb</span><span class="o">.</span><span class="n">construct_rscd_mdb</span><span class="p">(</span>
+<span class="linenos">31</span> <span class="n">db_path</span><span class="p">,</span> <span class="n">db_name</span><span class="p">,</span>
+<span class="linenos">32</span> <span class="n">modDataPath</span><span class="p">,</span> <span class="n">modDataset</span><span class="p">,</span> <span class="n">months</span><span class="p">,</span>
+<span class="linenos">33</span> <span class="n">obsDataPath</span><span class="p">,</span> <span class="n">obsDataset</span><span class="p">,</span> <span class="n">obsDataFmt</span><span class="p">,</span>
+<span class="linenos">34</span> <span class="n">bfilt</span><span class="p">)</span>
+<span class="linenos">35</span>
+<span class="linenos">36</span><span class="nb">print</span><span class="p">(</span><span class="s1">'MatchUp DB Created:'</span><span class="p">,</span> <span class="n">rscd_cnt</span><span class="p">,</span> <span class="s1">' model records,'</span><span class="p">,</span>
+<span class="linenos">37</span> <span class="n">buoy_cnt</span><span class="p">,</span> <span class="s1">'buoy records added.'</span><span class="p">)</span>
+<span class="linenos">38</span>
+<span class="linenos">39</span><span class="c1"># =============== Create Matched Records CSV File =========================</span>
+<span class="linenos">40</span><span class="n">csv_path</span> <span class="o">=</span> <span class="n">db_path</span>
+<span class="linenos">41</span><span class="n">csv_fname</span> <span class="o">=</span> <span class="n">db_name</span><span class="o">+</span><span class="s1">'.csv'</span>
+<span class="linenos">42</span><span class="n">mdb</span><span class="o">.</span><span class="n">db_match_to_csv</span><span class="p">(</span><span class="n">db_path</span><span class="p">,</span> <span class="n">db_name</span><span class="p">,</span> <span class="n">csv_path</span><span class="p">,</span> <span class="n">csv_fname</span><span class="p">)</span>
+<span class="linenos">43</span>
+<span class="linenos">44</span><span class="n">records</span> <span class="o">=</span> <span class="n">mdb</span><span class="o">.</span><span class="n">csv2tuples</span><span class="p">(</span><span class="n">csv_path</span><span class="o">+</span><span class="s1">'/'</span><span class="o">+</span><span class="n">csv_fname</span><span class="p">)</span>
+<span class="linenos">45</span>
+<span class="linenos">46</span><span class="c1"># Display records to be processed</span>
+<span class="linenos">47</span><span class="nb">print</span><span class="p">(</span><span class="n">records</span><span class="p">)</span>
+</pre></div>
+</div>
+</div>
+</section>
+<section id="example-2-calculate-validation-parameters">
+<h2>Example 2: Calculate validation parameters<a class="headerlink" href="#example-2-calculate-validation-parameters" title="Permalink to this headline">¶</a></h2>
+<div class="literal-block-wrapper docutils container" id="id2">
+<div class="code-block-caption"><span class="caption-text">rscd_tools_example_02_validate.py</span><a class="headerlink" href="#id2" title="Permalink to this code">¶</a></div>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="linenos"> 1</span><span class="ch">#!/usr/bin/env python3</span>
+<span class="linenos"> 2</span><span class="c1"># -*- coding: utf-8 -*-</span>
+<span class="linenos"> 3</span>
+<span class="linenos"> 4</span><span class="c1"># ----------------------------------------------------------------------------</span>
+<span class="linenos"> 5</span><span class="c1"># IMPORTS</span>
+<span class="linenos"> 6</span><span class="c1"># ----------------------------------------------------------------------------</span>
+<span class="linenos"> 7</span><span class="kn">from</span> <span class="nn">waveval.MatchUpDatabase</span> <span class="kn">import</span> <span class="n">csv2tuples</span><span class="p">,</span> <span class="n">getPlatformRecords</span><span class="p">,</span> <span class="n">getPlatformList</span>
+<span class="linenos"> 8</span><span class="kn">from</span> <span class="nn">waveval.Validation</span> <span class="kn">import</span> <span class="n">validate_records</span>
+<span class="linenos"> 9</span><span class="kn">from</span> <span class="nn">waveval.Validation</span> <span class="kn">import</span> <span class="n">save_tabulated_results</span>
+<span class="linenos">10</span>
+<span class="linenos">11</span><span class="c1"># ----------------------------------------------------------------------------</span>
+<span class="linenos">12</span><span class="c1"># Example 2: Calculate validation statistics for match records</span>
+<span class="linenos">13</span><span class="c1"># ----------------------------------------------------------------------------</span>
+<span class="linenos">14</span>
+<span class="linenos">15</span><span class="c1"># ================= Read Matched Records CSV File ===========================</span>
+<span class="linenos">16</span><span class="n">csv_path</span> <span class="o">=</span> <span class="s1">'./data/MATCHUPDB'</span>
+<span class="linenos">17</span><span class="n">csv_fname</span> <span class="o">=</span> <span class="s1">'rscd_matchup.csv'</span>
+<span class="linenos">18</span><span class="c1"># Load matched data records from CSV file</span>
+<span class="linenos">19</span><span class="n">matched_records</span> <span class="o">=</span> <span class="n">csv2tuples</span><span class="p">(</span><span class="n">csv_path</span><span class="o">+</span><span class="s1">'/'</span><span class="o">+</span><span class="n">csv_fname</span><span class="p">)</span>
+<span class="linenos">20</span><span class="c1"># Get list of uniques platform names</span>
+<span class="linenos">21</span><span class="n">platforms</span> <span class="o">=</span> <span class="n">getPlatformList</span><span class="p">(</span><span class="n">matched_records</span><span class="p">)</span>
+<span class="linenos">22</span><span class="c1"># Define wavebuoy netCDF data standard used</span>
+<span class="linenos">23</span><span class="n">buoyFmt</span> <span class="o">=</span> <span class="s1">'InSituTAC'</span>
+<span class="linenos">24</span>
+<span class="linenos">25</span><span class="c1"># ===================== Process Each Platform ===============================</span>
+<span class="linenos">26</span><span class="k">for</span> <span class="n">platform</span> <span class="ow">in</span> <span class="n">platforms</span><span class="p">:</span>
+<span class="linenos">27</span> <span class="c1"># Extract matched data records for current platform</span>
+<span class="linenos">28</span> <span class="n">records</span> <span class="o">=</span> <span class="n">getPlatformRecords</span><span class="p">(</span><span class="n">matched_records</span><span class="p">,</span><span class="n">platform</span><span class="p">)</span>
+<span class="linenos">29</span>
+<span class="linenos">30</span> <span class="c1"># ========================= Process Record ==============================</span>
+<span class="linenos">31</span> <span class="n">fields</span> <span class="o">=</span> <span class="p">[</span><span class="mi">0</span><span class="p">,</span><span class="mi">1</span><span class="p">]</span>
+<span class="linenos">32</span> <span class="k">for</span> <span class="n">field</span> <span class="ow">in</span> <span class="n">fields</span><span class="p">:</span>
+<span class="linenos">33</span> <span class="c1"># Process match up records</span>
+<span class="linenos">34</span> <span class="c1"># Choose variable to process</span>
+<span class="linenos">35</span> <span class="k">if</span> <span class="n">field</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
+<span class="linenos">36</span> <span class="n">oVarName</span> <span class="o">=</span> <span class="s1">'Hm0'</span> <span class="c1"># Significant wave height</span>
+<span class="linenos">37</span> <span class="k">if</span> <span class="n">field</span> <span class="o">==</span> <span class="mi">1</span><span class="p">:</span>
+<span class="linenos">38</span> <span class="n">oVarName</span> <span class="o">=</span> <span class="s1">'Tp'</span> <span class="c1"># Peak wave period</span>
+<span class="linenos">39</span> <span class="k">if</span> <span class="n">field</span> <span class="o">==</span> <span class="mi">2</span><span class="p">:</span>
+<span class="linenos">40</span> <span class="n">oVarName</span> <span class="o">=</span> <span class="s1">'Tm02'</span> <span class="c1"># Mean zero crossing period</span>
+<span class="linenos">41</span> <span class="k">if</span> <span class="n">field</span> <span class="o">==</span> <span class="mi">3</span><span class="p">:</span>
+<span class="linenos">42</span> <span class="n">oVarName</span> <span class="o">=</span> <span class="s1">'Dir'</span> <span class="c1"># Wave direction</span>
+<span class="linenos">43</span> <span class="k">if</span> <span class="n">field</span> <span class="o">==</span> <span class="mi">4</span><span class="p">:</span>
+<span class="linenos">44</span> <span class="n">oVarName</span> <span class="o">=</span> <span class="s1">'Spr'</span> <span class="c1"># Wave directional spreading</span>
+<span class="linenos">45</span>
+<span class="linenos">46</span> <span class="c1"># Set MDB variable names</span>
+<span class="linenos">47</span> <span class="k">if</span> <span class="n">oVarName</span> <span class="o">==</span> <span class="s1">'Hm0'</span><span class="p">:</span>
+<span class="linenos">48</span> <span class="n">mVarName</span> <span class="o">=</span> <span class="s1">'hs'</span>
+<span class="linenos">49</span> <span class="n">varOptions</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'VHM0'</span><span class="p">]</span>
+<span class="linenos">50</span> <span class="k">elif</span> <span class="n">oVarName</span> <span class="o">==</span> <span class="s1">'Tp'</span><span class="p">:</span>
+<span class="linenos">51</span> <span class="n">mVarName</span> <span class="o">=</span> <span class="s1">'fp'</span>
+<span class="linenos">52</span> <span class="n">varOptions</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'VTPK'</span><span class="p">]</span>
+<span class="linenos">53</span> <span class="k">elif</span> <span class="n">oVarName</span> <span class="o">==</span> <span class="s1">'Tm02'</span><span class="p">:</span>
+<span class="linenos">54</span> <span class="n">mVarName</span> <span class="o">=</span> <span class="s1">'f02'</span>
+<span class="linenos">55</span> <span class="n">varOptions</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'VTM02'</span><span class="p">]</span>
+<span class="linenos">56</span> <span class="k">elif</span> <span class="n">oVarName</span> <span class="o">==</span> <span class="s1">'Dir'</span><span class="p">:</span>
+<span class="linenos">57</span> <span class="n">mVarName</span> <span class="o">=</span> <span class="s1">'dir'</span>
+<span class="linenos">58</span> <span class="n">varOptions</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'VPED'</span><span class="p">]</span>
+<span class="linenos">59</span> <span class="k">elif</span> <span class="n">oVarName</span> <span class="o">==</span> <span class="s1">'Spr'</span><span class="p">:</span>
+<span class="linenos">60</span> <span class="n">mVarName</span> <span class="o">=</span> <span class="s1">'spr'</span>
+<span class="linenos">61</span> <span class="n">varOptions</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'VPSP'</span><span class="p">]</span>
+<span class="linenos">62</span>
+<span class="linenos">63</span> <span class="c1"># ================== Generate Validation Stats =======================</span>
+<span class="linenos">64</span> <span class="n">results_dir</span> <span class="o">=</span> <span class="s1">'./data/VALIDATION'</span>
+<span class="linenos">65</span> <span class="n">plot_results</span> <span class="o">=</span> <span class="kc">True</span>
+<span class="linenos">66</span> <span class="n">n_valid</span><span class="p">,</span> <span class="n">valid_stats</span> <span class="o">=</span> <span class="n">validate_records</span><span class="p">(</span><span class="n">records</span><span class="p">,</span>
+<span class="linenos">67</span> <span class="n">buoyFmt</span><span class="p">,</span> <span class="n">platform</span><span class="p">,</span>
+<span class="linenos">68</span> <span class="n">mVarName</span><span class="p">,</span> <span class="n">varOptions</span><span class="p">,</span>
+<span class="linenos">69</span> <span class="n">oVarName</span><span class="p">,</span>
+<span class="linenos">70</span> <span class="n">results_dir</span><span class="p">,</span>
+<span class="linenos">71</span> <span class="n">plot_results</span><span class="p">)</span>
+<span class="linenos">72</span>
+<span class="linenos">73</span> <span class="c1"># ================== Display Tabulated Results =======================</span>
+<span class="linenos">74</span> <span class="k">if</span> <span class="n">n_valid</span> <span class="o">></span> <span class="mi">0</span><span class="p">:</span>
+<span class="linenos">75</span> <span class="n">save_tabulated_results</span><span class="p">(</span><span class="n">valid_stats</span><span class="p">,</span> <span class="n">platform</span><span class="p">,</span> <span class="n">oVarName</span><span class="p">,</span> <span class="n">results_dir</span><span class="p">)</span>
+<span class="linenos">76</span> <span class="k">else</span><span class="p">:</span>
+<span class="linenos">77</span> <span class="nb">print</span><span class="p">(</span><span class="s1">'No validations statistics generated from match up records.'</span><span class="p">)</span>
+<span class="linenos">78</span>
+</pre></div>
+</div>
+</div>
+</section>
+</section>
+
+
+ <div class="clearer"></div>
+ </div>
+ </div>
+ </div>
+ <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+ <div class="sphinxsidebarwrapper">
+ <h3><a href="index.html">Table of Contents</a></h3>
+ <ul>
+<li><a class="reference internal" href="#">Examples</a><ul>
+<li><a class="reference internal" href="#example-1-create-a-matchup-database">Example 1: Create a matchup database</a></li>
+<li><a class="reference internal" href="#example-2-calculate-validation-parameters">Example 2: Calculate validation parameters</a></li>
+</ul>
+</li>
+</ul>
+
+ <h4>Previous topic</h4>
+ <p class="topless"><a href="formats.html"
+ title="previous chapter">WaveVal internal data formats</a></p>
+ <h4>Next topic</h4>
+ <p class="topless"><a href="automate.html"
+ title="next chapter">Batch Processing - (IFREMER Datarmor HPC)</a></p>
+ <div role="note" aria-label="source link">
+ <h3>This Page</h3>
+ <ul class="this-page-menu">
+ <li><a href="_sources/examples.rst.txt"
+ rel="nofollow">Show Source</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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
+ <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="automate.html" title="Batch Processing - (IFREMER Datarmor HPC)"
+ >next</a> |</li>
+ <li class="right" >
+ <a href="formats.html" title="WaveVal internal data formats"
+ >previous</a> |</li>
+ <li class="nav-item nav-item-0"><a href="index.html">WaveVal documentation</a> »</li>
+ <li class="nav-item nav-item-this"><a href="">Examples</a></li>
+ </ul>
+ </div>
+ <div class="footer" role="contentinfo">
+ © Copyright 2022.
+ Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 4.3.0.
+ </div>
+ </body>
+</html>
\ No newline at end of file
diff --git a/docs/_build/html/formats.html b/docs/_build/html/formats.html
new file mode 100644
index 0000000000000000000000000000000000000000..bc17c9dbb8ddf897c403df603bd5cec4c4fa4bc5
--- /dev/null
+++ b/docs/_build/html/formats.html
@@ -0,0 +1,336 @@
+
+
+<!doctype html>
+
+<html lang="en">
+ <head>
+ <meta charset="utf-8" />
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
+
+ <title>WaveVal internal data formats — WaveVal documentation</title>
+ <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
+ <link rel="stylesheet" type="text/css" href="_static/bizstyle.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 src="_static/bizstyle.js"></script>
+ <link rel="author" title="About these documents" href="about.html" />
+ <link rel="index" title="Index" href="genindex.html" />
+ <link rel="search" title="Search" href="search.html" />
+ <link rel="next" title="Examples" href="examples.html" />
+ <link rel="prev" title="Validation workflow" href="quickstart.html" />
+ <meta name="viewport" content="width=device-width,initial-scale=1.0" />
+ <!--[if lt IE 9]>
+ <script src="_static/css3-mediaqueries.js"></script>
+ <![endif]-->
+ </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="examples.html" title="Examples"
+ accesskey="N">next</a> |</li>
+ <li class="right" >
+ <a href="quickstart.html" title="Validation workflow"
+ accesskey="P">previous</a> |</li>
+ <li class="nav-item nav-item-0"><a href="index.html">WaveVal documentation</a> »</li>
+ <li class="nav-item nav-item-this"><a href="">WaveVal internal data formats</a></li>
+ </ul>
+ </div>
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body" role="main">
+
+ <section id="waveval-internal-data-formats">
+<span id="formats"></span><h1>WaveVal internal data formats<a class="headerlink" href="#waveval-internal-data-formats" title="Permalink to this headline">¶</a></h1>
+<p>The <a class="reference internal" href="Validation.html#module-Validation"><span class="std std-ref">Validation</span></a> module uses set predefined file and data formats for data input, passing, and output.
+The user input matched data records is in the form of a comma delimited CSV file, this is converted to a list
+of tuples for passing to the <a class="reference internal" href="Validation.html#module-Validation"><span class="std std-ref">Validation</span></a> process records function. Internally the validataion data are
+stored in a simple dictionary, and the data are returned in this format from the <a class="reference internal" href="Validation.html#module-Validation"><span class="std std-ref">Validation</span></a> process.
+The pre-processed time series data for a matched data pair are saved as a Matlab v4 binary file; beyond
+Matlab7.2 the data format converted to HDF5. The rationale for using a Matlab format was that Matlab is still
+widely used for data processing, but the formatted data can be easily imported into python using the
+<a class="reference external" href="https://docs.scipy.org/doc/scipy/reference/generated/scipy.io.loadmat.html">scipy.io.loadmat</a> function.</p>
+<section id="matched-data-records-csv-format">
+<h2>Matched data records CSV format<a class="headerlink" href="#matched-data-records-csv-format" title="Permalink to this headline">¶</a></h2>
+<p>The default input format for a set of model/observation data matches is a comma delimited CSV ASCII file.
+Each row in the CSV file represents a matched pair for a particular year and month; this year/month data
+fragmentation corresponds to the storage fragmentation used for archiving the ResourceCode hindcast data.</p>
+<p>The columns of each row contain:</p>
+<blockquote>
+<div><ol class="arabic simple">
+<li><p>Path to the directory containing the model extract data records</p></li>
+<li><p>Model extract data file name</p></li>
+<li><p>Path to the directory containing the observation data records</p></li>
+<li><p>Observation data file name</p></li>
+<li><p>Year to be processed</p></li>
+<li><p>Month to be processed</p></li>
+<li><p>Start date and time of observational data (space separated data and time)</p></li>
+<li><p>End data and time of observational data (space separated data and time)</p></li>
+<li><p>Platform name string</p></li>
+<li><p>Platform latitude</p></li>
+<li><p>Platform longitude</p></li>
+</ol>
+</div></blockquote>
+<p>To minimise issues with the use of different path separators across operating systems, it is recommended that
+the separator / be used for path strings.</p>
+<blockquote>
+<div><p><em>e.g.</em> E:/GitRepos/waveval/examples/data/RSCD_HINDCAST/2017/01/FREQ_NC</p>
+</div></blockquote>
+<p>File names should not include spaces or special characters as these are not currently accounted for in the readers.
+If the file names used in an archive include spaces and/or special characters the readers will need to be modified.</p>
+<p>The format for the observational data start and end date and time is yyyy-mm-dd HH:MM:SS.</p>
+<blockquote>
+<div><p><em>e.g.</em> 2005-07-04 12:35:00</p>
+</div></blockquote>
+</section>
+<section id="matched-data-records-internal-format">
+<h2>Matched data records internal format<a class="headerlink" href="#matched-data-records-internal-format" title="Permalink to this headline">¶</a></h2>
+<p>Internally the <a class="reference internal" href="Validation.html#module-Validation"><span class="std std-ref">Validation</span></a> module uses a python list of tuples, where each tuple corresponds to a
+record in the original CSV file supplied by the user. In essence the elements in a tuple corresponds to the
+CSV record field at the same location, <em>e.g.</em> the tuple elements for a record are:</p>
+<blockquote>
+<div><ol class="arabic simple">
+<li><p>tuple[0] = Path to the directory containing the model extract data records</p></li>
+<li><p>tuple[1] = Model extract data file name</p></li>
+<li><p>tuple[2] = Path to the directory containing the observation data records</p></li>
+<li><p>tuple[3] = Observation data file name</p></li>
+<li><p>tuple[4] = Year to be processed</p></li>
+<li><p>tuple[5] = Month to be processed</p></li>
+<li><p>tuple[6] = Start date and time of observational data (space separated data and time)</p></li>
+<li><p>tuple[7] = End data and time of observational data (space separated data and time)</p></li>
+<li><p>tuple[8] = Platform name string</p></li>
+</ol>
+</div></blockquote>
+</section>
+<section id="internal-validation-results-data-format">
+<h2>Internal validation results data format<a class="headerlink" href="#internal-validation-results-data-format" title="Permalink to this headline">¶</a></h2>
+<p>Internally the validation results are collected in a python data dictionary with the following key fields:</p>
+<table class="docutils align-default">
+<colgroup>
+<col style="width: 31%" />
+<col style="width: 69%" />
+</colgroup>
+<thead>
+<tr class="row-odd"><th class="head"><p>Keys</p></th>
+<th class="head"><p>Description</p></th>
+</tr>
+</thead>
+<tbody>
+<tr class="row-even"><td><p>results.MODEL</p></td>
+<td><p>Model data file name</p></td>
+</tr>
+<tr class="row-odd"><td><p>results.OBSERVATION</p></td>
+<td><p>Observation data file name</p></td>
+</tr>
+<tr class="row-even"><td><p>results.YEAR</p></td>
+<td><p>Year being processed</p></td>
+</tr>
+<tr class="row-odd"><td><p>results.MONTH</p></td>
+<td><p>Month being processed</p></td>
+</tr>
+<tr class="row-even"><td><p>results.PARAM</p></td>
+<td><p>Observation parameter name</p></td>
+</tr>
+<tr class="row-odd"><td><p>results.R</p></td>
+<td><p>Correlation value</p></td>
+</tr>
+<tr class="row-even"><td><p>results.MB</p></td>
+<td><p>Mean bias value</p></td>
+</tr>
+<tr class="row-odd"><td><p>results.NMB</p></td>
+<td><p>Normalised mean bias value</p></td>
+</tr>
+<tr class="row-even"><td><p>results.MAE</p></td>
+<td><p>Mean absolute error value</p></td>
+</tr>
+<tr class="row-odd"><td><p>results.NMAE</p></td>
+<td><p>Normalised mean absolute error value</p></td>
+</tr>
+<tr class="row-even"><td><p>results.RMSE</p></td>
+<td><p>Root mean square error value</p></td>
+</tr>
+<tr class="row-odd"><td><p>resutls.NRMSE</p></td>
+<td><p>Normalised root mean square error value</p></td>
+</tr>
+<tr class="row-even"><td><p>results.SI</p></td>
+<td><p>Scatter index value</p></td>
+</tr>
+<tr class="row-odd"><td><p>results.NSMPL</p></td>
+<td><p>Number of valid time series data samples used</p></td>
+</tr>
+</tbody>
+</table>
+<p>This structure is initialised by the <a class="reference internal" href="Validation.html#Validation.initialize_results" title="Validation.initialize_results"><code class="xref py py-func docutils literal notranslate"><span class="pre">Validation.initialize_results()</span></code></a> function, and
+results for a given matchup record are stored in the dictionary using the
+<a class="reference internal" href="Validation.html#Validation.store_valid_results" title="Validation.store_valid_results"><code class="xref py py-func docutils literal notranslate"><span class="pre">Validation.store_valid_results()</span></code></a> function.</p>
+</section>
+<section id="saved-binary-data-format">
+<h2>Saved binary data format<a class="headerlink" href="#saved-binary-data-format" title="Permalink to this headline">¶</a></h2>
+<p>To support post processing of the validation resuts, the results are stored in a binary format. This is
+currently a Matlab v4 binary format. This is generated using the <a class="reference external" href="https://docs.scipy.org/doc/scipy/reference/generated/scipy.io.savemat.html">scipy.io.savemat</a> function. This
+generates a simple binary data structure where each dictionary keys is saved as a variable using the key
+name. For post-processing exercises, the matlab formatted binary data can be loaded back into an internal
+results data dictionary using the <a class="reference internal" href="Validation.html#Validation.load_binary_results" title="Validation.load_binary_results"><code class="xref py py-func docutils literal notranslate"><span class="pre">Validation.load_binary_results()</span></code></a> function.</p>
+</section>
+<section id="saved-tabulated-ascii-data-format">
+<h2>Saved tabulated ASCII data format<a class="headerlink" href="#saved-tabulated-ascii-data-format" title="Permalink to this headline">¶</a></h2>
+<p>The results are store in a human-readable ASCII format as part of the <a class="reference internal" href="Validation.html#Validation.save_tabulated_results" title="Validation.save_tabulated_results"><code class="xref py py-func docutils literal notranslate"><span class="pre">Validation.save_tabulated_results()</span></code></a>
+call. The header line gives the integrated wave parameter that the tabulated statistics are for, the next line
+gives the table column field names, then there is a formated row for each valid result.</p>
+<p>The columns and formats are as follows:</p>
+<table class="docutils align-default">
+<colgroup>
+<col style="width: 19%" />
+<col style="width: 11%" />
+<col style="width: 70%" />
+</colgroup>
+<thead>
+<tr class="row-odd"><th class="head"><p>Field</p></th>
+<th class="head"><p>Format</p></th>
+<th class="head"><p>Description</p></th>
+</tr>
+</thead>
+<tbody>
+<tr class="row-even"><td><p>MODEL</p></td>
+<td><p>{:<60}</p></td>
+<td><p>Upto 60 characters</p></td>
+</tr>
+<tr class="row-odd"><td><p>OBSERVATION</p></td>
+<td><p>{:<25}</p></td>
+<td><p>Upto 25 characters</p></td>
+</tr>
+<tr class="row-even"><td><p>YEAR</p></td>
+<td><p>{:^7}</p></td>
+<td><p>Upto 7 digits centred</p></td>
+</tr>
+<tr class="row-odd"><td><p>MONTH</p></td>
+<td><p>{:^7}</p></td>
+<td><p>Upto 7 digits centred</p></td>
+</tr>
+<tr class="row-even"><td><p>PARAM</p></td>
+<td><p>{:^7}</p></td>
+<td><p>Upto 7 characters centred</p></td>
+</tr>
+<tr class="row-odd"><td><p>R</p></td>
+<td><p>{:^9.3}</p></td>
+<td><p>Upto 9 digits centred with 3 decimal place precision</p></td>
+</tr>
+<tr class="row-even"><td><p>MB</p></td>
+<td><p>{:^9.4}</p></td>
+<td><p>Upto 9 digits centred with 4 decimal place precision</p></td>
+</tr>
+<tr class="row-odd"><td><p>NMB</p></td>
+<td><p>{:^9.4}</p></td>
+<td><p>Upto 9 digits centred with 4 decimal place precision</p></td>
+</tr>
+<tr class="row-even"><td><p>MAE</p></td>
+<td><p>{:^9.4}</p></td>
+<td><p>Upto 9 digits centred with 4 decimal place precision</p></td>
+</tr>
+<tr class="row-odd"><td><p>NMAE</p></td>
+<td><p>{:^9.4}</p></td>
+<td><p>Upto 9 digits centred with 4 decimal place precision</p></td>
+</tr>
+<tr class="row-even"><td><p>RMSE</p></td>
+<td><p>{:^9.4}</p></td>
+<td><p>Upto 9 digits centred with 4 decimal place precision</p></td>
+</tr>
+<tr class="row-odd"><td><p>NRMSE</p></td>
+<td><p>{:^9.4}</p></td>
+<td><p>Upto 9 digits centred with 4 decimal place precision</p></td>
+</tr>
+<tr class="row-even"><td><p>SI</p></td>
+<td><p>{:^9.4}</p></td>
+<td><p>Upto 9 digits centred with 4 decimal place precision</p></td>
+</tr>
+<tr class="row-odd"><td><p>NSMPL</p></td>
+<td><p>{:^9}</p></td>
+<td><p>Upto 9 digits centred</p></td>
+</tr>
+</tbody>
+</table>
+</section>
+</section>
+
+
+ <div class="clearer"></div>
+ </div>
+ </div>
+ </div>
+ <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+ <div class="sphinxsidebarwrapper">
+ <h3><a href="index.html">Table of Contents</a></h3>
+ <ul>
+<li><a class="reference internal" href="#">WaveVal internal data formats</a><ul>
+<li><a class="reference internal" href="#matched-data-records-csv-format">Matched data records CSV format</a></li>
+<li><a class="reference internal" href="#matched-data-records-internal-format">Matched data records internal format</a></li>
+<li><a class="reference internal" href="#internal-validation-results-data-format">Internal validation results data format</a></li>
+<li><a class="reference internal" href="#saved-binary-data-format">Saved binary data format</a></li>
+<li><a class="reference internal" href="#saved-tabulated-ascii-data-format">Saved tabulated ASCII data format</a></li>
+</ul>
+</li>
+</ul>
+
+ <h4>Previous topic</h4>
+ <p class="topless"><a href="quickstart.html"
+ title="previous chapter">Validation workflow</a></p>
+ <h4>Next topic</h4>
+ <p class="topless"><a href="examples.html"
+ title="next chapter">Examples</a></p>
+ <div role="note" aria-label="source link">
+ <h3>This Page</h3>
+ <ul class="this-page-menu">
+ <li><a href="_sources/formats.rst.txt"
+ rel="nofollow">Show Source</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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
+ <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="examples.html" title="Examples"
+ >next</a> |</li>
+ <li class="right" >
+ <a href="quickstart.html" title="Validation workflow"
+ >previous</a> |</li>
+ <li class="nav-item nav-item-0"><a href="index.html">WaveVal documentation</a> »</li>
+ <li class="nav-item nav-item-this"><a href="">WaveVal internal data formats</a></li>
+ </ul>
+ </div>
+ <div class="footer" role="contentinfo">
+ © Copyright 2022.
+ Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 4.3.0.
+ </div>
+ </body>
+</html>
\ No newline at end of file
diff --git a/docs/_build/html/genindex.html b/docs/_build/html/genindex.html
new file mode 100644
index 0000000000000000000000000000000000000000..e61a39e8240d4059aff66052a45008176e67e3c9
--- /dev/null
+++ b/docs/_build/html/genindex.html
@@ -0,0 +1,677 @@
+
+
+<!doctype html>
+
+<html lang="en">
+ <head>
+ <meta charset="utf-8" />
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+ <title>Index — WaveVal documentation</title>
+ <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
+ <link rel="stylesheet" type="text/css" href="_static/bizstyle.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 src="_static/bizstyle.js"></script>
+ <link rel="author" title="About these documents" href="about.html" />
+ <link rel="index" title="Index" href="#" />
+ <link rel="search" title="Search" href="search.html" />
+ <meta name="viewport" content="width=device-width,initial-scale=1.0" />
+ <!--[if lt IE 9]>
+ <script src="_static/css3-mediaqueries.js"></script>
+ <![endif]-->
+ </head><body>
+ <div class="related" role="navigation" aria-label="related navigation">
+ <h3>Navigation</h3>
+ <ul>
+ <li class="right" style="margin-right: 10px">
+ <a href="#" 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="nav-item nav-item-0"><a href="index.html">WaveVal documentation</a> »</li>
+ <li class="nav-item nav-item-this"><a href="">Index</a></li>
+ </ul>
+ </div>
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body" role="main">
+
+
+<h1 id="index">Index</h1>
+
+<div class="genindex-jumpbox">
+ <a href="#B"><strong>B</strong></a>
+ | <a href="#C"><strong>C</strong></a>
+ | <a href="#D"><strong>D</strong></a>
+ | <a href="#E"><strong>E</strong></a>
+ | <a href="#G"><strong>G</strong></a>
+ | <a href="#H"><strong>H</strong></a>
+ | <a href="#I"><strong>I</strong></a>
+ | <a href="#L"><strong>L</strong></a>
+ | <a href="#M"><strong>M</strong></a>
+ | <a href="#N"><strong>N</strong></a>
+ | <a href="#O"><strong>O</strong></a>
+ | <a href="#P"><strong>P</strong></a>
+ | <a href="#R"><strong>R</strong></a>
+ | <a href="#S"><strong>S</strong></a>
+ | <a href="#T"><strong>T</strong></a>
+ | <a href="#V"><strong>V</strong></a>
+ | <a href="#W"><strong>W</strong></a>
+ | <a href="#Z"><strong>Z</strong></a>
+
+</div>
+<h2 id="B">B</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+ <td style="width: 33%; vertical-align: top;"><ul>
+ <li><a href="Validation.html#Validation.bias">bias() (in module Validation)</a>
+</li>
+ </ul></td>
+</tr></table>
+
+<h2 id="C">C</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+ <td style="width: 33%; vertical-align: top;"><ul>
+ <li><a href="Validation.html#Validation.calculate_circular_metrics">calculate_circular_metrics() (in module Validation)</a>
+</li>
+ <li><a href="Validation.html#Validation.calculate_metrics">calculate_metrics() (in module Validation)</a>
+</li>
+ <li><a href="Geometry.html#Geometry.cart2cmplx">cart2cmplx() (in module Geometry)</a>
+</li>
+ <li><a href="Geometry.html#Geometry.cart2pol">cart2pol() (in module Geometry)</a>
+</li>
+ <li><a href="Validation.html#Validation.circ_corr">circ_corr() (in module Validation)</a>
+</li>
+ <li><a href="Validation.html#Validation.circ_mean_abs_error">circ_mean_abs_error() (in module Validation)</a>
+</li>
+ <li><a href="Validation.html#Validation.circ_mean_bias">circ_mean_bias() (in module Validation)</a>
+</li>
+ <li><a href="Validation.html#Validation.circ_mod_pi">circ_mod_pi() (in module Validation)</a>
+</li>
+ <li><a href="Validation.html#Validation.circ_norm_ma_error">circ_norm_ma_error() (in module Validation)</a>
+</li>
+ <li><a href="Validation.html#Validation.circ_norm_mean_bias">circ_norm_mean_bias() (in module Validation)</a>
+</li>
+ <li><a href="Validation.html#Validation.circ_norm_rmse">circ_norm_rmse() (in module Validation)</a>
+</li>
+ <li><a href="Validation.html#Validation.circ_rms_error">circ_rms_error() (in module Validation)</a>
+</li>
+ </ul></td>
+ <td style="width: 33%; vertical-align: top;"><ul>
+ <li><a href="Validation.html#Validation.circ_scatter_index">circ_scatter_index() (in module Validation)</a>
+</li>
+ <li><a href="MatchUpDatabase.html#MatchUpDatabase.close_database">close_database() (in module MatchUpDatabase)</a>
+</li>
+ <li><a href="Geometry.html#Geometry.cmplx2cart">cmplx2cart() (in module Geometry)</a>
+</li>
+ <li><a href="Geometry.html#Geometry.cmplx2pol">cmplx2pol() (in module Geometry)</a>
+</li>
+ <li><a href="MatchUpDatabase.html#MatchUpDatabase.construct_rscd_mdb">construct_rscd_mdb() (in module MatchUpDatabase)</a>
+</li>
+ <li><a href="Validation.html#Validation.corr_coef">corr_coef() (in module Validation)</a>
+</li>
+ <li><a href="MatchUpDatabase.html#MatchUpDatabase.create_buoy_table">create_buoy_table() (in module MatchUpDatabase)</a>
+</li>
+ <li><a href="MatchUpDatabase.html#MatchUpDatabase.create_connection">create_connection() (in module MatchUpDatabase)</a>
+</li>
+ <li><a href="MatchUpDatabase.html#MatchUpDatabase.create_database">create_database() (in module MatchUpDatabase)</a>
+</li>
+ <li><a href="MatchUpDatabase.html#MatchUpDatabase.create_match_table">create_match_table() (in module MatchUpDatabase)</a>
+</li>
+ <li><a href="MatchUpDatabase.html#MatchUpDatabase.create_rscd_table">create_rscd_table() (in module MatchUpDatabase)</a>
+</li>
+ <li><a href="ObsData.html#ObsData.drifter.crossesDomain">crossesDomain() (ObsData.drifter method)</a>
+</li>
+ <li><a href="MatchUpDatabase.html#MatchUpDatabase.csv2tuples">csv2tuples() (in module MatchUpDatabase)</a>
+</li>
+ </ul></td>
+</tr></table>
+
+<h2 id="D">D</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+ <td style="width: 33%; vertical-align: top;"><ul>
+ <li>
+ DataFormats
+
+ <ul>
+ <li><a href="DataFormats.html#module-DataFormats">module</a>
+</li>
+ </ul></li>
+ <li><a href="TimeFuncs.html#TimeFuncs.dateNumFromStr">dateNumFromStr() (in module TimeFuncs)</a>
+</li>
+ <li><a href="TimeFuncs.html#TimeFuncs.dateStr">dateStr() (in module TimeFuncs)</a>
+</li>
+ </ul></td>
+ <td style="width: 33%; vertical-align: top;"><ul>
+ <li><a href="MatchUpDatabase.html#MatchUpDatabase.db_match_to_csv">db_match_to_csv() (in module MatchUpDatabase)</a>
+</li>
+ <li><a href="Validation.html#Validation.display_tabulated_results">display_tabulated_results() (in module Validation)</a>
+</li>
+ <li><a href="ObsData.html#ObsData.drifter">drifter (class in ObsData)</a>
+</li>
+ <li><a href="WaveSpectra.html#WaveSpectra.dsfunc">dsfunc() (in module WaveSpectra)</a>
+</li>
+ <li><a href="WaveSpectra.html#WaveSpectra.dsfuncnorm">dsfuncnorm() (in module WaveSpectra)</a>
+</li>
+ </ul></td>
+</tr></table>
+
+<h2 id="E">E</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+ <td style="width: 33%; vertical-align: top;"><ul>
+ <li><a href="ObsData.html#ObsData.emecwb">emecwb (class in ObsData)</a>
+</li>
+ </ul></td>
+ <td style="width: 33%; vertical-align: top;"><ul>
+ <li><a href="Validation.html#Validation.extract_model">extract_model() (in module Validation)</a>
+</li>
+ <li><a href="Validation.html#Validation.extract_obs">extract_obs() (in module Validation)</a>
+</li>
+ </ul></td>
+</tr></table>
+
+<h2 id="G">G</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+ <td style="width: 33%; vertical-align: top;"><ul>
+ <li><a href="ObsData.html#ObsData.emecwb.gapFillTimeseries">gapFillTimeseries() (ObsData.emecwb method)</a>
+
+ <ul>
+ <li><a href="ObsData.html#ObsData.wavebuoy.gapFillTimeseries">(ObsData.wavebuoy method)</a>
+</li>
+ </ul></li>
+ <li>
+ Geometry
+
+ <ul>
+ <li><a href="Geometry.html#module-Geometry">module</a>
+</li>
+ </ul></li>
+ <li><a href="WaveStats.html#WaveStats.get_buoy_locations">get_buoy_locations() (in module WaveStats)</a>
+</li>
+ <li><a href="MatchUpDatabase.html#MatchUpDatabase.get_match_records">get_match_records() (in module MatchUpDatabase)</a>
+</li>
+ <li><a href="WaveStats.html#WaveStats.get_metric_stats_by_buoy">get_metric_stats_by_buoy() (in module WaveStats)</a>
+</li>
+ <li><a href="WaveStats.html#WaveStats.get_metric_stats_by_year">get_metric_stats_by_year() (in module WaveStats)</a>
+</li>
+ <li><a href="WaveStats.html#WaveStats.get_metric_stats_global">get_metric_stats_global() (in module WaveStats)</a>
+</li>
+ <li><a href="ObsData.html#ObsData.get_nc_var">get_nc_var() (in module ObsData)</a>
+</li>
+ <li><a href="WaveStats.html#WaveStats.get_parameter_stats_by_buoy">get_parameter_stats_by_buoy() (in module WaveStats)</a>
+</li>
+ <li><a href="WaveStats.html#WaveStats.get_parameter_stats_by_year">get_parameter_stats_by_year() (in module WaveStats)</a>
+</li>
+ <li><a href="WaveStats.html#WaveStats.get_parameter_stats_global">get_parameter_stats_global() (in module WaveStats)</a>
+</li>
+ <li><a href="Geometry.html#Geometry.getBarycentricWeights">getBarycentricWeights() (in module Geometry)</a>
+</li>
+ <li><a href="Geometry.html#Geometry.getCentroidWeights">getCentroidWeights() (in module Geometry)</a>
+</li>
+ <li><a href="DataFormats.html#DataFormats.netcdfGeneric.getDim">getDim() (DataFormats.netcdfGeneric method)</a>
+</li>
+ <li><a href="DataFormats.html#DataFormats.netcdfGeneric.getGlobalAttr">getGlobalAttr() (DataFormats.netcdfGeneric method)</a>
+</li>
+ <li><a href="ModelData.html#ModelData.ssw_rs.getMetaData">getMetaData() (ModelData.ssw_rs method)</a>
+
+ <ul>
+ <li><a href="ModelData.html#ModelData.ww3.getMetaData">(ModelData.ww3 method)</a>
+</li>
+ <li><a href="ObsData.html#ObsData.drifter.getMetaData">(ObsData.drifter method)</a>
+</li>
+ <li><a href="ObsData.html#ObsData.emecwb.getMetaData">(ObsData.emecwb method)</a>
+</li>
+ <li><a href="ObsData.html#ObsData.wavebuoy.getMetaData">(ObsData.wavebuoy method)</a>
+</li>
+ </ul></li>
+ <li><a href="Geometry.html#Geometry.getNearestNode">getNearestNode() (in module Geometry)</a>
+</li>
+ <li><a href="Geometry.html#Geometry.getNodesWeights">getNodesWeights() (in module Geometry)</a>
+</li>
+ <li><a href="MatchUpDatabase.html#MatchUpDatabase.getPlatformList">getPlatformList() (in module MatchUpDatabase)</a>
+</li>
+ </ul></td>
+ <td style="width: 33%; vertical-align: top;"><ul>
+ <li><a href="MatchUpDatabase.html#MatchUpDatabase.getPlatformRecords">getPlatformRecords() (in module MatchUpDatabase)</a>
+</li>
+ <li><a href="ObsData.html#ObsData.emecwb.getQCTimeseries">getQCTimeseries() (ObsData.emecwb method)</a>
+
+ <ul>
+ <li><a href="ObsData.html#ObsData.wavebuoy.getQCTimeseries">(ObsData.wavebuoy method)</a>
+</li>
+ </ul></li>
+ <li><a href="ObsData.html#ObsData.emecwb.getQCVar">getQCVar() (ObsData.emecwb method)</a>
+
+ <ul>
+ <li><a href="ObsData.html#ObsData.wavebuoy.getQCVar">(ObsData.wavebuoy method)</a>
+</li>
+ </ul></li>
+ <li><a href="WaveSpectra.html#WaveSpectra.getSpectralMoments">getSpectralMoments() (in module WaveSpectra)</a>
+</li>
+ <li><a href="WaveSpectra.html#WaveSpectra.getSpectralParameters">getSpectralParameters() (in module WaveSpectra)</a>
+</li>
+ <li><a href="Validation.html#Validation.getSurfaceIndx">getSurfaceIndx() (in module Validation)</a>
+</li>
+ <li><a href="ObsData.html#ObsData.drifter.getTrackCoverage">getTrackCoverage() (ObsData.drifter method)</a>
+</li>
+ <li><a href="Geometry.html#Geometry.getTriangle">getTriangle() (in module Geometry)</a>
+</li>
+ <li><a href="Geometry.html#Geometry.getTriangleArea">getTriangleArea() (in module Geometry)</a>
+</li>
+ <li><a href="Geometry.html#Geometry.getTriangleCentroid">getTriangleCentroid() (in module Geometry)</a>
+</li>
+ <li><a href="DataFormats.html#DataFormats.netcdfGeneric.getVar">getVar() (DataFormats.netcdfGeneric method)</a>
+
+ <ul>
+ <li><a href="ModelData.html#ModelData.ssw_rs.getVar">(ModelData.ssw_rs method)</a>
+</li>
+ <li><a href="ModelData.html#ModelData.ww3.getVar">(ModelData.ww3 method)</a>
+</li>
+ <li><a href="ObsData.html#ObsData.drifter.getVar">(ObsData.drifter method)</a>
+</li>
+ <li><a href="ObsData.html#ObsData.emecwb.getVar">(ObsData.emecwb method)</a>
+</li>
+ <li><a href="ObsData.html#ObsData.wavebuoy.getVar">(ObsData.wavebuoy method)</a>
+</li>
+ </ul></li>
+ <li><a href="DataFormats.html#DataFormats.netcdfGeneric.getVarAttr">getVarAttr() (DataFormats.netcdfGeneric method)</a>
+</li>
+ <li><a href="DataFormats.html#DataFormats.netcdfGeneric.getVarAttrList">getVarAttrList() (DataFormats.netcdfGeneric method)</a>
+</li>
+ <li><a href="DataFormats.html#DataFormats.netcdfGeneric.getVarDimNames">getVarDimNames() (DataFormats.netcdfGeneric method)</a>
+</li>
+ <li><a href="DataFormats.html#DataFormats.netcdfGeneric.getVarDimSizes">getVarDimSizes() (DataFormats.netcdfGeneric method)</a>
+</li>
+ <li><a href="Validation.html#Validation.getVarName">getVarName() (in module Validation)</a>
+</li>
+ <li><a href="Geometry.html#Geometry.getWgtsMatrix">getWgtsMatrix() (in module Geometry)</a>
+</li>
+ <li>
+ Graphics
+
+ <ul>
+ <li><a href="Graphics.html#module-Graphics">module</a>
+</li>
+ </ul></li>
+ </ul></td>
+</tr></table>
+
+<h2 id="H">H</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+ <td style="width: 33%; vertical-align: top;"><ul>
+ <li><a href="DataFormats.html#DataFormats.netcdfGeneric.hasAttr">hasAttr() (DataFormats.netcdfGeneric method)</a>
+</li>
+ <li><a href="DataFormats.html#DataFormats.netcdfGeneric.hasDim">hasDim() (DataFormats.netcdfGeneric method)</a>
+</li>
+ </ul></td>
+ <td style="width: 33%; vertical-align: top;"><ul>
+ <li><a href="DataFormats.html#DataFormats.netcdfGeneric.hasGlobalAttr">hasGlobalAttr() (DataFormats.netcdfGeneric method)</a>
+</li>
+ <li><a href="DataFormats.html#DataFormats.netcdfGeneric.hasVar">hasVar() (DataFormats.netcdfGeneric method)</a>
+</li>
+ </ul></td>
+</tr></table>
+
+<h2 id="I">I</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+ <td style="width: 33%; vertical-align: top;"><ul>
+ <li><a href="MatchUpDatabase.html#MatchUpDatabase.recordFilter.includeRecord">includeRecord() (MatchUpDatabase.recordFilter method)</a>
+</li>
+ <li><a href="Validation.html#Validation.initialize_results">initialize_results() (in module Validation)</a>
+</li>
+ <li><a href="MatchUpDatabase.html#MatchUpDatabase.insert_buoy_records">insert_buoy_records() (in module MatchUpDatabase)</a>
+</li>
+ <li><a href="MatchUpDatabase.html#MatchUpDatabase.insert_match_record">insert_match_record() (in module MatchUpDatabase)</a>
+</li>
+ </ul></td>
+ <td style="width: 33%; vertical-align: top;"><ul>
+ <li><a href="MatchUpDatabase.html#MatchUpDatabase.insert_rscd_records">insert_rscd_records() (in module MatchUpDatabase)</a>
+</li>
+ <li><a href="Geometry.html#Geometry.interpTriangle">interpTriangle() (in module Geometry)</a>
+</li>
+ <li><a href="ObsData.html#ObsData.is_masked">is_masked() (in module ObsData)</a>
+</li>
+ <li><a href="Geometry.html#Geometry.isInsideTriangle">isInsideTriangle() (in module Geometry)</a>
+</li>
+ <li><a href="TimeFuncs.html#TimeFuncs.isLeapYear">isLeapYear() (in module TimeFuncs)</a>
+</li>
+ </ul></td>
+</tr></table>
+
+<h2 id="L">L</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+ <td style="width: 33%; vertical-align: top;"><ul>
+ <li><a href="DataFormats.html#DataFormats.netcdfGeneric.listDims">listDims() (DataFormats.netcdfGeneric method)</a>
+</li>
+ <li><a href="DataFormats.html#DataFormats.netcdfGeneric.listGlobalAttr">listGlobalAttr() (DataFormats.netcdfGeneric method)</a>
+</li>
+ <li><a href="DataFormats.html#DataFormats.netcdfGeneric.listVars">listVars() (DataFormats.netcdfGeneric method)</a>
+</li>
+ </ul></td>
+ <td style="width: 33%; vertical-align: top;"><ul>
+ <li><a href="Validation.html#Validation.load_binary_results">load_binary_results() (in module Validation)</a>
+</li>
+ <li><a href="MatchUpDatabase.html#MatchUpDatabase.load_buoy_archive">load_buoy_archive() (in module MatchUpDatabase)</a>
+</li>
+ <li><a href="MatchUpDatabase.html#MatchUpDatabase.load_rscd_archive">load_rscd_archive() (in module MatchUpDatabase)</a>
+</li>
+ </ul></td>
+</tr></table>
+
+<h2 id="M">M</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+ <td style="width: 33%; vertical-align: top;"><ul>
+ <li><a href="MatchUpDatabase.html#MatchUpDatabase.mapRecord">mapRecord() (in module MatchUpDatabase)</a>
+</li>
+ <li>
+ MatchUpDatabase
+
+ <ul>
+ <li><a href="MatchUpDatabase.html#module-MatchUpDatabase">module</a>
+</li>
+ </ul></li>
+ <li><a href="TimeFuncs.html#TimeFuncs.matlab2std">matlab2std() (in module TimeFuncs)</a>
+</li>
+ <li><a href="Validation.html#Validation.mean_absolute_error">mean_absolute_error() (in module Validation)</a>
+</li>
+ <li><a href="Validation.html#Validation.mean_bias">mean_bias() (in module Validation)</a>
+</li>
+ <li><a href="WaveSpectra.html#WaveSpectra.mean_wave_period">mean_wave_period() (in module WaveSpectra)</a>
+</li>
+ <li><a href="ModelData.html#ModelData.mesh2sms2dm">mesh2sms2dm() (in module ModelData)</a>
+</li>
+ <li><a href="Validation.html#Validation.model_efficiency">model_efficiency() (in module Validation)</a>
+</li>
+ <li>
+ ModelData
+
+ <ul>
+ <li><a href="ModelData.html#module-ModelData">module</a>
+</li>
+ </ul></li>
+ </ul></td>
+ <td style="width: 33%; vertical-align: top;"><ul>
+ <li>
+ module
+
+ <ul>
+ <li><a href="DataFormats.html#module-DataFormats">DataFormats</a>
+</li>
+ <li><a href="Geometry.html#module-Geometry">Geometry</a>
+</li>
+ <li><a href="Graphics.html#module-Graphics">Graphics</a>
+</li>
+ <li><a href="MatchUpDatabase.html#module-MatchUpDatabase">MatchUpDatabase</a>
+</li>
+ <li><a href="ModelData.html#module-ModelData">ModelData</a>
+</li>
+ <li><a href="ObsData.html#module-ObsData">ObsData</a>
+</li>
+ <li><a href="TimeFuncs.html#module-TimeFuncs">TimeFuncs</a>
+</li>
+ <li><a href="Validation.html#module-Validation">Validation</a>
+</li>
+ <li><a href="WaveSpectra.html#module-WaveSpectra">WaveSpectra</a>
+</li>
+ <li><a href="WaveStats.html#module-WaveStats">WaveStats</a>
+</li>
+ <li><a href="index.html#module-waveval">waveval</a>
+</li>
+ </ul></li>
+ </ul></td>
+</tr></table>
+
+<h2 id="N">N</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+ <td style="width: 33%; vertical-align: top;"><ul>
+ <li><a href="DataFormats.html#DataFormats.netcdfGeneric">netcdfGeneric (class in DataFormats)</a>
+</li>
+ <li><a href="Validation.html#Validation.norm_ma_error">norm_ma_error() (in module Validation)</a>
+</li>
+ </ul></td>
+ <td style="width: 33%; vertical-align: top;"><ul>
+ <li><a href="Validation.html#Validation.norm_mean_bias">norm_mean_bias() (in module Validation)</a>
+</li>
+ <li><a href="Validation.html#Validation.norm_rmse">norm_rmse() (in module Validation)</a>
+</li>
+ </ul></td>
+</tr></table>
+
+<h2 id="O">O</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+ <td style="width: 33%; vertical-align: top;"><ul>
+ <li>
+ ObsData
+
+ <ul>
+ <li><a href="ObsData.html#module-ObsData">module</a>
+</li>
+ </ul></li>
+ </ul></td>
+</tr></table>
+
+<h2 id="P">P</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+ <td style="width: 33%; vertical-align: top;"><ul>
+ <li><a href="Graphics.html#Graphics.plot_1d_spec">plot_1d_spec() (in module Graphics)</a>
+</li>
+ <li><a href="Graphics.html#Graphics.plot_2d_spec">plot_2d_spec() (in module Graphics)</a>
+</li>
+ <li><a href="Graphics.html#Graphics.plot_close">plot_close() (in module Graphics)</a>
+</li>
+ <li><a href="Graphics.html#Graphics.plot_correlation">plot_correlation() (in module Graphics)</a>
+</li>
+ </ul></td>
+ <td style="width: 33%; vertical-align: top;"><ul>
+ <li><a href="Graphics.html#Graphics.plot_time_series">plot_time_series() (in module Graphics)</a>
+</li>
+ <li><a href="Geometry.html#Geometry.pol2cart">pol2cart() (in module Geometry)</a>
+</li>
+ <li><a href="Geometry.html#Geometry.pol2cmplx">pol2cmplx() (in module Geometry)</a>
+</li>
+ <li><a href="Validation.html#Validation.process_record">process_record() (in module Validation)</a>
+</li>
+ </ul></td>
+</tr></table>
+
+<h2 id="R">R</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+ <td style="width: 33%; vertical-align: top;"><ul>
+ <li><a href="MatchUpDatabase.html#MatchUpDatabase.recordFilter">recordFilter (class in MatchUpDatabase)</a>
+</li>
+ <li><a href="Graphics.html#Graphics.Regional">Regional() (in module Graphics)</a>
+</li>
+ <li><a href="Graphics.html#Graphics.Regional_Weighted">Regional_Weighted() (in module Graphics)</a>
+</li>
+ </ul></td>
+ <td style="width: 33%; vertical-align: top;"><ul>
+ <li><a href="Validation.html#Validation.reliability_index">reliability_index() (in module Validation)</a>
+</li>
+ <li><a href="Validation.html#Validation.results_record">results_record() (in module Validation)</a>
+</li>
+ <li><a href="Validation.html#Validation.rms_error">rms_error() (in module Validation)</a>
+</li>
+ <li><a href="Geometry.html#Geometry.rotateVectorField">rotateVectorField() (in module Geometry)</a>
+</li>
+ </ul></td>
+</tr></table>
+
+<h2 id="S">S</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+ <td style="width: 33%; vertical-align: top;"><ul>
+ <li><a href="Validation.html#Validation.save_cleaned_ts_data">save_cleaned_ts_data() (in module Validation)</a>
+</li>
+ <li><a href="Validation.html#Validation.save_tabulated_results">save_tabulated_results() (in module Validation)</a>
+</li>
+ <li><a href="Validation.html#Validation.scatter_index">scatter_index() (in module Validation)</a>
+</li>
+ <li><a href="WaveSpectra.html#WaveSpectra.significant_wave_height">significant_wave_height() (in module WaveSpectra)</a>
+</li>
+ <li><a href="Validation.html#Validation.skill_score">skill_score() (in module Validation)</a>
+</li>
+ <li><a href="Geometry.html#Geometry.spatialCoverage">spatialCoverage (class in Geometry)</a>
+</li>
+ <li><a href="WaveSpectra.html#WaveSpectra.spec2d">spec2d() (in module WaveSpectra)</a>
+</li>
+ <li><a href="WaveSpectra.html#WaveSpectra.spec2dnorm">spec2dnorm() (in module WaveSpectra)</a>
+</li>
+ </ul></td>
+ <td style="width: 33%; vertical-align: top;"><ul>
+ <li><a href="WaveSpectra.html#WaveSpectra.spectral_narrowness">spectral_narrowness() (in module WaveSpectra)</a>
+</li>
+ <li><a href="WaveSpectra.html#WaveSpectra.spectral_period">spectral_period() (in module WaveSpectra)</a>
+</li>
+ <li><a href="WaveSpectra.html#WaveSpectra.spectral_width">spectral_width() (in module WaveSpectra)</a>
+</li>
+ <li><a href="WaveSpectra.html#WaveSpectra.spectralMoment">spectralMoment() (in module WaveSpectra)</a>
+</li>
+ <li><a href="ModelData.html#ModelData.ssw_rs">ssw_rs (class in ModelData)</a>
+</li>
+ <li><a href="ModelData.html#ModelData.sswMesh">sswMesh (class in ModelData)</a>
+</li>
+ <li><a href="TimeFuncs.html#TimeFuncs.std2matlab">std2matlab() (in module TimeFuncs)</a>
+</li>
+ <li><a href="Validation.html#Validation.store_valid_results">store_valid_results() (in module Validation)</a>
+</li>
+ </ul></td>
+</tr></table>
+
+<h2 id="T">T</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+ <td style="width: 33%; vertical-align: top;"><ul>
+ <li><a href="TimeFuncs.html#TimeFuncs.temporalCoverage">temporalCoverage (class in TimeFuncs)</a>
+</li>
+ <li><a href="WaveStats.html#WaveStats.test_for_failure">test_for_failure() (in module WaveStats)</a>
+</li>
+ <li><a href="Validation.html#Validation.time_interpolate_obs">time_interpolate_obs() (in module Validation)</a>
+</li>
+ <li>
+ TimeFuncs
+
+ <ul>
+ <li><a href="TimeFuncs.html#module-TimeFuncs">module</a>
+</li>
+ </ul></li>
+ </ul></td>
+ <td style="width: 33%; vertical-align: top;"><ul>
+ <li><a href="TimeFuncs.html#TimeFuncs.temporalCoverage.timeOverlap">timeOverlap() (TimeFuncs.temporalCoverage method)</a>
+</li>
+ <li><a href="MatchUpDatabase.html#MatchUpDatabase.touch">touch() (in module MatchUpDatabase)</a>
+</li>
+ <li><a href="MatchUpDatabase.html#MatchUpDatabase.tuples2csv">tuples2csv() (in module MatchUpDatabase)</a>
+</li>
+ </ul></td>
+</tr></table>
+
+<h2 id="V">V</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+ <td style="width: 33%; vertical-align: top;"><ul>
+ <li><a href="Validation.html#Validation.validate_records">validate_records() (in module Validation)</a>
+</li>
+ </ul></td>
+ <td style="width: 33%; vertical-align: top;"><ul>
+ <li>
+ Validation
+
+ <ul>
+ <li><a href="Validation.html#module-Validation">module</a>
+</li>
+ </ul></li>
+ </ul></td>
+</tr></table>
+
+<h2 id="W">W</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+ <td style="width: 33%; vertical-align: top;"><ul>
+ <li><a href="WaveSpectra.html#WaveSpectra.wave_energy_period">wave_energy_period() (in module WaveSpectra)</a>
+</li>
+ <li><a href="WaveSpectra.html#WaveSpectra.wave_steepness">wave_steepness() (in module WaveSpectra)</a>
+</li>
+ <li><a href="ObsData.html#ObsData.wavebuoy">wavebuoy (class in ObsData)</a>
+</li>
+ <li><a href="WaveSpectra.html#WaveSpectra.wavehgtvar">wavehgtvar() (in module WaveSpectra)</a>
+</li>
+ <li>
+ WaveSpectra
+
+ <ul>
+ <li><a href="WaveSpectra.html#module-WaveSpectra">module</a>
+</li>
+ </ul></li>
+ </ul></td>
+ <td style="width: 33%; vertical-align: top;"><ul>
+ <li>
+ WaveStats
+
+ <ul>
+ <li><a href="WaveStats.html#module-WaveStats">module</a>
+</li>
+ </ul></li>
+ <li>
+ waveval
+
+ <ul>
+ <li><a href="index.html#module-waveval">module</a>
+</li>
+ </ul></li>
+ <li><a href="ModelData.html#ModelData.ww3">ww3 (class in ModelData)</a>
+</li>
+ <li><a href="ModelData.html#ModelData.ww3Mesh">ww3Mesh (class in ModelData)</a>
+</li>
+ </ul></td>
+</tr></table>
+
+<h2 id="Z">Z</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+ <td style="width: 33%; vertical-align: top;"><ul>
+ <li><a href="WaveSpectra.html#WaveSpectra.zero_crossing_period">zero_crossing_period() (in module WaveSpectra)</a>
+</li>
+ </ul></td>
+</tr></table>
+
+
+
+ <div class="clearer"></div>
+ </div>
+ </div>
+ </div>
+ <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+ <div class="sphinxsidebarwrapper">
+<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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
+ <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="#" title="General Index"
+ >index</a></li>
+ <li class="right" >
+ <a href="py-modindex.html" title="Python Module Index"
+ >modules</a> |</li>
+ <li class="nav-item nav-item-0"><a href="index.html">WaveVal documentation</a> »</li>
+ <li class="nav-item nav-item-this"><a href="">Index</a></li>
+ </ul>
+ </div>
+ <div class="footer" role="contentinfo">
+ © Copyright 2022.
+ Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 4.3.0.
+ </div>
+ </body>
+</html>
\ No newline at end of file
diff --git a/docs/_build/html/index.html b/docs/_build/html/index.html
new file mode 100644
index 0000000000000000000000000000000000000000..c49f0e2541d9b5cc9bc8469810ed6659bead9e4b
--- /dev/null
+++ b/docs/_build/html/index.html
@@ -0,0 +1,293 @@
+
+
+<!doctype html>
+
+<html lang="en">
+ <head>
+ <meta charset="utf-8" />
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
+
+ <title>WaveVal: Wave Model Validation — WaveVal documentation</title>
+ <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
+ <link rel="stylesheet" type="text/css" href="_static/bizstyle.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 defer="defer" src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>
+ <script src="_static/bizstyle.js"></script>
+ <link rel="author" title="About these documents" href="about.html" />
+ <link rel="index" title="Index" href="genindex.html" />
+ <link rel="search" title="Search" href="search.html" />
+ <link rel="next" title="About WaveVal" href="about.html" />
+ <meta name="viewport" content="width=device-width,initial-scale=1.0" />
+ <!--[if lt IE 9]>
+ <script src="_static/css3-mediaqueries.js"></script>
+ <![endif]-->
+ </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="about.html" title="About WaveVal"
+ accesskey="N">next</a> |</li>
+ <li class="nav-item nav-item-0"><a href="#">WaveVal documentation</a> »</li>
+ <li class="nav-item nav-item-this"><a href="">WaveVal: Wave Model Validation</a></li>
+ </ul>
+ </div>
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body" role="main">
+
+ <section id="module-waveval">
+<span id="waveval-wave-model-validation"></span><h1>WaveVal: Wave Model Validation<a class="headerlink" href="#module-waveval" title="Permalink to this headline">¶</a></h1>
+<a class="reference internal image-reference" href="_images/waveval_example.png"><img alt="ResourceCode WaveVal Output." class="align-left" src="_images/waveval_example.png" style="width: 200px; height: 200px;" /></a>
+<section id="what-is-waveval">
+<h2>What is WaveVal?<a class="headerlink" href="#what-is-waveval" title="Permalink to this headline">¶</a></h2>
+<p>The <a class="reference external" href="https://git.ecdf.ed.ac.uk/uoe-ies-open-tools/WaveVal">WaveVal</a> software package was developed to support the validation of the <a class="reference external" href="https://resourcecode.ifremer.fr/">ResourceCode</a> waves hindcast database
+against the <a class="reference external" href="https://marine.copernicus.eu/">CMEMS</a> <a class="reference external" href="http://www.marineinsitu.eu/dashboard/">In Situ TAC</a> multi-year wavebuoy data archive. The waves hindcast database was generated
+using <a class="reference external" href="https://github.com/NOAA-EMC/WW3">WaveWatch III</a>, and covers the European Shelf waters for the period from 1994 to 2020. The <a class="reference external" href="https://resourcecode.ifremer.fr/">ResourceCode</a>
+web site is the front-end portal providing access to the hindcast data and a set of data analysis tools.</p>
+<p>The validation data generated by the WaveVal package are limited to the following subset of the integerated wave
+parameters:</p>
+<blockquote>
+<div><table class="docutils align-default">
+<colgroup>
+<col style="width: 35%" />
+<col style="width: 65%" />
+</colgroup>
+<thead>
+<tr class="row-odd"><th class="head"><p>Wave Parameter</p></th>
+<th class="head"><p>Description</p></th>
+</tr>
+</thead>
+<tbody>
+<tr class="row-even"><td><p><span class="math notranslate nohighlight">\(H_{m0}\)</span></p></td>
+<td><p>Significant wave height</p></td>
+</tr>
+<tr class="row-odd"><td><p><span class="math notranslate nohighlight">\(T_p\)</span></p></td>
+<td><p>Peak wave period</p></td>
+</tr>
+<tr class="row-even"><td><p><span class="math notranslate nohighlight">\(T_{m02}\)</span></p></td>
+<td><p>Mean zero-crossing period</p></td>
+</tr>
+<tr class="row-odd"><td><p><span class="math notranslate nohighlight">\(\theta_p\)</span></p></td>
+<td><p>Peak wave direction</p></td>
+</tr>
+<tr class="row-even"><td><p><span class="math notranslate nohighlight">\(\theta_{sp}\)</span></p></td>
+<td><p>Peak wave directional spreading</p></td>
+</tr>
+</tbody>
+</table>
+</div></blockquote>
+<p>Validation metrics are provided in the form of monthly statistical measures of the differences between
+overlapping time series of the modelled and observed integrated wave parameters. The metrics used are:</p>
+<blockquote>
+<div><table class="docutils align-default">
+<colgroup>
+<col style="width: 29%" />
+<col style="width: 71%" />
+</colgroup>
+<thead>
+<tr class="row-odd"><th class="head"><p>Metric</p></th>
+<th class="head"><p>Description</p></th>
+</tr>
+</thead>
+<tbody>
+<tr class="row-even"><td><p><span class="math notranslate nohighlight">\(R\)</span></p></td>
+<td><p>Pearson Correlation Coefficient</p></td>
+</tr>
+<tr class="row-odd"><td><p><span class="math notranslate nohighlight">\(MB\)</span></p></td>
+<td><p>Mean Bias</p></td>
+</tr>
+<tr class="row-even"><td><p><span class="math notranslate nohighlight">\(NMB\)</span></p></td>
+<td><p>Normalised Mean Bias</p></td>
+</tr>
+<tr class="row-odd"><td><p><span class="math notranslate nohighlight">\(MAE\)</span></p></td>
+<td><p>Mean Absolute Error</p></td>
+</tr>
+<tr class="row-even"><td><p><span class="math notranslate nohighlight">\(NMAE\)</span></p></td>
+<td><p>Normalised Mean Absolute Error</p></td>
+</tr>
+<tr class="row-odd"><td><p><span class="math notranslate nohighlight">\(RMSE\)</span></p></td>
+<td><p>Root-Mean-Square Error</p></td>
+</tr>
+<tr class="row-even"><td><p><span class="math notranslate nohighlight">\(NRMSE\)</span></p></td>
+<td><p>Normalised Root-Mean-Square Error</p></td>
+</tr>
+<tr class="row-odd"><td><p><span class="math notranslate nohighlight">\(SI\)</span></p></td>
+<td><p>Scatter Index</p></td>
+</tr>
+</tbody>
+</table>
+</div></blockquote>
+<p>Separate functions are provided to calculate the above validation metrics for circular variables
+(<em>e.g.</em> wave direction).</p>
+<p>The validation process is described on the <a class="reference internal" href="quickstart.html#workflow"><span class="std std-ref">Validation workflow</span></a> information page, and examples of using
+the tools are given on the <a class="reference internal" href="examples.html#examples"><span class="std std-ref">Examples</span></a> information page.</p>
+<p>Full source code is available from the <a class="reference external" href="https://git.ecdf.ed.ac.uk/uoe-ies-open-tools/WaveVal">GitLab</a> repository held at The University of Edinburgh.</p>
+<p>While <a class="reference external" href="https://git.ecdf.ed.ac.uk/uoe-ies-open-tools/WaveVal">WaveVal</a> is still under development, users should pull the newest code from the <a class="reference external" href="https://git.ecdf.ed.ac.uk/uoe-ies-open-tools/WaveVal">GitLab</a>
+repository regularly. If you have installed the package using the instructions below, you should not
+need to re-install after pulling new code.</p>
+<p><a class="reference external" href="https://git.ecdf.ed.ac.uk/uoe-ies-open-tools/WaveVal">WaveVal</a> is still under development and is intended to be a research tool, not production-level code.
+Please submit questions as <a class="reference external" href="https://git.ecdf.ed.ac.uk/uoe-ies-open-tools/WaveVal">GitLab</a> issues if you encounter unexpected behaviour or need help using
+<a class="reference external" href="https://git.ecdf.ed.ac.uk/uoe-ies-open-tools/WaveVal">WaveVal</a>. As of the current release, basic functionality is complete and has been tested.</p>
+</section>
+<section id="installation">
+<h2>Installation<a class="headerlink" href="#installation" title="Permalink to this headline">¶</a></h2>
+<p>First, pull down the current source code from <a class="reference external" href="https://git.ecdf.ed.ac.uk/uoe-ies-open-tools/WaveVal">GitLab</a> either by downloading a zip file or using <cite>git clone</cite>.</p>
+<p>From the command line, while in the main WaveVal directory, use the following command to install WaveVal:</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pip</span> <span class="n">install</span> <span class="o">-</span><span class="n">e</span> <span class="o">.</span><span class="p">[</span><span class="n">waveval</span><span class="p">]</span>
+</pre></div>
+</div>
+<p>The <cite>-e</cite> flag signals developer mode, meaning that if you update the code from <a class="reference external" href="https://git.ecdf.ed.ac.uk/uoe-ies-open-tools/WaveVal">Gitlab</a>, your installation will
+automatically take those changes into account without requiring re-installation.
+Some other essential packages used in <a class="reference external" href="https://git.ecdf.ed.ac.uk/uoe-ies-open-tools/WaveVal">WaveVal</a> may be installed if they do not exist in your system or environment.</p>
+<p>If you encounter problems with the above install method, you may try to install dependencies manually before
+installing <a class="reference external" href="https://git.ecdf.ed.ac.uk/uoe-ies-open-tools/WaveVal">WaveVal</a>. First, ensure you have a recent version of Python (greater than 3.5).
+Then, install packages <a class="reference external" href="https://pypi.org/project/numpy/">numpy</a>, <a class="reference external" href="https://pypi.org/project/scipy/">scipy</a>, <a class="reference external" href="https://pypi.org/project/matplotlib/">matplotlib</a>, <a class="reference external" href="https://pypi.org/project/netCDF4/">netCDF4</a>, and <a class="reference external" href="https://pypi.org/project/Cartopy/">cartopy</a>.</p>
+</section>
+<section id="information-pages">
+<h2>Information Pages<a class="headerlink" href="#information-pages" title="Permalink to this headline">¶</a></h2>
+<div class="toctree-wrapper compound">
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="about.html">About WaveVal</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="about.html#licence">Licence</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="quickstart.html">Validation workflow</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="quickstart.html#step-1-match-up-model-and-observation-data-records">Step 1: Match up model and observation data records</a></li>
+<li class="toctree-l2"><a class="reference internal" href="quickstart.html#step-2-extract-matched-data-records-from-tabulated-csv-file">Step 2: Extract matched data records from tabulated CSV file</a></li>
+<li class="toctree-l2"><a class="reference internal" href="quickstart.html#step-3-identify-unique-platforms-within-the-matched-data-records">Step 3: Identify unique platforms within the matched data records</a></li>
+<li class="toctree-l2"><a class="reference internal" href="quickstart.html#step-4-generate-validation-statistics-for-a-platform">Step 4: Generate validation statistics for a platform</a></li>
+<li class="toctree-l2"><a class="reference internal" href="quickstart.html#step-5-save-the-validation-results-for-post-processing">Step 5: Save the validation results for post-processing</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="formats.html">WaveVal internal data formats</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="formats.html#matched-data-records-csv-format">Matched data records CSV format</a></li>
+<li class="toctree-l2"><a class="reference internal" href="formats.html#matched-data-records-internal-format">Matched data records internal format</a></li>
+<li class="toctree-l2"><a class="reference internal" href="formats.html#internal-validation-results-data-format">Internal validation results data format</a></li>
+<li class="toctree-l2"><a class="reference internal" href="formats.html#saved-binary-data-format">Saved binary data format</a></li>
+<li class="toctree-l2"><a class="reference internal" href="formats.html#saved-tabulated-ascii-data-format">Saved tabulated ASCII data format</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="examples.html">Examples</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="examples.html#example-1-create-a-matchup-database">Example 1: Create a matchup database</a></li>
+<li class="toctree-l2"><a class="reference internal" href="examples.html#example-2-calculate-validation-parameters">Example 2: Calculate validation parameters</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="automate.html">Batch Processing - (IFREMER Datarmor HPC)</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="automate.html#setup-conda-environment">Setup conda environment</a></li>
+<li class="toctree-l2"><a class="reference internal" href="automate.html#construct-validation-process-scripts">Construct validation process scripts</a></li>
+<li class="toctree-l2"><a class="reference internal" href="automate.html#generate-pbs-job-scripts-and-submit-to-queue">Generate PBS job scripts and submit to queue</a></li>
+<li class="toctree-l2"><a class="reference internal" href="automate.html#post-process-validation-results">Post-process validation results</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="data_access.html">External data archives</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="data_access.html#cmems-copernicus-marine-service">CMEMS - Copernicus Marine Service</a></li>
+</ul>
+</li>
+</ul>
+</div>
+</section>
+<section id="waveval-package-content">
+<h2>WaveVal Package Content<a class="headerlink" href="#waveval-package-content" title="Permalink to this headline">¶</a></h2>
+<div class="toctree-wrapper compound">
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="Validation.html">Validation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="MatchUpDatabase.html">MatchUpDatabase</a></li>
+<li class="toctree-l1"><a class="reference internal" href="WaveStats.html">WaveStats</a></li>
+<li class="toctree-l1"><a class="reference internal" href="WaveSpectra.html">WaveSpectra</a></li>
+<li class="toctree-l1"><a class="reference internal" href="ModelData.html">ModelData</a></li>
+<li class="toctree-l1"><a class="reference internal" href="ObsData.html">ObsData</a></li>
+<li class="toctree-l1"><a class="reference internal" href="DataFormats.html">DataFormats</a></li>
+<li class="toctree-l1"><a class="reference internal" href="TimeFuncs.html">TimeFuncs</a></li>
+<li class="toctree-l1"><a class="reference internal" href="Geometry.html">Geometry</a></li>
+<li class="toctree-l1"><a class="reference internal" href="Graphics.html">Graphics</a></li>
+</ul>
+</div>
+</section>
+<section id="indices-and-tables">
+<h2>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h2>
+<ul class="simple">
+<li><p><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></p></li>
+<li><p><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></p></li>
+<li><p><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></p></li>
+</ul>
+</section>
+</section>
+
+
+ <div class="clearer"></div>
+ </div>
+ </div>
+ </div>
+ <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+ <div class="sphinxsidebarwrapper">
+ <h3><a href="#">Table of Contents</a></h3>
+ <ul>
+<li><a class="reference internal" href="#">WaveVal: Wave Model Validation</a><ul>
+<li><a class="reference internal" href="#what-is-waveval">What is WaveVal?</a></li>
+<li><a class="reference internal" href="#installation">Installation</a></li>
+<li><a class="reference internal" href="#information-pages">Information Pages</a></li>
+<li><a class="reference internal" href="#waveval-package-content">WaveVal Package Content</a></li>
+<li><a class="reference internal" href="#indices-and-tables">Indices and tables</a></li>
+</ul>
+</li>
+</ul>
+
+ <h4>Next topic</h4>
+ <p class="topless"><a href="about.html"
+ title="next chapter">About WaveVal</a></p>
+ <div role="note" aria-label="source link">
+ <h3>This Page</h3>
+ <ul class="this-page-menu">
+ <li><a href="_sources/index.rst.txt"
+ rel="nofollow">Show Source</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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
+ <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="about.html" title="About WaveVal"
+ >next</a> |</li>
+ <li class="nav-item nav-item-0"><a href="#">WaveVal documentation</a> »</li>
+ <li class="nav-item nav-item-this"><a href="">WaveVal: Wave Model Validation</a></li>
+ </ul>
+ </div>
+ <div class="footer" role="contentinfo">
+ © Copyright 2022.
+ Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 4.3.0.
+ </div>
+ </body>
+</html>
\ No newline at end of file
diff --git a/docs/_build/html/objects.inv b/docs/_build/html/objects.inv
new file mode 100644
index 0000000000000000000000000000000000000000..5e00d6f2e61de4abff0122bb9fa5a64efcf74bf5
Binary files /dev/null and b/docs/_build/html/objects.inv differ
diff --git a/docs/_build/html/py-modindex.html b/docs/_build/html/py-modindex.html
new file mode 100644
index 0000000000000000000000000000000000000000..3c5f1e5af8fbc5d5c5eb54013fc5a6aaf5456cac
--- /dev/null
+++ b/docs/_build/html/py-modindex.html
@@ -0,0 +1,183 @@
+
+
+<!doctype html>
+
+<html lang="en">
+ <head>
+ <meta charset="utf-8" />
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+ <title>Python Module Index — WaveVal documentation</title>
+ <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
+ <link rel="stylesheet" type="text/css" href="_static/bizstyle.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 src="_static/bizstyle.js"></script>
+ <link rel="author" title="About these documents" href="about.html" />
+ <link rel="index" title="Index" href="genindex.html" />
+ <link rel="search" title="Search" href="search.html" />
+
+ <meta name="viewport" content="width=device-width,initial-scale=1.0" />
+ <!--[if lt IE 9]>
+ <script src="_static/css3-mediaqueries.js"></script>
+ <![endif]-->
+
+ <script>
+ DOCUMENTATION_OPTIONS.COLLAPSE_INDEX = true;
+ </script>
+
+
+ </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="#" title="Python Module Index"
+ >modules</a> |</li>
+ <li class="nav-item nav-item-0"><a href="index.html">WaveVal documentation</a> »</li>
+ <li class="nav-item nav-item-this"><a href="">Python Module Index</a></li>
+ </ul>
+ </div>
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body" role="main">
+
+
+ <h1>Python Module Index</h1>
+
+ <div class="modindex-jumpbox">
+ <a href="#cap-d"><strong>d</strong></a> |
+ <a href="#cap-g"><strong>g</strong></a> |
+ <a href="#cap-m"><strong>m</strong></a> |
+ <a href="#cap-o"><strong>o</strong></a> |
+ <a href="#cap-t"><strong>t</strong></a> |
+ <a href="#cap-v"><strong>v</strong></a> |
+ <a href="#cap-w"><strong>w</strong></a>
+ </div>
+
+ <table class="indextable modindextable">
+ <tr class="pcap"><td></td><td> </td><td></td></tr>
+ <tr class="cap" id="cap-d"><td></td><td>
+ <strong>d</strong></td><td></td></tr>
+ <tr>
+ <td></td>
+ <td>
+ <a href="DataFormats.html#module-DataFormats"><code class="xref">DataFormats</code></a></td><td>
+ <em></em></td></tr>
+ <tr class="pcap"><td></td><td> </td><td></td></tr>
+ <tr class="cap" id="cap-g"><td></td><td>
+ <strong>g</strong></td><td></td></tr>
+ <tr>
+ <td></td>
+ <td>
+ <a href="Geometry.html#module-Geometry"><code class="xref">Geometry</code></a></td><td>
+ <em></em></td></tr>
+ <tr>
+ <td></td>
+ <td>
+ <a href="Graphics.html#module-Graphics"><code class="xref">Graphics</code></a></td><td>
+ <em></em></td></tr>
+ <tr class="pcap"><td></td><td> </td><td></td></tr>
+ <tr class="cap" id="cap-m"><td></td><td>
+ <strong>m</strong></td><td></td></tr>
+ <tr>
+ <td></td>
+ <td>
+ <a href="MatchUpDatabase.html#module-MatchUpDatabase"><code class="xref">MatchUpDatabase</code></a></td><td>
+ <em></em></td></tr>
+ <tr>
+ <td></td>
+ <td>
+ <a href="ModelData.html#module-ModelData"><code class="xref">ModelData</code></a></td><td>
+ <em></em></td></tr>
+ <tr class="pcap"><td></td><td> </td><td></td></tr>
+ <tr class="cap" id="cap-o"><td></td><td>
+ <strong>o</strong></td><td></td></tr>
+ <tr>
+ <td></td>
+ <td>
+ <a href="ObsData.html#module-ObsData"><code class="xref">ObsData</code></a></td><td>
+ <em></em></td></tr>
+ <tr class="pcap"><td></td><td> </td><td></td></tr>
+ <tr class="cap" id="cap-t"><td></td><td>
+ <strong>t</strong></td><td></td></tr>
+ <tr>
+ <td></td>
+ <td>
+ <a href="TimeFuncs.html#module-TimeFuncs"><code class="xref">TimeFuncs</code></a></td><td>
+ <em></em></td></tr>
+ <tr class="pcap"><td></td><td> </td><td></td></tr>
+ <tr class="cap" id="cap-v"><td></td><td>
+ <strong>v</strong></td><td></td></tr>
+ <tr>
+ <td></td>
+ <td>
+ <a href="Validation.html#module-Validation"><code class="xref">Validation</code></a></td><td>
+ <em></em></td></tr>
+ <tr class="pcap"><td></td><td> </td><td></td></tr>
+ <tr class="cap" id="cap-w"><td></td><td>
+ <strong>w</strong></td><td></td></tr>
+ <tr>
+ <td></td>
+ <td>
+ <a href="WaveSpectra.html#module-WaveSpectra"><code class="xref">WaveSpectra</code></a></td><td>
+ <em></em></td></tr>
+ <tr>
+ <td></td>
+ <td>
+ <a href="WaveStats.html#module-WaveStats"><code class="xref">WaveStats</code></a></td><td>
+ <em></em></td></tr>
+ <tr>
+ <td></td>
+ <td>
+ <a href="index.html#module-waveval"><code class="xref">waveval</code></a></td><td>
+ <em></em></td></tr>
+ </table>
+
+
+ <div class="clearer"></div>
+ </div>
+ </div>
+ </div>
+ <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+ <div class="sphinxsidebarwrapper">
+<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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
+ <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="#" title="Python Module Index"
+ >modules</a> |</li>
+ <li class="nav-item nav-item-0"><a href="index.html">WaveVal documentation</a> »</li>
+ <li class="nav-item nav-item-this"><a href="">Python Module Index</a></li>
+ </ul>
+ </div>
+ <div class="footer" role="contentinfo">
+ © Copyright 2022.
+ Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 4.3.0.
+ </div>
+ </body>
+</html>
\ No newline at end of file
diff --git a/docs/_build/html/quickstart.html b/docs/_build/html/quickstart.html
new file mode 100644
index 0000000000000000000000000000000000000000..6d92e75afdd5f2428d2b027490ad6fb41c1c8ddc
--- /dev/null
+++ b/docs/_build/html/quickstart.html
@@ -0,0 +1,250 @@
+
+
+<!doctype html>
+
+<html lang="en">
+ <head>
+ <meta charset="utf-8" />
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
+
+ <title>Validation workflow — WaveVal documentation</title>
+ <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
+ <link rel="stylesheet" type="text/css" href="_static/bizstyle.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 src="_static/bizstyle.js"></script>
+ <link rel="author" title="About these documents" href="about.html" />
+ <link rel="index" title="Index" href="genindex.html" />
+ <link rel="search" title="Search" href="search.html" />
+ <link rel="next" title="WaveVal internal data formats" href="formats.html" />
+ <link rel="prev" title="About WaveVal" href="about.html" />
+ <meta name="viewport" content="width=device-width,initial-scale=1.0" />
+ <!--[if lt IE 9]>
+ <script src="_static/css3-mediaqueries.js"></script>
+ <![endif]-->
+ </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="formats.html" title="WaveVal internal data formats"
+ accesskey="N">next</a> |</li>
+ <li class="right" >
+ <a href="about.html" title="About WaveVal"
+ accesskey="P">previous</a> |</li>
+ <li class="nav-item nav-item-0"><a href="index.html">WaveVal documentation</a> »</li>
+ <li class="nav-item nav-item-this"><a href="">Validation workflow</a></li>
+ </ul>
+ </div>
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body" role="main">
+
+ <section id="validation-workflow">
+<span id="workflow"></span><h1>Validation workflow<a class="headerlink" href="#validation-workflow" title="Permalink to this headline">¶</a></h1>
+<p>The core functions for generating validation metric values for a set of extracted model data
+against a wavebuoy data archive are in the following modules:</p>
+<ul class="simple">
+<li><p><a class="reference internal" href="MatchUpDatabase.html#module-MatchUpDatabase"><span class="std std-ref">MatchUpDatabase</span></a> used to generate a searchable set of model/observation data matches.</p></li>
+<li><p><a class="reference internal" href="Validation.html#module-Validation"><span class="std std-ref">Validation</span></a> used to generate validation metrics for a set of matched data records.</p></li>
+</ul>
+<p>The steps involved are as follows:</p>
+<section id="step-1-match-up-model-and-observation-data-records">
+<h2>Step 1: Match up model and observation data records<a class="headerlink" href="#step-1-match-up-model-and-observation-data-records" title="Permalink to this headline">¶</a></h2>
+<blockquote>
+<div><p>The validation process requires timeseries of data extracted for a specific location
+with in the model domain and a corresponding time record of wavebuoy data.
+The ResourceCode hindcast data are computed on an hourly basis and the data are
+stored in monthly records, sorted by year, month and data type (FREQ_NC, SPEC_NC).
+The InSituTAC wavebuoy data are available as either monthly files or a continuous
+single record file; these tools have been developed for use with the continuous
+wavebuoy records to simplify the process of the validating the complete hindcast dataset.</p>
+<p>The function for generating the matchup database is
+<a class="reference internal" href="MatchUpDatabase.html#MatchUpDatabase.construct_rscd_mdb" title="MatchUpDatabase.construct_rscd_mdb"><code class="xref py py-func docutils literal notranslate"><span class="pre">MatchUpDatabase.construct_rscd_mdb()</span></code></a>. This is used to generate an SQLite3
+database of matched buoy/model extract data by location.</p>
+<p>The validation process has been generalised to take matched data record information from a
+CSV file, allowing manual generation of the data match records without the need for
+generating an SQLite database. The SQLite matchup database can be converted to a CSV file
+using the <a class="reference internal" href="MatchUpDatabase.html#MatchUpDatabase.db_match_to_csv" title="MatchUpDatabase.db_match_to_csv"><code class="xref py py-func docutils literal notranslate"><span class="pre">MatchUpDatabase.db_match_to_csv()</span></code></a> function.</p>
+</div></blockquote>
+</section>
+<section id="step-2-extract-matched-data-records-from-tabulated-csv-file">
+<h2>Step 2: Extract matched data records from tabulated CSV file<a class="headerlink" href="#step-2-extract-matched-data-records-from-tabulated-csv-file" title="Permalink to this headline">¶</a></h2>
+<blockquote>
+<div><p>The validation process takes as input a list of a matched data records in the form of a
+tuple. The data in the CSV files is converted into the list of tuples using the function
+<a class="reference internal" href="MatchUpDatabase.html#MatchUpDatabase.csv2tuples" title="MatchUpDatabase.csv2tuples"><code class="xref py py-func docutils literal notranslate"><span class="pre">MatchUpDatabase.csv2tuples()</span></code></a>.</p>
+</div></blockquote>
+</section>
+<section id="step-3-identify-unique-platforms-within-the-matched-data-records">
+<h2>Step 3: Identify unique platforms within the matched data records<a class="headerlink" href="#step-3-identify-unique-platforms-within-the-matched-data-records" title="Permalink to this headline">¶</a></h2>
+<blockquote>
+<div><p>The records are processed by location, so the records for a particular platform need to be
+identified. The unique platform names are extracted from the list of matched data records
+using the function <a class="reference internal" href="MatchUpDatabase.html#MatchUpDatabase.getPlatformList" title="MatchUpDatabase.getPlatformList"><code class="xref py py-func docutils literal notranslate"><span class="pre">MatchUpDatabase.getPlatformList()</span></code></a>.</p>
+</div></blockquote>
+</section>
+<section id="step-4-generate-validation-statistics-for-a-platform">
+<h2>Step 4: Generate validation statistics for a platform<a class="headerlink" href="#step-4-generate-validation-statistics-for-a-platform" title="Permalink to this headline">¶</a></h2>
+<blockquote>
+<div><p>The following substeps are carried out:</p>
+<dl>
+<dt><strong>(4.1) Extract the records relevant to the current platform.</strong></dt><dd><p>The records corresponding to a given platform are extracted using the function
+<a class="reference internal" href="MatchUpDatabase.html#MatchUpDatabase.getPlatformRecords" title="MatchUpDatabase.getPlatformRecords"><code class="xref py py-func docutils literal notranslate"><span class="pre">MatchUpDatabase.getPlatformRecords()</span></code></a>.</p>
+</dd>
+<dt><strong>(4.2) Provide a list of the wave parameters to be tested</strong></dt><dd><p>The wave parameter options available are: [Hm0, Tp, Tm02, Dir, Spr]</p>
+</dd>
+<dt><strong>(4.3) Process the set of extracted matchup records</strong></dt><dd><p>The records are processed via the <a class="reference internal" href="Validation.html#Validation.validate_records" title="Validation.validate_records"><code class="xref py py-func docutils literal notranslate"><span class="pre">Validation.validate_records()</span></code></a> function.
+This loops over each record in the supplied list and processes them separately.</p>
+<p>A single record is processed by a call to the <a class="reference internal" href="Validation.html#Validation.process_record" title="Validation.process_record"><code class="xref py py-func docutils literal notranslate"><span class="pre">Validation.process_record()</span></code></a>
+function. The internal steps of the validation process for a given record are:</p>
+<blockquote>
+<div><p><em>(4.3.1) Extract model record timestamp, variable data and temporal coverage structure</em></p>
+<blockquote>
+<div><p>Call <a class="reference internal" href="Validation.html#Validation.extract_model" title="Validation.extract_model"><code class="xref py py-func docutils literal notranslate"><span class="pre">Validation.extract_model()</span></code></a></p>
+</div></blockquote>
+<p><em>(4.3.2) Extract observation record timestamp and variable data</em></p>
+<blockquote>
+<div><p>Call <a class="reference internal" href="Validation.html#Validation.extract_obs" title="Validation.extract_obs"><code class="xref py py-func docutils literal notranslate"><span class="pre">Validation.extract_obs()</span></code></a></p>
+</div></blockquote>
+<p><em>(4.3.3) Check the required buoy variable exists</em></p>
+<blockquote>
+<div><p>If the variable exists then continue process, otherwise exit record processing.</p>
+</div></blockquote>
+<p><em>(4.3.4) Check for temporal overlap between records</em></p>
+<blockquote>
+<div><p>If the time records overlap and there are at least 200 common samples then continue process,
+otherwise exit record processing.</p>
+</div></blockquote>
+<p><em>(4.3.5) Interpolate the observation variable onto the model time stamps</em></p>
+<blockquote>
+<div><p>The observations must be mapped to the model time stamps to allow the differencing required
+for metric statistics to be calculated. The interpolation method used is nearest neighbour with
+the constraint that the difference between the observation time and the model time is less
+than 1 hour. Missing observational data are filled with the <code class="docutils literal notranslate"><span class="pre">numpy.NAN</span></code> value.</p>
+<p>The function used is <a class="reference internal" href="Validation.html#Validation.time_interpolate_obs" title="Validation.time_interpolate_obs"><code class="xref py py-func docutils literal notranslate"><span class="pre">Validation.time_interpolate_obs()</span></code></a>.</p>
+<p>The model and interpolated observation data are plotted as overlayed time series if requested,
+and the model data and interpolated observational data are save as a binary file to allow rapid
+reprocessing if required.</p>
+</div></blockquote>
+<p><em>(4.3.6) Check there are sufficient valid observational values in interpolated data</em></p>
+<blockquote>
+<div><p>If there are at least 200 valid observations in the interpolated data then continue process,
+otherwise exit record processing.</p>
+</div></blockquote>
+<p><em>(4.3.7) Calculate validation metric statistics</em></p>
+<blockquote>
+<div><p>Determine the wave parameter type (standard or circular), then calculate the set of validation
+metrics for the records and save the output in the results records structure.</p>
+<ul class="simple">
+<li><p>For standard parameters call <a class="reference internal" href="Validation.html#Validation.calculate_metrics" title="Validation.calculate_metrics"><code class="xref py py-func docutils literal notranslate"><span class="pre">Validation.calculate_metrics()</span></code></a></p></li>
+<li><p>For circular parameters call <a class="reference internal" href="Validation.html#Validation.calculate_circular_metrics" title="Validation.calculate_circular_metrics"><code class="xref py py-func docutils literal notranslate"><span class="pre">Validation.calculate_circular_metrics()</span></code></a></p></li>
+</ul>
+<p>Generate and save a correlation plot if requested by calling <a class="reference internal" href="Graphics.html#Graphics.plot_correlation" title="Graphics.plot_correlation"><code class="xref py py-func docutils literal notranslate"><span class="pre">Graphics.plot_correlation()</span></code></a>.</p>
+</div></blockquote>
+<p><em>(4.3.8) Continue to next record</em></p>
+<blockquote>
+<div><p>Select next platform record and repeat steps (4.3.1) to (4.3.7)</p>
+</div></blockquote>
+</div></blockquote>
+<p><strong>(4.4) Return the full set of validation results for the current platform.</strong></p>
+<blockquote>
+<div><p>The results are returned in the form of a python data dictionary, where each element in a key field
+corresponds to a specific matched data pair record.</p>
+</div></blockquote>
+</dd>
+</dl>
+</div></blockquote>
+</section>
+<section id="step-5-save-the-validation-results-for-post-processing">
+<h2>Step 5: Save the validation results for post-processing<a class="headerlink" href="#step-5-save-the-validation-results-for-post-processing" title="Permalink to this headline">¶</a></h2>
+<blockquote>
+<div><p>The results are written out as a table formatted ASCII file, and are save as binary file
+for post-processing.</p>
+<p>This done by calling <a class="reference internal" href="Validation.html#Validation.save_tabulated_results" title="Validation.save_tabulated_results"><code class="xref py py-func docutils literal notranslate"><span class="pre">Validation.save_tabulated_results()</span></code></a>.</p>
+</div></blockquote>
+</section>
+</section>
+
+
+ <div class="clearer"></div>
+ </div>
+ </div>
+ </div>
+ <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+ <div class="sphinxsidebarwrapper">
+ <h3><a href="index.html">Table of Contents</a></h3>
+ <ul>
+<li><a class="reference internal" href="#">Validation workflow</a><ul>
+<li><a class="reference internal" href="#step-1-match-up-model-and-observation-data-records">Step 1: Match up model and observation data records</a></li>
+<li><a class="reference internal" href="#step-2-extract-matched-data-records-from-tabulated-csv-file">Step 2: Extract matched data records from tabulated CSV file</a></li>
+<li><a class="reference internal" href="#step-3-identify-unique-platforms-within-the-matched-data-records">Step 3: Identify unique platforms within the matched data records</a></li>
+<li><a class="reference internal" href="#step-4-generate-validation-statistics-for-a-platform">Step 4: Generate validation statistics for a platform</a></li>
+<li><a class="reference internal" href="#step-5-save-the-validation-results-for-post-processing">Step 5: Save the validation results for post-processing</a></li>
+</ul>
+</li>
+</ul>
+
+ <h4>Previous topic</h4>
+ <p class="topless"><a href="about.html"
+ title="previous chapter">About WaveVal</a></p>
+ <h4>Next topic</h4>
+ <p class="topless"><a href="formats.html"
+ title="next chapter">WaveVal internal data formats</a></p>
+ <div role="note" aria-label="source link">
+ <h3>This Page</h3>
+ <ul class="this-page-menu">
+ <li><a href="_sources/quickstart.rst.txt"
+ rel="nofollow">Show Source</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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
+ <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="formats.html" title="WaveVal internal data formats"
+ >next</a> |</li>
+ <li class="right" >
+ <a href="about.html" title="About WaveVal"
+ >previous</a> |</li>
+ <li class="nav-item nav-item-0"><a href="index.html">WaveVal documentation</a> »</li>
+ <li class="nav-item nav-item-this"><a href="">Validation workflow</a></li>
+ </ul>
+ </div>
+ <div class="footer" role="contentinfo">
+ © Copyright 2022.
+ Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 4.3.0.
+ </div>
+ </body>
+</html>
\ No newline at end of file
diff --git a/docs/_build/html/search.html b/docs/_build/html/search.html
new file mode 100644
index 0000000000000000000000000000000000000000..8588158ca59bfd394cf80cc25ec4d8ee95d549ea
--- /dev/null
+++ b/docs/_build/html/search.html
@@ -0,0 +1,110 @@
+
+
+<!doctype html>
+
+<html lang="en">
+ <head>
+ <meta charset="utf-8" />
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+ <title>Search — WaveVal documentation</title>
+ <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
+ <link rel="stylesheet" type="text/css" href="_static/bizstyle.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 src="_static/bizstyle.js"></script>
+ <script src="_static/searchtools.js"></script>
+ <script src="_static/language_data.js"></script>
+ <link rel="author" title="About these documents" href="about.html" />
+ <link rel="index" title="Index" href="genindex.html" />
+ <link rel="search" title="Search" href="#" />
+ <script src="searchindex.js" defer></script>
+
+ <meta name="viewport" content="width=device-width,initial-scale=1.0" />
+ <!--[if lt IE 9]>
+ <script src="_static/css3-mediaqueries.js"></script>
+ <![endif]-->
+
+ </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="nav-item nav-item-0"><a href="index.html">WaveVal documentation</a> »</li>
+ <li class="nav-item nav-item-this"><a href="">Search</a></li>
+ </ul>
+ </div>
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body" role="main">
+
+ <h1 id="search-documentation">Search</h1>
+
+ <noscript>
+ <div class="admonition warning">
+ <p>
+ Please activate JavaScript to enable the search
+ functionality.
+ </p>
+ </div>
+ </noscript>
+
+
+ <p>
+ Searching for multiple words only shows matches that contain
+ all words.
+ </p>
+
+
+ <form action="" method="get">
+ <input type="text" name="q" aria-labelledby="search-documentation" value="" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
+ <input type="submit" value="search" />
+ <span id="search-progress" style="padding-left: 10px"></span>
+ </form>
+
+
+
+ <div id="search-results">
+
+ </div>
+
+
+ <div class="clearer"></div>
+ </div>
+ </div>
+ </div>
+ <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+ <div class="sphinxsidebarwrapper">
+ </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="nav-item nav-item-0"><a href="index.html">WaveVal documentation</a> »</li>
+ <li class="nav-item nav-item-this"><a href="">Search</a></li>
+ </ul>
+ </div>
+ <div class="footer" role="contentinfo">
+ © Copyright 2022.
+ Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 4.3.0.
+ </div>
+ </body>
+</html>
\ No newline at end of file
diff --git a/docs/_build/html/searchindex.js b/docs/_build/html/searchindex.js
new file mode 100644
index 0000000000000000000000000000000000000000..ccfc95c9a83b733d988634e68d4d22f8fa23aeeb
--- /dev/null
+++ b/docs/_build/html/searchindex.js
@@ -0,0 +1 @@
+Search.setIndex({docnames:["DataFormats","Geometry","Graphics","MatchUpDatabase","ModelData","ObsData","TimeFuncs","Validation","WaveSpectra","WaveStats","about","automate","data_access","examples","formats","index","quickstart"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":4,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":3,"sphinx.domains.rst":2,"sphinx.domains.std":2,"sphinx.ext.intersphinx":1,"sphinx.ext.todo":2,"sphinx.ext.viewcode":1,sphinx:56},filenames:["DataFormats.rst","Geometry.rst","Graphics.rst","MatchUpDatabase.rst","ModelData.rst","ObsData.rst","TimeFuncs.rst","Validation.rst","WaveSpectra.rst","WaveStats.rst","about.rst","automate.rst","data_access.rst","examples.rst","formats.rst","index.rst","quickstart.rst"],objects:{"":[[0,0,0,"-","DataFormats"],[1,0,0,"-","Geometry"],[2,0,0,"-","Graphics"],[3,0,0,"-","MatchUpDatabase"],[4,0,0,"-","ModelData"],[5,0,0,"-","ObsData"],[6,0,0,"-","TimeFuncs"],[7,0,0,"-","Validation"],[8,0,0,"-","WaveSpectra"],[9,0,0,"-","WaveStats"],[15,0,0,"-","waveval"]],"DataFormats.netcdfGeneric":[[0,2,1,"","getDim"],[0,2,1,"","getGlobalAttr"],[0,2,1,"","getVar"],[0,2,1,"","getVarAttr"],[0,2,1,"","getVarAttrList"],[0,2,1,"","getVarDimNames"],[0,2,1,"","getVarDimSizes"],[0,2,1,"","hasAttr"],[0,2,1,"","hasDim"],[0,2,1,"","hasGlobalAttr"],[0,2,1,"","hasVar"],[0,2,1,"","listDims"],[0,2,1,"","listGlobalAttr"],[0,2,1,"","listVars"]],"MatchUpDatabase.recordFilter":[[3,2,1,"","includeRecord"]],"ModelData.ssw_rs":[[4,2,1,"","getMetaData"],[4,2,1,"","getVar"]],"ModelData.ww3":[[4,2,1,"","getMetaData"],[4,2,1,"","getVar"]],"ObsData.drifter":[[5,2,1,"","crossesDomain"],[5,2,1,"","getMetaData"],[5,2,1,"","getTrackCoverage"],[5,2,1,"","getVar"]],"ObsData.emecwb":[[5,2,1,"","gapFillTimeseries"],[5,2,1,"","getMetaData"],[5,2,1,"","getQCTimeseries"],[5,2,1,"","getQCVar"],[5,2,1,"","getVar"]],"ObsData.wavebuoy":[[5,2,1,"","gapFillTimeseries"],[5,2,1,"","getMetaData"],[5,2,1,"","getQCTimeseries"],[5,2,1,"","getQCVar"],[5,2,1,"","getVar"]],"TimeFuncs.temporalCoverage":[[6,2,1,"","timeOverlap"]],DataFormats:[[0,1,1,"","netcdfGeneric"]],Geometry:[[1,3,1,"","cart2cmplx"],[1,3,1,"","cart2pol"],[1,3,1,"","cmplx2cart"],[1,3,1,"","cmplx2pol"],[1,3,1,"","getBarycentricWeights"],[1,3,1,"","getCentroidWeights"],[1,3,1,"","getNearestNode"],[1,3,1,"","getNodesWeights"],[1,3,1,"","getTriangle"],[1,3,1,"","getTriangleArea"],[1,3,1,"","getTriangleCentroid"],[1,3,1,"","getWgtsMatrix"],[1,3,1,"","interpTriangle"],[1,3,1,"","isInsideTriangle"],[1,3,1,"","pol2cart"],[1,3,1,"","pol2cmplx"],[1,3,1,"","rotateVectorField"],[1,1,1,"","spatialCoverage"]],Graphics:[[2,3,1,"","Regional"],[2,3,1,"","Regional_Weighted"],[2,3,1,"","plot_1d_spec"],[2,3,1,"","plot_2d_spec"],[2,3,1,"","plot_close"],[2,3,1,"","plot_correlation"],[2,3,1,"","plot_time_series"]],MatchUpDatabase:[[3,3,1,"","close_database"],[3,3,1,"","construct_rscd_mdb"],[3,3,1,"","create_buoy_table"],[3,3,1,"","create_connection"],[3,3,1,"","create_database"],[3,3,1,"","create_match_table"],[3,3,1,"","create_rscd_table"],[3,3,1,"","csv2tuples"],[3,3,1,"","db_match_to_csv"],[3,3,1,"","getPlatformList"],[3,3,1,"","getPlatformRecords"],[3,3,1,"","get_match_records"],[3,3,1,"","insert_buoy_records"],[3,3,1,"","insert_match_record"],[3,3,1,"","insert_rscd_records"],[3,3,1,"","load_buoy_archive"],[3,3,1,"","load_rscd_archive"],[3,3,1,"","mapRecord"],[3,1,1,"","recordFilter"],[3,3,1,"","touch"],[3,3,1,"","tuples2csv"]],ModelData:[[4,3,1,"","mesh2sms2dm"],[4,1,1,"","sswMesh"],[4,1,1,"","ssw_rs"],[4,1,1,"","ww3"],[4,1,1,"","ww3Mesh"]],ObsData:[[5,1,1,"","drifter"],[5,1,1,"","emecwb"],[5,3,1,"","get_nc_var"],[5,3,1,"","is_masked"],[5,1,1,"","wavebuoy"]],TimeFuncs:[[6,3,1,"","dateNumFromStr"],[6,3,1,"","dateStr"],[6,3,1,"","isLeapYear"],[6,3,1,"","matlab2std"],[6,3,1,"","std2matlab"],[6,1,1,"","temporalCoverage"]],Validation:[[7,3,1,"","bias"],[7,3,1,"","calculate_circular_metrics"],[7,3,1,"","calculate_metrics"],[7,3,1,"","circ_corr"],[7,3,1,"","circ_mean_abs_error"],[7,3,1,"","circ_mean_bias"],[7,3,1,"","circ_mod_pi"],[7,3,1,"","circ_norm_ma_error"],[7,3,1,"","circ_norm_mean_bias"],[7,3,1,"","circ_norm_rmse"],[7,3,1,"","circ_rms_error"],[7,3,1,"","circ_scatter_index"],[7,3,1,"","corr_coef"],[7,3,1,"","display_tabulated_results"],[7,3,1,"","extract_model"],[7,3,1,"","extract_obs"],[7,3,1,"","getSurfaceIndx"],[7,3,1,"","getVarName"],[7,3,1,"","initialize_results"],[7,3,1,"","load_binary_results"],[7,3,1,"","mean_absolute_error"],[7,3,1,"","mean_bias"],[7,3,1,"","model_efficiency"],[7,3,1,"","norm_ma_error"],[7,3,1,"","norm_mean_bias"],[7,3,1,"","norm_rmse"],[7,3,1,"","process_record"],[7,3,1,"","reliability_index"],[7,3,1,"","results_record"],[7,3,1,"","rms_error"],[7,3,1,"","save_cleaned_ts_data"],[7,3,1,"","save_tabulated_results"],[7,3,1,"","scatter_index"],[7,3,1,"","skill_score"],[7,3,1,"","store_valid_results"],[7,3,1,"","time_interpolate_obs"],[7,3,1,"","validate_records"]],WaveSpectra:[[8,3,1,"","dsfunc"],[8,3,1,"","dsfuncnorm"],[8,3,1,"","getSpectralMoments"],[8,3,1,"","getSpectralParameters"],[8,3,1,"","mean_wave_period"],[8,3,1,"","significant_wave_height"],[8,3,1,"","spec2d"],[8,3,1,"","spec2dnorm"],[8,3,1,"","spectralMoment"],[8,3,1,"","spectral_narrowness"],[8,3,1,"","spectral_period"],[8,3,1,"","spectral_width"],[8,3,1,"","wave_energy_period"],[8,3,1,"","wave_steepness"],[8,3,1,"","wavehgtvar"],[8,3,1,"","zero_crossing_period"]],WaveStats:[[9,3,1,"","get_buoy_locations"],[9,3,1,"","get_metric_stats_by_buoy"],[9,3,1,"","get_metric_stats_by_year"],[9,3,1,"","get_metric_stats_global"],[9,3,1,"","get_parameter_stats_by_buoy"],[9,3,1,"","get_parameter_stats_by_year"],[9,3,1,"","get_parameter_stats_global"],[9,3,1,"","test_for_failure"]]},objnames:{"0":["py","module","Python module"],"1":["py","class","Python class"],"2":["py","method","Python method"],"3":["py","function","Python function"]},objtypes:{"0":"py:module","1":"py:class","2":"py:method","3":"py:function"},terms:{"0":[1,2,11,13,14],"00":[11,14],"00104":13,"01":[13,14],"02":11,"04":14,"07":14,"1":[1,2,11,14,15],"10":11,"100":11,"11":13,"12":14,"13":13,"15":11,"154":11,"1994":[11,15],"2":[2,8,11,14,15],"200":16,"2005":14,"2017":[13,14],"2019":11,"2020":15,"2022":10,"25":[2,14],"3":[10,11,13,14,15],"35":[11,14],"36":13,"4":[11,13,14,15],"489299":13,"5":[14,15],"500":3,"5g":11,"6":[11,14,16],"60":14,"62":13,"7":[11,14,16],"70":11,"731200":10,"8":[11,13,14,16],"9":[11,14],"998958":13,"99896":13,"case":13,"class":[0,1,3,4,5,6,10],"default":[1,11,14],"do":[10,15],"final":11,"float":[2,11],"function":[1,2,3,4,5,6,7,8,9,11,14,15,16],"import":[11,13,14],"int":[9,11],"long":10,"new":[3,11,15],"public":10,"return":[1,3,7,8,11,14,16],"true":[7,11,13],"try":[11,15],"while":15,A:[10,11,16],AND:10,AS:10,As:15,BE:10,BUT:10,BY:10,FOR:10,For:[11,13,14,16],IF:10,IN:[10,11],IS:10,If:[11,14,15,16],In:[14,15],It:11,NO:10,NOT:10,No:[11,13],OF:10,ON:10,OR:10,On:11,SUCH:10,THE:10,TO:10,The:[10,11,13,14,15,16],Then:[11,15],There:11,These:[3,6],To:[11,14],_:11,__main__:11,__name__:11,_by_buoi:11,about:[11,15],abov:[10,11,15],absolut:[7,11,13,14,15],access:[11,12,15],account:[11,14,15],across:[10,14],act:10,activ:11,ad:[11,13],add:11,advis:10,after:15,against:[10,11,13,15,16],all:10,allow:[10,11,16],amount:11,an:[3,7,11,14,16],anaconda:11,analysi:[2,15],angl:1,anglularunit:1,angular:7,angulardata:7,angularunit:1,ani:[10,11],anoth:11,append:11,appli:11,approcach:11,ar:[3,6,10,11,13,14,15,16],archiv:[3,10,11,14,15,16],archivepath:3,area:1,arg:11,argv:11,aris:10,asarrai:11,ascii:[7,11,15,16],associ:1,assum:11,astr:11,astropi:11,attrnam:0,autom:[10,11],automat:15,avail:[11,15,16],avoid:11,b:7,back:14,barycentr:1,base:[0,1,3,4,5,6,7,8,11],base_insitutac:11,basefil:11,bash:11,basi:[11,16],basic:15,batch:15,been:[10,11,15,16],befor:[11,12,15],behalf:10,behaviour:15,being:[11,14],below:15,between:[6,15,16],beyond:14,bfilt:[3,13],bia:[7,14,15],bin:[8,11,13],binari:[7,10,11,15,16],bool:[2,6],both:11,bsd:10,build:[0,13],buoi:[7,8,10,11,13,16],buoy_cnt:13,buoydatafmt:[3,7],buoydataset:3,buoyfil:7,buoyfmt:[7,11,13],buoyloc:11,buoypath:3,buoyvalid:11,busi:10,c:1,calcul:[1,7,8,11,15,16],calculate_circular_metr:[7,16],calculate_metr:[7,16],call:[11,14,16],callabl:11,can:[11,12,13,14,16],carri:16,cart2cmplx:1,cart2pol:1,cartesian:1,cartopi:[2,11,15],cartopy_offlinedata:11,caus:10,cd:11,centr:[8,14],centroid:1,chang:[11,15],channel:11,charact:14,check:[11,16],chmod:11,choos:[11,13],chunksiz:3,circ_corr:7,circ_mean_abs_error:7,circ_mean_bia:7,circ_mod_pi:7,circ_norm_ma_error:7,circ_norm_mean_bia:7,circ_norm_rms:7,circ_rms_error:7,circ_scatter_index:7,circlar:7,circular:[7,15,16],clean:7,clim:[2,11],clone:15,close:11,close_databas:3,cluster:11,cmax:2,cmem:[5,11,13,15],cmplx2cart:1,cmplx2pol:1,cmplx:1,code:[10,11,13,15],coeffici:[7,15],cofund:10,collect:[7,14],colouris:2,column:14,comma:14,command:[11,15],common:[11,16],complet:[11,15,16],complex:1,compon:11,comput:[11,16],conda:15,condarc:11,condit:10,config:11,configur:11,connect:3,consequenti:10,constraint:16,construct:[10,13,15],construct_rscd_mdb:[3,13,16],conta:11,contain:[4,7,8,9,11,13,14],continu:[11,16],contract:10,contributor:10,control:11,convent:10,convers:1,convert:[4,8,11,13,14,16],coord:1,coordin:1,copernicu:15,copi:[7,10],copyright:10,core:16,corr_coef:7,correl:[7,14,15,16],correspond:[11,13,14,16],could:11,count:[3,11],cover:15,coverag:[1,3,16],creat:[3,7,11,15],create_buoy_t:3,create_connect:3,create_databas:3,create_match_t:3,create_rscd_t:3,cross:[8,11,13,15],crossesdomain:5,csh:11,csv2tupl:[3,11,13,16],csv:[3,11,13,15],csv_file:3,csv_fname:[3,13],csv_path:[3,13],current:[11,13,14,15,16],d:[2,8,11,13],damag:10,dashboard:12,dat:11,dat_path:11,data:[0,1,3,4,5,6,7,8,10,11,13,15],dataas:3,databas:[3,15,16],datafmt:[3,7],dataformat:[4,5,15],datapath:7,datarmor:15,datarmor_insitutac_valid:11,dataset:[3,16],datawork:11,date:[6,14],datenum:6,datenumfromstr:6,datestr:6,datetim:[4,5,6],davidmkaplan:11,db:13,db_conn:3,db_file:3,db_match_to_csv:[3,13,16],db_name:[3,13],db_path:[3,13],dd:14,deactiv:11,decim:14,def:11,defin:[1,11,13],definit:4,degre:[1,7],degress:1,delimit:14,demonstr:13,densiti:8,depend:[0,1,2,3,4,5,6,7,8,9,11,15],depth:7,deriv:10,describ:[11,15],descript:[8,11,14,15],design:11,detail:12,determin:[1,16],develop:[10,11,15,16],df:8,dictionari:[7,11,14,16],differ:[10,14,15,16],differenc:16,digit:14,dimnam:0,dir:[11,13,16],direct:[8,10,11,13,15],directori:[11,13,14,15],disclaim:10,displai:[2,7,10,13],display_tabulated_result:7,distanc:1,distribut:10,document:10,doe:11,dom:11,domain:[5,10,16],done:16,down:15,download:[12,15],dpath:[9,11],drifter:5,dsfnc:8,dsfunc:8,dsfuncnorm:8,dt:8,dtype:11,dure:11,e:[11,13,14,15],each:[11,13,14,16],easili:14,ec:10,edinburgh:[10,15],editor:11,effici:7,either:[15,16],element:[14,16],elif:[11,13],els:[11,13],emec:5,emecwb:5,encount:15,end:[11,14,15],endors:10,energi:8,engin:10,ensur:15,enter:11,enterpris:10,enumer:11,env:[11,13],enviro:11,environ:15,envs_dir:11,ep:8,error:[7,11,14,15],essenc:14,essenti:15,estim:11,etc:11,eu:12,european:15,even:10,event:10,exampl:[14,15],except:11,execut:11,exemplari:10,exercis:14,exist:[11,15,16],exit:[11,16],express:10,extern:[0,1,2,3,4,5,6,7,8,9,15],extract:[3,4,7,10,13,14,15],extract_model:[7,16],extract_ob:[7,16],extranet:11,f02:[11,13],f:[8,11],facillit:11,factor:2,fail:11,fals:[2,3,7,11],featur:11,field:[11,13,14,16],fighnd:2,file:[0,3,4,5,7,9,11,13,14,15],filenam:[0,4,5],fill:16,filter:13,first:[11,15],fit:10,fix:7,flag:[11,15],fmax:2,fname:11,focu:10,follow:[10,11,14,15,16],foramt:7,forg:11,form:[10,14,15,16],format:[0,4,5,8,10,11,15,16],found:11,fp:[11,13],fr:11,fragment:14,freq:[2,8],freq_nc:[13,14,16],frequenc:[2,8,11,13],from:[1,2,3,4,7,8,10,11,12,13,14,15],front:15,frquenci:8,full:[11,15,16],fund:10,g:[11,13,14,15],ga:10,gapfilltimeseri:5,gener:[0,1,2,3,8,10,13,14,15],generalis:16,generate_validation_batch_job:11,genplot:11,geometri:[4,5,7,15],geomteri:3,get:[7,11,13],get_buoy_loc:[9,11],get_match_record:3,get_metric_stats_by_buoi:9,get_metric_stats_by_year:9,get_metric_stats_glob:9,get_nc_var:5,get_parameter_stats_by_buoi:[9,11],get_parameter_stats_by_year:9,get_parameter_stats_glob:[9,11],getbarycentricweight:1,getcentroidweight:1,getdim:0,getglobalattr:0,getmetadata:[4,5],getnearestnod:1,getnodesweight:1,getopt:11,getopterror:11,getplatformlist:[3,13,16],getplatformrecord:[3,13,16],getqctimeseri:5,getqcvar:5,getspectralmo:8,getspectralparamet:8,getsurfaceindx:7,gettrackcoverag:5,gettriangl:1,gettrianglearea:1,gettrianglecentroid:1,getvar:[0,4,5],getvarattr:0,getvarattrlist:0,getvardimnam:0,getvardims:0,getvarnam:7,getwgtsmatrix:1,git:15,gitlab:[13,15],gitrepo:14,give:[11,14],given:[8,10,11,14,15,16],global:11,good:10,grant:10,graphic:[11,15,16],greater:[11,15],h:11,h_:15,ha:[10,11,15,16],hasattr:0,hasdim:0,hasglobalattr:0,hasvar:0,have:[10,11,12,15,16],hdf5:14,header:[11,14],height:[8,11,13,15],held:15,help:15,here:11,hh:14,hindcast:[3,10,11,13,14,15,16],hm0:[8,11,13,16],holder:10,home1:11,home:11,hour:16,hourli:16,how:[11,13],howev:10,hp:11,hpc:15,hs:[11,13],html:11,http:[11,12],human:14,i:[10,11],idenfii:11,identifi:15,idx:11,ifrem:[8,15],iii:[3,11,15],implement:11,impli:10,incident:10,includ:[10,11,13,14],includerecord:3,index:[7,11,14,15],indirect:10,individu:11,indx:11,infil:11,info:11,inform:[10,11,16],initialis:[7,14],initialize_result:[7,14],input:[11,13,14,16],insert_buoy_record:3,insert_match_record:3,insert_rscd_record:3,insitu_glo_wav:13,insitutac:[11,13,16],insitutac_job_:11,insitutac_ts_:11,insitutac_validation_sit:11,instal:11,instruct:[11,15],insuffici:11,integer:15,integr:[8,10,11,14,15],intend:15,interfac:11,interg:8,intern:[0,1,2,3,4,5,6,7,8,9,11,15,16],interog:0,interpol:[1,7,16],interptriangl:1,interrupt:10,intranet:11,involv:16,io:14,irec:11,irrevoc:10,is_mask:5,isinsidetriangl:1,isleapyear:6,issu:[14,15],its:[10,11],itself:10,januari:13,job:15,join:11,jy:1,kei:[14,16],l:11,larg:[10,11],last:11,lat:[1,2,11],lat_div:2,lat_max:1,lat_min:1,latest:11,latitud:[11,14],layer:7,least:[11,16],len:11,less:[11,16],level:15,li:1,liabil:10,liabl:10,licenc:15,limit:[10,15],line:[11,14,15],link:10,list:[2,3,7,9,10,11,13,14,16],listdim:0,listglobalattr:0,listvar:0,load:[0,4,5,7,13,14],load_binary_result:[7,14],load_buoy_arch:3,load_rscd_arch:3,loader:0,loadmat:14,local:11,locat:[1,2,10,11,13,14,16],loci:1,locx:1,login:11,lon:[1,2,11],lon_div:2,lon_max:1,lon_min:1,longitud:[11,14],loop:[11,16],loss:10,m02:15,m0:15,m:11,mae:[7,11,14,15],mai:[10,15],main:[11,15],maintain:10,manipul:6,manual:[15,16],map:[2,7,8,11,16],maprecord:[3,11],marin:[4,15],marineinsitu:12,mat:7,match:[7,10,11,13,15],match_fil:3,matched_record:13,matchup:[3,7,14,15,16],matchupdatabas:[7,11,13,15,16],matchupdb:13,materi:10,matlab2std:6,matlab7:14,matlab:[7,14],matplotlib:[2,11,15],maximum:11,maxyear:11,mb:[7,11,14,15],mdb:[11,13],mean:[7,8,11,13,14,15],mean_absolute_error:7,mean_bia:7,mean_wave_period:8,meanv:9,measur:[10,15],med:8,mef:7,mem:11,memori:11,merchant:10,mesh2sms2dm:4,mesh:[1,4],meshfil:4,met:10,method:[1,10,11,15,16],metric:[2,7,9,11,15,16],metricstr:[9,11],minimis:14,minimum:11,minyear:11,miss:[11,16],mm:14,mo:13,moddatapath:13,moddataset:13,mode:15,model:[2,3,4,7,10,11,13,14],model_effici:7,modeldata:[3,7,15],modelfilenam:7,modfnam:2,modif:10,modifi:[11,14],modul:[7,8,9,11,13,14,15,16],modularis:10,modvar:2,moment:[8,10],month:[2,3,7,11,13,14,16],monthli:[15,16],motiv:10,multi:15,must:[10,11,13,16],mvarnam:[7,11,13],n:11,n_valid:[11,13],name:[7,10,11,13,14,16],nan:16,nano:11,narrow:8,nchnd:5,ndbc:8,nearest:16,need:[11,14,15,16],neglig:10,neighbour:16,neither:10,net:10,netcdf4:[0,6,10,11,15],netcdf:[4,5,10,11,13],netcdfgener:[0,4,5],newest:15,next:[11,14,16],nmae:[7,11,14,15],nmb:[7,11,14,15],noaa:8,node:[1,11],non:11,none:[2,3,11],nonexclus:10,nor:10,norm_ma_error:7,norm_mean_bia:7,norm_rms:7,normalis:[7,8,14,15],normlais:8,note:11,notic:10,np:11,nrmse:[7,11,14,15],nsampl:7,nsmpl:14,nstp:1,ntheta:[2,8],nu:8,num_rec:11,number:[1,11,14],numer:[4,10],numpi:[0,1,4,5,7,8,9,11,15,16],nwght:1,ob:[2,7],object:[0,1,3,4,6],obsdata:[3,7,15],obsdatafmt:13,obsdatapath:13,obsdataset:13,observ:[2,5,7,10,11,14,15],obsfilenam:7,obsplatform:2,obsvar:2,obsvarnam:7,obtain:12,oceanera:10,ofnam:11,onc:11,one:11,onli:11,onto:[1,7,16],open:[3,10,11],oper:14,opt:11,optin:11,option:[2,7,11,16],origin:14,os:[0,3,4,5,7,9,11],other:[10,11,15],otherwis:[10,16],ouput:11,out:[10,16],outfil:[4,11],outnam:2,outpath:[2,4,7],output:[4,7,11,13,14,16],ovarnam:[11,13],over:[11,16],overlai:16,overlaid:2,overlap:[15,16],p1:1,p2:1,p3:1,p:[1,11],packag:[1,10,11],page:[8,11],pai:11,paid:10,pair:[7,14,16],param:[9,11,14],paramet:[1,2,3,7,8,10,11,14,15,16],paramstr:11,pars:11,part:[11,14],particular:[10,14,16],pass:[11,14],path:[3,11,13,14],pb:15,pbd:11,peak:[8,11,13,15],pearson:15,perform:10,period:[8,11,13,15],permiss:[10,11],permit:10,pfnam:11,pfrm:11,pi:7,pip:15,pkg:11,pkgs_dir:11,place:[11,14],platform:[3,7,11,13,14,15],pleas:15,plot:[2,11,16],plot_1d_spec:2,plot_2d_spec:2,plot_area:2,plot_clos:2,plot_correl:[2,16],plot_result:[7,11,13],plot_time_seri:2,plottitl:2,plttitl:11,pname:11,point:1,pol2cart:1,pol2cmplx:1,polar:1,popul:3,port:11,portal:15,posit:1,possibl:10,post:[9,14,15],ppath:11,pre:14,precis:14,predefin:14,prefer:11,prepar:10,print:[11,13],prior:[10,11],problem:15,proces:11,process:[7,9,10,13,14,15],process_insitutac_stat:11,process_record:[7,16],processs:7,procstr:11,procur:10,produc:[10,11],product:[10,15],profil:11,profit:10,program:11,project:10,promot:10,provid:[10,11,15,16],publicli:10,publish:10,pull:15,purpos:[10,11],pvarnam:7,py:[11,13],pycod:11,python3:[11,13],python:[11,14,15,16],qsub:11,queri:3,question:15,queue:15,r:[1,7,11,14,15],radial:1,radian:[1,7],radii:1,rang:[1,7,11],rapid:16,rational:14,re:[3,11,15],read:[4,5,13],readabl:14,reader:[10,14],rec:[7,11],rec_fil:11,rec_list:11,recent:15,recfil:11,recfilt:3,recnum:11,recod:7,recommend:[11,14],reconstruct:8,record:[3,7,9,10,11,13,15],record_nmb:11,recordfilt:[3,13],records_fil:11,redistribut:10,region:2,regional_weight:[2,11],regist:12,registr:12,regularli:15,releas:15,relev:16,reliability_index:7,reliabl:7,rememb:11,remot:11,repeat:16,replac:11,repositori:15,repres:[8,11,14],reprocess:16,reproduc:10,request:[11,16],requir:[10,11,15,16],rerun:11,research:15,reserv:10,resourc:11,resourcecod:[3,4,10,11,13,14,15,16],resul:2,result:[7,13,15],results_dir:[7,13],results_record:7,resut:14,resutl:14,retain:10,retriev:8,ri:7,right:10,rms_error:7,rmse:[7,11,14,15],root:[7,11,14,15],rotatevectorfield:1,row:[3,14],rscd:7,rscd_2017_matchup_v03:11,rscd_cnt:13,rscd_file:3,rscd_hindcast:[13,14],rscd_matchup:13,rscd_tools_example_01_matchupdb:13,rscd_tools_example_02_valid:13,rscd_v3:11,rscddataset:3,rscdfile:7,rscdpath:3,run:[11,13],runtim:11,s:8,same:14,sampl:[14,16],save:[7,11,15],save_cleaned_ts_data:7,save_tabulated_result:[7,11,13,14,16],savemat:14,saveplot:[2,11],scatter:[7,14,15],scatter_index:7,school:10,scipi:[7,9,14,15],score:7,scotland:4,scottish:10,scover:13,script:[13,15],search:15,searchabl:16,section:11,see:12,select:[11,16],separ:[11,14,15,16],seri:[2,7,14,15,16],servic:[10,11,15],set:[0,1,3,7,10,11,13,14,15,16],setup:15,sf:8,shall:10,shebang:11,shelf:15,shell:11,should:[11,14,15],show:13,si:[7,11,14,15],signal:15,signific:[8,11,13,15],significant_wave_height:8,similar:11,similarli:11,simpl:14,simplifi:16,simul:10,singl:[11,16],site:[8,15],situ:[7,10,11,15],skill:7,skill_scor:7,sms2dm:4,so:[10,11,13,16],softwar:[10,15],some:15,sort:16,sourc:[0,1,2,3,4,5,6,7,8,9,10,11,15],sp:15,space:[8,11,14],spatial:1,spatialcoverag:[1,5,13],spec1d:2,spec2d:[2,8],spec2dnorm:8,spec_1d:2,spec_nc:16,special:[10,14],specif:[0,2,10,11,16],specifi:[2,3,7],specmom:8,spectra:[8,13],spectral:[8,10,13],spectral_narrow:8,spectral_period:8,spectral_width:8,spectralmo:8,spectrum:[2,8],split:11,spr:[11,13,16],spread:[8,11,13,15],spyder:11,sql_queri:3,sqlite3:16,sqlite:[3,16],squar:[7,14,15],ss:[7,14],ssw:4,ssw_r:4,sswfile:4,sswmesh:4,stage:11,stamp:[6,7,16],standard:[7,8,10,11,13,16],standardis:[2,6],start:14,start_rec:11,startyr:3,stat:[11,13],statist:[7,9,11,13,14,15],std2matlab:6,steep:8,step:[11,15],sth1:8,sth2:8,still:[14,15],stopyr:3,storag:14,store:[5,7,13,14,16],store_valid_result:[7,14],str:[2,3,6,7,9,11],strict:10,string:[11,14],strip:11,structur:[0,4,5,11,14,16],subdirectori:13,submiss:11,submit:15,subset:[11,15],substep:16,substitut:10,suffcient:10,suffici:16,suitabl:11,suppli:[14,16],support:[11,14,15],surfac:7,sy:11,system:[11,14,15],t:[7,11],t_:15,t_mod:2,t_model:7,t_ob:[2,7],t_p:15,t_var:7,tabl:[3,7,14,16],tabul:[7,11,13,15],tac:[11,15],take:[11,15,16],taken:11,tdw2:8,tempor:16,temporalcoverag:6,term:10,test:[15,16],test_for_failur:9,text:11,th1:8,th2:8,th:11,than:[11,15,16],thei:15,them:16,theori:10,theta1:7,theta2:7,theta:[1,7,8],theta_:15,theta_p:15,thi:[7,8,9,10,11,13,14,16],those:15,three:11,ti:3,time:[2,5,6,7,11,14,15,16],time_interpolate_ob:[7,16],timeend:6,timefunc:[2,3,4,5,15],timeoverlap:6,timeseri:[7,16],timestamp:[7,16],timestart:6,titlestr:2,tm01:8,tm02:[8,11,13,16],tm10:8,too:11,tool:[3,11,13,15,16],tort:10,touch:3,tp:[11,13,16],trec:6,triangl:1,triangular:1,ts:[11,13],tupl:[11,14,16],tuples2csv:3,type:[6,16],u:1,uk:10,und:3,under:[10,15],unexpect:15,uniqu:[11,13,15],univers:[10,15],unstructur:1,up:[10,11,13,15],updat:15,upper:11,upto:14,us:[1,6,8,10,11,13,14,15,16],user:[11,14,15],usr:[11,13],utf:[11,13],v1:1,v2:1,v3:1,v4:14,v:1,v_mod:2,v_ob:2,valid:[2,9,10],valid_stat:[11,13],validataion:[10,14],validate_record:[7,11,13,16],validation_sit:11,valu:[1,5,8,11,14,16],variabl:[7,11,13,14,15,16],varianc:8,varindex:5,varnam:[0,4,5],varopt:[7,11,13],verbos:3,version:15,vhm0:[11,13],vi:11,via:[11,16],vped:[11,13],vpsp:[11,13],vtm02:[11,13],vtpk:[11,13],w:[1,11],wa:[10,11,14,15],wai:[10,11],walltim:11,want:11,warranti:10,water:15,wave:[2,8,10,11,13,14,16],wave_energy_period:8,wave_steep:8,wavebuoi:[3,5,8,10,11,13,15,16],wavehgtvar:8,wavespectra:15,wavestat:[11,15],wavev:[1,2,3,4,5,7,8,11,13],wavewatch:[3,11,15],web:[8,15],weight:1,wght:[2,11],what:11,when:11,where:[11,14,16],whether:[1,10],which:11,wide:14,width:8,wieght:2,wight:1,wiki:8,within:[1,11,13,15],without:[10,11,15,16],work:10,workflow:15,worldwid:10,write:11,written:[10,16],ww3:4,ww3mesh:4,www:12,x:[1,11],xlim:2,y:1,year:[2,6,7,9,11,14,15,16],yearbgn:11,yearend:11,ylim:2,you:[11,12,15],your:[11,15],yr:9,yyyi:14,zero:[8,11,13,15],zero_crossing_period:8,zfill:11,zip:15},titles:["DataFormats","Geometry","Graphics","MatchUpDatabase","ModelData","ObsData","TimeFuncs","Validation","WaveSpectra","WaveStats","About WaveVal","Batch Processing - (IFREMER Datarmor HPC)","External data archives","Examples","WaveVal internal data formats","WaveVal: Wave Model Validation","Validation workflow"],titleterms:{"1":[13,16],"2":[13,16],"3":16,"4":16,"5":16,about:10,archiv:12,ascii:14,batch:11,binari:14,calcul:13,cmem:12,conda:11,construct:11,content:15,copernicu:12,creat:13,csv:[14,16],data:[12,14,16],databas:13,dataformat:0,datarmor:11,environ:11,exampl:13,extern:12,extract:16,file:16,format:14,from:16,gener:[11,16],geometri:1,graphic:2,hpc:11,identifi:16,ifrem:11,indic:15,inform:15,instal:15,intern:14,job:11,licenc:10,marin:12,match:[14,16],matchup:13,matchupdatabas:3,model:[15,16],modeldata:4,obsdata:5,observ:16,packag:15,page:15,paramet:13,pb:11,platform:16,post:[11,16],process:[11,16],queue:11,record:[14,16],result:[11,14,16],save:[14,16],script:11,servic:12,setup:11,statist:16,step:16,submit:11,tabl:15,tabul:[14,16],timefunc:6,uniqu:16,up:16,valid:[7,11,13,14,15,16],wave:15,wavespectra:8,wavestat:9,wavev:[10,14,15],what:15,within:16,workflow:16}})
\ No newline at end of file