Merge pull request #49 from quantifyearth/mwd-filename-format-update

Change output filename to match other IUCN projects

Author: mdales

CHANGES.md

@@ -1,3 +1,9 @@
+## v2.1.0 (09/03/2026)
+
+### Changed
+
+* Change the output filename format to match those used in other IUCN processes.
+
 ## v2.0.5 (18/02/2026)
 
 ### Added

aoh/_internal/speciesinfo.py

@@ -45,11 +45,21 @@ def __init__(self, species_data_path: Path, crosswalk_path: Path) -> None:
 
     @property
     def species_id(self) -> int:
-        return self.species_info.id_no.values[0]
+        return int(self.species_info.id_no.values[0])
 
     @property
-    def season(self) -> str:
-        return self.species_info.season.values[0]
+    def assessment_id(self) -> int | None:
+        try:
+            return int(self.species_info.assessment_id.values[0])
+        except AttributeError:
+            return None
+
+    @property
+    def season(self) -> str | None:
+        try:
+            return self.species_info.season.values[0]
+        except AttributeError:
+            return None
 
     @property
     def elevation_lower(self) -> int:
@@ -75,27 +85,23 @@ def raw_habitats(self) -> set[str]:
             self.manifest["error"] = "Species data missing or corrupt habitat data"
             raise ValueError(self.manifest["error"]) from exc
 
-    def filenames(self, output_directory_path:Path) -> tuple[Path,Path]:
-        species_id = self.species_id
-        try:
-            seasonality = self.season
-            result_filename = output_directory_path / f"{species_id}_{seasonality}.tif"
-            manifest_filename = output_directory_path / f"{species_id}_{seasonality}.json"
-        except AttributeError:
-            seasonality = None
-            result_filename = output_directory_path / f"{species_id}.tif"
-            manifest_filename = output_directory_path / f"{species_id}.json"
+    def filenames(self, output_directory_path: Path) -> tuple[Path,Path]:
+        species_id_part = f"T{self.species_id}"
+        assessment_id = self.assessment_id
+        assessment_id_part = f"A{assessment_id}" if assessment_id is not None else ""
+
+        season = self.season
+        seasonality_part = f"_{season}" if season is not None else ""
+
+        stem = f"aoh_{species_id_part}{assessment_id_part}{seasonality_part}"
+
+        result_filename = output_directory_path / f"{stem}.tif"
+        manifest_filename = output_directory_path / f"{stem}.json"
 
         return result_filename, manifest_filename
 
     def save_manifest(self, output_directory_path:Path, error_message: str | None = None) -> None:
-        species_id = self.species_id
-        try:
-            seasonality = self.season
-            manifest_filename = output_directory_path / f"{species_id}_{seasonality}.json"
-        except AttributeError:
-            manifest_filename = output_directory_path / f"{species_id}.json"
-
+        _, manifest_filename = self.filenames(output_directory_path)
         if error_message is not None:
             self.manifest["error"] = error_message
 

aoh/aohcalc.py

@@ -94,7 +94,7 @@ def main() -> None:
     parser.add_argument(
         '--output',
         type=Path,
-        help='Directory where area geotiffs should be stored.',
+        help='Directory where area geotiff and metadata should be stored.',
         required=True,
         dest='output_path',
     )

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "aoh"
-version = "2.0.5"
+version = "2.1.0"
 description = "A library for calculating Area of Habitat for species distribution mapping"
 authors = [
     {name = "Michael Dales", email = "mwd24@cam.ac.uk"}

tests/test_aoh_binary.py

@@ -96,6 +96,7 @@ def generate_species_info(
 ) -> None:
     properties = {
         "id_no": "1234",
+        "assessment_id": "789",
         "season": "1",
         "elevation_lower": float(elevation_range[0]),
         "elevation_upper": float(elevation_range[1]),
@@ -153,9 +154,9 @@ def test_simple_aoh(force_habitat) -> None:
             force_habitat=force_habitat,
         )
 
-        expected_geotiff_path = output_dir / "1234_1.tif"
+        expected_geotiff_path = output_dir / "aoh_T1234A789_1.tif"
         assert expected_geotiff_path.exists()
-        expected_manifest_path = output_dir / "1234_1.json"
+        expected_manifest_path = output_dir / "aoh_T1234A789_1.json"
         assert expected_manifest_path.exists()
 
         with open(expected_manifest_path, "r", encoding="UTF-8") as f:
@@ -224,9 +225,9 @@ def test_no_habitat_aoh(force_habitat) -> None:
             force_habitat=force_habitat,
         )
 
-        expected_geotiff_path = output_dir / "1234_1.tif"
+        expected_geotiff_path = output_dir / "aoh_T1234A789_1.tif"
         assert expected_geotiff_path.exists() == (not force_habitat)
-        expected_manifest_path = output_dir / "1234_1.json"
+        expected_manifest_path = output_dir / "aoh_T1234A789_1.json"
         assert expected_manifest_path.exists()
 
         with open(expected_manifest_path, "r", encoding="UTF-8") as f:
@@ -293,9 +294,9 @@ def test_simple_aoh_weight(force_habitat) -> None:
             weight_layer_paths=[area_path],
         )
 
-        expected_geotiff_path = output_dir / "1234_1.tif"
+        expected_geotiff_path = output_dir / "aoh_T1234A789_1.tif"
         assert expected_geotiff_path.exists()
-        expected_manifest_path = output_dir / "1234_1.json"
+        expected_manifest_path = output_dir / "aoh_T1234A789_1.json"
         assert expected_manifest_path.exists()
 
         with open(expected_manifest_path, "r", encoding="UTF-8") as f:
@@ -367,9 +368,9 @@ def test_simple_aoh_multiple_habitats(force_habitat) -> None:
             force_habitat=force_habitat,
         )
 
-        expected_geotiff_path = output_dir / "1234_1.tif"
+        expected_geotiff_path = output_dir / "aoh_T1234A789_1.tif"
         assert expected_geotiff_path.exists()
-        expected_manifest_path = output_dir / "1234_1.json"
+        expected_manifest_path = output_dir / "aoh_T1234A789_1.json"
         assert expected_manifest_path.exists()
 
         with open(expected_manifest_path, "r", encoding="UTF-8") as f:
@@ -439,9 +440,9 @@ def test_no_overlapping_habitats(force_habitat) -> None:
             force_habitat=force_habitat,
         )
 
-        expected_geotiff_path = output_dir / "1234_1.tif"
+        expected_geotiff_path = output_dir / "aoh_T1234A789_1.tif"
         assert expected_geotiff_path.exists() == (not force_habitat)
-        expected_manifest_path = output_dir / "1234_1.json"
+        expected_manifest_path = output_dir / "aoh_T1234A789_1.json"
         assert expected_manifest_path.exists()
 
         with open(expected_manifest_path, "r", encoding="UTF-8") as f:
@@ -502,9 +503,9 @@ def test_no_elevation_aoh(force_habitat) -> None:
             force_habitat=force_habitat,
         )
 
-        expected_geotiff_path = output_dir / "1234_1.tif"
+        expected_geotiff_path = output_dir / "aoh_T1234A789_1.tif"
         assert expected_geotiff_path.exists()
-        expected_manifest_path = output_dir / "1234_1.json"
+        expected_manifest_path = output_dir / "aoh_T1234A789_1.json"
         assert expected_manifest_path.exists()
 
         with open(expected_manifest_path, "r", encoding="UTF-8") as f:
@@ -579,12 +580,12 @@ def test_simple_aoh_area() -> None:
         expected_area = yg.area_raster(("WGS84", (360/200, -180/200)))
 
         with (
-            yg.read_raster(output_dir_without_area / "1234_1.tif") as aoh_sans_area,
-            yg.read_raster(output_dir_with_area / "1234_1.tif") as aoh_with_area,
+            yg.read_raster(output_dir_without_area / "aoh_T1234A789_1.tif") as aoh_sans_area,
+            yg.read_raster(output_dir_with_area / "aoh_T1234A789_1.tif") as aoh_with_area,
         ):
-            with open(output_dir_without_area / "1234_1.json", "r", encoding="UTF-8") as f:
+            with open(output_dir_without_area / "aoh_T1234A789_1.json", "r", encoding="UTF-8") as f:
                 sans_area_manifest = json.load(f)
-            with open(output_dir_with_area / "1234_1.json", "r", encoding="UTF-8") as f:
+            with open(output_dir_with_area / "aoh_T1234A789_1.json", "r", encoding="UTF-8") as f:
                 with_area_manifest = json.load(f)
 
             # Check calculated values. All habitat layers for this
@@ -661,10 +662,10 @@ def test_simple_aoh_area_and_weights() -> None:
         expected_area = yg.area_raster(("WGS84", (360/200, -180/200)))
 
         with (
-            yg.read_raster(output_dir_without_area / "1234_1.tif") as aoh_sans_area,
-            yg.read_raster(output_dir_with_area / "1234_1.tif") as aoh_with_area,
+            yg.read_raster(output_dir_without_area / "aoh_T1234A789_1.tif") as aoh_sans_area,
+            yg.read_raster(output_dir_with_area / "aoh_T1234A789_1.tif") as aoh_with_area,
         ):
-            with open(output_dir_with_area / "1234_1.json", "r", encoding="UTF-8") as f:
+            with open(output_dir_with_area / "aoh_T1234A789_1.json", "r", encoding="UTF-8") as f:
                 with_area_manifest = json.load(f)
 
             manual_version_total = (aoh_sans_area * expected_area * 2).sum()

tests/test_aoh_fractional.py

@@ -96,6 +96,7 @@ def generate_species_info(
 ) -> None:
     properties = {
         "id_no": "1234",
+        "assessment_id": "789",
         "season": "1",
         "elevation_lower": float(elevation_range[0]),
         "elevation_upper": float(elevation_range[1]),
@@ -156,9 +157,9 @@ def test_simple_aoh(force_habitat) -> None:
             force_habitat=force_habitat,
         )
 
-        expected_geotiff_path = output_dir / "1234_1.tif"
+        expected_geotiff_path = output_dir / "aoh_T1234A789_1.tif"
         assert expected_geotiff_path.exists()
-        expected_manifest_path = output_dir / "1234_1.json"
+        expected_manifest_path = output_dir / "aoh_T1234A789_1.json"
         assert expected_manifest_path.exists()
 
         with open(expected_manifest_path, "r", encoding="UTF-8") as f:
@@ -227,9 +228,9 @@ def test_no_habitat_aoh(force_habitat) -> None:
             force_habitat=force_habitat,
         )
 
-        expected_geotiff_path = output_dir / "1234_1.tif"
+        expected_geotiff_path = output_dir / "aoh_T1234A789_1.tif"
         assert expected_geotiff_path.exists() == (not force_habitat)
-        expected_manifest_path = output_dir / "1234_1.json"
+        expected_manifest_path = output_dir / "aoh_T1234A789_1.json"
         assert expected_manifest_path.exists()
 
         with open(expected_manifest_path, "r", encoding="UTF-8") as f:
@@ -299,9 +300,9 @@ def test_simple_aoh_weights(force_habitat) -> None:
             force_habitat=force_habitat,
         )
 
-        expected_geotiff_path = output_dir / "1234_1.tif"
+        expected_geotiff_path = output_dir / "aoh_T1234A789_1.tif"
         assert expected_geotiff_path.exists()
-        expected_manifest_path = output_dir / "1234_1.json"
+        expected_manifest_path = output_dir / "aoh_T1234A789_1.json"
         assert expected_manifest_path.exists()
 
         with open(expected_manifest_path, "r", encoding="UTF-8") as f:
@@ -372,9 +373,9 @@ def test_simple_aoh_multiple_habitats(force_habitat) -> None:
             force_habitat=force_habitat,
         )
 
-        expected_geotiff_path = output_dir / "1234_1.tif"
+        expected_geotiff_path = output_dir / "aoh_T1234A789_1.tif"
         assert expected_geotiff_path.exists()
-        expected_manifest_path = output_dir / "1234_1.json"
+        expected_manifest_path = output_dir / "aoh_T1234A789_1.json"
         assert expected_manifest_path.exists()
 
         with open(expected_manifest_path, "r", encoding="UTF-8") as f:
@@ -445,9 +446,9 @@ def test_no_overlapping_habitats(force_habitat) -> None:
             force_habitat=force_habitat,
         )
 
-        expected_geotiff_path = output_dir / "1234_1.tif"
+        expected_geotiff_path = output_dir / "aoh_T1234A789_1.tif"
         assert expected_geotiff_path.exists() == (not force_habitat)
-        expected_manifest_path = output_dir / "1234_1.json"
+        expected_manifest_path = output_dir / "aoh_T1234A789_1.json"
         assert expected_manifest_path.exists()
 
         with open(expected_manifest_path, "r", encoding="UTF-8") as f:
@@ -511,9 +512,9 @@ def test_no_elevation_aoh(force_habitat) -> None:
             force_habitat=force_habitat,
         )
 
-        expected_geotiff_path = output_dir / "1234_1.tif"
+        expected_geotiff_path = output_dir / "aoh_T1234A789_1.tif"
         assert expected_geotiff_path.exists()
-        expected_manifest_path = output_dir / "1234_1.json"
+        expected_manifest_path = output_dir / "aoh_T1234A789_1.json"
         assert expected_manifest_path.exists()
 
         with open(expected_manifest_path, "r", encoding="UTF-8") as f:
@@ -588,12 +589,12 @@ def test_simple_aoh_area() -> None:
         expected_area = yg.area_raster(("WGS84", (360/200, -180/200)))
 
         with (
-            yg.read_raster(output_dir_without_area / "1234_1.tif") as aoh_sans_area,
-            yg.read_raster(output_dir_with_area / "1234_1.tif") as aoh_with_area,
+            yg.read_raster(output_dir_without_area / "aoh_T1234A789_1.tif") as aoh_sans_area,
+            yg.read_raster(output_dir_with_area / "aoh_T1234A789_1.tif") as aoh_with_area,
         ):
-            with open(output_dir_without_area / "1234_1.json", "r", encoding="UTF-8") as f:
+            with open(output_dir_without_area / "aoh_T1234A789_1.json", "r", encoding="UTF-8") as f:
                 sans_area_manifest = json.load(f)
-            with open(output_dir_with_area / "1234_1.json", "r", encoding="UTF-8") as f:
+            with open(output_dir_with_area / "aoh_T1234A789_1.json", "r", encoding="UTF-8") as f:
                 with_area_manifest = json.load(f)
 
             # Check calculated values. All habitat layers for this
@@ -671,10 +672,10 @@ def test_simple_aoh_area_and_weights() -> None:
         expected_area = yg.area_raster(("WGS84", (360/200, -180/200)))
 
         with (
-            yg.read_raster(output_dir_without_area / "1234_1.tif") as aoh_sans_area,
-            yg.read_raster(output_dir_with_area / "1234_1.tif") as aoh_with_area,
+            yg.read_raster(output_dir_without_area / "aoh_T1234A789_1.tif") as aoh_sans_area,
+            yg.read_raster(output_dir_with_area / "aoh_T1234A789_1.tif") as aoh_with_area,
         ):
-            with open(output_dir_with_area / "1234_1.json", "r", encoding="UTF-8") as f:
+            with open(output_dir_with_area / "aoh_T1234A789_1.json", "r", encoding="UTF-8") as f:
                 with_area_manifest = json.load(f)
 
             manual_version_total = (aoh_sans_area * expected_area * 2).sum()