pybreathe 0.0.0__tar.gz

pybreathe-0.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Thibaut Coustillet
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

pybreathe-0.0.0/MANIFEST.in

@@ -0,0 +1,8 @@
+include README.md
+include LICENSE
+include pyproject.toml
+
+prune tests
+prune *.egg-info
+global-exclude __pycache__
+global-exclude .*

pybreathe-0.0.0/PKG-INFO

@@ -0,0 +1,68 @@
+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
+```

pybreathe-0.0.0/README.md

@@ -0,0 +1,37 @@
+# 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
+```

pybreathe-0.0.0/pybreathe/__init__.py

@@ -0,0 +1 @@
+from .base import BreathingFlow, flow_merger

pybreathe-0.0.0/pybreathe/base/__init__.py

@@ -0,0 +1,2 @@
+from .breathingflow import BreathingFlow
+from .utils import flow_merger