Skip to content

Commit f11c5c7

Browse files
update the docs
1 parent 42b071f commit f11c5c7

95 files changed

Lines changed: 11886 additions & 21609 deletions

File tree

Some content is hidden

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

_modules/gridded/depth.html

Lines changed: 570 additions & 282 deletions
Large diffs are not rendered by default.

_modules/gridded/gridded.html

Lines changed: 45 additions & 125 deletions
Large diffs are not rendered by default.

_modules/gridded/grids.html

Lines changed: 151 additions & 183 deletions
Large diffs are not rendered by default.
Lines changed: 34 additions & 118 deletions
Original file line numberDiff line numberDiff line change
@@ -1,80 +1,45 @@
1-
2-
31
<!DOCTYPE html>
4-
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
5-
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
2+
<html class="writer-html5" lang="en" >
63
<head>
7-
<meta charset="utf-8">
8-
9-
<meta name="viewport" content="width=device-width, initial-scale=1.0">
10-
4+
<meta charset="utf-8" />
5+
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
116
<title>gridded.pysgrid.processing_2d &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]-->
1212

13-
14-
15-
16-
17-
18-
19-
20-
<script type="text/javascript" src="../../../_static/js/modernizr.min.js"></script>
21-
22-
23-
<script type="text/javascript" id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script>
13+
<script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js"></script>
2414
<script src="../../../_static/jquery.js"></script>
2515
<script src="../../../_static/underscore.js"></script>
16+
<script src="../../../_static/_sphinx_javascript_frameworks_compat.js"></script>
2617
<script src="../../../_static/doctools.js"></script>
27-
<script src="../../../_static/language_data.js"></script>
28-
29-
<script type="text/javascript" src="../../../_static/js/theme.js"></script>
30-
31-
32-
33-
34-
<link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
35-
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
18+
<script src="../../../_static/sphinx_highlight.js"></script>
19+
<script src="../../../_static/js/theme.js"></script>
3620
<link rel="index" title="Index" href="../../../genindex.html" />
3721
<link rel="search" title="Search" href="../../../search.html" />
3822
</head>
3923

40-
<body class="wy-body-for-nav">
41-
42-
24+
<body class="wy-body-for-nav">
4325
<div class="wy-grid-for-nav">
44-
4526
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
4627
<div class="wy-side-scroll">
4728
<div class="wy-side-nav-search" >
48-
4929

5030

51-
<a href="../../../index.html" class="icon icon-home"> gridded
52-
53-
5431

32+
<a href="../../../index.html" class="icon icon-home">
33+
gridded
5534
</a>
56-
57-
58-
59-
6035
<div role="search">
6136
<form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
62-
<input type="text" name="q" placeholder="Search docs" />
37+
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
6338
<input type="hidden" name="check_keywords" value="yes" />
6439
<input type="hidden" name="area" value="default" />
6540
</form>
6641
</div>
67-
68-
69-
</div>
70-
71-
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
72-
73-
74-
75-
76-
77-
42+
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
7843
<ul>
7944
<li class="toctree-l1"><a class="reference internal" href="../../../overview.html">Overview</a><ul>
8045
<li class="toctree-l2"><a class="reference internal" href="../../../overview.html#goals">Goals</a></li>
@@ -138,81 +103,44 @@
138103
</li>
139104
</ul>
140105

141-
142-
143106
</div>
144107
</div>
145108
</nav>
146109

147-
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
148-
149-
150-
<nav class="wy-nav-top" aria-label="top navigation">
151-
110+
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
152111
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
153112
<a href="../../../index.html">gridded</a>
154-
155113
</nav>
156114

157-
158115
<div class="wy-nav-content">
159-
160116
<div class="rst-content">
161-
162-
163-
164-
165-
166-
167-
168-
169-
170-
171-
172-
173-
174-
175-
176-
177-
178-
<div role="navigation" aria-label="breadcrumbs navigation">
179-
117+
<div role="navigation" aria-label="Page navigation">
180118
<ul class="wy-breadcrumbs">
181-
182-
<li><a href="../../../index.html">Docs</a> &raquo;</li>
183-
184-
<li><a href="../../index.html">Module code</a> &raquo;</li>
185-
186-
<li>gridded.pysgrid.processing_2d</li>
187-
188-
119+
<li><a href="../../../index.html" class="icon icon-home" aria-label="Home"></a></li>
120+
<li class="breadcrumb-item"><a href="../../index.html">Module code</a></li>
121+
<li class="breadcrumb-item active">gridded.pysgrid.processing_2d</li>
189122
<li class="wy-breadcrumbs-aside">
190-
191123
</li>
192-
193124
</ul>
194-
195-
196125
<hr/>
197126
</div>
198127
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
199128
<div itemprop="articleBody">
200-
129+
201130
<h1>Source code for gridded.pysgrid.processing_2d</h1><div class="highlight"><pre>
202131
<span></span><span class="sd">&#39;&#39;&#39;</span>
203132
<span class="sd">Created on Apr 2, 2015</span>
204133

205134
<span class="sd">@author: ayan</span>
206135
<span class="sd">&#39;&#39;&#39;</span>
207136

208-
<span class="kn">from</span> <span class="nn">__future__</span> <span class="kn">import</span> <span class="p">(</span><span class="n">absolute_import</span><span class="p">,</span> <span class="n">division</span><span class="p">,</span> <span class="n">print_function</span><span class="p">)</span>
209137

210138
<span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
211139
<span class="kn">import</span> <span class="nn">numpy.ma</span> <span class="k">as</span> <span class="nn">ma</span>
212140

213141

214142
<div class="viewcode-block" id="vector_sum"><a class="viewcode-back" href="../../../gridded.pysgrid.html#gridded.pysgrid.processing_2d.vector_sum">[docs]</a><span class="k">def</span> <span class="nf">vector_sum</span><span class="p">(</span><span class="n">x_arr</span><span class="p">,</span> <span class="n">y_arr</span><span class="p">):</span>
215-
<span class="sd">&quot;&quot;&quot;</span>
143+
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
216144
<span class="sd"> Calculate the vector sum of arrays of</span>
217145
<span class="sd"> x and y vectors.</span>
218146

@@ -228,7 +156,7 @@ <h1>Source code for gridded.pysgrid.processing_2d</h1><div class="highlight"><pr
228156

229157

230158
<div class="viewcode-block" id="rotate_vectors"><a class="viewcode-back" href="../../../gridded.pysgrid.html#gridded.pysgrid.processing_2d.rotate_vectors">[docs]</a><span class="k">def</span> <span class="nf">rotate_vectors</span><span class="p">(</span><span class="n">x_arr</span><span class="p">,</span> <span class="n">y_arr</span><span class="p">,</span> <span class="n">angle_arr</span><span class="p">):</span>
231-
<span class="sd">&quot;&quot;&quot;</span>
159+
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
232160
<span class="sd"> Given x and y vectors in a projected coordinate</span>
233161
<span class="sd"> system, rotate them by angles into a different</span>
234162
<span class="sd"> coordinate system.</span>
@@ -251,7 +179,7 @@ <h1>Source code for gridded.pysgrid.processing_2d</h1><div class="highlight"><pr
251179

252180

253181
<div class="viewcode-block" id="avg_to_cell_center"><a class="viewcode-back" href="../../../gridded.pysgrid.html#gridded.pysgrid.processing_2d.avg_to_cell_center">[docs]</a><span class="k">def</span> <span class="nf">avg_to_cell_center</span><span class="p">(</span><span class="n">data_array</span><span class="p">,</span> <span class="n">avg_dim</span><span class="p">):</span>
254-
<span class="sd">&quot;&quot;&quot;</span>
182+
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
255183
<span class="sd"> Given a two-dimensional numpy.array, average</span>
256184
<span class="sd"> adjacent row values (avg_dim=1) or adjacent</span>
257185
<span class="sd"> column values (avg_dim=0) to the grid cell</span>
@@ -279,42 +207,30 @@ <h1>Source code for gridded.pysgrid.processing_2d</h1><div class="highlight"><pr
279207
</pre></div>
280208

281209
</div>
282-
283210
</div>
284211
<footer>
285-
286212

287213
<hr/>
288214

289215
<div role="contentinfo">
290-
<p>
291-
&copy; Copyright
292-
293-
</p>
216+
<p>&#169; Copyright .</p>
294217
</div>
295-
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
296218

297-
</footer>
219+
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
220+
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
221+
provided by <a href="https://readthedocs.org">Read the Docs</a>.
222+
298223

224+
</footer>
299225
</div>
300226
</div>
301-
302227
</section>
303-
304228
</div>
305-
306-
307-
308-
<script type="text/javascript">
229+
<script>
309230
jQuery(function () {
310231
SphinxRtdTheme.Navigation.enable(true);
311232
});
312-
</script>
313-
314-
315-
316-
317-
233+
</script>
318234

319235
</body>
320236
</html>

0 commit comments

Comments
 (0)