Metadata-Version: 2.2
Name: pyboundfit
Version: 0.1.0
Summary: Boundary fits using polynomials or splines
Author-email: Nicolás Cardiel <cardiel@ucm.es>
License: GPL-3.0-or-later
Project-URL: Homepage, https://github.com/nicocardiel/pyboundfit
Project-URL: Repository, https://github.com/nicocardiel/pyboundfit.git
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: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: GNU General Public License (GPL)
Classifier: Operating System :: OS Independent
Classifier: Topic :: Scientific/Engineering :: Astronomy
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE.txt
Requires-Dist: lmfit
Requires-Dist: matplotlib
Requires-Dist: numpy
Requires-Dist: scipy
Provides-Extra: test
Requires-Dist: pytest; extra == "test"

# pyboundfit

Boundary fits using polynomials or splines, based on the method described in
[Cardiel 2009](https://ui.adsabs.harvard.edu/abs/2009MNRAS.396..680C/abstract).
This code is a Python implementation of part of the functionality
implemented in the original Fortran 77 code [boundfit](https://github.com/nicocardiel/boundfit).

## Instaling the code

In order to keep your Python installation clean, it is highly recommended to 
first build a specific Python 3 *virtual enviroment*

### Creating and activating the Python virtual environment

```shell
$ python3 -m venv venv_pyboundfit
$ . venv_pyboundfit/bin/activate
(venv_pyboundfit) $ 
```

### Installing the package

The latest stable version is available via de [PyPI repository](https://pypi.org/project/pyboundfit/):

```shell
(venv_teareduce) $ pip install pyboundfit
```
**Note**: This command can also be employed in a Windows terminal opened through the 
``CMD.exe prompt`` icon available in Anaconda Navigator.

The latest development version is available through [GitHub](https://github.com/nicocardiel/pyboundfit):

```shell
(venv_teareduce) $ pip install git+https://github.com/nicocardiel/pyboundfit.git@main#egg=pyboundfit
```

### Testing the installation

```shell
(venv_teareduce) $ pip show teareduce
```

```shell
(venv_teareduce) $ ipython
In [1]: import pyboundfit
In [2]: print(pyboundfit.__version__)
?.?.?
```
