Skip to content

Commit

Permalink
Docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@aazuspan
aazuspan committed Oct 9, 2021
1 parent d3d79c1 commit aa7ca33
Show file tree
Hide file tree
Showing 25 changed files with 48 additions and 66 deletions.
Binary file modified docs/_build/doctrees/environment.pickle
View file
Binary file not shown.
Binary file modified docs/_build/doctrees/index.doctree
View file
Binary file not shown.
Binary file modified docs/_build/doctrees/wxee.doctree
View file
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/_build/html/_modules/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@


<div class="version">
0.1.0
0.1.1
</div>


Expand Down
2 changes: 1 addition & 1 deletion docs/_build/html/_modules/wxee/climatology.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@


<div class="version">
0.1.0
0.1.1
</div>


Expand Down
2 changes: 1 addition & 1 deletion docs/_build/html/_modules/wxee/collection.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@


<div class="version">
0.1.0
0.1.1
</div>


Expand Down
2 changes: 1 addition & 1 deletion docs/_build/html/_modules/wxee/image.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@


<div class="version">
0.1.0
0.1.1
</div>


Expand Down
60 changes: 23 additions & 37 deletions docs/_build/html/_modules/wxee/time_series.html
View file

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/_build/html/contributing.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@


<div class="version">
0.1.0
0.1.1
</div>


Expand Down
2 changes: 1 addition & 1 deletion docs/_build/html/examples.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@


<div class="version">
0.1.0
0.1.1
</div>


Expand Down
2 changes: 1 addition & 1 deletion docs/_build/html/examples/climatology_anomaly.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@


<div class="version">
0.1.0
0.1.1
</div>


Expand Down
2 changes: 1 addition & 1 deletion docs/_build/html/examples/climatology_mean.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@


<div class="version">
0.1.0
0.1.1
</div>


Expand Down
2 changes: 1 addition & 1 deletion docs/_build/html/examples/downloading_images_and_collections.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@


<div class="version">
0.1.0
0.1.1
</div>


Expand Down
2 changes: 1 addition & 1 deletion docs/_build/html/examples/eemont.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@


<div class="version">
0.1.0
0.1.1
</div>


Expand Down
2 changes: 1 addition & 1 deletion docs/_build/html/examples/fire_progressions.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@


<div class="version">
0.1.0
0.1.1
</div>


Expand Down
2 changes: 1 addition & 1 deletion docs/_build/html/examples/image_collection_to_xarray.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@


<div class="version">
0.1.0
0.1.1
</div>


Expand Down
2 changes: 1 addition & 1 deletion docs/_build/html/examples/modis.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@


<div class="version">
0.1.0
0.1.1
</div>


Expand Down
2 changes: 1 addition & 1 deletion docs/_build/html/examples/temporal_aggregation.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@


<div class="version">
0.1.0
0.1.1
</div>


Expand Down
2 changes: 1 addition & 1 deletion docs/_build/html/examples/temporal_interpolation.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@


<div class="version">
0.1.0
0.1.1
</div>


Expand Down
2 changes: 1 addition & 1 deletion docs/_build/html/genindex.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@


<div class="version">
0.1.0
0.1.1
</div>


Expand Down
4 changes: 2 additions & 2 deletions docs/_build/html/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@


<div class="version">
0.1.0
0.1.1
</div>


Expand Down Expand Up @@ -187,7 +187,7 @@
text-align: unset;
}
</style>
<a class="reference external image-reference" href="https://github.com/aazuspan/wxee"><img alt="wxee" src="https://raw.githubusercontent.com/aazuspan/wxee/main/docs/_static/wxee.png" style="width: 200px;" /></a>
<a class="reference external image-reference" href="https://github.com/aazuspan/wxee"><img alt="wxee .-- -..-" src="https://raw.githubusercontent.com/aazuspan/wxee/main/docs/_static/wxee.png" style="width: 200px;" /></a>
<div class="line-block">
<div class="line"><br /></div>
</div>
Expand Down
Binary file modified docs/_build/html/objects.inv
View file
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/_build/html/search.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@


<div class="version">
0.1.0
0.1.1
</div>


Expand Down
2 changes: 1 addition & 1 deletion docs/_build/html/searchindex.js
View file

Large diffs are not rendered by default.

14 changes: 5 additions & 9 deletions docs/_build/html/wxee.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@


<div class="version">
0.1.0
0.1.1
</div>


Expand Down Expand Up @@ -507,18 +507,14 @@ <h3>Methods and Properties<a class="headerlink" href="#methods-and-properties" t

<dl class="py method">
<dt class="sig sig-object py" id="wxee.time_series.TimeSeries.interval">
<span class="sig-name descname"><span class="pre">interval</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">unit</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span> <span class="o"><span class="pre">=</span></span> <span class="default_value"><span class="pre">'day'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">reducer</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Any</span><span class="p"><span class="pre">]</span></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> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">ee.Number</span></span></span><a class="reference internal" href="_modules/wxee/time_series.html#TimeSeries.interval"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#wxee.time_series.TimeSeries.interval" title="Permalink to this definition"></a></dt>
<dd><p>Compute and reduce time intervals between images in the collection. By default, the mean interval will be returned,
but you could also calculate the minimum or maximum time between images, for example.</p>
<span class="sig-name descname"><span class="pre">interval</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">unit</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span> <span class="o"><span class="pre">=</span></span> <span class="default_value"><span class="pre">'day'</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">ee.Number</span></span></span><a class="reference internal" href="_modules/wxee/time_series.html#TimeSeries.interval"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#wxee.time_series.TimeSeries.interval" title="Permalink to this definition"></a></dt>
<dd><p>Compute the mean time interval between images in the time series.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>unit</strong> (<em>str</em><em>, </em><em>default &quot;day&quot;</em>) – The unit to return the time interval in. One of “minute”, “hour”, “day”, “week”, “month”, “year”.</p></li>
<li><p><strong>reducer</strong> (<em>ee.Reducer</em><em>, </em><em>optional</em>) – The reducer to apply to the list of image intervals. If none is provided, ee.Reducer.mean() will be used.</p></li>
</ul>
<dd class="field-odd"><p><strong>unit</strong> (<em>str</em><em>, </em><em>default &quot;day&quot;</em>) – The unit to return the time interval in. One of “minute”, “hour”, “day”, “week”, “month”, “year”.</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>The reduced time interval between images.</p>
<dd class="field-even"><p>The mean time interval between images.</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>ee.Number</p>
Expand Down

0 comments on commit aa7ca33

Please sign in to comment.