Metadata-Version: 2.5
Name: pygridfit
Version: 0.2.1
Summary: Python Port of gridfit (John D'Errico, 2006)
License-Expression: GPL-3.0-or-later
License-File: LICENSE
License-File: NOTICE
Requires-Python: >=3.10.0
Requires-Dist: hea>=0.1.10
Requires-Dist: matplotlib>=3.9.4
Requires-Dist: numpy>=2.0.2
Requires-Dist: pytest>=8.3.5
Requires-Dist: scipy>=1.13.2
Requires-Dist: watermark>=2.5.0
Provides-Extra: dev
Requires-Dist: maturin; extra == 'dev'
Requires-Dist: pytest; extra == 'dev'
Requires-Dist: ruff==0.16.2; extra == 'dev'
Requires-Dist: twine; extra == 'dev'
Description-Content-Type: text/markdown

# pygridfit

Originally a Python port (`GridFit`) of the MATLAB [gridfit](https://www.mathworks.com/matlabcentral/fileexchange/8998-surface-fitting-using-gridfit) function (D'Errico, 2006), but with some improvement (`GridFit(smoothness="auto")`), and a new shiny method (`GamFit`).  


## Installation

To install the latest tagged version:

```bash
pip install pygridfit
```

Or to install the development version, clone the repository and install it with `pip install -e`:

```bash
git clone https://github.com/berenslab/pygridfit.git
pip install -e pygridfit
```

## Usage

See the [gridfit example](https://github.com/berenslab/pygridfit/blob/main/notebooks/example.gridfit.ipynb) and the [gamfit example](https://github.com/berenslab/pygridfit/blob/main/notebooks/example.gamfit.ipynb) notebooks for usage.

## License

GPL-3.0-or-later, from 0.2.0 onwards. Releases up to 0.1.7
were BSD 3-Clause and stay that way. The `gridfit` code ported from John
D'Errico's MATLAB original keeps its BSD 2-Clause terms; see `NOTICE`.