Metadata-Version: 2.1
Name: pyMdfReader
Version: 0.1.3
Summary: Read the binary MDF file format
Home-page: https://github.com/eelcovv/pyMdfReader
Author: Eelco van Vliet
Author-email: eelcovv@gmail.com
License: MIT
Project-URL: Documentation, https://pymdfreader.readthedocs.io/en/latest/
Platform: any
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python
Description-Content-Type: text/x-rst; charset=UTF-8
License-File: LICENSE.txt
Requires-Dist: numpy
Requires-Dist: pandas
Requires-Dist: importlib-metadata ; python_version < "3.8"
Provides-Extra: dev
Requires-Dist: pytest ; extra == 'dev'
Requires-Dist: pytest-cov ; extra == 'dev'
Requires-Dist: black ; extra == 'dev'
Requires-Dist: tox ; extra == 'dev'
Requires-Dist: pre-commit ; extra == 'dev'
Provides-Extra: examples
Requires-Dist: matplotlib ; extra == 'examples'
Provides-Extra: notebook
Requires-Dist: seaborn ; extra == 'notebook'
Requires-Dist: jupyter ; extra == 'notebook'
Provides-Extra: testing
Requires-Dist: setuptools ; extra == 'testing'
Requires-Dist: pytest ; extra == 'testing'
Requires-Dist: pytest-cov ; extra == 'testing'

===========
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

.. code:: python

    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

.. code:: python

    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
========

* Loading and Plotting MDF files: `example_mdf`_ or `example_mdf_rtd`_

.. _example_mdf: _static/example_mdf_reader.html
.. _example_mdf_rtd: https://pymdfreader.readthedocs.io/en/latest/_static/example_filtering.html


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.

.. _pre-commit: https://pre-commit.com/

Note
====

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