Metadata-Version: 2.1
Name: fppanalysis
Version: 0.1.4
Summary: Analysis tools for time series
Home-page: https://github.com/uit-cosmo/fpp-analysis-tools
License: MIT
Author: gregordecristoforo
Author-email: gregor.decristoforo@gmail.com
Requires-Python: >=3.8,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Dist: PyWavelets (>=1.2.0,<2.0.0)
Requires-Dist: matplotlib (>=3.6.3,<4.0.0)
Requires-Dist: mpmath (>=1.2.1,<2.0.0)
Requires-Dist: numpy (>=1.18,<2.0)
Requires-Dist: scipy (>=1.8.0,<2.0.0)
Requires-Dist: tqdm (>=4.62.3,<5.0.0)
Description-Content-Type: text/markdown

# fpp-analysis-tools
Collection of tools designed to analyse time series of intermittent fluctuations.

## Installation
The package is published to PyPI and can be installed with
```sh
pip install fppanalysis
```

If you want the development version you must first clone the repo to your local machine,
then install the project in development mode:

```sh
git clone git@github.com:uit-cosmo/fpp-analysis-tools.git
cd fpp-analysis-tools
poetry install
```

If you plan to use the GPUs, specifically for the deconvolution then setup the following conda environment:
```sh
conda create --name my-env
conda activate my-env
conda install -c rapidsai -c nvidia -c conda-forge \
    cusignal=21.08 python=3.8 cudatoolkit=11.0
conda install poetry 
poetry install
```

## Usage
You can import all functions directly from `fppanalysis`, such as

```Python
import fppanalysis as fa

bin_centers, hist = fa.get_hist(Data, N)
```

