Stable version of the fiat_integrator

.github/workflows/docs.yml

@@ -1,11 +1,22 @@
-name: Build Docs
+name: Build Documentation
 
-# We don't want pushes (or PRs) to gh-pages to kick anything off
 on:
   push:
     branches: [ main ]
+    paths:
+      - tests/*
+      - hydromt_fiat/*
+      - docs/*
+      - examples/*
+      - pyproject.toml
   pull_request:
     branches: [ main ]
+    paths:
+      - tests/*
+      - hydromt_fiat/*
+      - docs/*
+      - examples/*
+      - pyproject.toml
 
 jobs:
   # Build docs on Linux
@@ -20,43 +31,51 @@ jobs:
     steps:
       - name: Checkout source
         uses: actions/checkout@v2
-
-      # - name: Get tags
-      #   run: git fetch --depth=1 origin +refs/tags/*:refs/tags/*
 
-      - name: Setup environment
+      - name: Setup Mambaforge
         uses: conda-incubator/setup-miniconda@v2
         with:
-          python-version: "3.9"
-          mamba-version: "*"
-          channels: conda-forge,defaults
-          channel-priority: true
-          environment-file: envs/hydromt-fiat-dev.yml
-          activate-environment: hydromt-fiat-dev
+          python-version: "3.10"
+          miniforge-variant: Mambaforge
+          miniforge-version: latest
+          channels: conda-forge
+          activate-environment: hydromt-fiat-docs
+          use-mamba: true
+
+      - name: Set cache date
+        run: echo "DATE=$(date +'%Y%m%d')" >> $GITHUB_ENV
+
+      - name: load from cache if it exists for our environment
+        uses: actions/cache@v3
+        with:
+          path: /usr/share/miniconda3/envs/hydromt-fiat-docs
+          key: docs-conda-${{ hashFiles('envs/hydromt-fiat-docs.yml') }}-${{ env.DATE }}
+        id: cache
+
+      - name: Update environment & write to cache
+        run: mamba env update -n hydromt-fiat-docs -f envs/hydromt-fiat-docs.yml
+        if: steps.cache.outputs.cache-hit != 'true'
 
       - name: Install hydromt-fiat
-        run: flit install
+        run: pip install .
 
-      # Move examples folder before make html for nbsphinx
       - name: Build docs
+        if: ${{ github.event_name != 'pull_request' && !github.event.act }}
         run: |
-          mv examples docs/_examples
-          pushd docs
           make html
-          popd
+
       # This overrides the version "dev" with the proper version if we're building off a
       # branch that's not main (which is confined to n.nn.x above) or on a tag.
       - name: Set doc version
-        if: ${{ github.event_name != 'push' || !contains(github.ref, 'main') }}
         run: echo "DOC_VERSION=$(python -c 'from hydromt_fiat import __version__ as v; print("dev" if "dev" in v else "v"+v.replace(".dev",""))')" >> $GITHUB_ENV
 
       - name: Upload to GitHub Pages
-        if: ${{ github.event_name != 'pull_request'}}
+        if: ${{ github.event_name != 'pull_request' && !github.event.act }}
         uses: peaceiris/actions-gh-pages@v3.8.0
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
           publish_dir: ./docs/_build/html
-          exclude_assets: '.buildinfo,_sources/*'
+          exclude_assets: .buildinfo,_sources/*,_examples/*.ipynb
           destination_dir: ./${{ env.DOC_VERSION }}
           keep_files: false
-          full_commit_message: Deploy ${{ env.DOC_VERSION }} to GitHub Pages
+          full_commit_message: Deploy ${{ env.DOC_VERSION }} to GitHub Pages

.gitignore

@@ -117,3 +117,8 @@ venv.bak/
 # dask
 /local_test_database
 
+/examples/data/miami_dade_landuse.gpkg
+cache
+/examples/FIAT_database
+hydromt_fiat/data/damage_functions/flooding/AllDDF_HAZUS_fractions.xlsx
+hydromt_fiat/data/damage_functions/flooding/~$AllDDF_HAZUS_fractions.xlsx

README.rst

@@ -1,5 +1,5 @@
-hydroMT-fiat: FIAT plugin for hydroMT
-#########################################
+HydroMT-FIAT: HydroMT plugin for Delft-FIAT
+############################################
 
 .. image:: https://codecov.io/gh/Deltares/hydromt_fiat/branch/main/graph/badge.svg
     :target: https://codecov.io/gh/Deltares/hydromt_fiat
@@ -20,46 +20,44 @@ hydroMT-fiat: FIAT plugin for hydroMT
     :target: https://mybinder.org/v2/gh/Deltares/hydromt_fiat/main?urlpath=lab/tree/examples
 
 
-hydroMT_ is a python package, developed by Deltares, to build and analysis hydro models.
+HydroMT_ is a python package, developed by Deltares, to build and analyze hydro models.
 It provides a generic model api with attributes to access the model schematization,
 (dynamic) forcing data, results and states. This plugin provides an implementation 
-for the FIAT_ model.
+for the Delft-FIAT_ model.
 
 
 .. _hydromt: https://deltares.github.io/hydromt
-.. _FIAT: https://storymaps.arcgis.com/stories/687a256881b94bf6ad20677543bb8cf2
+.. _Delft-FIAT: https://www.deltares.nl/en/software-and-data/products/delft-fiat-flood-impact-assessment-tool
 
 
 Installation
 ------------
 
-hydroMT-fiat will soon be availble from pypi and conda-forge (in progress).
+HydroMT-FIAT is available from pypi and will be added to conda-forge (in progress).
 
-To install hydromt_fiat using pip do:
+To install hydromt_fiat for usage, do:
 
 .. code-block:: console
 
   pip install hydromt_fiat
 
-We recommend installing a hydromt-fiat environment including the hydromt_fiat package
-based on the environment.yml file. This environment will install all package dependencies 
-including the core of hydroMT_.
+For developing on HydroMT-FIAT, do:
 
 .. code-block:: console
 
-  conda env create -f binder/environment.yml
-  conda activate hydromt-fiat
-  pip install hydromt_fiat
+  conda env create -f envs/hydromt-fiat-dev.yml
+  conda activate hydromt-fiat-dev
+  pip install -e .
 
 Documentation
 -------------
 
-Learn more about the hydroMT_fiat plugin in its `online documentation <https://deltares.github.io/hydromt_fiat/>`_
+Learn more about the HydroMT-FIAT plugin in its `online documentation <https://deltares.github.io/hydromt_fiat/>`_
 
 Contributing
 ------------
 
-You can find information about contributing to hydroMT at our `Contributing page <https://deltares.github.io/hydromt_fiat/latest/contributing.html>`_.
+You can find information about contributing to HydroMT at our `Contributing page <https://deltares.github.io/hydromt/latest/dev/contributing>`_.
 
 License
 -------

binder/environment.yml

@@ -4,32 +4,24 @@ channels:
   - conda-forge
 
 dependencies:
-  - affine
   - click
   - black
-  - bottleneck
-  - cartopy # to run examples
   - dask
-  - descartes # to run examples
-  - entrypoints
-  - flit>=3.2
   - gdal>=3.1
   - geopandas
-  - hydromt>=0.4.1
-  - jupyterlab # to run examples
-  - netcdf4
-  - matplotlib # to run examples
-  - numba
+  - hydromt=0.8.0
+  - hydromt_sfincs
   - numpy
-  - openpyxl
+  - osmnx
   - pandas
   - pip
-  - pyflwdir>=0.4.7
   - pygeos>=0.8
-  - python>=3.7
-  - rasterio
+  - python=3.10
+  - pydantic=1.10.9
+  - pytest
   - requests
-  - scipy
   - xarray
-  - zarr
+  - pip:
+    - us
+    - census