gbmsc-pde 0.1.0__tar.gz

gbmsc_pde-0.1.0/CHANGELOG.md

@@ -0,0 +1,18 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+This project follows semantic versioning.
+
+## [0.1.0] - 2026-06-06
+
+### Added
+
+- Initial public release of `gbmsc-pde`.
+- Structured 2D source-grid utilities.
+- Grid-Based Multinode Shepard Collocation method.
+- Sparse differential operators.
+- Linear PDE assembly with diffusion, convection, reaction, and source terms.
+- Boundary-condition support for Dirichlet, Neumann, and Robin conditions.
+- Linear solver interface for direct, CG, and GMRES solvers.
+- Package metadata, tests, example, docs, and GitHub Actions CI.

gbmsc_pde-0.1.0/CITATION.cff

@@ -0,0 +1,11 @@
+cff-version: 1.2.0
+title: "gbmsc-pde"
+message: "If you use gbmsc-pde in academic work, please cite it using this metadata."
+type: software
+authors:
+  - family-names: "El Harrak"
+    given-names: "Anouar"
+version: "0.1.0"
+date-released: "2026-06-06"
+license: "Apache-2.0"
+repository-code: "https://github.com/e-anouar/gbmsc-pde"

gbmsc_pde-0.1.0/LICENSE

@@ -0,0 +1,160 @@
+Apache License
+Version 2.0, January 2004
+https://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction, and
+distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by the
+copyright owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all other
+entities that control, are controlled by, or are under common control with
+that entity. For the purposes of this definition, "control" means (i) the
+power, direct or indirect, to cause the direction or management of such entity,
+whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or
+more of the outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity exercising
+permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications,
+including but not limited to software source code, documentation source, and
+configuration files.
+
+"Object" form shall mean any form resulting from mechanical transformation or
+translation of a Source form, including but not limited to compiled object
+code, generated documentation, and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or Object form,
+made available under the License, as indicated by a copyright notice that is
+included in or attached to the work.
+
+"Derivative Works" shall mean any work, whether in Source or Object form, that
+is based on (or derived from) the Work and for which the editorial revisions,
+annotations, elaborations, or other modifications represent, as a whole, an
+original work of authorship. For the purposes of this License, Derivative Works
+shall not include works that remain separable from, or merely link (or bind by
+name) to the interfaces of, the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including the original
+version of the Work and any modifications or additions to that Work or
+Derivative Works thereof, that is intentionally submitted to Licensor for
+inclusion in the Work by the copyright owner or by an individual or Legal
+Entity authorized to submit on behalf of the copyright owner. For the purposes
+of this definition, "submitted" means any form of electronic, verbal, or
+written communication sent to the Licensor or its representatives, including
+but not limited to communication on electronic mailing lists, source code
+control systems, and issue tracking systems that are managed by, or on behalf
+of, the Licensor for the purpose of discussing and improving the Work, but
+excluding communication that is conspicuously marked or otherwise designated in
+writing by the copyright owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity on behalf
+of whom a Contribution has been received by Licensor and subsequently
+incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of this
+License, each Contributor hereby grants to You a perpetual, worldwide,
+non-exclusive, no-charge, royalty-free, irrevocable copyright license to
+reproduce, prepare Derivative Works of, publicly display, publicly perform,
+sublicense, and distribute the Work and such Derivative Works in Source or
+Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of this
+License, each Contributor hereby grants to You a perpetual, worldwide,
+non-exclusive, no-charge, royalty-free, irrevocable patent license to make,
+have made, use, offer to sell, sell, import, and otherwise transfer the Work,
+where such license applies only to those patent claims licensable by such
+Contributor that are necessarily infringed by their Contribution(s) alone or by
+combination of their Contribution(s) with the Work to which such Contribution(s)
+was submitted. If You institute patent litigation against any entity alleging
+that the Work or a Contribution incorporated within the Work constitutes direct
+or contributory patent infringement, then any patent licenses granted to You
+under this License for that Work shall terminate as of the date such litigation
+is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the Work or
+Derivative Works thereof in any medium, with or without modifications, and in
+Source or Object form, provided that You meet the following conditions:
+
+(a) You must give any other recipients of the Work or Derivative Works a copy
+of this License; and
+
+(b) You must cause any modified files to carry prominent notices stating that
+You changed the files; and
+
+(c) You must retain, in the Source form of any Derivative Works that You
+distribute, all copyright, patent, trademark, and attribution notices from the
+Source form of the Work, excluding those notices that do not pertain to any part
+of the Derivative Works; and
+
+(d) If the Work includes a "NOTICE" text file as part of its distribution, then
+any Derivative Works that You distribute must include a readable copy of the
+attribution notices contained within such NOTICE file, excluding those notices
+that do not pertain to any part of the Derivative Works, in at least one of the
+following places: within a NOTICE text file distributed as part of the
+Derivative Works; within the Source form or documentation, if provided along
+with the Derivative Works; or within a display generated by the Derivative
+Works, if and wherever such third-party notices normally appear. The contents
+of the NOTICE file are for informational purposes only and do not modify the
+License. You may add Your own attribution notices within Derivative Works that
+You distribute, alongside or as an addendum to the NOTICE text from the Work,
+provided that such additional attribution notices cannot be construed as
+modifying the License.
+
+You may add Your own copyright statement to Your modifications and may provide
+additional or different license terms and conditions for use, reproduction, or
+distribution of Your modifications, or for any such Derivative Works as a
+whole, provided Your use, reproduction, and distribution of the Work otherwise
+complies with the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise, any
+Contribution intentionally submitted for inclusion in the Work by You to the
+Licensor shall be under the terms and conditions of this License, without any
+additional terms or conditions. Notwithstanding the above, nothing herein shall
+supersede or modify the terms of any separate license agreement you may have
+executed with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade names,
+trademarks, service marks, or product names of the Licensor, except as required
+for reasonable and customary use in describing the origin of the Work and
+reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or agreed to in
+writing, Licensor provides the Work (and each Contributor provides its
+Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied, including, without limitation, any warranties
+or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+PARTICULAR PURPOSE. You are solely responsible for determining the
+appropriateness of using or redistributing the Work and assume any risks
+associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory, whether in
+tort (including negligence), contract, or otherwise, unless required by
+applicable law (such as deliberate and grossly negligent acts) or agreed to in
+writing, shall any Contributor be liable to You for damages, including any
+direct, indirect, special, incidental, or consequential damages of any character
+arising as a result of this License or out of the use or inability to use the
+Work (including but not limited to damages for loss of goodwill, work stoppage,
+computer failure or malfunction, or any and all other commercial damages or
+losses), even if such Contributor has been advised of the possibility of such
+damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing the Work or
+Derivative Works thereof, You may choose to offer, and charge a fee for,
+acceptance of support, warranty, indemnity, or other liability obligations
+and/or rights consistent with this License. However, in accepting such
+obligations, You may act only on Your own behalf and on Your sole
+responsibility, not on behalf of any other Contributor, and only if You agree
+to indemnify, defend, and hold each Contributor harmless for any liability
+incurred by, or claims asserted against, such Contributor by reason of your
+accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+Copyright 2026 gbmsc-pde contributors

gbmsc_pde-0.1.0/MANIFEST.in

@@ -0,0 +1,15 @@
+include README.md
+include LICENSE
+include CHANGELOG.md
+include CITATION.cff
+include pyproject.toml
+include MANIFEST.in
+include NOTICE
+
+recursive-include docs/gbmsc_pde *.md
+recursive-include examples/gbmsc_pde *.py *.ipynb
+recursive-include tests/gbmsc_pde *.py
+
+prune .github
+prune .pytest_cache
+global-exclude __pycache__ *.py[cod]

gbmsc_pde-0.1.0/NOTICE

@@ -0,0 +1,4 @@
+gbmsc-pde
+Copyright 2026 gbmsc-pde contributors
+
+This product includes software developed for the gbmsc-pde project.

gbmsc_pde-0.1.0/PKG-INFO

@@ -0,0 +1,215 @@
+Metadata-Version: 2.4
+Name: gbmsc-pde
+Version: 0.1.0
+Summary: PDE solvers using the Grid-Based Multinode Shepard Collocation method.
+Author: Anouar El Harrak
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/e-anouar/gbmsc-pde
+Project-URL: Repository, https://github.com/e-anouar/gbmsc-pde
+Project-URL: Issues, https://github.com/e-anouar/gbmsc-pde/issues
+Project-URL: Changelog, https://github.com/e-anouar/gbmsc-pde/blob/main/CHANGELOG.md
+Project-URL: Documentation, https://e-anouar.github.io/gbmsc-pde/
+Keywords: GBMSC,pde,numerical-methods,approximation,interpolation,Shepard,scientific-computing
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering :: Mathematics
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy>=1.23
+Requires-Dist: scipy>=1.9
+Provides-Extra: dev
+Requires-Dist: build>=1.2; extra == "dev"
+Requires-Dist: pytest>=8; extra == "dev"
+Requires-Dist: ruff>=0.8; extra == "dev"
+Requires-Dist: twine>=5.0; extra == "dev"
+Provides-Extra: docs
+Requires-Dist: mkdocs>=1.6; extra == "docs"
+Requires-Dist: mkdocs-material>=9.5; extra == "docs"
+Requires-Dist: mkdocstrings[python]>=0.25; extra == "docs"
+Provides-Extra: plot
+Requires-Dist: matplotlib>=3.7; extra == "plot"
+Provides-Extra: examples
+Requires-Dist: matplotlib>=3.7; extra == "examples"
+Requires-Dist: jupyter>=1.0; extra == "examples"
+Dynamic: license-file
+
+# gbmsc-pde
+
+`gbmsc-pde` is a Python package for solving linear PDEs on two-dimensional
+rectangular domains with the **Grid-Based Multinode Shepard Collocation Method
+(GBMSC)**.
+
+Version: `0.1.0`
+
+## Method
+
+GBMSC uses a structured source grid, samples local multinode tensor-product
+subgrids, builds local Lagrange interpolants on those subgrids, and blends the
+local interpolants with Shepard weights.  PDE equations are enforced by
+collocation at source nodes, with sparse differential operators assembled from
+the blended approximation.
+
+## Features
+
+- Structured 2D source-grid generation.
+- Local multinode Lagrange interpolation on sliding subgrids.
+- Shepard blending of local approximants.
+- Sparse first- and second-derivative operators.
+- Linear PDE assembly with diffusion, convection, reaction, and source terms.
+- Dirichlet, Neumann, and Robin boundary-condition helpers.
+- Direct, CG, and GMRES sparse linear solvers.
+- Exact-nodal interpolation mode for source-node reconstruction.
+
+## Installation
+
+Install from a local checkout:
+
+```bash
+pip install .
+```
+
+For development:
+
+```bash
+pip install -e ".[dev]"
+```
+
+For documentation tooling:
+
+```bash
+pip install -e ".[docs]"
+```
+
+For plotting support:
+
+```bash
+pip install ".[plot]"
+```
+
+## Quick Start
+
+```python
+import numpy as np
+
+from gbmsc_pde import (
+    BoundaryConditions,
+    GBMSCApproximation,
+    LinearPDE,
+    LinearSolver,
+    SourceGrid,
+)
+
+grid = SourceGrid(grid_shape=(21, 21), subgrid_shape=(5, 5))
+approximation = GBMSCApproximation(grid, step=(4, 4), support_mode="nodal_limit")
+
+pde = LinearPDE(approximation)
+pde.add_diffusion_term(-1.0)
+pde.add_source_term(lambda x, y: np.ones_like(x))
+
+bcs = BoundaryConditions(grid)
+bcs.add_dirichlet(grid.boundary_indices()["all"], 0.0)
+
+u = LinearSolver(pde, bcs).solve()
+solution_grid = u.reshape(grid.grid_shape)
+
+grid.plot(solution_grid, view="2d")
+```
+
+The step must align with the local subgrid size:
+
+```text
+N_x = step_x * k_x + n_x
+N_y = step_y * k_y + n_y
+```
+
+for integer `k_x` and `k_y`.
+
+## Public API
+
+Preferred names:
+
+```python
+from gbmsc_pde import (
+    SourceGrid,
+    GBMSCApproximation,
+    BoundaryConditions,
+    LinearPDE,
+    LinearSolver,
+)
+```
+
+New code should use these names consistently: `SourceGrid`,
+`GBMSCApproximation`, `BoundaryConditions`, `LinearPDE`, and `LinearSolver`.
+
+## Project Layout
+
+```text
+src/
+  gbmsc_pde/
+    approximation/   GBMSC approximation and interpolation routines
+    boundary/        Boundary-condition containers and appliers
+    source_grid/     Structured source-grid utilities
+    operators/       Sparse differential-operator builders
+    pde/             Linear PDE terms and assembly
+    solvers/         Linear solvers
+```
+
+## Development
+
+Run tests:
+
+```bash
+pytest
+```
+
+Run lightweight lint checks:
+
+```bash
+ruff check src tests examples/gbmsc_pde/*.py
+```
+
+Build source and wheel distributions:
+
+```bash
+python -m build
+```
+
+Check package metadata before uploading:
+
+```bash
+twine check dist/*
+```
+
+Build the documentation site:
+
+```bash
+mkdocs build
+```
+
+See `CONTRIBUTING.md` for the full release checklist.
+
+## Contribution Policy
+
+This project is currently not accepting external contributions. Issues and
+pull requests may be used by the maintainer for project tracking, but there is
+no expectation that external contributions will be reviewed or merged.
+
+## Versioning
+
+This project uses semantic versioning.  The first public release is `0.1.0`.
+
+## Citation
+
+If this package supports academic work, please cite it using the metadata in
+`CITATION.cff`.  If you also use the underlying numerical method, cite the
+method preprint as described in the documentation citation page.
+
+## License
+
+Distributed under the Apache License 2.0. See `LICENSE`.

gbmsc_pde-0.1.0/README.md

@@ -0,0 +1,174 @@
+# gbmsc-pde
+
+`gbmsc-pde` is a Python package for solving linear PDEs on two-dimensional
+rectangular domains with the **Grid-Based Multinode Shepard Collocation Method
+(GBMSC)**.
+
+Version: `0.1.0`
+
+## Method
+
+GBMSC uses a structured source grid, samples local multinode tensor-product
+subgrids, builds local Lagrange interpolants on those subgrids, and blends the
+local interpolants with Shepard weights.  PDE equations are enforced by
+collocation at source nodes, with sparse differential operators assembled from
+the blended approximation.
+
+## Features
+
+- Structured 2D source-grid generation.
+- Local multinode Lagrange interpolation on sliding subgrids.
+- Shepard blending of local approximants.
+- Sparse first- and second-derivative operators.
+- Linear PDE assembly with diffusion, convection, reaction, and source terms.
+- Dirichlet, Neumann, and Robin boundary-condition helpers.
+- Direct, CG, and GMRES sparse linear solvers.
+- Exact-nodal interpolation mode for source-node reconstruction.
+
+## Installation
+
+Install from a local checkout:
+
+```bash
+pip install .
+```
+
+For development:
+
+```bash
+pip install -e ".[dev]"
+```
+
+For documentation tooling:
+
+```bash
+pip install -e ".[docs]"
+```
+
+For plotting support:
+
+```bash
+pip install ".[plot]"
+```
+
+## Quick Start
+
+```python
+import numpy as np
+
+from gbmsc_pde import (
+    BoundaryConditions,
+    GBMSCApproximation,
+    LinearPDE,
+    LinearSolver,
+    SourceGrid,
+)
+
+grid = SourceGrid(grid_shape=(21, 21), subgrid_shape=(5, 5))
+approximation = GBMSCApproximation(grid, step=(4, 4), support_mode="nodal_limit")
+
+pde = LinearPDE(approximation)
+pde.add_diffusion_term(-1.0)
+pde.add_source_term(lambda x, y: np.ones_like(x))
+
+bcs = BoundaryConditions(grid)
+bcs.add_dirichlet(grid.boundary_indices()["all"], 0.0)
+
+u = LinearSolver(pde, bcs).solve()
+solution_grid = u.reshape(grid.grid_shape)
+
+grid.plot(solution_grid, view="2d")
+```
+
+The step must align with the local subgrid size:
+
+```text
+N_x = step_x * k_x + n_x
+N_y = step_y * k_y + n_y
+```
+
+for integer `k_x` and `k_y`.
+
+## Public API
+
+Preferred names:
+
+```python
+from gbmsc_pde import (
+    SourceGrid,
+    GBMSCApproximation,
+    BoundaryConditions,
+    LinearPDE,
+    LinearSolver,
+)
+```
+
+New code should use these names consistently: `SourceGrid`,
+`GBMSCApproximation`, `BoundaryConditions`, `LinearPDE`, and `LinearSolver`.
+
+## Project Layout
+
+```text
+src/
+  gbmsc_pde/
+    approximation/   GBMSC approximation and interpolation routines
+    boundary/        Boundary-condition containers and appliers
+    source_grid/     Structured source-grid utilities
+    operators/       Sparse differential-operator builders
+    pde/             Linear PDE terms and assembly
+    solvers/         Linear solvers
+```
+
+## Development
+
+Run tests:
+
+```bash
+pytest
+```
+
+Run lightweight lint checks:
+
+```bash
+ruff check src tests examples/gbmsc_pde/*.py
+```
+
+Build source and wheel distributions:
+
+```bash
+python -m build
+```
+
+Check package metadata before uploading:
+
+```bash
+twine check dist/*
+```
+
+Build the documentation site:
+
+```bash
+mkdocs build
+```
+
+See `CONTRIBUTING.md` for the full release checklist.
+
+## Contribution Policy
+
+This project is currently not accepting external contributions. Issues and
+pull requests may be used by the maintainer for project tracking, but there is
+no expectation that external contributions will be reviewed or merged.
+
+## Versioning
+
+This project uses semantic versioning.  The first public release is `0.1.0`.
+
+## Citation
+
+If this package supports academic work, please cite it using the metadata in
+`CITATION.cff`.  If you also use the underlying numerical method, cite the
+method preprint as described in the documentation citation page.
+
+## License
+
+Distributed under the Apache License 2.0. See `LICENSE`.

gbmsc_pde-0.1.0/docs/gbmsc_pde/api.md

@@ -0,0 +1,22 @@
+# API Reference
+
+This page is generated from the Python docstrings.  For task-oriented usage,
+start with the component pages and examples.
+
+::: gbmsc_pde
+
+::: gbmsc_pde.source_grid.grid.SourceGrid
+
+::: gbmsc_pde.approximation.shepard.GBMSCApproximation
+
+::: gbmsc_pde.approximation.shepard.lagrange_1d
+
+::: gbmsc_pde.operators.differential.build_differential_operators
+
+::: gbmsc_pde.pde.problem.LinearPDE
+
+::: gbmsc_pde.boundary.conditions.BoundaryConditions
+
+::: gbmsc_pde.boundary.applier.BoundaryConditionApplier
+
+::: gbmsc_pde.solvers.linear.LinearSolver