Adds land-sea mask generation

conda-env/ci.yml

@@ -13,7 +13,9 @@ dependencies:
     - netcdf4
     - numpy >=2.0.0,<3.0.0
     - pandas
+    - pooch >=1.8
     - python-dateutil
+    - regionmask
     - scipy
     - sparse
     - xarray >=2024.03.0
@@ -26,4 +28,3 @@ dependencies:
     # ==================
     - pytest
     - pytest-cov
-    - pooch # Required for xarray tutorial data

conda-env/dev.yml

@@ -13,7 +13,9 @@ dependencies:
     - netcdf4
     - numpy >=2.0.0,<3.0.0
     - pandas
+    - pooch >=1.8
     - python-dateutil
+    - regionmask
     - scipy
     - sparse
     - xarray >=2024.03.0
@@ -34,7 +36,6 @@ dependencies:
     - pandoc
     - ipython # Required for nbsphinx syntax highlighting
     - gsw-xarray # Required for vertical regridding example
-    - pooch # Required for xarray tutorial data
     # Quality Assurance
     # ==================
     - types-python-dateutil

docs/api.rst

@@ -39,6 +39,17 @@ Below is a list of top-level API functions that are available in ``xcdat``.
     create_zonal_grid
     tutorial.open_dataset
 
+Module-level API Functions
+--------------------------
+
+Below is a list of module-level API functions that are available in ``xcdat``.
+
+.. autosummary::
+    :toctree: generated/
+
+    mask.pcmdi_land_sea_mask
+
+
 Accessors
 ---------
 
@@ -123,6 +134,9 @@ Methods
     Dataset.bounds.get_bounds
     Dataset.bounds.add_missing_bounds
     Dataset.spatial.average
+    Dataset.spatial.mask_land
+    Dataset.spatial.mask_sea
+    Dataset.spatial.generate_land_sea_mask
     Dataset.temporal.average
     Dataset.temporal.group_average
     Dataset.temporal.climatology