eelcovv / pymdfreader

pyMdfReader

A reader for Micro lab MDF files

Description

This module is used to read the micro lab MDF data files. An efficient mechanism is used to allow to make selection of data columns.

Example of usage:

Read a MDF file as a whole

import mdf_reader.mdf_parser as mdf
data_file = "example_data_file.mdf"

header_object = mdf.MDFParser(data_file)
header_object.data.info()

Read a selection of columns based on a filter

header_object = mdf.MDFParser(data_file, import_data=False)
header_object.set_column_selection(filter_list=["BALDER", "A[XYZ]"])
header_object.import_data()

Note that the data is stored in a pandas data frame 'header_object.data'

Examples

• See here for examples of filtering with the SignalFilters package: example_mdf or example_mdf_rtd

Unit Test

In order to run the standard unit test do:

tox

Installation

To install the package run:

pip install pyMdfReader

In case you want to run all the examples in a virtual environment you can also do:

pip install pyMdfReader[examples]

which makes sure that a that also the package matplotlib, seaborn and jupyter are installed as well.

Making Changes & Contributing

This project uses pre-commit, please make sure to install it before making any changes:

pip install pre-commit
cd pyMdfReader
pre-commit install

It is a good idea to update the hooks to the latest version:

pre-commit autoupdate

Don't forget to tell your contributors to also install and use pre-commit.

Note

This project has been set up using PyScaffold 4.5. For details and usage information on PyScaffold see https://pyscaffold.org/.