Deploy v0.3.0 to GitHub Pages

v0.3.0/_examples/add_roadnetwork.html

@@ -636,13 +636,6 @@ <h1><strong>Step 4:</strong> Run the FIAT model<a class="headerlink" href="#Step
 2023-11-02 09:43:10,658 - hydromt_fiat - data_catalog - INFO - Parsing data catalog from c:\Repositories\hydromt_fiat\examples\data\road_network\hydromt_fiat_catalog_USA.yml
 2023-11-02 09:43:10,665 - hydromt_fiat - log - DEBUG - Writing log messages to new file c:\Repositories\hydromt_fiat\examples\data\road_network\FIAT model\hydromt.log.
 2023-11-02 09:43:10,665 - hydromt_fiat - model_api - INFO - Initializing fiat model from hydromt_fiat (v0.2.1.dev0).
-</pre></div></div>
-</div>
-<div class="nboutput docutils container">
-<div class="prompt empty docutils container">
-</div>
-<div class="output_area docutils container">
-<div class="highlight"><pre>
 2023-11-02 09:43:10,688 - hydromt_fiat - model_api - INFO - setup_region.region: {&#39;geom&#39;:                                             geometry
 0  POLYGON ((-79.96177 32.79061, -79.96177 32.767...}
 2023-11-02 09:43:10,689 - hydromt_fiat - basin_mask - DEBUG - Parsed region (kind=geom): {&#39;geom&#39;: &#39;GeoDataFrame [-79.96177042  32.76748646 -79.91724162  32.79061007] (crs = EPSG:4326)&#39;}

v0.3.0/_generated/hydromt_fiat.fiat.FiatModel.html

@@ -661,7 +661,7 @@ <h1>hydromt_fiat.fiat.FiatModel<a class="headerlink" href="#hydromt-fiat-fiat-fi
 <tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">update_geoms</span></code>()</p></td>
 <td><p></p></td>
 </tr>
-<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">update_ground_elevation</span></code>(source)</p></td>
+<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">update_ground_elevation</span></code>(source, unit)</p></td>
 <td><p></p></td>
 </tr>
 <tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">update_ground_floor_height</span></code>(source[, ...])</p></td>

v0.3.0/_generated/hydromt_fiat.fiat.FiatModel.maps.html

@@ -481,7 +481,7 @@
 <h1>hydromt_fiat.fiat.FiatModel.maps<a class="headerlink" href="#hydromt-fiat-fiat-fiatmodel-maps" title="Link to this heading">#</a></h1>
 <dl class="py property">
 <dt class="sig sig-object py" id="hydromt_fiat.fiat.FiatModel.maps">
-<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">FiatModel.</span></span><span class="sig-name descname"><span class="pre">maps</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Dict" title="(in Python v3.12)"><span class="pre">Dict</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.xarray.dev/en/stable/generated/xarray.DataArray.html#xarray.DataArray" title="(in xarray v2024.3.1.dev0)"><span class="pre">DataArray</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.xarray.dev/en/stable/generated/xarray.Dataset.html#xarray.Dataset" title="(in xarray v2024.3.1.dev0)"><span class="pre">Dataset</span></a><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#hydromt_fiat.fiat.FiatModel.maps" title="Link to this definition">#</a></dt>
+<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">FiatModel.</span></span><span class="sig-name descname"><span class="pre">maps</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Dict" title="(in Python v3.12)"><span class="pre">Dict</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.xarray.dev/en/stable/generated/xarray.DataArray.html#xarray.DataArray" title="(in xarray v2024.5.1.dev0)"><span class="pre">DataArray</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.xarray.dev/en/stable/generated/xarray.Dataset.html#xarray.Dataset" title="(in xarray v2024.5.1.dev0)"><span class="pre">Dataset</span></a><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#hydromt_fiat.fiat.FiatModel.maps" title="Link to this definition">#</a></dt>
 <dd><p>Model maps. Returns dict of xarray.DataArray or xarray.Dataset.</p>
 </dd></dl>
 

v0.3.0/_generated/hydromt_fiat.fiat.FiatModel.set_maps.html

@@ -481,14 +481,14 @@
 <h1>hydromt_fiat.fiat.FiatModel.set_maps<a class="headerlink" href="#hydromt-fiat-fiat-fiatmodel-set-maps" title="Link to this heading">#</a></h1>
 <dl class="py method">
 <dt class="sig sig-object py" id="hydromt_fiat.fiat.FiatModel.set_maps">
-<span class="sig-prename descclassname"><span class="pre">FiatModel.</span></span><span class="sig-name descname"><span class="pre">set_maps</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.xarray.dev/en/stable/generated/xarray.DataArray.html#xarray.DataArray" title="(in xarray v2024.3.1.dev0)"><span class="pre">DataArray</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.xarray.dev/en/stable/generated/xarray.Dataset.html#xarray.Dataset" title="(in xarray v2024.3.1.dev0)"><span class="pre">Dataset</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">split_dataset</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><span class="pre">bool</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span></span><a class="headerlink" href="#hydromt_fiat.fiat.FiatModel.set_maps" title="Link to this definition">#</a></dt>
+<span class="sig-prename descclassname"><span class="pre">FiatModel.</span></span><span class="sig-name descname"><span class="pre">set_maps</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.xarray.dev/en/stable/generated/xarray.DataArray.html#xarray.DataArray" title="(in xarray v2024.5.1.dev0)"><span class="pre">DataArray</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.xarray.dev/en/stable/generated/xarray.Dataset.html#xarray.Dataset" title="(in xarray v2024.5.1.dev0)"><span class="pre">Dataset</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">split_dataset</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><span class="pre">bool</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span></span><a class="headerlink" href="#hydromt_fiat.fiat.FiatModel.set_maps" title="Link to this definition">#</a></dt>
 <dd><p>Add raster data to the maps component.</p>
 <p>Dataset can either be added as is (default) or split into several
 DataArrays using the split_dataset argument.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dd class="field-odd"><ul class="simple">
-<li><p><strong>data</strong> (<a class="reference external" href="https://docs.xarray.dev/en/stable/generated/xarray.Dataset.html#xarray.Dataset" title="(in xarray v2024.3.1.dev0)"><em>xarray.Dataset</em></a><em> or </em><a class="reference external" href="https://docs.xarray.dev/en/stable/generated/xarray.DataArray.html#xarray.DataArray" title="(in xarray v2024.3.1.dev0)"><em>xarray.DataArray</em></a>) – New forcing data to add</p></li>
+<li><p><strong>data</strong> (<a class="reference external" href="https://docs.xarray.dev/en/stable/generated/xarray.Dataset.html#xarray.Dataset" title="(in xarray v2024.5.1.dev0)"><em>xarray.Dataset</em></a><em> or </em><a class="reference external" href="https://docs.xarray.dev/en/stable/generated/xarray.DataArray.html#xarray.DataArray" title="(in xarray v2024.5.1.dev0)"><em>xarray.DataArray</em></a>) – New forcing data to add</p></li>
 <li><p><strong>name</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a><em>, </em><em>optional</em>) – Variable name, only in case data is of type DataArray or if a Dataset is
 added as is (split_dataset=False).</p></li>
 <li><p><strong>split_dataset</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><em>bool</em></a><em>, </em><em>optional</em>) – If data is a xarray.Dataset split it into several xarray.DataArrays.</p></li>

v0.3.0/_modules/hydromt_fiat/fiat.html

@@ -457,6 +457,7 @@ <h1>Source code for hydromt_fiat.fiat</h1><div class="highlight"><pre>
 <span class="kn">from</span> <span class="nn">hydromt_fiat.workflows.building_footprints</span> <span class="kn">import</span> <span class="n">join_exposure_building_footprints</span>
 <span class="kn">from</span> <span class="nn">hydromt_fiat.workflows.gis</span> <span class="kn">import</span> <span class="n">locate_from_exposure</span>
 <span class="kn">from</span> <span class="nn">hydromt_fiat.workflows.utils</span> <span class="kn">import</span> <span class="n">get_us_county_numbers</span>
+<span class="kn">from</span> <span class="nn">hydromt_fiat.workflows.utils</span> <span class="kn">import</span> <span class="n">rename_geoid_short</span>
 
 <span class="n">__all__</span> <span class="o">=</span> <span class="p">[</span><span class="s2">&quot;FiatModel&quot;</span><span class="p">]</span>
 
@@ -889,9 +890,10 @@ <h1>Source code for hydromt_fiat.fiat</h1><div class="highlight"><pre>
     <span class="k">def</span> <span class="nf">update_ground_elevation</span><span class="p">(</span>
         <span class="bp">self</span><span class="p">,</span>
         <span class="n">source</span><span class="p">:</span> <span class="n">Union</span><span class="p">[</span><span class="nb">int</span><span class="p">,</span> <span class="nb">float</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="nb">str</span><span class="p">,</span> <span class="n">Path</span><span class="p">],</span>
+        <span class="n">unit</span><span class="p">:</span> <span class="nb">str</span>
     <span class="p">):</span>
         <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">exposure</span><span class="p">:</span>
-            <span class="bp">self</span><span class="o">.</span><span class="n">exposure</span><span class="o">.</span><span class="n">setup_ground_elevation</span><span class="p">(</span><span class="n">source</span><span class="p">)</span>
+            <span class="bp">self</span><span class="o">.</span><span class="n">exposure</span><span class="o">.</span><span class="n">setup_ground_elevation</span><span class="p">(</span><span class="n">source</span><span class="p">,</span> <span class="n">unit</span><span class="p">)</span>
 
     <span class="k">def</span> <span class="nf">setup_exposure_raster</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 <span class="w">        </span><span class="sd">&quot;&quot;&quot;Setup raster exposure data for Delft-FIAT.</span>
@@ -1157,9 +1159,10 @@ <h1>Source code for hydromt_fiat.fiat</h1><div class="highlight"><pre>
             <span class="n">svi</span><span class="o">.</span><span class="n">match_geo_ID</span><span class="p">()</span>
             <span class="n">svi</span><span class="o">.</span><span class="n">download_shp_geom</span><span class="p">(</span><span class="n">year_data</span><span class="p">,</span> <span class="n">county_numbers</span><span class="p">)</span>
             <span class="n">svi</span><span class="o">.</span><span class="n">merge_svi_data_shp</span><span class="p">()</span>
+            <span class="n">gdf</span> <span class="o">=</span> <span class="n">rename_geoid_short</span><span class="p">(</span><span class="n">svi</span><span class="o">.</span><span class="n">svi_data_shp</span><span class="p">)</span>
 
             <span class="c1"># store the relevant tables coming out of the social vulnerability module</span>
-            <span class="bp">self</span><span class="o">.</span><span class="n">set_tables</span><span class="p">(</span><span class="n">df</span><span class="o">=</span><span class="n">svi</span><span class="o">.</span><span class="n">svi_data_shp</span><span class="p">,</span> <span class="n">name</span><span class="o">=</span><span class="s2">&quot;social_vulnerability_scores&quot;</span><span class="p">)</span>
+            <span class="bp">self</span><span class="o">.</span><span class="n">set_tables</span><span class="p">(</span><span class="n">df</span><span class="o">=</span><span class="n">gdf</span><span class="p">,</span> <span class="n">name</span><span class="o">=</span><span class="s2">&quot;social_vulnerability_scores&quot;</span><span class="p">)</span>
             <span class="c1"># TODO: Think about adding an indicator for missing data to the svi.svi_data_shp</span>
 
             <span class="c1"># Link the SVI score to the exposure data</span>
@@ -1239,8 +1242,8 @@ <h1>Source code for hydromt_fiat.fiat</h1><div class="highlight"><pre>
         <span class="n">equity</span><span class="o">.</span><span class="n">download_shp_geom</span><span class="p">(</span><span class="n">year_data</span><span class="p">,</span> <span class="n">county_numbers</span><span class="p">)</span>
         <span class="n">equity</span><span class="o">.</span><span class="n">merge_equity_data_shp</span><span class="p">()</span>
         <span class="n">equity</span><span class="o">.</span><span class="n">clean</span><span class="p">()</span>
-
-        <span class="bp">self</span><span class="o">.</span><span class="n">set_tables</span><span class="p">(</span><span class="n">df</span><span class="o">=</span><span class="n">equity</span><span class="o">.</span><span class="n">equity_data_shp</span><span class="p">,</span> <span class="n">name</span><span class="o">=</span><span class="s2">&quot;equity_data&quot;</span><span class="p">)</span>
+        <span class="n">gdf</span> <span class="o">=</span> <span class="n">rename_geoid_short</span><span class="p">(</span><span class="n">equity</span><span class="o">.</span><span class="n">equity_data_shp</span><span class="p">)</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">set_tables</span><span class="p">(</span><span class="n">df</span><span class="o">=</span> <span class="n">gdf</span><span class="p">,</span> <span class="n">name</span><span class="o">=</span><span class="s2">&quot;equity_data&quot;</span><span class="p">)</span>
 
         <span class="c1"># Save the census block aggregation area data</span>
         <span class="n">block_groups</span> <span class="o">=</span> <span class="n">equity</span><span class="o">.</span><span class="n">get_block_groups</span><span class="p">()</span>