Skip to content

Commit

Permalink
Merge branch 'pre_generator'
Browse files Browse the repository at this point in the history
  • Loading branch information
danielhrisca committed Jan 30, 2018
2 parents 7aa4ac3 + d0ecd63 commit 9d398b8
Show file tree
Hide file tree
Showing 36 changed files with 6,472 additions and 8,221 deletions.
4 changes: 3 additions & 1 deletion .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,9 @@ install:
script:
- set -e
- python --version
- python test/run_all.py
- python -m coverage run test/run_all.py
- python -m coverage xml -i --include */asammdf/*
- if [[ "$TRAVIS_PULL_REQUEST" = "false" ]]; then python-codacy-coverage -r coverage.xml; fi
- python -m sphinx -nW -b html documentation documentation/_build/html

after_success:
5 changes: 0 additions & 5 deletions ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
# Pyhton version
Please write here the output of printing ``sys.version``

# Platform information
Expand All @@ -8,8 +7,4 @@ Please write here the output of printing ``platform.platform()``
Please write here the output of printing ``asammdf.__version__``

# Description
<<<<<<< HEAD
Please describe the issue here.
=======
Please describe the issue here.
>>>>>>> development
42 changes: 20 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
[![PyPI version](https://badge.fury.io/py/asammdf.svg)](https://badge.fury.io/py/asammdf) [![Documentation Status](http://readthedocs.org/projects/asammdf/badge/?version=master)](http://asammdf.readthedocs.io/en/master/?badge=stable) [![Codacy Badge](https://api.codacy.com/project/badge/Grade/a3da21da90ca43a5b72fc24b56880c99)](https://www.codacy.com/app/danielhrisca/asammdf?utm_source=github.com&utm_medium=referral&utm_content=danielhrisca/asammdf&utm_campaign=badger)

[![Build Status](https://travis-ci.org/danielhrisca/asammdf.svg?branch=master)](https://travis-ci.org/danielhrisca/asammdf)


*asammdf* is a fast parser/editor for ASAM (Associtation for Standardisation of Automation and Measuring Systems) MDF (Measurement Data Format) files.
Expand All @@ -9,17 +6,24 @@

*asammdf* works on Python 2.7, and Python >= 3.4 (Travis CI tests done with Python 2.7 and Python >= 3.5)

# Status
! | master | development
--|--|--
Travis CI | [![Build Status](https://travis-ci.org/danielhrisca/asammdf.svg?branch=master)](https://travis-ci.org/danielhrisca/asammdf) | [![Build Status](https://travis-ci.org/danielhrisca/asammdf.svg?branch=development)](https://travis-ci.org/danielhrisca/asammdf)
Codacy | [![Codacy Badge](https://api.codacy.com/project/badge/Grade/a3da21da90ca43a5b72fc24b56880c99?branch=master)](https://www.codacy.com/app/danielhrisca/asammdf?utm_source=github.com&utm_medium=referral&utm_content=danielhrisca/asammdf&utm_campaign=badger) | [![Codacy Badge](https://api.codacy.com/project/badge/Grade/a3da21da90ca43a5b72fc24b56880c99?branch=development)](https://www.codacy.com/app/danielhrisca/asammdf?utm_source=github.com&utm_medium=referral&utm_content=danielhrisca/asammdf&utm_campaign=badger)
Coverage | [![Codacy Badge](https://api.codacy.com/project/badge/Coverage/a3da21da90ca43a5b72fc24b56880c99?branch=master)](https://www.codacy.com/app/danielhrisca/asammdf?utm_source=github.com&utm_medium=referral&utm_content=danielhrisca/asammdf&utm_campaign=Badge_Coverage) | [![Codacy Badge](https://api.codacy.com/project/badge/Coverage/a3da21da90ca43a5b72fc24b56880c99?branch=development)](https://www.codacy.com/app/danielhrisca/asammdf?utm_source=github.com&utm_medium=referral&utm_content=danielhrisca/asammdf&utm_campaign=Badge_Coverage)
ReadTheDocs | [![Documentation Status](http://readthedocs.org/projects/asammdf/badge/?version=master)](http://asammdf.readthedocs.io/en/master/?badge=stable) | [![Documentation Status](http://readthedocs.org/projects/asammdf/badge/?version=development)](http://asammdf.readthedocs.io/en/development/?badge=stable)
PyPI | [![PyPI version](https://badge.fury.io/py/asammdf.svg)](https://badge.fury.io/py/asammdf) |


Project goals
=============
# 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 3-rd party dependencies

Features
========
# Features

* create new mdf files from scratch
* append new channels
Expand Down Expand Up @@ -52,8 +56,7 @@ Features
* usually a measurement will have channels from different sources at different rates
* the *Signal* class facilitates operations with such channels

Major features not implemented (yet)
====================================
# Major features not implemented (yet)
* for version 3

* functionality related to sample reduction block (but the class is defined)
Expand All @@ -69,8 +72,7 @@ Major features not implemented (yet)
* channels with default X axis
* channels with reference to attachment

Usage
=====
# Usage

```python
from asammdf import MDF
Expand All @@ -94,14 +96,12 @@ Usage
```

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

Documentation
=============
http://asammdf.readthedocs.io/en/master
# Documentation
http://asammdf.readthedocs.io/en/development

Installation
============
# Installation
*asammdf* is available on

* github: https://github.com/danielhrisca/asammdf/
Expand All @@ -111,8 +111,7 @@ Installation
pip install asammdf
```

Dependencies
============
# Dependencies
asammdf uses the following libraries

* numpy : the heart that makes all tick
Expand All @@ -127,8 +126,7 @@ optional dependencies needed for exports
* xlsxwriter : for Excel export
* scipy : for Matlab .mat export

Benchmarks
==========
# Benchmarks

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

6 changes: 3 additions & 3 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -90,11 +90,11 @@ Usage
Check the *examples* folder for extended usage demo, or the documentation
http://asammdf.readthedocs.io/en/master/examples.html
http://asammdf.readthedocs.io/en/development/examples.html

Documentation
=============
http://asammdf.readthedocs.io/en/master
http://asammdf.readthedocs.io/en/development

Installation
============
Expand Down Expand Up @@ -128,7 +128,7 @@ optional dependencies needed for exports
Benchmarks
==========

Graphical results can be seen here at http://asammdf.readthedocs.io/en/master/benchmarks.html
Graphical results can be seen here at http://asammdf.readthedocs.io/en/development/benchmarks.html


Python 3 x86
Expand Down
16 changes: 9 additions & 7 deletions asammdf/__init__.py
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
# -*- coding: utf-8 -*-
""" asammdf is a parser and editor for ASAM MDF files """
from .mdf2 import MDF2
from .mdf3 import MDF3
from .mdf4 import MDF4

from .mdf_v2 import MDF2
from .mdf_v3 import MDF3
from .mdf_v4 import MDF4
from .mdf import MDF, SUPPORTED_VERSIONS
from .signal import Signal
from .version import __version__


__all__ = [
'__version__',
'configure',
'MDF',
'MDF2',
'MDF2'
'MDF3',
'MDF4',
'Signal',
Expand All @@ -27,6 +27,10 @@ def configure(
overwrite=None):
""" configure asammdf parameters
Note
----
this is not thread safe
Parameters
----------
integer_compacting : bool
Expand All @@ -46,7 +50,6 @@ def configure(
"""

if integer_compacting is not None:
MDF2._compact_integers_on_append = bool(integer_compacting)
MDF3._compact_integers_on_append = bool(integer_compacting)
MDF4._compact_integers_on_append = bool(integer_compacting)

Expand All @@ -57,6 +60,5 @@ def configure(
MDF4._split_data_blocks = bool(split_data_blocks)

if overwrite is not None:
MDF2._overwrite = bool(overwrite)
MDF3._overwrite = bool(overwrite)
MDF4._overwrite = bool(overwrite)
Loading

0 comments on commit 9d398b8

Please sign in to comment.