215 roughness update defaults

.github/workflows/autoblack.yml

@@ -27,4 +27,4 @@ jobs:
           git remote set-url origin https://x-access-token:${{ secrets.GITHUB_TOKEN }}@github.com/$GITHUB_REPOSITORY
           git checkout $GITHUB_HEAD_REF
           git commit -am "fixup: Format Python code with Black"
-          git push
+          git push

.github/workflows/update_pages.yml

@@ -1,26 +1,18 @@
+name: Deploy Sphinx documentation to Pages
 
-name: Pages
 on:
   push:
-    branches:
-    - main
+    branches: [main] # branch to trigger deployment
+
 jobs:
-  build:
+  pages:
     runs-on: ubuntu-latest
     steps:
-
-    - name: Checkout
-      uses: actions/checkout@v2
+    - id: deployment
+      uses: sphinx-notes/pages@v3
       with:
-        fetch-depth: 0 # otherwise, you will failed to push refs to dest repo
-
-    - name: Build and Commit
-      uses: sphinx-notes/pages@master
-      with:
-        documentation_path: docs
-
-    - name: Push changes
-      uses: ad-m/github-push-action@master
+        publish: false
+    - uses: peaceiris/actions-gh-pages@v3
       with:
         github_token: ${{ secrets.GITHUB_TOKEN }}
-        branch: gh-pages
+        publish_dir: ${{ steps.deployment.outputs.artifact }}

pyproject.toml

@@ -7,7 +7,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "geofabrics"
-version = "1.1.21"
+version = "1.1.22"
 description = "A package for creating geofabrics for flood modelling."
 readme = "README.md"
 authors = [{ name = "Rose pearson", email = "[email protected]" }]

src/geofabrics/dem.py

@@ -2715,6 +2715,29 @@ def add_lidar(
         self._dem = self._dem.where(mask)
         self._write_netcdf_conventions_in_place(self._dem, self.catchment_geometry.crs)
 
+    def add_roads(self, roads_polygon: dict):
+            """Set roads to paved and unpaved roughness values.
+
+            Parameters
+            ----------
+
+            roads_polygon
+                Dataframe with polygon and associated roughness values
+            """
+
+
+            # Set unpaved roads
+            mask = clip_mask(
+                self._dem.z, roads_polygon[roads_polygon["surface"]=="unpaved"].geometry, self.chunk_size
+            )
+            self._dem["zo"] = self._dem.zo.where(~mask, self.default_values["unpaved"])
+            # Then set paved roads
+            mask = clip_mask(
+                self._dem.z, roads_polygon[roads_polygon["surface"]=="paved"].geometry, self.chunk_size
+            )
+            self._dem["zo"] = self._dem.zo.where(~mask, self.default_values["paved"])
+            self._write_netcdf_conventions_in_place(self._dem, self.catchment_geometry.crs)
+
     def _add_tiled_lidar_chunked(
         self,
         lidar_datasets_info: dict,