Metadata-Version: 2.1
Name: openmnglab
Version: 0.2.2
Summary: A Python framework for microneurography analysis
Home-page: https://github.com/Digital-C-Fiber/openMNGlab
License: MIT
Keywords: microneurography,neurophysiology,electrophysiology
Author: Peter Konradi
Author-email: codingchipmunk@posteo.net
Requires-Python: >=3.11,<4.0
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Healthcare Industry
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3 :: Only
Requires-Dist: h5py (>=3.9.0,<4.0.0)
Requires-Dist: matplotlib (>=3.7.1,<4.0.0)
Requires-Dist: pandas (>=2.0.1,<3.0.0)
Requires-Dist: pandera (>=0.14.5,<0.15.0)
Requires-Dist: quantities (>=0.14.1,<0.15.0)
Requires-Dist: seaborn (>=0.12.2,<0.13.0)
Project-URL: Documentation, https://openmnglab.readthedocs.io/en/latest/
Project-URL: Repository, https://github.com/Digital-C-Fiber/openMNGlab
Description-Content-Type: text/markdown

# OpenMNGLab
🚧 under heavy construction, expect every new version to break the API 🚧

[![PyPI](https://img.shields.io/pypi/v/openmnglab?style=for-the-badge)](https://pypi.org/project/openmnglab/) [![PyPI pyversions](https://img.shields.io/pypi/pyversions/openmnglab.svg?style=for-the-badge)](https://pypi.python.org/pypi/pandera/) [![DOCS](https://readthedocs.org/projects/openmnglab/badge/?version=latest&style=for-the-badge)](https://openmnglab.readthedocs.io/en/latest/)  [![DOI (Zenodo)](https://img.shields.io/badge/Zenodo-doi%3A10.5281%2Fzenodo.8331924-blue?style=for-the-badge)](https://doi.org/10.5281/zenodo.8331924) 


A Python framework for [microneurography](https://en.wikipedia.org/wiki/Microneurography) analysis.
The core idea is to build up an execution plan of pre-defined (implemented) "function modules". The plan can then be executed and 
results retrieved.

## Installation
Currently, the package requires Python v3.11 at minimum.
The package is distributed via PyPI as "[openmnglab](https://pypi.org/project/openmnglab/)". 

## Quickstart
For a quickstart see the [quickstart.ipynb](quickstart/quickstart.ipynb)

## Citing
The repository in general can be cited using the Zenodo-DOI [10.5281/zenodo.8331924](https://doi.org/10.5281/zenodo.8331924).
On the [Zenodo project page](https://zenodo.org/records/8341948) you will find additional DOIs to cite specific versions of the library. 
