Metadata-Version: 2.1
Name: inflow-haisslab
Version: 1.2.27
Summary: General python code for analysis pipeline
Author-Email: =?utf-8?q?Timoth=C3=A9_Jost-MOUSSEAU?= <timothe.jost-mousseau@pasteur.com>
License: MIT
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Project-URL: Homepage, https://gitlab.pasteur.fr/haisslab/analysis-packages/Inflow
Requires-Python: >=3.11
Requires-Dist: concurrent-log-handler>=0.9
Requires-Dist: cryptography>=38.0
Requires-Dist: h5py>=3.7
Requires-Dist: matplotlib>=3.6
Requires-Dist: natsort>=8.2
Requires-Dist: npTDMS>=1.6
Requires-Dist: numpy>=1.23
Requires-Dist: opencv_python_headless>=4.6
Requires-Dist: pandas>=1.4
Requires-Dist: paramiko>=2.8
Requires-Dist: scipy>=1.9
Requires-Dist: seaborn>=0.11
Requires-Dist: suite2p-haisslab>=0.14.0
Requires-Dist: timelined_array>=0.0.14
Requires-Dist: shapely>=2.0.6
Provides-Extra: gui
Requires-Dist: suite2p-haisslab[gui]>=0.14.11; extra == "gui"
Description-Content-Type: text/markdown

# [Inflow](https://haisslab.pages.pasteur.fr/analysis-packages/Inflow/)
Core package for analysis, and pipelining utilities in the Haiss Lab  
Find the documentation for the functions of this package in a searchable website here : https://haisslab.pages.pasteur.fr/analysis-packages/Inflow/

## Requirements
Inflow requires python 3.7 or later, and is tested on Windows 10.

## Installing
Installing the package via pip typically takes a few seconds.  To install, activate your developpement environment :
```
conda activate <myenvironment>
```
If you don't have an environment or conda installed, [follow these instructions](https://gitlab.pasteur.fr/haisslab/analysis-packages/how-to-start/-/blob/main/README.md)  
Then run the Inflow install using :
```
pip install git+https://gitlab.pasteur.fr/haisslab/analysis-packages/Inflow.git
```

**NB**:  
This package is still under active development, for the best experience please regularly update the package by running :  
```
pip install --force-reinstall --no-deps -U git+https://gitlab.pasteur.fr/haisslab/analysis-packages/Inflow.git
```
For dev environment (expect bugs), use this one :
```
pip install --force-reinstall --no-deps git+https://gitlab.pasteur.fr/haisslab/analysis-packages/Inflow.git@dev
```

This  will force the reinstallation of the package, without the need to do a `pip uninstall Inflow` first, and without reinstalling the dependancies like numpy etc (hence faster).


For **pre-realeases environment** (dev after minimal testing, please don't hesitate to report bugs), use this one :  
```
pip install --force-reinstall --no-deps -U git+https://gitlab.pasteur.fr/haisslab/analysis-packages/Inflow.git@pre-releases
```

## Usage

```python
import Inflow
Inflow.load.tdms("mytdmsfile.tdms").
```

 
