Metadata-Version: 2.1
Name: eitprocessing
Version: 1.0.1
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
Provides-Extra: dev
Requires-Dist: pytest >=7.4.0 ; extra == 'dev'
Requires-Dist: bump2version ; 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

| fair-software.eu recommendations | |
| :-- | :--  |
| (1/5) code repository              | [![github repo badge](https://img.shields.io/badge/github-repo-000.svg?logo=github&labelColor=gray&color=blue)](git@github.com:EIT-ALIVE/eitprocessing) |
| (2/5) license                      | [![github license badge](https://img.shields.io/github/license/EIT-ALIVE/eitprocessing)](git@github.com:EIT-ALIVE/eitprocessing) |
| (3/5) community 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/) |
| (4/5) citation                     |  [![DOI](https://zenodo.org/badge/617944717.svg)](https://zenodo.org/badge/latestdoi/617944717) |
| (5/5) checklist                    | [![workflow cii badge](https://bestpractices.coreinfrastructure.org/projects/<replace-with-created-project-identifier>/badge)](https://bestpractices.coreinfrastructure.org/projects/<replace-with-created-project-identifier>) |
| howfairis                          | [![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**                 | &nbsp; |
| Build                              | [![build](git@github.com:EIT-ALIVE/eitprocessing/actions/workflows/build.yml/badge.svg)](git@github.com:EIT-ALIVE/eitprocessing/actions/workflows/build.yml) |
| Citation data consistency               | [![cffconvert](git@github.com:EIT-ALIVE/eitprocessing/actions/workflows/cffconvert.yml/badge.svg)](git@github.com:EIT-ALIVE/eitprocessing/actions/workflows/cffconvert.yml) |
| MarkDown link checker              | [![markdown-link-check](git@github.com:EIT-ALIVE/eitprocessing/actions/workflows/markdown-link-check.yml/badge.svg)](git@github.com:EIT-ALIVE/eitprocessing/actions/workflows/markdown-link-check.yml) |

## How to use eitprocessing

Processing of lung image data from electrical impedance tomography

The project setup is documented in [project_setup.md](project_setup.md). Feel free to remove this document (and/or the link to this document) if you don't need it.

## Installation

Install eitprocessing as follows:

- Create fresh environment
  - Make sure you are in your base environment: `conda activate`
  - Create a new environment: `conda create -n <envname> python=3.10`
  - Activate new environment: `conda activate <envname>`
- Clone and install
  - Clone the repository: `git clone git@github.com:EIT-ALIVE/eitprocessing.git`
  - Install:
    - For basic use: `pip install -e .`
    - For full developer options (testing, etc): `pip install -e .[dev]`

## Documentation

We have custom documentation on a dedicated page [here](https://eit-alive.github.io/eitprocessing/)

## 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).
