PyFishPack 0.1.0__tar.gz

pyfishpack-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Qianye Su
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

pyfishpack-0.1.0/PKG-INFO

@@ -0,0 +1,81 @@
+Metadata-Version: 2.4
+Name: PyFishPack
+Version: 0.1.0
+Summary: Python wrapper for FISHPACK - Fast direct solvers for separable elliptic PDEs
+Home-page: https://github.com/QianyeSu/PyFishPack
+Author: PyFishPack Contributors
+Author-email: your.email@example.com
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/QianyeSu/PyFishPack
+Project-URL: Repository, https://github.com/QianyeSu/PyFishPack
+Project-URL: Bug Tracker, https://github.com/QianyeSu/PyFishPack/issues
+Keywords: numerical-analysis,pde-solver,elliptic-equations,scientific-computing,fishpack,fortran
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Science/Research
+Classifier: Topic :: Scientific/Engineering :: Mathematics
+Classifier: Topic :: Scientific/Engineering :: Physics
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Fortran
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy>=1.24.0
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: black; extra == "dev"
+Requires-Dist: isort; extra == "dev"
+Requires-Dist: flake8; extra == "dev"
+Provides-Extra: build
+Requires-Dist: meson; extra == "build"
+Requires-Dist: ninja; extra == "build"
+Requires-Dist: build; extra == "build"
+Requires-Dist: wheel; extra == "build"
+Dynamic: author-email
+Dynamic: home-page
+Dynamic: license-file
+Dynamic: requires-python
+
+# PyFishPack
+
+PyFishPack is a modernized Python-facing Fortran solver package derived from NCAR FISHPACK.
+
+Project links:
+
+- Homepage: https://github.com/QianyeSu/PyFishPack
+- Repository: https://github.com/QianyeSu/PyFishPack
+- Bug Tracker: https://github.com/QianyeSu/PyFishPack/issues
+
+## Source layout
+
+- Modern Fortran `.f90` sources live under `PyFishPack/src`.
+- Original F77 `.f` sources are kept as archive material under `PyFishPack/src/archive/f77`.
+- The backend uses modern Fortran `bind(C)` entry points plus a thin NumPy C API wrapper.
+
+## Build
+
+Use the `skyborn_dev` conda environment with Meson and Ninja.
+
+```bash
+conda activate skyborn_dev
+meson setup build
+ninja -C build
+```
+
+## Public APIs
+
+PyFishPack exposes xinvert-style equation helpers from `PyFishPack.apps`, including:
+
+`invert_Poisson`, `invert_geostrophic`, `invert_PV2D`, `invert_Eliassen`, `invert_Fofonoff`, `invert_GillMatsuno`, `invert_GillMatsuno_test`, `invert_BrethertonHaidvogel`, `invert_Stommel`, `invert_StommelMunk`, `invert_Stommel_test`, `invert_StommelArons`, `invert_omega`, `invert_3DOcean`, `invert_RefState`, `invert_RefStateSWM`, `invert_MultiGrid`.
+
+The compiled `fishpack` backend also exposes direct solver and transform entry points for the modern Fortran kernels, including the `genbun`, `poistg`, `pois3d`, Helmholtz, SOR, and FFTPACK interfaces.
+
+## Verification
+
+The current backend verification covers the exposed equation APIs, source-layout checks, a local xinvert benchmark, and backend import checks. The modern backend reports `modern-fortran` through `fishpack.backend_info()`.

pyfishpack-0.1.0/PyFishPack/__init__.py

@@ -0,0 +1,74 @@
+"""
+PyFishPack - Python wrapper for FISHPACK Fortran library
+
+FISHPACK is a collection of Fortran routines for solving separable
+elliptic partial differential equations.
+"""
+
+__version__ = "0.1.0"
+
+try:
+    # Import the compiled fishpack extension
+    from . import fishpack
+    from .apps import (
+        invert_3DOcean,
+        invert_BrethertonHaidvogel,
+        invert_Eliassen,
+        invert_Fofonoff,
+        invert_GillMatsuno,
+        invert_GillMatsuno_test,
+        invert_MultiGrid,
+        invert_PV2D,
+        invert_Poisson,
+        invert_RefState,
+        invert_RefStateSWM,
+        invert_Stommel,
+        invert_StommelArons,
+        invert_StommelMunk,
+        invert_Stommel_test,
+        invert_geostrophic,
+        invert_omega,
+        spectral_transform,
+    )
+
+    # Make commonly used functions available at package level
+    # These will be available as PyFishPack.genbun, etc.
+    from .fishpack import *
+
+    __all__ = [name for name in dir(fishpack) if not name.startswith('_')]
+    __all__.extend([
+        "invert_3DOcean",
+        "invert_BrethertonHaidvogel",
+        "invert_Eliassen",
+        "invert_Fofonoff",
+        "invert_GillMatsuno",
+        "invert_GillMatsuno_test",
+        "invert_MultiGrid",
+        "invert_PV2D",
+        "invert_Poisson",
+        "invert_RefState",
+        "invert_RefStateSWM",
+        "invert_Stommel",
+        "invert_StommelArons",
+        "invert_StommelMunk",
+        "invert_Stommel_test",
+        "invert_geostrophic",
+        "invert_omega",
+        "spectral_transform",
+    ])
+
+except ImportError as e:
+    import warnings
+    print(f"Warning: Could not import fishpack extension: {e}")
+    print("Make sure the extension is compiled correctly.")
+    warnings.warn(f"Could not import fishpack extension: {e}. "
+                  f"Make sure the extension is compiled correctly.",
+                  ImportWarning)
+
+    # Fallback - define empty __all__
+    __all__ = []
+
+# Package metadata
+__author__ = "Qianye Su"
+__email__ = "suqianye2000@gmail.com"
+__url__ = "https://github.com/QianyeSu/PyFishPack"

pyfishpack-0.1.0/PyFishPack/_dummy.c

@@ -0,0 +1,23 @@
+/* Dummy C extension for Windows compatibility */
+#include <Python.h>
+
+static PyObject* dummy_function(PyObject* self, PyObject* args) {
+    return Py_None;
+}
+
+static PyMethodDef DummyMethods[] = {
+    {"dummy", dummy_function, METH_VARARGS, "Dummy function"},
+    {NULL, NULL, 0, NULL}
+};
+
+static struct PyModuleDef dummymodule = {
+    PyModuleDef_HEAD_INIT,
+    "_dummy",
+    NULL,
+    -1,
+    DummyMethods
+};
+
+PyMODINIT_FUNC PyInit__dummy(void) {
+    return PyModule_Create(&dummymodule);
+}