Metadata-Version: 2.4
Name: py_ams_point_interpolant
Version: 0.1.0
Summary: Python interface for the PointInterpolant executable of the Adaptive Multigrid Solvers (former PoissonRecon) project.
Author-email: Ricard Campos <ricard.campos@coronis.es>
License-Expression: MIT
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Operating System :: OS Independent
Classifier: Natural Language :: English
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE.txt
Requires-Dist: numpy>=1.19.0
Requires-Dist: matplotlib>=3.5.0
Provides-Extra: dev
Requires-Dist: ruff>=0.4; extra == "dev"
Requires-Dist: cibuildwheel>=2.19.0; extra == "dev"
Requires-Dist: build>=1.2.0; extra == "dev"
Requires-Dist: twine>=5.0.0; extra == "dev"
Dynamic: license-file

# Python Adaptive Multigrid Solver Point Interpolant (py_ams_point_interpolant)

Python interface for the PointInterpolant executable of the Adaptive Multigrid Solvers (a.k.a. PoissonRecon) project.

## Installation

### Requirements

- Python >= 3.10
- CMake >= 3.20
- NumPy >= 1.19.0
- pybind11 >= 2.11.1 (will be automatically downloaded by CMake)
- [PoissonRecon](https://github.com/mkazhdan/PoissonRecon) (will be automatically downloaded by CMake)
- OpenMP (optional, for parallel computation)

### From PyPI

```
pip install py_ams_point_interpolant
```

### From sources

This project requires Python >= 3.10 and CMake to build (cmake should automatically download pybind and PoissonRecon sources, also required). To build and install it using `pip`:

```
cd <path_to>/py_ams_point_interpolant
pip install .
```

## Demos

You have examples of usage in the `demos` folder for 2D and 3D interpolation. To run them from the folder containing this readme:

```
python demo/demo_2d.py
python demo/demo_3d.py
```
