Regridding functionalities (powered by xESMF)

.pre-commit-config.yaml

@@ -32,6 +32,7 @@ repos:
     hooks:
     -   id: isort
         args: ['--profile', 'black']
+        exclude: clisops/core/__init__.py
 #-   repo: https://github.com/pycqa/pydocstyle
 #    rev: 6.1.1
 #    hooks:

.readthedocs.yml

@@ -25,4 +25,7 @@ python:
 build:
   os: ubuntu-20.04
   tools:
-    python: "3.8"
+    python: "mambaforge-4.10"
+
+conda:
+  environment: docs/environment.yml

HISTORY.rst

@@ -1,6 +1,13 @@
 Version History
 ===============
 
+v0.9.7 (unreleased)
+-------------------
+
+New Features
+^^^^^^^^^^^^
+* ``clisops.ops.regrid``, ``clisops.core.regrid``, ``clisops.core.Weights`` and ``clisops.core.Grid`` added (#TBA). Allowing the remapping of geospatial data on various grids by applying the `xESMF <https://pangeo-xesmf.readthedocs.io/en/latest/>`_ regridder.
+
 v0.9.6 (2023-04-05)
 -------------------
 

README.rst

@@ -48,6 +48,24 @@ The package provides the following operations:
 * average
 * regrid
 
+Online Demo
+-----------
+
+..
+  todo: Links have to be adjusted to the master or respective branch!
+
+You can try clisops online using Binder (just click on the binder link below),
+or view the notebooks on NBViewer.
+
+.. image:: https://mybinder.org/badge_logo.svg
+   :target: https://mybinder.org/v2/gh/roocs/clisops/master?filepath=notebooks
+   :alt: Binder Launcher
+
+.. image:: https://raw.githubusercontent.com/jupyter/design/master/logos/Badges/nbviewer_badge.svg
+   :target: https://nbviewer.jupyter.org/github/roocs/clisops/tree/master/notebooks/
+   :alt: NBViewer
+   :height: 20
+
 Credits
 -------
 

binder/environment.yml

@@ -0,0 +1,36 @@
+name: clisops
+channels:
+ - conda-forge
+dependencies:
+ - python >=3.8
+ - bottleneck >=1.3.1
+ - cf_xarray >=0.7.5
+ - cftime >=1.4.1
+ - dask >=2.6.0
+ - gdal >=3.0
+ - geopandas >=0.11
+ - loguru >=0.5.3
+ - netCDF4 >=1.4
+ - numba  # needed for xesmf v0.6.3, see: https://github.com/conda-forge/xesmf-feedstock/pull/24
+ - numpy >=1.16
+ - packaging
+ - pandas >=1.0.3,<2.0
+ - poppler >=0.67
+ - pyproj >=3.3.0
+ - pooch
+ - requests >=2.0
+ - roocs-utils >=0.6.4,<0.7
+ - shapely >=1.9
+ - sparse >=0.8.0  # needed for xesmf v0.6.3, see: https://github.com/conda-forge/xesmf-feedstock/pull/24
+ - xarray >=0.21,<2023.3.0
+ - xesmf >=0.7.1
+ - jupyterlab
+ - matplotlib>=3.5.2
+ - cartopy>=0.20.2
+ - GitPython
+ - pip:
+   - psy-maps
+   - clisops @ git+https://github.com/roocs/clisops/@regrid-main#egg=clisops
+   - roocs-grids @ git+https://github.com/roocs/roocs-grids.git@main#egg=roocs-grids
+#   - cf-xarray @ git+https://github.com/xarray-contrib/cf-xarray/@main#egg=cf-xarray
+#   - roocs-utils @ git+https://github.com/roocs/roocs-utils.git@master#egg=roocs-utils

binder/postBuild

@@ -1,2 +1,3 @@
-pip install matplotlib
-pip install .
+set -e
+
+git clone https://github.com/roocs/mini-esgf-data ~/.mini-esgf-data

clisops/core/__init__.py

@@ -9,3 +9,5 @@
     subset_time_by_components,
     subset_time_by_values,
 )
+
+from .regrid import Grid, Weights, regrid, weights_cache_init, weights_cache_flush