Merge pull request #205 from ASFHyP3/develop

Release v1.0.1

.github/workflows/changelog.yml

@@ -14,6 +14,6 @@ on:
 jobs:
   call-changelog-check-workflow:
     # Docs: https://github.com/ASFHyP3/actions
-    uses: ASFHyP3/actions/.github/workflows/reusable-changelog-check.yml@v0.9.0
+    uses: ASFHyP3/actions/.github/workflows/reusable-changelog-check.yml@v0.11.0
     secrets:
       USER_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/create-jira-issue.yml

@@ -6,7 +6,7 @@ on:
 
 jobs:
   call-create-jira-issue-workflow:
-    uses: ASFHyP3/actions/.github/workflows/reusable-create-jira-issue.yml@v0.9.0
+    uses: ASFHyP3/actions/.github/workflows/reusable-create-jira-issue.yml@v0.11.0
     secrets:
       JIRA_BASE_URL: ${{ secrets.JIRA_BASE_URL }}
       JIRA_USER_EMAIL: ${{ secrets.JIRA_USER_EMAIL }}

.github/workflows/labeled-pr.yml

@@ -13,4 +13,4 @@ on:
 jobs:
   call-labeled-pr-check-workflow:
     # Docs: https://github.com/ASFHyP3/actions
-    uses: ASFHyP3/actions/.github/workflows/reusable-labeled-pr-check.yml@v0.9.0
+    uses: ASFHyP3/actions/.github/workflows/reusable-labeled-pr-check.yml@v0.11.0

.github/workflows/release-checklist-comment.yml

@@ -10,7 +10,7 @@ on:
 jobs:
   call-release-workflow:
     # Docs: https://github.com/ASFHyP3/actions
-    uses: ASFHyP3/actions/.github/workflows/reusable-release-checklist-comment.yml@v0.9.0
+    uses: ASFHyP3/actions/.github/workflows/reusable-release-checklist-comment.yml@v0.11.0
     permissions:
       pull-requests: write
     secrets:

.github/workflows/release.yml

@@ -8,7 +8,7 @@ on:
 jobs:
   call-release-workflow:
     # Docs: https://github.com/ASFHyP3/actions
-    uses: ASFHyP3/actions/.github/workflows/reusable-release.yml@v0.9.0
+    uses: ASFHyP3/actions/.github/workflows/reusable-release.yml@v0.11.0
     with:
       release_prefix: HyP3 ISCE2
     secrets:

.github/workflows/static-analysis.yml

@@ -5,10 +5,10 @@ on: push
 jobs:
   call-secrets-analysis-workflow:
     # Docs: https://github.com/ASFHyP3/actions
-    uses: ASFHyP3/actions/.github/workflows/reusable-secrets-analysis.yml@v0.9.0
+    uses: ASFHyP3/actions/.github/workflows/reusable-secrets-analysis.yml@v0.11.0
 
   call-flake8-workflow:
     # Docs: https://github.com/ASFHyP3/actions
-    uses: ASFHyP3/actions/.github/workflows/reusable-flake8.yml@v0.9.0
+    uses: ASFHyP3/actions/.github/workflows/reusable-flake8.yml@v0.11.0
     with:
       local_package_names: hyp3_isce2

.github/workflows/tag-version.yml

@@ -8,7 +8,7 @@ on:
 jobs:
   call-bump-version-workflow:
     # Docs: https://github.com/ASFHyP3/actions
-    uses: ASFHyP3/actions/.github/workflows/reusable-bump-version.yml@v0.9.0
+    uses: ASFHyP3/actions/.github/workflows/reusable-bump-version.yml@v0.11.0
     with:
       user: tools-bot
       email: [email protected]

.github/workflows/test-and-build.yml

@@ -13,20 +13,20 @@ on:
 jobs:
   call-pytest-workflow:
     # Docs: https://github.com/ASFHyP3/actions
-    uses: ASFHyP3/actions/.github/workflows/reusable-pytest.yml@v0.9.0
+    uses: ASFHyP3/actions/.github/workflows/reusable-pytest.yml@v0.11.0
     with:
       local_package_name: hyp3_isce2
       python_versions: >-
         ["3.9", "3.10"]
 
   call-version-info-workflow:
     # Docs: https://github.com/ASFHyP3/actions
-    uses: ASFHyP3/actions/.github/workflows/reusable-version-info.yml@v0.9.0
+    uses: ASFHyP3/actions/.github/workflows/reusable-version-info.yml@v0.11.0
 
   call-docker-ghcr-workflow:
     needs: call-version-info-workflow
     # Docs: https://github.com/ASFHyP3/actions
-    uses: ASFHyP3/actions/.github/workflows/reusable-docker-ghcr.yml@v0.9.0
+    uses: ASFHyP3/actions/.github/workflows/reusable-docker-ghcr.yml@v0.11.0
     with:
       version_tag: ${{ needs.call-version-info-workflow.outputs.version_tag }}
       release_branch: main

CHANGELOG.md

@@ -6,6 +6,11 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [PEP 440](https://www.python.org/dev/peps/pep-0440/)
 and uses [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+
+## [1.0.1]
+### Changed
+* Updated the water mask description in the product metadata templates
+
 ## [1.0.0]
 ### Added
 * `merge_tops_bursts.py` file and workflow for merge burst products created using insar_tops_bursts.
@@ -22,7 +27,7 @@ and uses [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [0.10.0]
 ### Added
-* Support for a new water masking dataset based off of OpenStreetMaps and ESA WorldCover data.
+* Support for a new water masking dataset based off of OpenStreetMap and ESA WorldCover data.
 ### Removed
 * Polygon processing functions: `split_geometry_on_antimeridian` and `get_envelope_wgs84` from `water_mask.py`.
 

src/hyp3_isce2/metadata/templates/insar_burst/insar_burst_base.md.txt.j2

@@ -223,19 +223,19 @@ https://spacedata.copernicus.eu/collections/copernicus-digital-elevation-model.
 ----------------
 ## 8. Water Mask
 
-The water mask identifies coastal waters and major inland waterbodies. These areas are assigned a pixel value of 0.
-All remaining pixels (land, islands in large lakes, small inland waterbodies, and landfast Antarctic ice) have
-a value of 1. The water mask is stored as an 8-bit unsigned integer GeoTIFF file and is always included in the product
-package.
+The water mask identifies coastal waters and most inland waterbodies. These areas are assigned a pixel value of 0.
+All remaining pixels (land, islands in large lakes, very small inland waterbodies, and landfast Antarctic ice)
+have a value of 1. All areas between 85 and 90 degrees north latitude are assigned a value of 0, and all areas
+between 85 and 90 degrees south latitude are assigned a value of 1. The water mask is stored as an 8-bit unsigned
+integer GeoTIFF file and is always included in the product package.
 
 Users can choose to apply the water mask before phase unwrapping. This mitigates potential errors in the unwrapping
 process caused by invalid coherence over water bodies. The water mask will also return nodata values in areas of water
-in the output products. This product {{ "has" if apply_water_mask else "has not" }}
-had the water mask applied.
+in the output products. This product {{ "has" if apply_water_mask else "has not" }} had the water mask applied.
 
-The water mask is generated using data from OpenStreetMaps and/or ESA WorldCover depending on location. Areas within
+The water mask is generated using data from OpenStreetMap and/or ESA WorldCover depending on location. Areas within
 Canada, Alaska, and Russia are primarily covered by ESA WorldCover data, while the rest of the world is covered
-by OpenStreetMaps data. Water masks were previously generated from the GSHHG dataset.
+by OpenStreetMap data.
 
 *************
 {% block burst_insar_processing %}{% endblock %}

src/hyp3_isce2/water_mask.py

@@ -70,7 +70,7 @@ def get_tiles(filename: str, tmp_path: Optional[Path]) -> None:
 def create_water_mask(input_image: str, output_image: str, gdal_format='ISCE', tmp_path: Optional[Path] = Path('.')):
     """Create a water mask GeoTIFF with the same geometry as a given input GeoTIFF
 
-    The water mask is assembled from OpenStreetMaps data.
+    The water mask is assembled from OpenStreetMap data.
 
     Shoreline data is unbuffered and pixel values of 1 indicate land touches the pixel and 0 indicates there is no
     land in the pixel.