Skip to content
Snippets Groups Projects
Commit a5b0d329 authored by Chris Old's avatar Chris Old
Browse files

Merge branch 'master' into 'main' 

Added html pages for documentation, while issues with readthedocs are resolved.

See merge request !48
parents cb6dbc98 59385772
No related branches found
Tags v1.0.0-beta
1 merge request!48Added html pages for documentation, while issues with readthedocs are resolved.
Hide whitespace changes
Inline Side-by-side
Showing
with 206 additions and 0 deletions
docs/_build/doctrees/DataFormats.doctree 0 → 100644
+ 0
− 0
View file @ a5b0d329
File added
docs/_build/doctrees/Geometry.doctree 0 → 100644
+ 0
− 0
View file @ a5b0d329
File added
docs/_build/doctrees/Graphics.doctree 0 → 100644
+ 0
− 0
View file @ a5b0d329
File added
docs/_build/doctrees/MatchUpDatabase.doctree 0 → 100644
+ 0
− 0
View file @ a5b0d329
File added
docs/_build/doctrees/ModelData.doctree 0 → 100644
+ 0
− 0
View file @ a5b0d329
File added
docs/_build/doctrees/ObsData.doctree 0 → 100644
+ 0
− 0
View file @ a5b0d329
File added
docs/_build/doctrees/TimeFuncs.doctree 0 → 100644
+ 0
− 0
View file @ a5b0d329
File added
docs/_build/doctrees/Validation.doctree 0 → 100644
+ 0
− 0
View file @ a5b0d329
File added
docs/_build/doctrees/WaveSpectra.doctree 0 → 100644
+ 0
− 0
View file @ a5b0d329
File added
docs/_build/doctrees/WaveStats.doctree 0 → 100644
+ 0
− 0
View file @ a5b0d329
File added
docs/_build/doctrees/about.doctree 0 → 100644
+ 0
− 0
View file @ a5b0d329
File added
docs/_build/doctrees/automate.doctree 0 → 100644
+ 0
− 0
View file @ a5b0d329
File added
docs/_build/doctrees/data_access.doctree 0 → 100644
+ 0
− 0
View file @ a5b0d329
File added
docs/_build/doctrees/environment.pickle 0 → 100644
+ 0
− 0
View file @ a5b0d329
File added
docs/_build/doctrees/examples.doctree 0 → 100644
+ 0
− 0
View file @ a5b0d329
File added
docs/_build/doctrees/formats.doctree 0 → 100644
+ 0
− 0
View file @ a5b0d329
File added
docs/_build/doctrees/index.doctree 0 → 100644
+ 0
− 0
View file @ a5b0d329
File added
docs/_build/doctrees/quickstart.doctree 0 → 100644
+ 0
− 0
View file @ a5b0d329
File added
docs/_build/html/.buildinfo 0 → 100644
+ 4
− 0
View file @ a5b0d329
# 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
docs/_build/html/DataFormats.html 0 → 100644
+ 202
− 0
View file @ a5b0d329
<!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 &#8212; 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> &#187;</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> &#187;</li>
<li class="nav-item nav-item-this"><a href="">DataFormats</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
&#169; 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
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment