Metadata-Version: 2.4
Name: pybreathe
Version: 0.0.0
Summary: A python package for respiratory air flow rates analysis
Author-email: Thibaut Coustillet <thib.coustillet@gmail.com>
License-Expression: MIT
Project-URL: Homepage, https://github.com/tcoustillet/pybreathe
Project-URL: Source, https://github.com/tcoustillet/pybreathe
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Intended Audience :: Science/Research
Classifier: Operating System :: OS Independent
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: matplotlib>=3.10.1
Requires-Dist: numpy>=2.2.4
Requires-Dist: openpyxl>=3.1.5
Requires-Dist: pandas>=2.2.3
Requires-Dist: scipy>=1.15.2
Requires-Dist: seaborn>=0.13.2
Provides-Extra: dev
Requires-Dist: ipykernel>=6.29.5; extra == "dev"
Requires-Dist: jupyterlab>=4.4.1; extra == "dev"
Requires-Dist: pytest>=8.4.0; extra == "dev"
Requires-Dist: pylint>=3.3.5; extra == "dev"
Requires-Dist: pycodestyle>=2.13.0; extra == "dev"
Requires-Dist: pydocstyle>=6.3.0; extra == "dev"
Requires-Dist: black>=25.1.0; extra == "dev"
Dynamic: license-file

# pybreathe: a python package for respiratory air flow rates analysis

## Get started

First of all, we highly recommend that you install [miniconda](https://www.anaconda.com/docs/getting-started/miniconda/install) on your machine.

To set up the virtual environment required for respiratory flow analysis, open **Anaconda prompt**, copy the full package path and move to it with `$ cd package_path`. Then, please run (only the first time):

```bash
$ conda env create -f environment.yml
$ conda activate venv_pybreathe
$ python -m ipykernel install --user --name=venv_pybreathe
```

Then, every time you want to analyze data, activate the virtual environment with:

```bash
$ conda activate venv_pybreathe
```

and run the example script (or any other) with:

```bash
$ jupyter lab example.ipynb
```

> /!\ You must either be in the same directory as your .ipynb file, or specify the absolute path.

Finally, to quit the analysis, please follow these steps:

- Right clic on your .ipynb file in the tree, then "Shut Down Kernel"
- Clic on "File", the "Shut Down"
- When you regain control in your terminal, run:

```bash
$ conda deactivate
```
