Skip to content

Commit b089a7f

Browse files
ChrisBarker-NOAAChrisBarker-NOAA
committed
updating documentation
1 parent f11c5c7 commit b089a7f

43 files changed

Lines changed: 4274 additions & 3868 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.buildinfo‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Sphinx build info version 1
2-
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
3-
config: 4de5a44be5f2d7a545ffab27118c51ea
2+
# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
3+
config: ef6f11c492cfefe850b05aca724ce5de
44
tags: 645f666f9bcd5a90fca523b33c5a78b7

‎_modules/gridded/depth.html‎

Lines changed: 573 additions & 510 deletions
Large diffs are not rendered by default.

‎_modules/gridded/gridded.html‎

Lines changed: 32 additions & 77 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,20 @@
1+
2+
13
<!DOCTYPE html>
2-
<html class="writer-html5" lang="en" >
4+
<html class="writer-html5" lang="en" data-content_root="../../">
35
<head>
46
<meta charset="utf-8" />
57
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
6-
<title>gridded.gridded &mdash; gridded 0.0.8 documentation</title>
7-
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
8-
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
9-
<!--[if lt IE 9]>
10-
<script src="../../_static/js/html5shiv.min.js"></script>
11-
<![endif]-->
8+
<title>gridded.gridded &mdash; gridded 0.7.2dev documentation</title>
9+
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=fa44fd50" />
10+
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=e59714d7" />
11+
1212

13-
<script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js"></script>
14-
<script src="../../_static/jquery.js"></script>
15-
<script src="../../_static/underscore.js"></script>
16-
<script src="../../_static/_sphinx_javascript_frameworks_compat.js"></script>
17-
<script src="../../_static/doctools.js"></script>
18-
<script src="../../_static/sphinx_highlight.js"></script>
13+
<script src="../../_static/jquery.js?v=5d32c60e"></script>
14+
<script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
15+
<script src="../../_static/documentation_options.js?v=46001abd"></script>
16+
<script src="../../_static/doctools.js?v=9bcbadda"></script>
17+
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
1918
<script src="../../_static/js/theme.js"></script>
2019
<link rel="index" title="Index" href="../../genindex.html" />
2120
<link rel="search" title="Search" href="../../search.html" />
@@ -25,7 +24,7 @@
2524
<div class="wy-grid-for-nav">
2625
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
2726
<div class="wy-side-scroll">
28-
<div class="wy-side-nav-search" >
27+
<div class="wy-side-nav-search" style="background: white" >
2928

3029

3130

@@ -41,73 +40,20 @@
4140
</div>
4241
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
4342
<ul>
44-
<li class="toctree-l1"><a class="reference internal" href="../../overview.html">Overview</a><ul>
45-
<li class="toctree-l2"><a class="reference internal" href="../../overview.html#goals">Goals</a></li>
46-
<li class="toctree-l2"><a class="reference internal" href="../../overview.html#why-gridded">Why gridded?</a></li>
47-
<li class="toctree-l2"><a class="reference internal" href="../../overview.html#data-standards">Data standards</a></li>
48-
</ul>
49-
</li>
50-
<li class="toctree-l1"><a class="reference internal" href="../../installing.html">Installing</a><ul>
51-
<li class="toctree-l2"><a class="reference internal" href="../../installing.html#pip">pip</a><ul>
52-
<li class="toctree-l3"><a class="reference internal" href="../../installing.html#from-source">From source</a></li>
53-
</ul>
54-
</li>
55-
<li class="toctree-l2"><a class="reference internal" href="../../installing.html#conda">conda</a><ul>
56-
<li class="toctree-l3"><a class="reference internal" href="../../installing.html#conda-forge">conda-forge</a></li>
57-
<li class="toctree-l3"><a class="reference internal" href="../../installing.html#environments">Environments</a></li>
58-
</ul>
59-
</li>
60-
</ul>
61-
</li>
43+
<li class="toctree-l1"><a class="reference internal" href="../../overview.html">Overview</a></li>
44+
<li class="toctree-l1"><a class="reference internal" href="../../installing.html">Installing</a></li>
6245
<li class="toctree-l1"><a class="reference internal" href="../../tutorial.html">Tutorial</a></li>
63-
<li class="toctree-l1"><a class="reference internal" href="../../non_conforming_data.html">Loading Non Conforming Data</a><ul>
64-
<li class="toctree-l2"><a class="reference internal" href="../../non_conforming_data.html#if-your-files-conform-to-the-underlying-data-model">If your files conform to the underlying data model</a><ul>
65-
<li class="toctree-l3"><a class="reference internal" href="../../non_conforming_data.html#unstructured-grids">Unstructured Grids</a></li>
66-
<li class="toctree-l3"><a class="reference internal" href="../../non_conforming_data.html#curvilinear-grids">Curvilinear Grids</a></li>
67-
</ul>
68-
</li>
69-
<li class="toctree-l2"><a class="reference internal" href="../../non_conforming_data.html#if-your-files-do-not-conform-to-the-underlying-data-model">If your files do not conform to the underlying data model</a><ul>
70-
<li class="toctree-l3"><a class="reference internal" href="../../non_conforming_data.html#the-grid">The Grid</a></li>
71-
</ul>
72-
</li>
73-
</ul>
74-
</li>
75-
<li class="toctree-l1"><a class="reference internal" href="../../api_reference.html"><code class="docutils literal notranslate"><span class="pre">gridded</span> <span class="pre">API</span></code></a><ul>
76-
<li class="toctree-l2"><a class="reference internal" href="../../api_reference.html#gridded-dataset"><code class="docutils literal notranslate"><span class="pre">gridded.Dataset</span></code></a></li>
77-
<li class="toctree-l2"><a class="reference internal" href="../../api_reference.html#grid-objects">Grid objects</a></li>
78-
<li class="toctree-l2"><a class="reference internal" href="../../api_reference.html#variable-objects">Variable objects</a></li>
79-
<li class="toctree-l2"><a class="reference internal" href="../../api_reference.html#time-object">Time object</a></li>
80-
<li class="toctree-l2"><a class="reference internal" href="../../api_reference.html#depth-object">Depth object</a></li>
81-
</ul>
82-
</li>
83-
<li class="toctree-l1"><a class="reference internal" href="../../api_reference.html#design-principles">Design Principles</a><ul>
84-
<li class="toctree-l2"><a class="reference internal" href="../../api_reference.html#grid-independence">Grid Independence</a></li>
85-
<li class="toctree-l2"><a class="reference internal" href="../../api_reference.html#duck-typing">Duck Typing</a></li>
86-
<li class="toctree-l2"><a class="reference internal" href="../../api_reference.html#lazy-loading-data-arrays">Lazy loading / data arrays</a></li>
87-
</ul>
88-
</li>
89-
<li class="toctree-l1"><a class="reference internal" href="../../api_reference.html#reference">Reference</a><ul>
90-
<li class="toctree-l2"><a class="reference internal" href="../../gridded.html">gridded package</a><ul>
91-
<li class="toctree-l3"><a class="reference internal" href="../../gridded.html#subpackages">Subpackages</a></li>
92-
<li class="toctree-l3"><a class="reference internal" href="../../gridded.html#submodules">Submodules</a></li>
93-
<li class="toctree-l3"><a class="reference internal" href="../../gridded.html#module-gridded.depth">gridded.depth module</a></li>
94-
<li class="toctree-l3"><a class="reference internal" href="../../gridded.html#module-gridded.gridded">gridded.gridded module</a></li>
95-
<li class="toctree-l3"><a class="reference internal" href="../../gridded.html#module-gridded.grids">gridded.grids module</a></li>
96-
<li class="toctree-l3"><a class="reference internal" href="../../gridded.html#module-gridded.time">gridded.time module</a></li>
97-
<li class="toctree-l3"><a class="reference internal" href="../../gridded.html#module-gridded.utilities">gridded.utilities module</a></li>
98-
<li class="toctree-l3"><a class="reference internal" href="../../gridded.html#module-gridded.variable">gridded.variable module</a></li>
99-
<li class="toctree-l3"><a class="reference internal" href="../../gridded.html#module-gridded">Module contents</a></li>
100-
</ul>
101-
</li>
102-
</ul>
103-
</li>
46+
<li class="toctree-l1"><a class="reference internal" href="../../non_conforming_data.html">Loading Non Conforming Data</a></li>
47+
<li class="toctree-l1"><a class="reference internal" href="../../api_reference.html"><code class="docutils literal notranslate"><span class="pre">gridded</span> <span class="pre">API</span></code></a></li>
48+
<li class="toctree-l1"><a class="reference internal" href="../../api_reference.html#design-principles">Design Principles</a></li>
49+
<li class="toctree-l1"><a class="reference internal" href="../../api_reference.html#reference">Reference</a></li>
10450
</ul>
10551

10652
</div>
10753
</div>
10854
</nav>
10955

110-
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
56+
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" style="background: white" >
11157
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
11258
<a href="../../index.html">gridded</a>
11359
</nav>
@@ -156,7 +102,9 @@ <h1>Source code for gridded.gridded</h1><div class="highlight"><pre>
156102
<span class="sd">&quot;&quot;&quot;</span>
157103

158104

159-
<div class="viewcode-block" id="Dataset"><a class="viewcode-back" href="../../gridded.html#gridded.gridded.Dataset">[docs]</a><span class="k">class</span> <span class="nc">Dataset</span><span class="p">():</span>
105+
<div class="viewcode-block" id="Dataset">
106+
<a class="viewcode-back" href="../../gridded.html#gridded.gridded.Dataset">[docs]</a>
107+
<span class="k">class</span> <span class="nc">Dataset</span><span class="p">():</span>
160108
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
161109
<span class="sd"> An object that represent an entire complete dataset --</span>
162110
<span class="sd"> a collection of Variables and the Grid that they are stored on.</span>
@@ -281,7 +229,9 @@ <h1>Source code for gridded.gridded</h1><div class="highlight"><pre>
281229

282230
<span class="c1"># raise NotImplementedError</span>
283231

284-
<div class="viewcode-block" id="Dataset.save"><a class="viewcode-back" href="../../gridded.html#gridded.gridded.Dataset.save">[docs]</a> <span class="k">def</span> <span class="nf">save</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="nb">format</span><span class="o">=</span><span class="s1">&#39;netcdf4&#39;</span><span class="p">):</span>
232+
<div class="viewcode-block" id="Dataset.save">
233+
<a class="viewcode-back" href="../../gridded.html#gridded.gridded.Dataset.save">[docs]</a>
234+
<span class="k">def</span> <span class="nf">save</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="nb">format</span><span class="o">=</span><span class="s1">&#39;netcdf4&#39;</span><span class="p">):</span>
285235
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
286236
<span class="sd"> save the dataset to a file</span>
287237

@@ -302,7 +252,10 @@ <h1>Source code for gridded.gridded</h1><div class="highlight"><pre>
302252

303253
<span class="n">ncds</span><span class="o">.</span><span class="n">close</span><span class="p">()</span></div>
304254

305-
<div class="viewcode-block" id="Dataset.get_variables_by_attribute"><a class="viewcode-back" href="../../gridded.html#gridded.gridded.Dataset.get_variables_by_attribute">[docs]</a> <span class="k">def</span> <span class="nf">get_variables_by_attribute</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">attr</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
255+
256+
<div class="viewcode-block" id="Dataset.get_variables_by_attribute">
257+
<a class="viewcode-back" href="../../gridded.html#gridded.gridded.Dataset.get_variables_by_attribute">[docs]</a>
258+
<span class="k">def</span> <span class="nf">get_variables_by_attribute</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">attr</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
306259
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
307260
<span class="sd"> return the variables that have attributes that fit the defined input</span>
308261

@@ -321,6 +274,7 @@ <h1>Source code for gridded.gridded</h1><div class="highlight"><pre>
321274
<span class="k">pass</span>
322275
<span class="k">return</span> <span class="n">variables</span></div>
323276

277+
324278
<span class="nd">@property</span>
325279
<span class="k">def</span> <span class="nf">info</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
326280
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
@@ -341,6 +295,7 @@ <h1>Source code for gridded.gridded</h1><div class="highlight"><pre>
341295
<span class="n">grid</span>
342296
<span class="p">))</span>
343297
<span class="k">return</span> <span class="n">msg</span></div>
298+
344299
</pre></div>
345300

346301
</div>

0 commit comments

Comments
 (0)