Metadata-Version: 2.1
Name: pyglotaran
Version: 0.2.0
Summary: The Glotaran fitting engine.
Home-page: https://github.com/glotaran/pyglotaran
Author: Joern Weissenborn, Joris Snellenburg, Ivo van Stokkum
Author-email: joern.weissenborn@gmail.com,
                    j.snellenburg@gmail.com,
                    i.h.m.van.stokkum@vu.nl
License: GPLv3
Project-URL: GloTarAn Ecosystem, http://glotaran.org
Project-URL: Documentation, https://glotaran.readthedocs.io
Project-URL: Source, https://github.com/glotaran/pyglotaran
Project-URL: Tracker, https://github.com/glotaran/pyglotaran/issues
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: OS Independent
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Physics
Classifier: Topic :: Scientific/Engineering :: Chemistry
Requires-Python: >=3.8, <3.9
Description-Content-Type: text/markdown
Requires-Dist: click (>=7.0)
Requires-Dist: lmfit (>=0.9.13)
Requires-Dist: netCDF4 (>=1.5.3)
Requires-Dist: numba (>=0.48)
Requires-Dist: pandas (>=0.25.2)
Requires-Dist: pyyaml (>=5.2)
Requires-Dist: scipy (>=1.3.2)
Requires-Dist: sdtfile (>=2020.8.3)
Requires-Dist: setuptools (>=41.2)
Requires-Dist: xarray (>=0.14)
Requires-Dist: numpy (>=1.17.3) ; sys_platform != "win32"
Requires-Dist: numpy (==1.19.3) ; sys_platform == "win32"

# pyGloTarAn

pyGloTarAn is a python library for global and target analysis

[![latest release](https://pypip.in/version/pyglotaran/badge.svg)](https://pypi.org/project/pyglotaran/)
[![Conda Version](https://img.shields.io/conda/vn/conda-forge/pyglotaran.svg)](https://anaconda.org/conda-forge/pyglotaran)
![Tests](https://github.com/glotaran/pyglotaran/workflows/Tests/badge.svg)
[![Documentation Status](https://readthedocs.org/projects/pyglotaran/badge/?version=latest)](https://pyglotaran.readthedocs.io/en/latest/?badge=latest)
[![Coverage Status](https://codecov.io/gh/glotaran/pyglotaran/branch/master/graph/badge.svg)](https://codecov.io/gh/glotaran/pyglotaran)
[![Total alerts](https://img.shields.io/lgtm/alerts/g/glotaran/pyglotaran.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/glotaran/pyglotaran/alerts/)

## Warning

This project is still in a pre-alpha release stage and should only be used with care.

## Additional warning for scientists

The algorithms provided by this package still need to be validated and reviewed, pending the official release it should not be used in scientific publications.

## Temporary rename notice (!!!)

This package was previously released on [pypi](https://pypi.org/) under the name [glotaran](https://pypi.org/project/glotaran/) but was changed so as to not confuse it with the original Glotaran software, first published in the Journal of Statistical Software titeled [Glotaran: A Java-Based Graphical User Interface for the R Package TIMP](https://www.jstatsoft.org/article/view/v049i03) DOI: [10.18637/jss.v049.i03](https://www.jstatsoft.org/article/view/v049i03)

# Installation

Prerequisites:

- Python 3.6 or higher _(Python 2 is **not** supported)_
- On Windows only 64bit is supported

Note for Windows Users: The easiest way to get python for Windows is via [Anaconda](https://www.anaconda.com/)

## Stable Release

To install pyglotaran from [pypi](https://pypi.org/), run this command in your terminal:

```
$ pip install pyglotaran
```

If you want to install it via conda, you can run the following command:

```
$ conda install -c conda-forge pyglotaran
```

## From Source

```
$ git clone https://github.com/glotaran/pyglotaran.git
$ cd pyglotaran

$ pip install .
# To enforce python3 on systems where python2 is also installed
$ pip3 install .

```

_Note for Anaconda Users: Please make sure to update your distribution prior to install since some packages managed by Anaconda cannot be updated by `pip`._

# Mailinglist

[mailing-list](https://groups.google.com/forum/#!forum/glotaran)

## Credits

The credits can be found in the documentation
[authors section](https://pyglotaran.readthedocs.io/en/latest/authors.html)


