Merge pull request #26 from brews/inconsistent_ds

Breaking change to ProjectionTemplate signature

Author: brews

CHANGELOG.md

@@ -21,6 +21,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - BREAKING: `isku.build_extraction_workflow` is now `isku.build_extraction_template`.
 - BREAKING: `isku.build_projection_workflow` is now `isku.build_projection_template`.
 - BREAKING: In `isku.extract_regions`, the `workflow` argument is now `template`.
+- BREAKING: `isku.ProjectionTemplate` protocol methods `d` argument is now `ds` to make it consistent with extraction signatures.
 - Improved README.
 - Improved CONTRIBUTING.
 - Add project URLs to package metadata.

src/isku/project.py

@@ -20,19 +20,19 @@ class ProjectionTemplate(Protocol):
     build_projection_template: Build a projection template from simple functions.
     """
 
-    def pre_project(self, d: xr.Dataset) -> xr.Dataset:
+    def pre_project(self, ds: xr.Dataset) -> xr.Dataset:
         """
         Pre-process a dataset before projection
         """
         ...
 
-    def project(self, d: xr.Dataset) -> xr.Dataset:
+    def project(self, ds: xr.Dataset) -> xr.Dataset:
         """
         Create a projection from a dataset
         """
         ...
 
-    def post_project(self, d: xr.Dataset) -> xr.Dataset:
+    def post_project(self, ds: xr.Dataset) -> xr.Dataset:
         """
         Process a projected dataset
         """
@@ -70,7 +70,7 @@ def build_projection_template(
     )
 
 
-def project(d: xr.Dataset, *, model: ProjectionTemplate) -> xr.Dataset:
+def project(ds: xr.Dataset, *, model: ProjectionTemplate) -> xr.Dataset:
     """
     Project a dataset of predictors, 'd', with 'model' to return a projected dataset
 
@@ -79,7 +79,7 @@ def project(d: xr.Dataset, *, model: ProjectionTemplate) -> xr.Dataset:
     build_projection_template: Build a projection template from simple functions.
     ProjectionTemplate: Technical ProjectionTemplate protocol.
     """
-    preprocessed = model.pre_project(d)
+    preprocessed = model.pre_project(ds)
     projected = model.project(preprocessed)
     postprocessed = model.post_project(projected)