rastr 0.3.0__tar.gz → 0.5.0__tar.gz

{rastr-0.3.0 → rastr-0.5.0}/.github/copilot-instructions.md

@@ -10,7 +10,7 @@
 - Write unit tests using `pytest` inside `tests/`, structured based on `src/`.  
   - Example: `src/x/y/z` → `tests/x/y/test_z.py`  
 - Use test fixtures and group tests into classes when appropriate.  
-- When testing methods on classes, create nested test classes within the test class associated with the overall tested class (e.g., `TestContour` nested within `TestRasterModel` when testing the `contour` method of `RasterModel`).
+- When testing methods on classes, create nested test classes within the test class associated with the overall tested class (e.g., `TestContour` nested within `TestRaster` when testing the `contour` method of `Raster`).
 - After modifying a function, run its unit tests using pytest.
 - Run tests in virtual environment: `.\.venv\Scripts\activate; python -m pytest tests/path/to/test_file.py -v`
 

{rastr-0.3.0 → rastr-0.5.0}/.github/workflows/ci.yml

@@ -5,17 +5,17 @@ permissions:
 on:
   workflow_dispatch:
   push:
-    branches: ['master', 'develop']
+    branches: ["master", "develop"]
     paths-ignore:
-      - 'docs/**'
-      - '**/*.md'
-      - 'mkdocs.yml'
+      - "docs/**"
+      - "**/*.md"
+      - "mkdocs.yml"
   pull_request:
-    branches: ['master', 'develop']
+    branches: ["master", "develop"]
     paths-ignore:
-      - 'docs/**'
-      - '**/*.md'
-      - 'mkdocs.yml'
+      - "docs/**"
+      - "**/*.md"
+      - "mkdocs.yml"
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
   cancel-in-progress: true
@@ -39,21 +39,15 @@ jobs:
           version: "0.7.13" # Sync with pyproject.toml
           enable-cache: true
 
-      - name: Set up Python
-        uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b # v5.3.0
-        with:
-          python-version: ${{ matrix.python-version }}
-        
-      - name: Setup dependencies
+      - name: Setup Python
         run: |
           uv python pin ${{ matrix.python-version }}
-          uv export --no-managed-python --no-group doc --resolution ${{ matrix.resolution }} > ci-requirements.txt 
-          uv pip install --system -r ci-requirements.txt
+          uv python install
 
       - name: Run pre-commit
         if: matrix.checks
         run: |
-          uv run --frozen pre-commit run --all-files
+          uv run pre-commit run --all-files
 
       - name: Run pyright
         if: matrix.checks
@@ -64,7 +58,10 @@ jobs:
         uses: pavelzw/pytest-action@510c5e90c360a185039bea56ce8b3e7e51a16507 # v2.2.0
         if: matrix.pytest
         with:
+          custom-pytest: uv run pytest
           custom-arguments: --cov --junitxml=junit.xml -o junit_family=legacy --cov-report=xml
+        env:
+          MPLBACKEND: Agg # https://github.com/orgs/community/discussions/26434
 
       - name: Create test reports directory
         if: matrix.pytest && matrix.os == 'ubuntu-latest' && matrix.python-version == '3.13'
@@ -96,20 +93,20 @@ jobs:
     runs-on: ubuntu-latest
     needs: tests
     if: always() && needs.tests.result == 'success'
-    
+
     steps:
       - name: Checkout code
         uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
         with:
-          fetch-depth: 0  # Shallow clones should be disabled for better relevancy of analysis
-      
+          fetch-depth: 0 # Shallow clones should be disabled for better relevancy of analysis
+
       - name: Download coverage reports
         uses: actions/download-artifact@fa0a91b85d4f404e444e00e005971372dc801d16 # v4.1.8
         with:
           name: coverage-reports
           path: test-reports/
         continue-on-error: true
-      
+
       - name: Create SonarQube properties
         run: |
           cat > sonar-project.properties << EOF
@@ -122,7 +119,7 @@ jobs:
           sonar.exclusions=**/Dockerfile,**/notebooks/**,**/scripts/**
           sonar.verbose=false
           EOF
-      
+
       - name: Run SonarQube analysis
         uses: SonarSource/sonarqube-scan-action@884b79409bbd464b2a59edc326a4b77dc56b2195 # v3.1.0
         env:

{rastr-0.3.0 → rastr-0.5.0}/CONTRIBUTING.md

@@ -55,9 +55,21 @@ uv run detect-test-pollution --fuzz --tests ./tests
 
 and follow the prompts to bisect the tests.
 
-### Profiling Test collection speed
+### Profiling the Test Suite
 
-To profile the speed of test collection (which is mostly related to import times), use `pyinstrument`:
+To profile the test suite, use `pyinstrument`:
+
+```shell
+uv run pyinstrument -m pytest
+```
+
+For more in-depth exploration, try the `-r html` option to generate an HTML report:
+
+```shell
+uv run pyinstrument -r html -m pytest
+```
+
+To profile the speed of test _collection_ (which is mostly related to import times), you can also use `pyinstrument`:
 
 ```shell
 uv run pyinstrument -m pytest --collect-only

{rastr-0.3.0 → rastr-0.5.0}/PKG-INFO

@@ -1,11 +1,11 @@
 Metadata-Version: 2.4
 Name: rastr
-Version: 0.3.0
+Version: 0.5.0
 Summary: Geospatial Raster datatype library for Python.
 Project-URL: Source Code, https://github.com/tonkintaylor/rastr
 Project-URL: Bug Tracker, https://github.com/tonkintaylor/rastr/issues
 Project-URL: Releases, https://github.com/tonkintaylor/rastr/releases
-Project-URL: Source Archive, https://github.com/tonkintaylor/rastr/archive/46f802e7abd275eff61c73c5edc147d92966c886.zip
+Project-URL: Source Archive, https://github.com/tonkintaylor/rastr/archive/fde05e3c098da7ff9e77a37332d55fb7dbacd873.zip
 Author-email: Tonkin & Taylor Limited <Sub-DisciplineData+AnalyticsStaff@tonkintaylor.co.nz>, Nathan McDougall <nmcdougall@tonkintaylor.co.nz>, Ben Karl <bkarl@tonkintaylor.co.nz>
 License-Expression: MIT
 License-File: LICENSE
@@ -75,10 +75,10 @@ from pyproj.crs.crs import CRS
 from rasterio.transform import from_origin
 from rastr.create import full_raster
 from rastr.meta import RasterMeta
-from rastr.raster import RasterModel
+from rastr.raster import Raster
 
 # Create an example raster
-raster = RasterModel.example()
+raster = Raster.example()
 
 # Basic arithmetic operations
 doubled = raster * 2
@@ -131,6 +131,12 @@ Current version limitations:
 - Square cells only (rectangular cell support planned).
 - Only float dtypes (integer support planned).
 
+## Similar Projects
+
+- [rasters](https://github.com/python-rasters/rasters) is a project with similar goals of providing a dedicated raster datatype in Python with higher-level interfaces for GIS operations. Unlike `rastr`, it has support for multi-band rasters, and has some more advanced functionality for Earth Science applications. Both projects are relatively new and under active development.
+- [rasterio](https://rasterio.readthedocs.io/) is a core dependency of `rastr` and provides low-level raster I/O and processing capabilities.
+- [rioxarray](https://corteva.github.io/rioxarray/stable/getting_started/getting_started.html) extends [`xarray`](https://docs.xarray.dev/en/stable/index.html) for raster data with geospatial support via `rasterio`.
+
 ### Contributing
 
 See the

{rastr-0.3.0 → rastr-0.5.0}/README.md

@@ -41,10 +41,10 @@ from pyproj.crs.crs import CRS
 from rasterio.transform import from_origin
 from rastr.create import full_raster
 from rastr.meta import RasterMeta
-from rastr.raster import RasterModel
+from rastr.raster import Raster
 
 # Create an example raster
-raster = RasterModel.example()
+raster = Raster.example()
 
 # Basic arithmetic operations
 doubled = raster * 2
@@ -97,6 +97,12 @@ Current version limitations:
 - Square cells only (rectangular cell support planned).
 - Only float dtypes (integer support planned).
 
+## Similar Projects
+
+- [rasters](https://github.com/python-rasters/rasters) is a project with similar goals of providing a dedicated raster datatype in Python with higher-level interfaces for GIS operations. Unlike `rastr`, it has support for multi-band rasters, and has some more advanced functionality for Earth Science applications. Both projects are relatively new and under active development.
+- [rasterio](https://rasterio.readthedocs.io/) is a core dependency of `rastr` and provides low-level raster I/O and processing capabilities.
+- [rioxarray](https://corteva.github.io/rioxarray/stable/getting_started/getting_started.html) extends [`xarray`](https://docs.xarray.dev/en/stable/index.html) for raster data with geospatial support via `rasterio`.
+
 ### Contributing
 
 See the

{rastr-0.3.0 → rastr-0.5.0}/pyproject.toml

@@ -63,7 +63,7 @@ dev = [
   "pre-commit-update>=0.8.0",
   "pyinstrument>=5.1.1",
   "pyright[nodejs]>=1.1.403",
-  "ruff>=0.12.5",
+  "ruff>=0.13.2",
   "tqdm>=4.67.1",
   "usethis>=0.15.2",
 ]
@@ -123,7 +123,6 @@ lint.ignore = [
   # In some cases where your code is poorly-performing you might want to enable them again.
   # ##############################
   "PD101",   # Harms readability for a performance optimization.
-  "PD901",   # We often call variables "df" in functions dealing with pandas DataFrames.
   "PERF203", # Too many false positives.
   "PERF401", # This can hurt readability; the performance is not always worth it.
   "PIE804",  # This is controversial, some pandas APIs work better with dict approach.
@@ -182,7 +181,6 @@ lint.per-file-ignores."tests/**/*.py" = [
   "PLR0913", # When we use fixtures, our test functions can have many arguments
   "S101",    # Using assert is fine in tests
   "SLF001",  # Accessing private members is sometimes necessary in tests
-  "TID253",  # Conditional imports are not banned for tests
 ]
 lint.allowed-confusables = [ "ℹ", "–", "σ" ]
 lint.flake8-tidy-imports.banned-api."pytz".msg = "'zoneinfo' should be preferred to 'pytz' when using Python 3.9 and later, see https://tonkintaylor-sonarqube.azurewebsites.net/coding_rules?open=python%3AS6890&rule_key=python%3AS6890"

{rastr-0.3.0 → rastr-0.5.0}/src/rastr/_version.py

@@ -28,7 +28,7 @@ version_tuple: VERSION_TUPLE
 commit_id: COMMIT_ID
 __commit_id__: COMMIT_ID
 
-__version__ = version = '0.3.0'
-__version_tuple__ = version_tuple = (0, 3, 0)
+__version__ = version = '0.5.0'
+__version_tuple__ = version_tuple = (0, 5, 0)
 
 __commit_id__ = commit_id = None

{rastr-0.3.0 → rastr-0.5.0}/src/rastr/create.py

@@ -13,7 +13,7 @@ from shapely.geometry import Point
 
 from rastr.gis.fishnet import create_point_grid, get_point_grid_shape
 from rastr.meta import RasterMeta
-from rastr.raster import RasterModel
+from rastr.raster import Raster
 
 if TYPE_CHECKING:
     from collections.abc import Iterable
@@ -49,9 +49,9 @@ def raster_distance_from_polygon(
     *,
     raster_meta: RasterMeta,
     extent_polygon: Polygon | None = None,
-    snap_raster: RasterModel | None = None,
+    snap_raster: Raster | None = None,
     show_pbar: bool = False,
-) -> RasterModel:
+) -> Raster:
     """Make a raster where each cell's value is its centre's distance to a polygon.
 
     The raster should use a projected coordinate system.
@@ -116,7 +116,7 @@ def raster_distance_from_polygon(
     distances = np.where(mask, np.array([polygon.distance(pt) for pt in _pts]), np.nan)
     distance_raster = distances.reshape(x.shape)
 
-    return RasterModel(arr=distance_raster, raster_meta=raster_meta)
+    return Raster(arr=distance_raster, raster_meta=raster_meta)
 
 
 def _pbar(iterable: Iterable[_T], *, desc: str | None = None) -> Iterable[_T]:
@@ -130,11 +130,11 @@ def full_raster(
     *,
     bounds: tuple[float, float, float, float],
     fill_value: float = np.nan,
-) -> RasterModel:
+) -> Raster:
     """Create a raster with a specified fill value for all cells."""
     shape = get_point_grid_shape(bounds=bounds, cell_size=raster_meta.cell_size)
     arr = np.full(shape, fill_value, dtype=np.float32)
-    return RasterModel(arr=arr, raster_meta=raster_meta)
+    return Raster(arr=arr, raster_meta=raster_meta)
 
 
 def rasterize_gdf(
@@ -142,7 +142,7 @@ def rasterize_gdf(
     *,
     raster_meta: RasterMeta,
     target_cols: list[str],
-) -> list[RasterModel]:
+) -> list[Raster]:
     """Rasterize geometries from a GeoDataFrame.
 
     Supports polygons, points, linestrings, and other geometry types.
@@ -205,8 +205,8 @@ def rasterize_gdf(
             dtype=np.float32,
         )
 
-        # Create RasterModel
-        raster = RasterModel(arr=raster_array, raster_meta=raster_meta)
+        # Create Raster
+        raster = Raster(arr=raster_array, raster_meta=raster_meta)
         rasters.append(raster)
 
     return rasters
@@ -286,7 +286,7 @@ def raster_from_point_cloud(
     *,
     crs: CRS | str,
     cell_size: float | None = None,
-) -> RasterModel:
+) -> Raster:
     """Create a raster from a point cloud via interpolation.
 
     Interpolation is only possible within the convex hull of the points. Outside of
@@ -320,8 +320,18 @@ def raster_from_point_cloud(
     if len(x) != len(y) or len(x) != len(z):
         msg = "Length of x, y, and z must be equal."
         raise ValueError(msg)
+    xy_finite_mask = np.isfinite(x) & np.isfinite(y)
+    if np.any(~xy_finite_mask):
+        msg = "Some (x,y) points are NaN-valued or non-finite. These will be ignored."
+        warnings.warn(msg, stacklevel=2)
+        x = x[xy_finite_mask]
+        y = y[xy_finite_mask]
+        z = z[xy_finite_mask]
     if len(x) < 3:
-        msg = "At least three (x, y, z) points are required to triangulate a surface."
+        msg = (
+            "At least three valid (x, y, z) points are required to triangulate a "
+            "surface."
+        )
         raise ValueError(msg)
     # Check for duplicate (x, y) points
     xy_points = np.column_stack((x, y))
@@ -332,8 +342,8 @@ def raster_from_point_cloud(
     # Heuristic for cell size if not provided
     if cell_size is None:
         # Half the 5th percentile of nearest neighbor distances between the (x,y) points
-        tree = KDTree(np.column_stack((x, y)))
-        distances, _ = tree.query(np.column_stack((x, y)), k=2)
+        tree = KDTree(xy_points)
+        distances, _ = tree.query(xy_points, k=2)
         distances: np.ndarray
         cell_size = float(np.percentile(distances[distances > 0], 5)) / 2
 
@@ -378,4 +388,4 @@ def raster_from_point_cloud(
         crs=crs,
         transform=transform,
     )
-    return RasterModel(arr=arr, raster_meta=raster_meta)
+    return Raster(arr=arr, raster_meta=raster_meta)

{rastr-0.3.0 → rastr-0.5.0}/src/rastr/io.py

@@ -9,7 +9,7 @@ import rasterio.merge
 from pyproj.crs.crs import CRS
 
 from rastr.meta import RasterMeta
-from rastr.raster import RasterModel
+from rastr.raster import Raster
 
 if TYPE_CHECKING:
     from numpy.typing import NDArray
@@ -17,7 +17,7 @@ if TYPE_CHECKING:
 
 def read_raster_inmem(
     raster_path: Path | str, *, crs: CRS | str | None = None
-) -> RasterModel:
+) -> Raster:
     """Read raster data from a file and return an in-memory Raster object."""
     crs = CRS.from_user_input(crs) if crs is not None else None
 
@@ -35,13 +35,13 @@ def read_raster_inmem(
             arr[arr == nodata] = np.nan
 
     raster_meta = RasterMeta(cell_size=cell_size, crs=crs, transform=transform)
-    raster_obj = RasterModel(arr=arr, raster_meta=raster_meta)
+    raster_obj = Raster(arr=arr, raster_meta=raster_meta)
     return raster_obj
 
 
 def read_raster_mosaic_inmem(
     mosaic_dir: Path | str, *, glob: str = "*.tif", crs: CRS | None = None
-) -> RasterModel:
+) -> Raster:
     """Read a raster mosaic from a directory and return an in-memory Raster object.
 
     This assumes that all rasters have the same metadata, e.g. coordinate system,
@@ -87,7 +87,7 @@ def read_raster_mosaic_inmem(
         arr = arr.squeeze().astype(np.float64)
 
         raster_meta = RasterMeta(cell_size=cell_size, crs=crs, transform=transform)
-        raster_obj = RasterModel(arr=arr, raster_meta=raster_meta)
+        raster_obj = Raster(arr=arr, raster_meta=raster_meta)
         return raster_obj
     finally:
         for src in sources: