Metadata-Version: 2.1
Name: edfrd
Version: 0.6
Summary: edfrd is a Python 3 software library to read EDF files.
Home-page: https://cbmi.htw-berlin.de/
License: LGPL-3.0
Author: Christoph Jansen
Author-email: Christoph.Jansen@htw-berlin.de
Requires-Python: >=3.4,<4.0
Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Requires-Dist: numpy (>=1.15,<2.0)
Project-URL: Repository, https://github.com/somnonetz/edfrd
Description-Content-Type: text/markdown

# edfrd

edfrd is a Python 3 software library to read EDF files.

## Installation

```bash
pip3 install --user edfrd
```

## Usage

```python
from edfrd import read_header, read_data_records

file_path = 'PATH/TO/FILE.edf'

header = read_header(file_path, calculate_number_of_data_records=True)

data_records = [
    data_record for data_record in
    read_data_records(file_path, header)  # generator
]

for signal_header, signal in zip(header.signals, data_records[0]):
    print(
        signal_header.label,
        signal.size,
        signal.dtype  # numpy int16 array
    )

# optional parameters, default is None
_ = read_data_records(
    file_path,
    header,
    start=0,
    end=header.number_of_data_records
)
```

