TRT-635 Removing netcdf4 input handling (#34)

Author: owenlittlejohns

.gitattributes

@@ -9,3 +9,21 @@ repos:
       - id: check-json
       - id: check-yaml
       - id: check-added-large-files
+  - repo: http://github.com/astral-sh/ruff-pre-commit
+    rev: v0.12.12
+    hooks:
+      - id: ruff
+        args: [ "--fix", "--show-fixes" ]
+        types_or: [ python, jupyter ]
+        exclude: |
+          (?x)^(
+              gdal_adapter/transform.py|
+              gdal_adapter/reformat.py
+          )$
+      - id: ruff-format
+        types_or: [ python, jupyter ]
+        exclude: |
+          (?x)^(
+              gdal_adapter/transform.py|
+              gdal_adapter/reformat.py
+          )$

.pre-commit-config.yaml

@@ -5,6 +5,27 @@ documented in this file. The format is based on [Keep a
 Changelog](http://keepachangelog.com/en/1.0.0/).
 
 
+## [v3.0.0] - 2025-09-18
+
+### Added:
+
+* `ruff` hooks have been added to the `pre-commit` settings for this repository.
+  They exclude large legacy files, but will otherwise scan smaller files as
+  they are iterated.
+
+### Changed:
+
+* Functionality to generate netCDF4 output files from GeoTIFFs has been migrated
+  into a new separate module. This may be a step towards a separate microservice
+  for this operation.
+
+### Removed:
+
+* Input files that are netCDF4 or zip files containing netCDF4 files will no
+  longer be processed in this service. Instead, the [net2cog](https://github.com/podaac/net2cog)
+  service should be used as a preceding step to ensure a GeoTIFF input to this
+  service.
+
 ## [v2.0.0] - 2025-09-05
 
 ### Changed:
@@ -319,5 +340,6 @@ This is the final version. We will stop the development for a while.
 
 ## [v1.0.0]
 
+[v3.0.0]: https://github.com/nasa/harmony-gdal-adapter/releases/tag/3.0.0
 [v2.0.0]: https://github.com/nasa/harmony-gdal-adapter/releases/tag/2.0.0
 [v1.1.0]: https://github.com/nasa/harmony-gdal-adapter/releases/tag/1.1.0

CHANGELOG.md

@@ -1,7 +1,8 @@
-"""This module contains custom exceptions specific to the Harmony GDAL Adapter
-    service. These exceptions are intended to allow for clearer messages to the
-    end-user and easier debugging of expected errors that arise during an
-    invocation of the service.
+"""Contains custom exceptions specific to the Harmony GDAL Adapter service.
+
+These exceptions are intended to allow for clearer messages to the
+end-user and easier debugging of expected errors that arise during an
+invocation of the service.
 
 """
 # noqa: D107
@@ -13,42 +14,29 @@ class HGAException(HarmonyException):
     """Base class for exceptions in the Harmony GDAL Adapter."""
 
     def __init__(self, message):
-        super().__init__(message, 'nasa/harmony-gdal-adapter')
+        super().__init__(message)
 
 
 class DownloadError(HGAException):
-    """ This exception is raised when the Harmony GDAL Adapter cannot retrieve
-        input data.
+    """Raised when the Harmony GDAL Adapter cannot retrieve input data."""
 
-    """
     def __init__(self, url, message):
-        super().__init__(f'Could not download resource: {url}, {message}')
+        super().__init__(f"Could not download resource: {url}, {message}")
 
 
-class UnknownFileFormatError(HGAException):
-    """ This is raised when the input file format is one that cannot by
-        processed by the Harmony GDAL Adapter.
+class UnsupportedFileFormatError(HGAException):
+    """Raised when the input file format is cannot processed by the HGA."""
 
-    """
     def __init__(self, file_format):
-        super().__init__('Cannot process unrecognised file format: '
-                         f'"{file_format}"')
+        super().__init__(f'Cannot process unsupported file format: "{file_format}"')
 
 
 class IncompatibleVariablesError(HGAException):
-    """ This exception is raised when the dataset variables requested are not
-    compatible, i.e. they have different projections, geotransforms, sizes or
-    data types.
+    """Raised when the dataset variables requested are not compatible.
 
-    """
-    def __init__(self, message):
-        super().__init__(f'Incompatible variables: {message}')
-
-
-class MultipleZippedNetCDF4FilesError(HGAException):
-    """ This exception is raised when the input file supplied to HGA is a zip
-        file containing multiple NetCDF-4 files, as these cannot be aggregated.
+    i.e. they have different projections, geotransforms, sizes or data types.
 
     """
-    def __init__(self, zip_file):
-        super().__init__(f'Multiple NetCDF-4 files within input: {zip_file}.')
+
+    def __init__(self, message):
+        super().__init__(f"Incompatible variables: {message}")