Metadata-Version: 2.1
Name: eitprocessing
Version: 1.3.2
Summary: Processing of lung image data from electrical impedance tomography.
Author-email: Dani Bodor <d.bodor@esciencecenter.nl>, Peter Somhorst <p.somhorst@erasmusmc.nl>, Walter Baccinelli <w.baccinelli@esciencecenter.nl>
License: Apache-2.0 license
Project-URL: Documentation, https://github.com/EIT-ALIVE/eitprocessing/blob/main/README.md
Project-URL: Repository, https://github.com/EIT-ALIVE/eitprocessing/
Project-URL: Changelog, https://github.com/EIT-ALIVE/eitprocessing/blob/main/CHANGELOG.md
Keywords: Mechanical lung ventilation,Electrical impedance tomography,Image/data processing,Advanced respiratory care
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
License-File: NOTICE
Requires-Dist: matplotlib>=3.7.1
Requires-Dist: numpy>=1.24.2
Requires-Dist: scipy>=1.10.1
Requires-Dist: tqdm>=4.65.0
Requires-Dist: strenum>=0.4.10
Requires-Dist: ruff>=0.3
Requires-Dist: anytree>=2.12.1
Provides-Extra: dev
Requires-Dist: pytest>=7.4.0; extra == "dev"
Requires-Dist: bump-my-version; extra == "dev"
Requires-Dist: coverage; extra == "dev"
Requires-Dist: pycodestyle; extra == "dev"
Requires-Dist: pytest-cov; extra == "dev"
Requires-Dist: pytest-runner; extra == "dev"
Requires-Dist: coveralls; extra == "dev"
Requires-Dist: sphinx; extra == "dev"
Requires-Dist: sphinx_rtd_theme; extra == "dev"
Requires-Dist: sphinx-autoapi; extra == "dev"
Requires-Dist: tox; extra == "dev"
Requires-Dist: myst_parser; extra == "dev"
Provides-Extra: notebooks
Requires-Dist: ipykernel>=6.15.2; extra == "notebooks"
Requires-Dist: ipython>=8.4.0; extra == "notebooks"
Requires-Dist: jupyter>=1.0.0; extra == "notebooks"
Requires-Dist: jupytext>=1.14.5; extra == "notebooks"
Requires-Dist: notebook>=6.4.12; extra == "notebooks"
Provides-Extra: publishing
Requires-Dist: build; extra == "publishing"
Requires-Dist: twine; extra == "publishing"
Requires-Dist: wheel; extra == "publishing"

# Badges <!-- omit in toc -->

| Badges         |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| :------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Registry       | [![RSD](https://img.shields.io/badge/rsd-eitprocessing-00a3e3.svg)](https://www.research-software.nl/software/eitprocessing) [![workflow pypi badge](https://img.shields.io/pypi/v/eitprocessing.svg?colorB=blue)](https://pypi.python.org/project/eitprocessing/) [![github repo badge](https://img.shields.io/badge/github-repo-000.svg?logo=github&labelColor=gray&color=blue)](git@github.com:EIT-ALIVE/eitprocessing)                                                                                   |
| License        | [![github license badge](https://img.shields.io/github/license/EIT-ALIVE/eitprocessing)](git@github.com:EIT-ALIVE/eitprocessing)                                                                                                                                                                                                                                                                                                                                                                             |
| Citation       | [![DOI](https://zenodo.org/badge/617944717.svg)](https://zenodo.org/badge/latestdoi/617944717)                                                                                                                                                                                                                                                                                                                                                                                                               |
| Fairness       | [![OpenSSF Best Practices](https://www.bestpractices.dev/projects/9147/badge)](https://www.bestpractices.dev/projects/9147) [![fair-software badge](https://img.shields.io/badge/fair--software.eu-%E2%97%8F%20%20%E2%97%8F%20%20%E2%97%8F%20%20%E2%97%8F%20%20%E2%97%8B-yellow)](https://fair-software.eu)                                                                                                                                                                                                  |
| GitHub Actions | ![build](https://github.com/EIT-ALIVE/eitprocessing/actions/workflows/build.yml/badge.svg) ![dash_actions](https://github.com/EIT-ALIVE/eitprocessing/actions/workflows/dash_actions.yml/badge.svg) ![lint](https://github.com/EIT-ALIVE/eitprocessing/actions/workflows/lint.yml/badge.svg) ![documentation](https://github.com/EIT-ALIVE/eitprocessing/actions/workflows/documentation.yml/badge.svg) ![cffconvert](https://github.com/EIT-ALIVE/eitprocessing/actions/workflows/cffconvert.yml/badge.svg) |
| Python         | ![Python](https://img.shields.io/badge/python-3.10-blue.svg)                                                                                                                                                                                                                                                                                                                                                                                                                                                 |

# Contents <!-- omit in toc -->

- [What is eitprocessing?](#what-is-eitprocessing)
- [Installation](#installation)
  - [Virtual environment](#virtual-environment)
  - [Install using `pip`](#install-using-pip)
- [Documentation](#documentation)
- [Contributing](#contributing)
- [Credits](#credits)

# What is eitprocessing?

Processing of data from electrical impedance tomography and other respiratory monitoring tools.

[Electrical Impedance Tomography](https://en.wikipedia.org/wiki/Electrical_impedance_tomography) (EIT) is a noninvasive
and radiation-free continuous imaging tool for monitoring respiratory mechanics. eitprocessing aims to provide a
versatile, user-friendly, reproducible and reliable workflow for the processing and analysis of EIT data and related
waveform data, like pressures and flow.

eitprocessing includes tools to load data exported from EIT-devices from several manufacturers, including Dräger, SenTec
and Timpel, as well as data from other sources. Several pre-processing tools and analysis tools are provided.

<!-- TODO when available, add summarisation and reporting -->
<!-- TODO extend with short list of available tools when applicable -->

[eit_dash](https://github.com/EIT-ALIVE/eit_dash) provides an accompanying GUI.

We welcome any [contributions or suggestions](CONTRIBUTING.md)

# Installation

## Virtual environment

It is advised to install eitprocessing in a dedicated virtual environment. See e.g. [Install packages in a virtual
environment using pip and
venv](https://packaging.python.org/en/latest/guides/installing-using-pip-and-virtual-environments/) or [Getting started
with conda](https://docs.conda.io/projects/conda/en/stable/user-guide/getting-started.html).

For conda (using 'eit-alive' as example environment name; you can choose your own):
```
conda create -n eit-alive python=3.10
conda activate eit-alive
```

## Install using `pip`

eitprocessing can be installed from PyPi as follows:

- For basic use: `pip install eitprocessing`
- For full developer options (testing, etc): 
  - `git clone git@github.com:EIT-ALIVE/eitprocessing.git`
  - `cd eitprocessing`
  - `pip install -e ".[dev]"`

# Documentation

Please see our [usage documentation](https://eit-alive.github.io/eitprocessing/) for a detailed explanation of the package.

# Contributing

If you want to contribute to the development of eitprocessing,
have a look at the [contribution guidelines](CONTRIBUTING.md) and the [developer documentation](README.dev.md).

# Credits

This package was created with [Cookiecutter](https://github.com/audreyr/cookiecutter) and the [NLeSC/python-template](https://github.com/NLeSC/python-template).
