Deploying to gh-pages from @ bb58515 🚀

latest/_modules/index.html

@@ -82,6 +82,7 @@
 
   <h1>All modules for which code is available</h1>
 <ul><li><a href="geocube/_show_versions.html">geocube._show_versions</a></li>
+<li><a href="geocube/api/core.html">geocube.api.core</a></li>
 <li><a href="geocube/exceptions.html">geocube.exceptions</a></li>
 <li><a href="geocube/rasterize.html">geocube.rasterize</a></li>
 <li><a href="geocube/vector.html">geocube.vector</a></li>

latest/cli.html

@@ -56,7 +56,11 @@
 <li class="toctree-l1"><a class="reference internal" href="examples/examples.html">Usage Examples</a></li>
 <li class="toctree-l1 current"><a class="reference internal" href="modules.html">API Documentation</a><ul class="current">
 <li class="toctree-l2"><a class="reference internal" href="geocube.html">Core</a></li>
-<li class="toctree-l2 current"><a class="current reference internal" href="#">geocube.cli package</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="#">geocube.cli package</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="#geocube">geocube</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#geocube-make-geocube">geocube make_geocube</a></li>
+</ul>
+</li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li>
@@ -91,6 +95,113 @@
 
   <section id="geocube-cli-package">
 <h1>geocube.cli package<a class="headerlink" href="#geocube-cli-package" title="Link to this heading"></a></h1>
+<section id="geocube">
+<h2>geocube<a class="headerlink" href="#geocube" title="Link to this heading"></a></h2>
+<p>Top-level command and entry point into the GeoCube CLI</p>
+<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>geocube<span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span><span class="w"> </span>COMMAND<span class="w"> </span><span class="o">[</span>ARGS<span class="o">]</span>...
+</pre></div>
+</div>
+<p class="rubric">Options</p>
+<dl class="std option">
+<dt class="sig sig-object std" id="cmdoption-geocube-v">
+<span class="sig-name descname"><span class="pre">-v</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--version</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-geocube-v" title="Link to this definition"></a></dt>
+<dd><p>Show the current version</p>
+</dd></dl>
+
+<dl class="std option">
+<dt class="sig sig-object std" id="cmdoption-geocube-show-versions">
+<span class="sig-name descname"><span class="pre">--show-versions</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-geocube-show-versions" title="Link to this definition"></a></dt>
+<dd><p>Show debugging version information</p>
+</dd></dl>
+
+<p class="rubric">Commands</p>
+<dl class="object">
+<dt class="sig sig-object">
+<span class="sig-name descname"><span class="pre">make-geocube</span></span></dt>
+<dd><p>Utility to load vector data into the…</p>
+</dd></dl>
+
+</section>
+<section id="geocube-make-geocube">
+<h2>geocube make_geocube<a class="headerlink" href="#geocube-make-geocube" title="Link to this heading"></a></h2>
+<p>Utility to load vector data into the xarray raster format.</p>
+<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>geocube<span class="w"> </span>make_geocube<span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span><span class="w"> </span>VECTOR_DATA<span class="w"> </span>OUTPUT_FILE
+</pre></div>
+</div>
+<p class="rubric">Options</p>
+<dl class="std option">
+<dt class="sig sig-object std" id="cmdoption-geocube-make_geocube-i">
+<span class="sig-name descname"><span class="pre">-i</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--interpolate-na-method</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;interpolate_na_method&gt;</span></span><a class="headerlink" href="#cmdoption-geocube-make_geocube-i" title="Link to this definition"></a></dt>
+<dd><p>This is the method for interpolation to use to fill in the nodata.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Options<span class="colon">:</span></dt>
+<dd class="field-odd"><p>linear | nearest | cubic</p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="std option">
+<dt class="sig sig-object std" id="cmdoption-geocube-make_geocube-gb">
+<span class="sig-name descname"><span class="pre">-gb</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--group-by</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;group_by&gt;</span></span><a class="headerlink" href="#cmdoption-geocube-make_geocube-gb" title="Link to this definition"></a></dt>
+<dd><p>When specified, perform basic combining/reducing of the data on this column.</p>
+</dd></dl>
+
+<dl class="std option">
+<dt class="sig sig-object std" id="cmdoption-geocube-make_geocube-f">
+<span class="sig-name descname"><span class="pre">-f</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--fill</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;fill&gt;</span></span><a class="headerlink" href="#cmdoption-geocube-make_geocube-f" title="Link to this definition"></a></dt>
+<dd><p>The value to fill in the grid with for nodata. Default is NaN.</p>
+</dd></dl>
+
+<dl class="std option">
+<dt class="sig sig-object std" id="cmdoption-geocube-make_geocube-l">
+<span class="sig-name descname"><span class="pre">-l</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--like</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;like&gt;</span></span><a class="headerlink" href="#cmdoption-geocube-make_geocube-l" title="Link to this definition"></a></dt>
+<dd><p>Uses the netCDF file output of a previous <code class="docutils literal notranslate"><span class="pre">load()</span></code> to form the basis of a request for another product.</p>
+</dd></dl>
+
+<dl class="std option">
+<dt class="sig sig-object std" id="cmdoption-geocube-make_geocube-g">
+<span class="sig-name descname"><span class="pre">-g</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--geom</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;geom&gt;</span></span><a class="headerlink" href="#cmdoption-geocube-make_geocube-g" title="Link to this definition"></a></dt>
+<dd><p>GeoJSON string for the bounding box of the data used to construct the grid.</p>
+</dd></dl>
+
+<dl class="std option">
+<dt class="sig sig-object std" id="cmdoption-geocube-make_geocube-a">
+<span class="sig-name descname"><span class="pre">-a</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--align</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;align&gt;</span></span><a class="headerlink" href="#cmdoption-geocube-make_geocube-a" title="Link to this definition"></a></dt>
+<dd><p>Load data such that point ‘align’ lies on the pixel boundary. Default is (0, 0).</p>
+</dd></dl>
+
+<dl class="std option">
+<dt class="sig sig-object std" id="cmdoption-geocube-make_geocube-r">
+<span class="sig-name descname"><span class="pre">-r</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--resolution</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;resolution&gt;</span></span><a class="headerlink" href="#cmdoption-geocube-make_geocube-r" title="Link to this definition"></a></dt>
+<dd><p>A tuple of the spatial resolution of the returned data. Ex. -r -10 10.</p>
+</dd></dl>
+
+<dl class="std option">
+<dt class="sig sig-object std" id="cmdoption-geocube-make_geocube-c">
+<span class="sig-name descname"><span class="pre">-c</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--output-crs</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;output_crs&gt;</span></span><a class="headerlink" href="#cmdoption-geocube-make_geocube-c" title="Link to this definition"></a></dt>
+<dd><p>The CRS of the returned data. (e.g. epsg:4326). If no CRS is supplied, the CRS of the input data is used.</p>
+</dd></dl>
+
+<dl class="std option">
+<dt class="sig sig-object std" id="cmdoption-geocube-make_geocube-m">
+<span class="sig-name descname"><span class="pre">-m</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--measurements</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;measurements&gt;</span></span><a class="headerlink" href="#cmdoption-geocube-make_geocube-m" title="Link to this definition"></a></dt>
+<dd><p>Measurement subset to load in.</p>
+</dd></dl>
+
+<p class="rubric">Arguments</p>
+<dl class="std option">
+<dt class="sig sig-object std" id="cmdoption-geocube-make_geocube-arg-VECTOR_DATA">
+<span class="sig-name descname"><span class="pre">VECTOR_DATA</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-geocube-make_geocube-arg-VECTOR_DATA" title="Link to this definition"></a></dt>
+<dd><p>Required argument</p>
+</dd></dl>
+
+<dl class="std option">
+<dt class="sig sig-object std" id="cmdoption-geocube-make_geocube-arg-OUTPUT_FILE">
+<span class="sig-name descname"><span class="pre">OUTPUT_FILE</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-geocube-make_geocube-arg-OUTPUT_FILE" title="Link to this definition"></a></dt>
+<dd><p>Required argument</p>
+</dd></dl>
+
+</section>
 </section>