quickpaver 0.2.0__tar.gz → 0.3.0__tar.gz

quickpaver-0.3.0/CHANGELOG.rst

@@ -0,0 +1,62 @@
+==============
+Changelog
+==============
+
+0.3.0 (2026-06-03)
+------------------
+
+* ENH: add ``compute_transfer_matrix`` to build conservative sparse transfer
+* ENH: add add regular-grid indexing helpers:
+
+  * ``rlg_idx_to_nn``
+  * ``rlg_nn_to_idx``
+  * ``span_to_node_numbers_2d``
+  * ``span_to_node_numbers_3d``
+
+* ENH: add sparse spatial operators for rectilinear grids:
+
+  * ``get_rlg_spatial_grad_mat``
+  * ``make_rlg_spatial_gradient_matrices``
+  * ``get_rlg_perm_mat``
+  * ``make_rlg_spatial_permutation_matrices``
+
+* ENH: add polygon-to-grid selection utilities:
+
+  * ``create_selections_array_2d``
+  * ``get_polygon_selection_with_dilation_2d``
+  * ``get_polygon_selection_with_dilation_3d``
+  * ``binary_dilation``
+
+* ENH: add grid resampling and array upsampling utilities:
+
+  * ``resample_grid``
+  * ``duplicative_upsample``
+  * ``conservative_upsample``
+
+* ENH: add export helpers for ``RectilinearGrid``:
+
+  * ``to_shapely`` for 2D Shapely polygon export.
+  * ``to_pyvista`` for optional PyVista export using ``ImageData``,
+    ``RectilinearGrid`` or ``StructuredGrid`` representations.
+
+* ENH: add grid geometry helpers such as ``get_array_borders_selection`` and
+  owner/neighbour index pairing utilities.
+* ENH: add input validation for rectilinear grid dimensions, cell sizes, sparse
+  operator axes, dilation masks, and upsampling factors.
+* TEST: add extensive pytest coverage for rectilinear grids, sparse operators,
+  polygon selections, dilation, resampling, upsampling, Shapely export, and
+  optional PyVista export.
+* DOC: improve tiling documentation.
+* DOC: add documentation for rectilinear grid utilities.
+* DOC: update notebooks for tiling, transfer matrices, and grid utilities.
+
+0.2.0 (2026-03-18)
+------------------
+
+* ENH: ``extract_tiling_vertices`` now returns cluster indices for merged vertices.
+* DOC: improve documentation.
+
+0.1.0 (2026-03-14)
+------------------
+
+* First release on PyPI.

{quickpaver-0.2.0 → quickpaver-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: quickpaver
-Version: 0.2.0
+Version: 0.3.0
 Summary: A python package providing a paving toolbox.
 Author-email: Antoine Collet <antoinecollet5@gmail.com>
 License: BSD 3-Clause License
@@ -56,7 +56,7 @@ Requires-Dist: numpy>=1.2
 Requires-Dist: shapely>=2.1
 Requires-Dist: scipy>=1.10
 Provides-Extra: all
-Requires-Dist: quickpaver[docs,examples,install,lint,tests]; extra == "all"
+Requires-Dist: quickpaver[docs,examples,install,lint,pyvista,tests]; extra == "all"
 Provides-Extra: docs
 Requires-Dist: quickpaver[examples]; extra == "docs"
 Requires-Dist: sphinx<9; extra == "docs"
@@ -80,16 +80,18 @@ Provides-Extra: examples
 Requires-Dist: matplotlib; extra == "examples"
 Requires-Dist: marimo; extra == "examples"
 Requires-Dist: nested_grid_plotter>=2.1.0; extra == "examples"
-Provides-Extra: scikit-sparse-old
-Requires-Dist: scikit-sparse<0.5.0; extra == "scikit-sparse-old"
+Requires-Dist: pyvista[all]; extra == "examples"
 Provides-Extra: lint
 Requires-Dist: pre-commit; extra == "lint"
-Requires-Dist: codespell>=2.1.0; extra == "lint"
+Requires-Dist: pre-commit-hooks; extra == "lint"
+Requires-Dist: codespell; extra == "lint"
 Requires-Dist: ruff; extra == "lint"
 Requires-Dist: ty; extra == "lint"
 Provides-Extra: install
 Requires-Dist: pip; extra == "install"
 Requires-Dist: wheel; extra == "install"
+Provides-Extra: pyvista
+Requires-Dist: pyvista; extra == "pyvista"
 
 ==========
 quickpaver

{quickpaver-0.2.0 → quickpaver-0.3.0}/pyproject.toml

@@ -46,7 +46,7 @@ quickpaver = ["data/*.geojson"]
 version = { attr = "quickpaver.__about__.__version__" }
 
 [project.optional-dependencies]
-all = ['quickpaver[install, lint, tests, examples, docs]']
+all = ['quickpaver[install, lint, tests, examples, docs, pyvista]']
 docs = [
     "quickpaver[examples]",
     "sphinx<9",
@@ -68,10 +68,15 @@ tests = [
     "pytest-cookies",
     "coverage",
 ]
-examples = ["matplotlib", "marimo", "nested_grid_plotter>=2.1.0"]
-scikit_sparse_old = ["scikit-sparse<0.5.0"]
-lint = ["pre-commit", "codespell>=2.1.0", "ruff", "ty"]
+examples = [
+    "matplotlib",
+    "marimo",
+    "nested_grid_plotter>=2.1.0",
+    "pyvista[all]",
+]
+lint = ["pre-commit", "pre-commit-hooks", "codespell", "ruff", "ty"]
 install = ["pip", "wheel"]
+pyvista = ["pyvista"]
 
 [tool.ruff]
 lint.select = [

{quickpaver-0.2.0 → quickpaver-0.3.0}/quickpaver/__about__.py

@@ -3,6 +3,6 @@
 
 """Get the metadata."""
 
-__version__ = "0.2.0"
+__version__ = "0.3.0"
 __author__ = "Antoine Collet"
 __email__ = "antoine.collet5@gmail.com"

quickpaver-0.3.0/quickpaver/__init__.py

@@ -0,0 +1,177 @@
+# SPDX-License-Identifier: BSD-3-Clause
+# Copyright (c) 2026 Antoine COLLET
+
+"""Tools for polygonal paving, transfer matrices, and rectilinear grids.
+
+``quickpaver`` provides utilities to generate polygonal tilings, manipulate
+rectilinear grids, compute transfer matrices between geometries, and load simple
+geographical test contours. The package is designed around cell-based geometry:
+tiles, polygons, and grid cells are represented explicitly and can be combined
+with NumPy arrays, Shapely geometries, and sparse SciPy matrices.
+
+The public API is grouped into four main areas:
+
+- polygon and tiling generation;
+- transfer-matrix construction;
+- geographical test contours;
+- rectilinear-grid utilities.
+
+Polygon helpers
+^^^^^^^^^^^^^^^
+
+Utilities for creating base polygons and describing supported tile types.
+
+.. autosummary::
+   :toctree: _autosummary
+
+   PolygonType
+   gen_polygon
+
+Tiling functions
+^^^^^^^^^^^^^^^^
+
+Functions to generate polygonal tilings over a target surface. Supported tile
+families include rectangles, triangles, and hexagons. Tiling generators return
+both the generated polygons and adjacency information between kept tiles.
+
+.. autosummary::
+   :toctree: _autosummary
+
+   gen_hexagonal_tiling
+   gen_rectangular_tiling
+   gen_triangular_tiling
+   gen_polygonal_tiling
+   extract_tiling_centers
+   extract_tiling_vertices
+
+Transfer matrices
+^^^^^^^^^^^^^^^^^
+
+Utilities to compute sparse transfer matrices between source and target
+geometries.
+
+.. autosummary::
+   :toctree: _autosummary
+
+   compute_transfer_matrix
+
+Test data
+^^^^^^^^^
+
+Convenience functions providing geographical contours useful for examples,
+tests, and demonstrations.
+
+.. autosummary::
+   :toctree: _autosummary
+
+   load_france_contour
+   load_corsica_contour
+   load_france_and_corsica_contour
+
+Regular grids
+^^^^^^^^^^^^^
+
+Classes and utilities for working with cell-based rectilinear grids. These
+functions cover grid indexing, sparse neighbour operators, polygon selections,
+binary dilation, resampling, and conservative or duplicative array upsampling.
+
+.. autosummary::
+   :toctree: _autosummary
+
+   Grid
+   RectilinearGrid
+   rlg_idx_to_nn
+   rlg_nn_to_idx
+   span_to_node_numbers_2d
+   span_to_node_numbers_3d
+   get_array_borders_selection
+   get_owner_neigh_indices
+   get_rlg_spatial_grad_mat
+   make_rlg_spatial_gradient_matrices
+   get_rlg_perm_mat
+   make_rlg_spatial_permutation_matrices
+   create_selections_array_2d
+   get_polygon_selection_with_dilation_2d
+   get_polygon_selection_with_dilation_3d
+   binary_dilation
+   resample_grid
+   duplicative_upsample
+   conservative_upsample
+
+"""
+
+from quickpaver.__about__ import __author__, __email__, __version__
+from quickpaver._grid import (
+    Grid,
+    RectilinearGrid,
+    binary_dilation,
+    conservative_upsample,
+    create_selections_array_2d,
+    duplicative_upsample,
+    get_array_borders_selection,
+    get_owner_neigh_indices,
+    get_polygon_selection_with_dilation_2d,
+    get_polygon_selection_with_dilation_3d,
+    get_rlg_perm_mat,
+    get_rlg_spatial_grad_mat,
+    make_rlg_spatial_gradient_matrices,
+    make_rlg_spatial_permutation_matrices,
+    resample_grid,
+    rlg_idx_to_nn,
+    rlg_nn_to_idx,
+    span_to_node_numbers_2d,
+    span_to_node_numbers_3d,
+)
+from quickpaver._tiling import (
+    PolygonType,
+    extract_tiling_centers,
+    extract_tiling_vertices,
+    gen_hexagonal_tiling,
+    gen_polygon,
+    gen_polygonal_tiling,
+    gen_rectangular_tiling,
+    gen_triangular_tiling,
+)
+from quickpaver._transfer_matrix import compute_transfer_matrix
+from quickpaver.data import (
+    load_corsica_contour,
+    load_france_and_corsica_contour,
+    load_france_contour,
+)
+
+__all__ = [
+    "__author__",
+    "__email__",
+    "__version__",
+    "PolygonType",
+    "gen_hexagonal_tiling",
+    "gen_polygon",
+    "gen_rectangular_tiling",
+    "gen_triangular_tiling",
+    "gen_polygonal_tiling",
+    "Grid",
+    "RectilinearGrid",
+    "create_selections_array_2d",
+    "rlg_idx_to_nn",
+    "rlg_nn_to_idx",
+    "span_to_node_numbers_2d",
+    "span_to_node_numbers_3d",
+    "binary_dilation",
+    "get_owner_neigh_indices",
+    "get_polygon_selection_with_dilation_2d",
+    "get_polygon_selection_with_dilation_3d",
+    "get_rlg_spatial_grad_mat",
+    "make_rlg_spatial_gradient_matrices",
+    "get_rlg_perm_mat",
+    "make_rlg_spatial_permutation_matrices",
+    "resample_grid",
+    "duplicative_upsample",
+    "conservative_upsample",
+    "load_france_contour",
+    "load_corsica_contour",
+    "load_france_and_corsica_contour",
+    "extract_tiling_centers",
+    "extract_tiling_vertices",
+    "compute_transfer_matrix",
+    "get_array_borders_selection",
+]