deploy: 902f760

IMMM-SFA · Feb 21, 2024 · 6e13147 · 6e13147
1 parent eb1efd8
commit 6e13147
Show file tree

Hide file tree

Showing 24 changed files with 121 additions and 519 deletions.
diff --git a/_images/index_getting_started.svg b/_images/index_getting_started.svg
diff --git a/_sources/contributing.rst.txt b/_sources/contributing.rst.txt
@@ -81,9 +81,10 @@ To push **naturf** to pypi, you should first have ``build`` and ``twine`` instal
 
   python3 -m pip install --upgrade twine
 
-You also need to set up a `PyPi account <https://pypi.org/>` and `API token <https://pypi.org/help/#apitoken>`
+You also need to set up a `PyPi account <https://pypi.org/>`_ and `API token <https://pypi.org/help/#apitoken>`_
 
 Then run:
+
 .. code-block:: bash
 
   python -m build

diff --git a/_sources/getting_started.rst.txt b/_sources/getting_started.rst.txt
diff --git a/_sources/index.rst.txt b/_sources/index.rst.txt
@@ -19,16 +19,24 @@ naturf documentation
  3) Prepare binary files to be fed into WRF to understand the effect of building morphology on the urban microclimate.
 
 
+About
+-----
+
+The Neighborhood Adaptive Tissues for Urban Resilience Futures tool (**naturf**) enables the examination of the effect of urban morphology at variable resolutions on the urban microclimate through the Weather Research and Forecasting model (WRF). Following the work of Ching et al. (citation) on NUDAPT/WUDAPT, **naturf** calculates 132 urban parameters based on shapefiles of building footprints and heights; however, **naturf** is capable of compiling these urban parameters at finer, sub-kilometer resolutions than offered by NUDAPT/WUDAPT.
+
+**naturf** takes in building polygon shapefiles with height data and uses the Python package **geopandas** to calculate 132 urban parameters for each building that are compiled into a binary file. The name of the binary file as well as an automatically generated index file instructs WRF to place the binary data into the correct location in a geogrid.  **naturf** also uses **hamilton** as a means of organizing, streamlining, and visualizing its workflow.
+
+
 .. grid:: 2
     :gutter: 4
 
-    .. grid-item-card::  Getting Started
-        :img-top: _static/index_getting_started.svg
+    .. grid-item-card::  Quickstarter
+        :img-top: _static/index_quickstarter.svg
         :text-align: center
 
-        New to **naturf**?  Get familiar with what **naturf** is all about.
+        New to **naturf**?  Follow the quickstarter for a quick start.
 
-        .. button-ref:: getting_started
+        .. button-ref:: quickstarter
                 :click-parent:
                 :color: primary
                 :expand:
@@ -84,7 +92,6 @@ naturf documentation
    :maxdepth: 2
    :hidden:
 
-   getting_started
    quickstarter
    user_guide
    modules

diff --git a/_sources/release_notes.rst.txt b/_sources/release_notes.rst.txt
@@ -4,6 +4,12 @@ Release notes
 This is the list of changes to **naturf** between each release. For full details,
 see the `commit logs <https://github.com/IMMM-SFA/naturf/commits>`_.
 
+Version 1.0.1
+_____________
+
+- See the `v1.0.1 release notes <https://github.com/IMMM-SFA/naturf/releases/tag/v1.0.1>`_.
+
+
 Version 1.0.0
 _____________
 

diff --git a/_sources/user_guide.rst.txt b/_sources/user_guide.rst.txt
@@ -207,6 +207,27 @@ Vertical Distribution of Building Heights (118-132)
 
 The vertical distribution of building heights is a representation of where buildings are located at each vertical level. **naturf** represents buildings as arbitrary float values in an array, and each vertical dimension of the array shows how many buildings reach that height. [Burian2003]_
 
+Dependencies
+____________
+
+==========================  ===============
+Dependency                  Minimum Version
+==========================  ===============
+fiona                       1.8.19
+geocube                     0.3.1
+geopandas                   0.10.2
+joblib                      1.0.1
+numpy                       1.22.4
+pandas                      1.4.2
+pyproj                      3.0.1
+rasterio                    1.2.10
+rtree                       1.0.0
+sf-hamilton[visualization]  1.45
+shapely                     1.8.2, <2
+tqdm                        4.66.1
+xarray                      2022.3.0
+==========================  ===============
+
 References
 ----------
 

diff --git a/authors.html b/authors.html
@@ -58,7 +58,6 @@
 </div>
         </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
               <ul class="current">
-<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
 <li class="toctree-l1"><a class="reference internal" href="quickstarter.html">Quickstarter</a></li>
 <li class="toctree-l1"><a class="reference internal" href="user_guide.html">User guide</a></li>
 <li class="toctree-l1"><a class="reference internal" href="modules.html">naturf</a></li>

diff --git a/contributing.html b/contributing.html
@@ -58,7 +58,6 @@
 </div>
         </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
               <ul class="current">
-<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
 <li class="toctree-l1"><a class="reference internal" href="quickstarter.html">Quickstarter</a></li>
 <li class="toctree-l1"><a class="reference internal" href="user_guide.html">User guide</a></li>
 <li class="toctree-l1"><a class="reference internal" href="modules.html">naturf</a></li>
@@ -182,13 +181,13 @@ <h2>Developer Guide<a class="headerlink" href="#developer-guide" title="Link to
 python3<span class="w"> </span>-m<span class="w"> </span>pip<span class="w"> </span>install<span class="w"> </span>--upgrade<span class="w"> </span>twine
 </pre></div>
 </div>
-<p>You also need to set up a <cite>PyPi account &lt;https://pypi.org/&gt;</cite> and <cite>API token &lt;https://pypi.org/help/#apitoken&gt;</cite></p>
-<p>Then run:
-.. code-block:: bash</p>
-<blockquote>
-<div><p>python -m build</p>
-<p>twine upload dist/*</p>
-</div></blockquote>
+<p>You also need to set up a <a class="reference external" href="https://pypi.org/">PyPi account</a> and <a class="reference external" href="https://pypi.org/help/#apitoken">API token</a></p>
+<p>Then run:</p>
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>python<span class="w"> </span>-m<span class="w"> </span>build
+
+twine<span class="w"> </span>upload<span class="w"> </span>dist/*
+</pre></div>
+</div>
 </section>
 </section>
 

diff --git a/footer.html b/footer.html
@@ -57,7 +57,6 @@
 </div>
         </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
               <ul class="current">
-<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
 <li class="toctree-l1"><a class="reference internal" href="quickstarter.html">Quickstarter</a></li>
 <li class="toctree-l1"><a class="reference internal" href="user_guide.html">User guide</a></li>
 <li class="toctree-l1"><a class="reference internal" href="modules.html">naturf</a></li>

diff --git a/genindex.html b/genindex.html
@@ -55,7 +55,6 @@
 </div>
         </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
               <ul>
-<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
 <li class="toctree-l1"><a class="reference internal" href="quickstarter.html">Quickstarter</a></li>
 <li class="toctree-l1"><a class="reference internal" href="user_guide.html">User guide</a></li>
 <li class="toctree-l1"><a class="reference internal" href="modules.html">naturf</a></li>