GRSdriver 2.0.2__tar.gz → 2.0.4__tar.gz

{grsdriver-2.0.2 → grsdriver-2.0.4}/GRSdriver/__init__.py

@@ -88,7 +88,14 @@ equations.
 # v2.0.2 (2026-10-16):
 # continuous integration (tests with Python 3.9 to 3.13, PyPI publishing on tags);
 # grs_driver --help without matplotlib/cartopy
-__version__='2.0.2'
+#
+# v2.0.3 (2026-10-16):
+# README for 2.0, optional extras viz and tutorials, minimal environment.yml
+#
+# v2.0.4 (2026-10-17):
+# direct reading of the bands on their own grid (~20-25 % faster on full scenes),
+# Landsat angles in float32 (also interpolated and in dask mode), automatic GitHub release
+__version__='2.0.4'
 __package__ ='GRSdriver'
 
 from .driver_landsat_col2 import LandsatDriver

{grsdriver-2.0.2 → grsdriver-2.0.4}/GRSdriver/driver_landsat_col2.py

@@ -18,8 +18,10 @@ Example::
 import datetime
 import glob
 import os
+from concurrent.futures import ThreadPoolExecutor
 
 import numpy as np
+import dask.array as da
 import pandas as pd
 import geopandas as gpd
 import xarray as xr
@@ -254,9 +256,11 @@ class LandsatDriver():
         # convert band from normalized radiance into reflectance
         # vis-NIR-SWIR bands only (upper limit 3000nm)
         # -----------------------------------------------------------
-        mus = np.cos(np.radians(self.prod['sza'])).astype(self.prod.bands.dtype)
-        self.prod['bands'] = xr.where(self.prod.wl <= 3000, self.prod.bands / mus, self.prod.bands,
-                                      keep_attrs=True).transpose(*self.prod.bands.dims)
+        bands = self.prod.bands
+        mus = np.cos(np.radians(self.prod['sza'])).astype(bands.dtype)
+        # DataArray.where rather than xr.where, which computes float64 on dask arrays (float32 declared)
+        self.prod['bands'] = bands.where(self.prod.wl > 3000, bands / mus).astype(bands.dtype) \
+            .transpose(*bands.dims)
 
 
         self.prod.attrs = self.prod.attrs
@@ -301,7 +305,19 @@ class LandsatDriver():
             margin = 2 * max(abs(float(ds.x[1] - ds.x[0])), abs(float(ds.y[1] - ds.y[0])))
             ds = ds.sel(x=slice(x.min() - margin, x.max() + margin),
                         y=slice(y.max() + margin, y.min() - margin))
+            dtypes = {var: ds[var].dtype for var in ds.data_vars}
             ds = ds.interp(x=self.prod.x, y=self.prod.y, method=method)
+            # interp computes in float64 (on dask arrays while declaring the input dtype):
+            # float variables back to their dtype (e.g. float32 angles)
+            for var, dtype in dtypes.items():
+                if dtype.kind == 'f':
+                    data = ds[var].data
+                    if isinstance(data, da.Array):
+                        data = data.map_blocks(lambda block, dtype=dtype: block.astype(dtype, copy=False),
+                                               dtype=dtype)
+                    else:
+                        data = data.astype(dtype, copy=False)
+                    ds[var] = ds[var].copy(data=data)
         if self.prod.bands.chunks is not None:
             ds = ds.chunk({dim: self.prod.bands.chunksizes[dim] for dim in ('y', 'x')})
         return ds
@@ -463,18 +479,20 @@ class LandsatDriver():
 
         # lazy reading in dask mode
         chunks = DASK_CHUNKS if use_dask() else None
-        geom = []
-        for geom_ in geoms:
-            ang_file = glob.glob(opj(self.abspath, '*' + geom_[1] + '.TIF'))[0]
-            raster = xrio.open_rasterio(ang_file, chunks=chunks).squeeze()
-            raster.rio.write_nodata(nodata, inplace=True)
-            raster = raster.where(raster != raster.rio.nodata).astype(np.float32) * np.float32(scale_factor)
-
-            raster.name = geom_[0]
-            geom.append(raster)
-        geom = xr.merge(geom,compat='override')
+
+        def read_angle(suffix):
+            # native grid of the angle file, read as float32 (exact for the stored integers)
+            ang_file = glob.glob(opj(self.abspath, '*' + suffix + '.TIF'))[0]
+            with rasterio.open(ang_file) as src:
+                grid = (src.transform, src.width, src.height)
+            raster = read_on_grid(ang_file, *grid, nodata=nodata, dtype='float32', chunks=chunks)
+            return raster.where(raster != nodata) * np.float32(scale_factor)
+
+        with ThreadPoolExecutor(max_workers=max(1, self.n_workers)) as executor:
+            rasters = list(executor.map(read_angle, [suffix for _, suffix in geoms]))
+        geom = xr.Dataset({name: raster for (name, _), raster in zip(geoms, rasters)})
         geom['raa'] = (geom['saa'] - geom['vaa'])  # %360
-        self.geom = geom.drop_vars(['vaa', 'saa','band'])
+        self.geom = geom.drop_vars(['vaa', 'saa'])
 
     @staticmethod
     def scat_angle(sza, vza, azi):

{grsdriver-2.0.2 → grsdriver-2.0.4}/GRSdriver/run.py

@@ -37,7 +37,6 @@ os.environ[USE_DASK] = "1"
 def main():
 
     args = docopt(__doc__, version=__package__ + '_' + __version__)
-    print(args)
 
     # optional dependencies (extra 'cli'), imported after the parsing so that --help works without them
     try:

{grsdriver-2.0.2 → grsdriver-2.0.4}/GRSdriver/utils.py

@@ -49,11 +49,39 @@ def use_dask():
     return value.lower() in ('1', 'true')
 
 
+def _pixel_offset(src_transform, transform):
+    '''
+    (row, col) offset of the target grid in the source grid when both grids coincide (same
+    pixel size, north up, target origin on a source pixel corner), else None.
+    '''
+    if not (np.isclose(transform.a, src_transform.a) and np.isclose(transform.e, src_transform.e)
+            and transform.b == transform.d == src_transform.b == src_transform.d == 0):
+        return None
+    col = (transform.c - src_transform.c) / src_transform.a
+    row = (transform.f - src_transform.f) / src_transform.e
+    if abs(col - round(col)) > 1e-6 or abs(row - round(row)) > 1e-6:
+        return None
+    return round(row), round(col)
+
+
 def _read_window(path, transform, width, height, resampling, nodata, dtype):
     '''
     Read the first band of ``path`` on a target grid, as a numpy array (see :func:`read_on_grid`).
     '''
     with rasterio.open(path) as src:
+        offset = _pixel_offset(src.transform, transform)
+        if offset is not None:
+            # target grid = part of the source grid: direct copy, no resampling needed
+            row, col = offset
+            src_nodata = src.nodata if nodata is None else nodata
+            data = np.full((height, width), 0 if src_nodata is None else src_nodata,
+                           dtype=dtype or src.dtypes[0])
+            r0, c0 = max(row, 0), max(col, 0)
+            r1, c1 = min(row + height, src.height), min(col + width, src.width)
+            if r1 > r0 and c1 > c0:
+                window = rasterio.windows.Window(c0, r0, c1 - c0, r1 - r0)
+                data[r0 - row:r1 - row, c0 - col:c1 - col] = src.read(1, window=window)
+            return data
         # source window covering the target grid (north up), with a margin for the
         # resampling kernel
         minx, maxx = transform.c, transform.c + transform.a * width

{grsdriver-2.0.2 → grsdriver-2.0.4}/GRSdriver.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: GRSdriver
-Version: 2.0.2
+Version: 2.0.4
 Summary: Driver for L1C satellite images dedicated to GRS processor
 Author-email: Tristan Harmel <tristan.harmel@gmail.com>
 License-Expression: Apache-2.0
@@ -33,14 +33,24 @@ Requires-Dist: xarray
 Requires-Dist: shapely
 Requires-Dist: geopandas>=1.0
 Provides-Extra: dev
-Requires-Dist: black; extra == "dev"
-Requires-Dist: bumpver; extra == "dev"
-Requires-Dist: isort; extra == "dev"
-Requires-Dist: pip-tools; extra == "dev"
 Requires-Dist: pytest; extra == "dev"
+Requires-Dist: build; extra == "dev"
+Requires-Dist: twine; extra == "dev"
 Provides-Extra: cli
 Requires-Dist: matplotlib; extra == "cli"
 Requires-Dist: cartopy; extra == "cli"
+Provides-Extra: viz
+Requires-Dist: matplotlib; extra == "viz"
+Requires-Dist: holoviews; extra == "viz"
+Requires-Dist: datashader; extra == "viz"
+Requires-Dist: bokeh; extra == "viz"
+Requires-Dist: colorcet; extra == "viz"
+Requires-Dist: panel; extra == "viz"
+Provides-Extra: tutorials
+Requires-Dist: jupyterlab; extra == "tutorials"
+Requires-Dist: matplotlib; extra == "tutorials"
+Requires-Dist: cartopy; extra == "tutorials"
+Requires-Dist: requests; extra == "tutorials"
 Dynamic: license-file
 
 <img src="https://raw.githubusercontent.com/Tristanovsk/GRSdriver/master/docs/source/_static/GRS_driver.png" alt="GRSdriver_icon" width="100"/>
@@ -49,7 +59,10 @@ Dynamic: license-file
 ## Driver dedicated to load and prepare data for the GRS processor
 
 [![PyPI](https://img.shields.io/pypi/v/GRSdriver)](https://pypi.org/project/GRSdriver/)
+[![Python](https://img.shields.io/pypi/pyversions/GRSdriver)](https://pypi.org/project/GRSdriver/)
+[![tests](https://github.com/Tristanovsk/GRSdriver/actions/workflows/tests.yml/badge.svg)](https://github.com/Tristanovsk/GRSdriver/actions/workflows/tests.yml)
 [![Documentation](https://readthedocs.org/projects/grsdriver/badge/?version=latest)](https://grsdriver.readthedocs.io)
+[![License](https://img.shields.io/pypi/l/GRSdriver)](https://github.com/Tristanovsk/GRSdriver/blob/master/LICENSE)
 
 GRSdriver loads a Level-1 satellite image into a single `xarray.Dataset` ready for the
 [GRS](https://github.com/CNES/GRSprocessor) atmospheric and sunglint correction:
@@ -59,37 +72,49 @@ GRSdriver loads a Level-1 satellite image into a single `xarray.Dataset` ready f
 - Landsat 8 and 9 Collection-2 L1: reflectance, brightness temperature of the thermal bands,
   sun/viewing angles and L1 quality flags
 - spectral response functions and central wavelengths of each band
-- spatial subsetting, lazy (dask) loading and low memory options for full tiles
+- spatial subsetting, parallel reading, lazy (dask) loading and low memory options for full tiles
 - visualization tools
 
 Full documentation: https://grsdriver.readthedocs.io
 
+## What's new in 2.0
+
+- **pip-only install**: EOReader and the GDAL Python bindings are no longer needed.
+- **~2x faster**: full Sentinel-2 tile at 20 m in ~30 s (bands read and angles computed in
+  parallel), fully lazy dask mode in ~20 s.
+- **Fixes**: Sentinel-2 angles of processing baselines < 4.0, alignment of the Landsat
+  panchromatic band, size of the `SpatioTemp` boxes.
+- **Upgrading from 1.x**: the drivers no longer take `**kwargs` (they were passed to EOReader) and
+  have no `.reader` attribute; a `subset` given as a sequence is a bounding box
+  `(minx, miny, maxx, maxy)` in the product CRS. See the
+  [CHANGELOG](https://github.com/Tristanovsk/GRSdriver/blob/master/CHANGELOG.md).
+
 ## Installation
 
+Python 3.9 to 3.13:
+
 ```commandline
 pip install GRSdriver
 ```
 
 No separate GDAL installation is needed: rasterio and geopandas ship with their own GDAL
-(including the JPEG2000 driver for Sentinel-2). The `grs_driver` command line (RGB quicklooks)
-needs matplotlib and cartopy:
-```commandline
-pip install "GRSdriver[cli]"
-```
+(including the JPEG2000 driver for Sentinel-2). Optional extras:
+
+| Extra | For | Install |
+|---|---|---|
+| `cli` | `grs_driver` command line (RGB quicklooks) | `pip install "GRSdriver[cli]"` |
+| `viz` | interactive visualization tools (`GRSdriver.visual`) | `pip install "GRSdriver[viz]"` |
+| `tutorials` | running the tutorial notebooks | `pip install "GRSdriver[tutorials]"` |
 
-### Installation from the repository (to use the notebooks and visualization tools)
+### From the repository
+
+To run the tutorials or work on the code:
 ```commandline
 git clone https://github.com/Tristanovsk/GRSdriver.git
 cd GRSdriver
-conda env create -f environment.yml
-conda activate grs
-pip install -e .
-```
-
-For the interactive visualization tools and the notebooks:
-```commandline
-conda install -c conda-forge jupyterlab holoviews panel datashader cartopy
+pip install -e ".[cli,viz,tutorials,dev]"
 ```
+or with conda: `conda env create -f environment.yml && conda activate grsdriver`.
 
 ## Quick start
 
@@ -104,6 +129,12 @@ prod = l1c.prod          # bands, vza, raa, sza, SRF, wl_true + metadata
 # Landsat 8/9
 l1 = LandsatDriver('LC09_L1TP_..._02_T1', resolution=30)
 l1.load_product()
+
+# region of interest: any geometry (GeoSeries, any CRS), here a lon/lat box
+import geopandas as gpd
+from shapely.geometry import box
+roi = gpd.GeoSeries([box(5.0, 43.38, 5.25, 43.58)], crs=4326)
+l1c = Sentinel2Driver('S2B_MSIL1C_..._.SAFE', resolution=20, subset=roi)
 ```
 
 The bands are read by 4 threads in parallel: set `n_workers` (e.g. `n_workers=1`) to trade speed
@@ -174,6 +205,9 @@ Viewing azimuth of each band computed by GRSdriver:
 
 ![example files](https://raw.githubusercontent.com/Tristanovsk/GRSdriver/master/docs/source/_static/example_ndwi_mask.png)
 
-## Changes
+## Changes and contributing
 
-See [CHANGELOG.md](https://github.com/Tristanovsk/GRSdriver/blob/master/CHANGELOG.md).
+See the [CHANGELOG](https://github.com/Tristanovsk/GRSdriver/blob/master/CHANGELOG.md). Tests run
+with `pytest tests` (the tests that need satellite products are skipped when they are not
+available); the [contributing guide](https://grsdriver.readthedocs.io/en/latest/contributing.html)
+explains how to update the tutorials and make a release.

{grsdriver-2.0.2 → grsdriver-2.0.4}/GRSdriver.egg-info/requires.txt

@@ -19,8 +19,20 @@ matplotlib
 cartopy
 
 [dev]
-black
-bumpver
-isort
-pip-tools
 pytest
+build
+twine
+
+[tutorials]
+jupyterlab
+matplotlib
+cartopy
+requests
+
+[viz]
+matplotlib
+holoviews
+datashader
+bokeh
+colorcet
+panel

{grsdriver-2.0.2 → grsdriver-2.0.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: GRSdriver
-Version: 2.0.2
+Version: 2.0.4
 Summary: Driver for L1C satellite images dedicated to GRS processor
 Author-email: Tristan Harmel <tristan.harmel@gmail.com>
 License-Expression: Apache-2.0
@@ -33,14 +33,24 @@ Requires-Dist: xarray
 Requires-Dist: shapely
 Requires-Dist: geopandas>=1.0
 Provides-Extra: dev
-Requires-Dist: black; extra == "dev"
-Requires-Dist: bumpver; extra == "dev"
-Requires-Dist: isort; extra == "dev"
-Requires-Dist: pip-tools; extra == "dev"
 Requires-Dist: pytest; extra == "dev"
+Requires-Dist: build; extra == "dev"
+Requires-Dist: twine; extra == "dev"
 Provides-Extra: cli
 Requires-Dist: matplotlib; extra == "cli"
 Requires-Dist: cartopy; extra == "cli"
+Provides-Extra: viz
+Requires-Dist: matplotlib; extra == "viz"
+Requires-Dist: holoviews; extra == "viz"
+Requires-Dist: datashader; extra == "viz"
+Requires-Dist: bokeh; extra == "viz"
+Requires-Dist: colorcet; extra == "viz"
+Requires-Dist: panel; extra == "viz"
+Provides-Extra: tutorials
+Requires-Dist: jupyterlab; extra == "tutorials"
+Requires-Dist: matplotlib; extra == "tutorials"
+Requires-Dist: cartopy; extra == "tutorials"
+Requires-Dist: requests; extra == "tutorials"
 Dynamic: license-file
 
 <img src="https://raw.githubusercontent.com/Tristanovsk/GRSdriver/master/docs/source/_static/GRS_driver.png" alt="GRSdriver_icon" width="100"/>
@@ -49,7 +59,10 @@ Dynamic: license-file
 ## Driver dedicated to load and prepare data for the GRS processor
 
 [![PyPI](https://img.shields.io/pypi/v/GRSdriver)](https://pypi.org/project/GRSdriver/)
+[![Python](https://img.shields.io/pypi/pyversions/GRSdriver)](https://pypi.org/project/GRSdriver/)
+[![tests](https://github.com/Tristanovsk/GRSdriver/actions/workflows/tests.yml/badge.svg)](https://github.com/Tristanovsk/GRSdriver/actions/workflows/tests.yml)
 [![Documentation](https://readthedocs.org/projects/grsdriver/badge/?version=latest)](https://grsdriver.readthedocs.io)
+[![License](https://img.shields.io/pypi/l/GRSdriver)](https://github.com/Tristanovsk/GRSdriver/blob/master/LICENSE)
 
 GRSdriver loads a Level-1 satellite image into a single `xarray.Dataset` ready for the
 [GRS](https://github.com/CNES/GRSprocessor) atmospheric and sunglint correction:
@@ -59,37 +72,49 @@ GRSdriver loads a Level-1 satellite image into a single `xarray.Dataset` ready f
 - Landsat 8 and 9 Collection-2 L1: reflectance, brightness temperature of the thermal bands,
   sun/viewing angles and L1 quality flags
 - spectral response functions and central wavelengths of each band
-- spatial subsetting, lazy (dask) loading and low memory options for full tiles
+- spatial subsetting, parallel reading, lazy (dask) loading and low memory options for full tiles
 - visualization tools
 
 Full documentation: https://grsdriver.readthedocs.io
 
+## What's new in 2.0
+
+- **pip-only install**: EOReader and the GDAL Python bindings are no longer needed.
+- **~2x faster**: full Sentinel-2 tile at 20 m in ~30 s (bands read and angles computed in
+  parallel), fully lazy dask mode in ~20 s.
+- **Fixes**: Sentinel-2 angles of processing baselines < 4.0, alignment of the Landsat
+  panchromatic band, size of the `SpatioTemp` boxes.
+- **Upgrading from 1.x**: the drivers no longer take `**kwargs` (they were passed to EOReader) and
+  have no `.reader` attribute; a `subset` given as a sequence is a bounding box
+  `(minx, miny, maxx, maxy)` in the product CRS. See the
+  [CHANGELOG](https://github.com/Tristanovsk/GRSdriver/blob/master/CHANGELOG.md).
+
 ## Installation
 
+Python 3.9 to 3.13:
+
 ```commandline
 pip install GRSdriver
 ```
 
 No separate GDAL installation is needed: rasterio and geopandas ship with their own GDAL
-(including the JPEG2000 driver for Sentinel-2). The `grs_driver` command line (RGB quicklooks)
-needs matplotlib and cartopy:
-```commandline
-pip install "GRSdriver[cli]"
-```
+(including the JPEG2000 driver for Sentinel-2). Optional extras:
+
+| Extra | For | Install |
+|---|---|---|
+| `cli` | `grs_driver` command line (RGB quicklooks) | `pip install "GRSdriver[cli]"` |
+| `viz` | interactive visualization tools (`GRSdriver.visual`) | `pip install "GRSdriver[viz]"` |
+| `tutorials` | running the tutorial notebooks | `pip install "GRSdriver[tutorials]"` |
 
-### Installation from the repository (to use the notebooks and visualization tools)
+### From the repository
+
+To run the tutorials or work on the code:
 ```commandline
 git clone https://github.com/Tristanovsk/GRSdriver.git
 cd GRSdriver
-conda env create -f environment.yml
-conda activate grs
-pip install -e .
-```
-
-For the interactive visualization tools and the notebooks:
-```commandline
-conda install -c conda-forge jupyterlab holoviews panel datashader cartopy
+pip install -e ".[cli,viz,tutorials,dev]"
 ```
+or with conda: `conda env create -f environment.yml && conda activate grsdriver`.
 
 ## Quick start
 
@@ -104,6 +129,12 @@ prod = l1c.prod          # bands, vza, raa, sza, SRF, wl_true + metadata
 # Landsat 8/9
 l1 = LandsatDriver('LC09_L1TP_..._02_T1', resolution=30)
 l1.load_product()
+
+# region of interest: any geometry (GeoSeries, any CRS), here a lon/lat box
+import geopandas as gpd
+from shapely.geometry import box
+roi = gpd.GeoSeries([box(5.0, 43.38, 5.25, 43.58)], crs=4326)
+l1c = Sentinel2Driver('S2B_MSIL1C_..._.SAFE', resolution=20, subset=roi)
 ```
 
 The bands are read by 4 threads in parallel: set `n_workers` (e.g. `n_workers=1`) to trade speed
@@ -174,6 +205,9 @@ Viewing azimuth of each band computed by GRSdriver:
 
 ![example files](https://raw.githubusercontent.com/Tristanovsk/GRSdriver/master/docs/source/_static/example_ndwi_mask.png)
 
-## Changes
+## Changes and contributing
 
-See [CHANGELOG.md](https://github.com/Tristanovsk/GRSdriver/blob/master/CHANGELOG.md).
+See the [CHANGELOG](https://github.com/Tristanovsk/GRSdriver/blob/master/CHANGELOG.md). Tests run
+with `pytest tests` (the tests that need satellite products are skipped when they are not
+available); the [contributing guide](https://grsdriver.readthedocs.io/en/latest/contributing.html)
+explains how to update the tutorials and make a release.

{grsdriver-2.0.2 → grsdriver-2.0.4}/README.md

@@ -4,7 +4,10 @@
 ## Driver dedicated to load and prepare data for the GRS processor
 
 [![PyPI](https://img.shields.io/pypi/v/GRSdriver)](https://pypi.org/project/GRSdriver/)
+[![Python](https://img.shields.io/pypi/pyversions/GRSdriver)](https://pypi.org/project/GRSdriver/)
+[![tests](https://github.com/Tristanovsk/GRSdriver/actions/workflows/tests.yml/badge.svg)](https://github.com/Tristanovsk/GRSdriver/actions/workflows/tests.yml)
 [![Documentation](https://readthedocs.org/projects/grsdriver/badge/?version=latest)](https://grsdriver.readthedocs.io)
+[![License](https://img.shields.io/pypi/l/GRSdriver)](https://github.com/Tristanovsk/GRSdriver/blob/master/LICENSE)
 
 GRSdriver loads a Level-1 satellite image into a single `xarray.Dataset` ready for the
 [GRS](https://github.com/CNES/GRSprocessor) atmospheric and sunglint correction:
@@ -14,37 +17,49 @@ GRSdriver loads a Level-1 satellite image into a single `xarray.Dataset` ready f
 - Landsat 8 and 9 Collection-2 L1: reflectance, brightness temperature of the thermal bands,
   sun/viewing angles and L1 quality flags
 - spectral response functions and central wavelengths of each band
-- spatial subsetting, lazy (dask) loading and low memory options for full tiles
+- spatial subsetting, parallel reading, lazy (dask) loading and low memory options for full tiles
 - visualization tools
 
 Full documentation: https://grsdriver.readthedocs.io
 
+## What's new in 2.0
+
+- **pip-only install**: EOReader and the GDAL Python bindings are no longer needed.
+- **~2x faster**: full Sentinel-2 tile at 20 m in ~30 s (bands read and angles computed in
+  parallel), fully lazy dask mode in ~20 s.
+- **Fixes**: Sentinel-2 angles of processing baselines < 4.0, alignment of the Landsat
+  panchromatic band, size of the `SpatioTemp` boxes.
+- **Upgrading from 1.x**: the drivers no longer take `**kwargs` (they were passed to EOReader) and
+  have no `.reader` attribute; a `subset` given as a sequence is a bounding box
+  `(minx, miny, maxx, maxy)` in the product CRS. See the
+  [CHANGELOG](https://github.com/Tristanovsk/GRSdriver/blob/master/CHANGELOG.md).
+
 ## Installation
 
+Python 3.9 to 3.13:
+
 ```commandline
 pip install GRSdriver
 ```
 
 No separate GDAL installation is needed: rasterio and geopandas ship with their own GDAL
-(including the JPEG2000 driver for Sentinel-2). The `grs_driver` command line (RGB quicklooks)
-needs matplotlib and cartopy:
-```commandline
-pip install "GRSdriver[cli]"
-```
+(including the JPEG2000 driver for Sentinel-2). Optional extras:
+
+| Extra | For | Install |
+|---|---|---|
+| `cli` | `grs_driver` command line (RGB quicklooks) | `pip install "GRSdriver[cli]"` |
+| `viz` | interactive visualization tools (`GRSdriver.visual`) | `pip install "GRSdriver[viz]"` |
+| `tutorials` | running the tutorial notebooks | `pip install "GRSdriver[tutorials]"` |
 
-### Installation from the repository (to use the notebooks and visualization tools)
+### From the repository
+
+To run the tutorials or work on the code:
 ```commandline
 git clone https://github.com/Tristanovsk/GRSdriver.git
 cd GRSdriver
-conda env create -f environment.yml
-conda activate grs
-pip install -e .
-```
-
-For the interactive visualization tools and the notebooks:
-```commandline
-conda install -c conda-forge jupyterlab holoviews panel datashader cartopy
+pip install -e ".[cli,viz,tutorials,dev]"
 ```
+or with conda: `conda env create -f environment.yml && conda activate grsdriver`.
 
 ## Quick start
 
@@ -59,6 +74,12 @@ prod = l1c.prod          # bands, vza, raa, sza, SRF, wl_true + metadata
 # Landsat 8/9
 l1 = LandsatDriver('LC09_L1TP_..._02_T1', resolution=30)
 l1.load_product()
+
+# region of interest: any geometry (GeoSeries, any CRS), here a lon/lat box
+import geopandas as gpd
+from shapely.geometry import box
+roi = gpd.GeoSeries([box(5.0, 43.38, 5.25, 43.58)], crs=4326)
+l1c = Sentinel2Driver('S2B_MSIL1C_..._.SAFE', resolution=20, subset=roi)
 ```
 
 The bands are read by 4 threads in parallel: set `n_workers` (e.g. `n_workers=1`) to trade speed
@@ -129,6 +150,9 @@ Viewing azimuth of each band computed by GRSdriver:
 
 ![example files](https://raw.githubusercontent.com/Tristanovsk/GRSdriver/master/docs/source/_static/example_ndwi_mask.png)
 
-## Changes
+## Changes and contributing
 
-See [CHANGELOG.md](https://github.com/Tristanovsk/GRSdriver/blob/master/CHANGELOG.md).
+See the [CHANGELOG](https://github.com/Tristanovsk/GRSdriver/blob/master/CHANGELOG.md). Tests run
+with `pytest tests` (the tests that need satellite products are skipped when they are not
+available); the [contributing guide](https://grsdriver.readthedocs.io/en/latest/contributing.html)
+explains how to update the tutorials and make a release.

{grsdriver-2.0.2 → grsdriver-2.0.4}/pyproject.toml

@@ -46,9 +46,14 @@ version = { attr = "GRSdriver.__version__" }
 dependencies = { file = ["requirements.txt"] }
 
 [project.optional-dependencies]
-dev = ["black", "bumpver", "isort", "pip-tools", "pytest"]
+# tests and release (see the contributing guide)
+dev = ["pytest", "build", "twine"]
 # grs_driver command line (RGB quicklook)
 cli = ["matplotlib", "cartopy"]
+# interactive visualization tools (GRSdriver.visual)
+viz = ["matplotlib", "holoviews", "datashader", "bokeh", "colorcet", "panel"]
+# to run the tutorial notebooks
+tutorials = ["jupyterlab", "matplotlib", "cartopy", "requests"]
 
 [project.urls]
 Documentation = "https://grsdriver.readthedocs.io"

{grsdriver-2.0.2 → grsdriver-2.0.4}/tests/test_landsat_driver.py

@@ -94,3 +94,19 @@ def test_n_workers_identical():
         l1.load_product()
         prods.append(l1.prod)
     np.testing.assert_array_equal(prods[0].bands.values, prods[1].bands.values)
+
+
+@pytest.mark.parametrize('resolution', [30, 60])
+def test_dask_identical(monkeypatch, resolution):
+    '''Lazy (dask) product identical to the eager one, float32 angles in both modes.'''
+    prods = []
+    for lazy in ('0', '1'):
+        monkeypatch.setenv('GRSDRIVER_USE_DASK', lazy)
+        l1 = LandsatDriver(IMAGE, band_idx=[1, 4, 9], subset=SUBSET, resolution=resolution)
+        l1.load_product()
+        prods.append(l1.prod.compute())
+    eager, lazy = prods
+    for var in ('bands', 'sza', 'vza', 'raa'):
+        assert eager[var].dtype == lazy[var].dtype == np.float32
+        np.testing.assert_array_equal(eager[var].values, lazy[var].values)
+    np.testing.assert_array_equal(eager.flags_l1.values, lazy.flags_l1.values)

{grsdriver-2.0.2 → grsdriver-2.0.4}/tests/test_utils.py

@@ -34,3 +34,32 @@ def test_clip_raster_size():
     clipped = SpatioTemp.clip_raster(raster, 43.47, 5.10, 10000)
     for coord in (clipped.x, clipped.y):
         assert abs(float(coord.max() - coord.min()) + 100 - 10000) <= 200
+
+
+@pytest.mark.parametrize('offset', [(0, 0), (3, 5), (-4, -2), (95, 90)])
+def test_read_on_grid_direct(tmp_path, offset):
+    '''Target grid aligned on the source grid: direct copy identical to the GDAL resampling,
+    with the fill value outside the source.'''
+    import rasterio
+    from affine import Affine
+    from rasterio.enums import Resampling
+    from GRSdriver import utils
+    src_transform = Affine(30, 0, 600000, 0, -30, 4800000)
+    data = np.arange(100 * 100, dtype=np.uint16).reshape(100, 100) + 1
+    data[10:20, 30:40] = 0
+    path = tmp_path / 'src.tif'
+    with rasterio.open(path, 'w', driver='GTiff', width=100, height=100, count=1, dtype='uint16',
+                       crs='EPSG:32631', transform=src_transform, nodata=0) as dst:
+        dst.write(data, 1)
+    row, col = offset
+    transform = src_transform * Affine.translation(col, row)
+    args = (str(path), transform, 20, 30, Resampling.nearest, 0, 'float32')
+    direct = utils._read_window(*args)
+    try:
+        utils._pixel_offset, pixel_offset = (lambda *a: None), utils._pixel_offset
+        resampled = utils._read_window(*args)
+    finally:
+        utils._pixel_offset = pixel_offset
+    assert pixel_offset(src_transform, transform) == (row, col)
+    assert direct.dtype == resampled.dtype == np.float32
+    np.testing.assert_array_equal(direct, resampled)