Skip to content

Commit

Permalink
deploy: 8c917a0
Browse files Browse the repository at this point in the history
  • Loading branch information
erexer committed Sep 24, 2024
1 parent 27fcbd7 commit 015b3dd
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 8 deletions.
10 changes: 9 additions & 1 deletion _sources/index.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -28,14 +28,16 @@ The Neighborhood Adaptive Tissues for Urban Resilience Futures tool (**naturf**)


.. grid:: 2
:gutter: 4
:gutter: 5

.. grid-item-card:: Quickstarter
:img-top: _static/index_quickstarter.svg
:class-img-top: sd-px-5, sd-py-5
:text-align: center

New to **naturf**? Run the quickstarter in your browser.

+++
.. button-link:: https://naturf.msdlive.org/
:click-parent:
:color: primary
Expand All @@ -45,11 +47,13 @@ The Neighborhood Adaptive Tissues for Urban Resilience Futures tool (**naturf**)

.. grid-item-card:: User Guide
:img-top: _static/index_user_guide.svg
:class-img-top: sd-px-5, sd-py-5
:text-align: center

The user guide provides in-depth information on the
key concepts of **naturf**.

+++
.. button-ref:: user_guide
:click-parent:
:color: primary
Expand All @@ -59,12 +63,14 @@ The Neighborhood Adaptive Tissues for Urban Resilience Futures tool (**naturf**)

.. grid-item-card:: API Reference
:img-top: _static/index_api.svg
:class-img-top: sd-px-5, sd-py-5
:text-align: center

The reference guide contains a detailed description of
the **naturf** API. The reference describes how the methods
work and which parameters can be used.

+++
.. button-ref:: naturf
:click-parent:
:color: primary
Expand All @@ -74,12 +80,14 @@ The Neighborhood Adaptive Tissues for Urban Resilience Futures tool (**naturf**)

.. grid-item-card:: Contributing to naturf
:img-top: _static/index_contribute.svg
:class-img-top: sd-px-5, sd-py-5
:text-align: center

Saw a typo in the documentation? Want to improve
existing functionalities? The contributing guidelines will guide
you through the process of improving **naturf**.

+++
.. button-ref:: contributing
:click-parent:
:color: primary
Expand Down
20 changes: 14 additions & 6 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@

<section id="naturf-documentation">
<h1>naturf documentation<a class="headerlink" href="#naturf-documentation" title="Link to this heading"></a></h1>
<p><strong>Date</strong>: Sep 16, 2024 <strong>Version</strong>: 1.0.3</p>
<p><strong>Date</strong>: Sep 24, 2024 <strong>Version</strong>: 1.0.3</p>
<p><strong>Useful links</strong>:
<a class="reference external" href="https://github.com/immm-sfa/naturf">Source Repository</a> |
<a class="reference external" href="https://github.com/immm-sfa/naturf/issues">Issues &amp; Ideas</a> |
Expand All @@ -113,48 +113,56 @@ <h2>About<a class="headerlink" href="#about" title="Link to this heading"></a
<p>The Neighborhood Adaptive Tissues for Urban Resilience Futures tool (<strong>naturf</strong>) 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, <strong>naturf</strong> calculates 132 urban parameters based on shapefiles of building footprints and heights; however, <strong>naturf</strong> is capable of compiling these urban parameters at finer, sub-kilometer resolutions than offered by NUDAPT/WUDAPT.</p>
<p><strong>naturf</strong> takes in building polygon shapefiles with height data and uses the Python package <strong>geopandas</strong> 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. <strong>naturf</strong> also uses <strong>hamilton</strong> as a means of organizing, streamlining, and visualizing its workflow.</p>
<div class="sd-container-fluid sd-sphinx-override sd-mb-4 docutils">
<div class="sd-row sd-row-cols-2 sd-row-cols-xs-2 sd-row-cols-sm-2 sd-row-cols-md-2 sd-row-cols-lg-2 sd-g-4 sd-g-xs-4 sd-g-sm-4 sd-g-md-4 sd-g-lg-4 docutils">
<div class="sd-row sd-row-cols-2 sd-row-cols-xs-2 sd-row-cols-sm-2 sd-row-cols-md-2 sd-row-cols-lg-2 sd-g-5 sd-g-xs-5 sd-g-sm-5 sd-g-md-5 sd-g-lg-5 docutils">
<div class="sd-col sd-d-flex-row docutils">
<div class="sd-card sd-sphinx-override sd-w-100 sd-shadow-sm sd-text-center docutils">
<img alt="" class="sd-card-img-top" src="_images/index_quickstarter.svg" /><div class="sd-card-body docutils">
<img alt="" class="sd-card-img-top sd-px-5 sd-py-5" src="_images/index_quickstarter.svg" /><div class="sd-card-body docutils">
<div class="sd-card-title sd-font-weight-bold docutils">
Quickstarter</div>
<p class="sd-card-text">New to <strong>naturf</strong>? Run the quickstarter in your browser.</p>
</div>
<div class="sd-card-footer docutils">
<p class="sd-card-text"><span class="sd-d-grid"><a class="sd-sphinx-override sd-btn sd-text-wrap sd-btn-primary sd-stretched-link reference external" href="https://naturf.msdlive.org/"><span>Get started!</span></a></span></p>
</div>
</div>
</div>
<div class="sd-col sd-d-flex-row docutils">
<div class="sd-card sd-sphinx-override sd-w-100 sd-shadow-sm sd-text-center docutils">
<img alt="" class="sd-card-img-top" src="_images/index_user_guide.svg" /><div class="sd-card-body docutils">
<img alt="" class="sd-card-img-top sd-px-5 sd-py-5" src="_images/index_user_guide.svg" /><div class="sd-card-body docutils">
<div class="sd-card-title sd-font-weight-bold docutils">
User Guide</div>
<p class="sd-card-text">The user guide provides in-depth information on the
key concepts of <strong>naturf</strong>.</p>
</div>
<div class="sd-card-footer docutils">
<p class="sd-card-text"><span class="sd-d-grid"><a class="sd-sphinx-override sd-btn sd-text-wrap sd-btn-primary sd-stretched-link reference internal" href="user_guide.html"><span class="doc">See the User Guide</span></a></span></p>
</div>
</div>
</div>
<div class="sd-col sd-d-flex-row docutils">
<div class="sd-card sd-sphinx-override sd-w-100 sd-shadow-sm sd-text-center docutils">
<img alt="" class="sd-card-img-top" src="_images/index_api.svg" /><div class="sd-card-body docutils">
<img alt="" class="sd-card-img-top sd-px-5 sd-py-5" src="_images/index_api.svg" /><div class="sd-card-body docutils">
<div class="sd-card-title sd-font-weight-bold docutils">
API Reference</div>
<p class="sd-card-text">The reference guide contains a detailed description of
the <strong>naturf</strong> API. The reference describes how the methods
work and which parameters can be used.</p>
</div>
<div class="sd-card-footer docutils">
<p class="sd-card-text"><span class="sd-d-grid"><a class="sd-sphinx-override sd-btn sd-text-wrap sd-btn-primary sd-stretched-link reference internal" href="naturf.html"><span class="doc">See the Reference Guide</span></a></span></p>
</div>
</div>
</div>
<div class="sd-col sd-d-flex-row docutils">
<div class="sd-card sd-sphinx-override sd-w-100 sd-shadow-sm sd-text-center docutils">
<img alt="" class="sd-card-img-top" src="_images/index_contribute.svg" /><div class="sd-card-body docutils">
<img alt="" class="sd-card-img-top sd-px-5 sd-py-5" src="_images/index_contribute.svg" /><div class="sd-card-body docutils">
<div class="sd-card-title sd-font-weight-bold docutils">
Contributing to naturf</div>
<p class="sd-card-text">Saw a typo in the documentation? Want to improve
existing functionalities? The contributing guidelines will guide
you through the process of improving <strong>naturf</strong>.</p>
</div>
<div class="sd-card-footer docutils">
<p class="sd-card-text"><span class="sd-d-grid"><a class="sd-sphinx-override sd-btn sd-text-wrap sd-btn-primary sd-stretched-link reference internal" href="contributing.html"><span class="doc">See the development guide</span></a></span></p>
</div>
</div>
Expand Down
2 changes: 1 addition & 1 deletion searchindex.js

Large diffs are not rendered by default.

0 comments on commit 015b3dd

Please sign in to comment.