Skip to main content

ASAM MDF measurement data file parser

Project description

logo of asammdf

asammdf is a fast parser and editor for ASAM (Association for Standardization of Automation and Measuring Systems) MDF (Measurement Data Format) files.

asammdf supports MDF versions 2 (.dat), 3 (.mdf) and 4 (.mf4).

asammdf works on Python >= 3.10

PyPI - Downloads PyPI - License PyPI - Python Version PyPI - Version Checked with mypy pre-commit Ruff


screenshot of the graphical user interface

Status

Continuous Integration Coveralls Codacy ReadTheDocs
continuous integration Coverage Status Codacy Badge Documentation Status
PyPI conda-forge
PyPI version conda-forge version

Project goals

The main goals for this library are:

  • to be faster than the other Python-based mdf libraries
  • to have clean and easy-to-understand code base
  • to have minimal 3rd party dependencies

Features

  • create new mdf files from scratch
  • append new channels
  • read unsorted MDF v3 and v4 files
  • read CAN and LIN bus logging files
  • extract CAN and LIN signals from anonymous bus logging measurements
  • filter a subset of channels from original mdf file
  • cut measurement to specified time interval
  • convert to different mdf version
  • export to pandas, HDF5, Matlab (v7.3), CSV and parquet
  • merge multiple files sharing the same internal structure
  • read and save mdf version 4.10 files containing zipped data blocks
  • space optimizations for saved files (no duplicated blocks)
  • split large data blocks (configurable size) for mdf version 4
  • full support (read, append, save) for the following map types (multidimensional array channels):
    • mdf version 3 channels with CDBLOCK
    • mdf version 4 structure channel composition
    • mdf version 4 channel arrays with CNTemplate storage and one of the array types:
      • 0 - array
      • 1 - scaling axis
      • 2 - look-up
  • add and extract attachments for mdf version 4
  • handle large files (for example merging two files, each with 14000 channels and 5GB size, on a RaspberryPi)
  • extract channel data, master channel and extra channel information as Signal objects for unified operations with v3 and v4 files
  • time domain operation using the Signal class
    • pandas DataFrames are good if all the channels have the same time base
    • a measurement will usually have channels from different sources at different rates
    • the Signal class facilitates operations with such channels
  • graphical interface to visualize channels and perform operations with the files

Major features not implemented (yet)

  • for version 3
    • functionality related to sample reduction block: the sample reduction blocks are simply ignored
  • for version 4
    • experimental support for MDF v4.20 column oriented storage
    • functionality related to sample reduction block: the sample reduction blocks are simply ignored
    • handling of channel hierarchy: channel hierarchy is ignored
    • full handling of bus logging measurements: currently only CAN and LIN bus logging are implemented with the ability to get signals defined in the attached CAN/LIN database (.arxml or .dbc). Signals can also be extracted from an anonymous bus logging measurement by providing a CAN or LIN database (.dbc or .arxml)
    • handling of unfinished measurements (mdf 4): finalization is attempted when the file is loaded, however not all the finalization steps are supported
    • full support for remaining mdf 4 channel arrays types
    • xml schema for MDBLOCK: most metadata stored in the comment blocks will not be available
    • full handling of event blocks: events are transferred to the new files (in case of calling methods that return new MDF objects) but no new events can be created
    • channels with default X axis: the default X axis is ignored and the channel group's master channel is used
    • attachment encryption/decryption using user provided encryption/decryption functions; this is not part of the MDF v4 spec and is only supported by this library

Usage

from asammdf import MDF

mdf = MDF('sample.mdf')
speed = mdf.get('WheelSpeed')
speed.plot()

important_signals = ['WheelSpeed', 'VehicleSpeed', 'VehicleAcceleration']
# get short measurement with a subset of channels from 10s to 12s
short = mdf.filter(important_signals).cut(start=10, stop=12)

# convert to version 4.10 and save to disk
short.convert('4.10').save('important signals.mf4')

# plot some channels from a huge file
efficient = MDF('huge.mf4')
for signal in efficient.select(['Sensor1', 'Voltage3']):
    signal.plot()

Check the examples folder for extended usage demo, or the documentation http://asammdf.readthedocs.io/en/master/examples.html

https://canlogger.csselectronics.com/canedge-getting-started/ce3/log-file-tools/asammdf-gui/

Documentation

http://asammdf.readthedocs.io/en/master

And a nicely written tutorial on the CSS Electronics site.

Contributing & Support

Please have a look at the contributing guidelines.

If you enjoy this library please consider making a donation to the numpy project or to danielhrisca using liberapay.

Donate using Liberapay

Contributors

Thanks to all who contributed with commits to asammdf:

profile pictures of the contributors

Installation

asammdf is available on

pip install asammdf
# for the GUI
pip install asammdf[gui]
# or for anaconda
conda install -c conda-forge asammdf

In case a wheel is not present for your OS/Python versions and you lack the proper compiler setup to compile the C-extension code, then you can simply copy-paste the package code to your site-packages. In this way the Python fallback code will be used instead of the compiled C-extension code.

Dependencies

asammdf uses the following libraries

  • numpy : the heart that makes all tick
  • numexpr : for algebraic and rational channel conversions
  • wheel : for installation in virtual environments
  • pandas : for DataFrame export
  • canmatrix : to handle CAN/LIN bus logging measurements
  • natsort
  • lxml : for canmatrix arxml support
  • lz4 : to speed up the disk IO performance
  • python-dateutil : measurement start time handling

Optional dependencies needed for exports

  • h5py : for HDF5 export
  • hdf5storage : for Matlab v7.3 .mat export
  • pyarrow : for parquet export
  • scipy: for Matlab v4 and v5 .mat export

Other optional dependencies

  • PySide6 : for GUI tool
  • pyqtgraph : for GUI tool and Signal plotting
  • matplotlib : as fallback for Signal plotting
  • faust-cchardet : to detect non-standard Unicode encodings
  • chardet : to detect non-standard Unicode encodings
  • pyqtlet2 : for the GPS window
  • isal : for faster zlib compression/decompression
  • fsspec : access files stored in the cloud

Benchmarks

http://asammdf.readthedocs.io/en/master/benchmarks.html

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

asammdf-8.6.0.tar.gz (9.1 MB view details)

Uploaded Source

Built Distributions

asammdf-8.6.0-cp310-abi3-win_amd64.whl (1.2 MB view details)

Uploaded CPython 3.10+Windows x86-64

asammdf-8.6.0-cp310-abi3-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl (1.2 MB view details)

Uploaded CPython 3.10+manylinux: glibc 2.17+ x86-64manylinux: glibc 2.28+ x86-64

asammdf-8.6.0-cp310-abi3-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl (1.2 MB view details)

Uploaded CPython 3.10+manylinux: glibc 2.17+ ARM64manylinux: glibc 2.28+ ARM64

asammdf-8.6.0-cp310-abi3-macosx_11_0_arm64.whl (1.2 MB view details)

Uploaded CPython 3.10+macOS 11.0+ ARM64

asammdf-8.6.0-cp310-abi3-macosx_10_9_x86_64.whl (1.2 MB view details)

Uploaded CPython 3.10+macOS 10.9+ x86-64

File details

Details for the file asammdf-8.6.0.tar.gz.

File metadata

  • Download URL: asammdf-8.6.0.tar.gz
  • Upload date:
  • Size: 9.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.4

File hashes

Hashes for asammdf-8.6.0.tar.gz
Algorithm Hash digest
SHA256 5130644b02b199d3113b07d2ed16b97e64e70f089618358e88ee2ad9333325d1
MD5 6f631ba63f94ce502db6da870a0caf49
BLAKE2b-256 ff6ca81fc269c5eaf1967919bc6d0a29fde4418ac6d632f9eabdad8102bb6a6b

See more details on using hashes here.

File details

Details for the file asammdf-8.6.0-cp310-abi3-win_amd64.whl.

File metadata

  • Download URL: asammdf-8.6.0-cp310-abi3-win_amd64.whl
  • Upload date:
  • Size: 1.2 MB
  • Tags: CPython 3.10+, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.4

File hashes

Hashes for asammdf-8.6.0-cp310-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 172ed3099479828802ffffa4e7106eb10ae01803b32de68fa7d52d99404cdfb7
MD5 6e34d9528ece46a193aeefdcb8ab8121
BLAKE2b-256 7232fddf08395db52a5643954577b1ea4f547c63c9940c66693dcc9bb7837503

See more details on using hashes here.

File details

Details for the file asammdf-8.6.0-cp310-abi3-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl.

File metadata

File hashes

Hashes for asammdf-8.6.0-cp310-abi3-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 db52266238830e853c38d8788586299a6efbcf1a826ff52edad62f05867f3ef9
MD5 932001e51ffbafdbf795b8d0dad9a848
BLAKE2b-256 8350c706f7d6ffd4eb26d3221a5387963ca6c7174dc892321e636f03ed5ed9b6

See more details on using hashes here.

File details

Details for the file asammdf-8.6.0-cp310-abi3-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl.

File metadata

File hashes

Hashes for asammdf-8.6.0-cp310-abi3-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl
Algorithm Hash digest
SHA256 854cb120db61d7363f76b15509e5bf7d1daf5ed51bd825a6d14f85cfece5f98d
MD5 6bf3779710223d0d0d2371448b68b444
BLAKE2b-256 b562d27cc9978a4eb7efa131d3e72f836801b3dae5ba0790e1d07b62a727bb70

See more details on using hashes here.

File details

Details for the file asammdf-8.6.0-cp310-abi3-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for asammdf-8.6.0-cp310-abi3-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 a6413880270d4158c4536a984c05b66d32d5e3a6c0ff2850edb5a03a8cc9cdf0
MD5 2ad73bb5d6c7a09c670a225adfaae6e9
BLAKE2b-256 14ba053ba7f2c75cb9251b3bfa3b12afc01ddd99a3e7ba3ae466b6a87595611b

See more details on using hashes here.

File details

Details for the file asammdf-8.6.0-cp310-abi3-macosx_10_9_x86_64.whl.

File metadata

File hashes

Hashes for asammdf-8.6.0-cp310-abi3-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 bb3bcd6d6d23837758ef850d47151336484be2a220fd4c235a2d997f9ca9d877
MD5 c256982268962112de58aab11d72c9ba
BLAKE2b-256 6f658bfbdbf48512a1953c4df4f3afabc0ed09824f5533ba8b6e5d4cc2f88c00

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page