mdf_reader

Subpackages

• mdf_reader.common
  • mdf_reader.common.converters
  • mdf_reader.common.decoders
  • mdf_reader.common.functions
  • mdf_reader.common.logging_hdlr
  • mdf_reader.common.pandas_TextParser_hdlr
  • mdf_reader.common.plots
• mdf_reader.data_models
  • mdf_reader.data_models.code_tables
  • mdf_reader.data_models.schemas
• mdf_reader.reader
  • mdf_reader.reader.get_sections
  • mdf_reader.reader.import_data
  • mdf_reader.reader.read_sections
• mdf_reader.tests
  • mdf_reader.tests.tests
• mdf_reader.validator
  • mdf_reader.validator.validate

Submodules

• mdf_reader.__main__
• mdf_reader.properties
• mdf_reader.read

Package Contents

Functions

read	Manages the integral sequence in data file reading

Attributes

__version__

read(source, data_model=None, data_model_path=None, sections=None, chunksize=None, skiprows=None, out_path=None)

Reads a data file to a pandas DataFrame using a pre-defined data model. Read data is validates against its data model producing a boolean mask on output.

The data model needs to be input to the module as a named model (included in the module) or as the path to a valid data model.

Parameters

source (str) – The file path to read

Keyword Arguments

• data_model (str, optional) – Name of internally available data model

• data_model_path (str, optional) – Path to external data model

• sections (list, optional) – List with subset of data model sections to outpu (default is all)

• chunksize (int, optional) – Number of reports per chunk (default is no chunking)

• skiprows (int, optional) – Number of initial rows to skip from file (default is 0)

• out_path (str, optional) – Path to output data, valid mask and attributes (default is no output)

Returns

output – Attributes data, mask and atts contain the corresponding information from the data file.

Return type

object

Note

This module can also be run as a script, with the keyword arguments as name_arg=arg

__version__ = 1.1