Skip to content

EIT-ALIVE/eitprocessing

Repository files navigation

Badges

Badges
Registry RSD workflow pypi badge github repo badge
License github license badge
Citation DOI
Fairness OpenSSF Best Practices fair-software badge
GitHub Actions build dash_actions lint documentation cffconvert
Python Python

Contents

What is eitprocessing?

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

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.

eit_dash provides an accompanying GUI.

We welcome any contributions or suggestions

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 or Getting started with conda.

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 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 and the developer documentation.

Credits

This package was created with Cookiecutter and the NLeSC/python-template.