Skip to content

Commit

Permalink
setup.py: in case of cython compiling failing, bitarray becomes requi…
Browse files Browse the repository at this point in the history 
…rement instead of cython
  • Loading branch information
@ratal
ratal committed Sep 4, 2015
1 parent 223b2d0 commit 058f977
Show file tree
Hide file tree
Showing 3 changed files with 108 additions and 98 deletions.
8 changes: 5 additions & 3 deletions README
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,16 @@ Abstract:
=========
This Module imports MDF files (Measured Data Format V3.x and V4.x), typically from INCA (ETAS), CANape or CANOe. It is widely used in automotive industry to record data from ECUs. The main module mdfreader.py inherits from 2 modules (One pair for each MDF version X) : The first one to read the file's blocks descriptions (mdfinfoX) and the second (mdfXreader) to read the raw data from the file. It can optionally run multithreaded and I am proud to say I did not see any other tool reading faster this kind of files --> makes it suitable to process big amount of data in a batch, generally data from endurance evaluation.

The structure of the mdf dictionary, for each channel: mdf[channelName]
=======================================================================
The structure of the mdf dictionary, for each channel: mdf[channelName] below keys exist
========================================================================================
- data: numpy vector
- unit: unitName
- master : vector name corresponding to master channel
- masterType : type of master channel (time, angle, distance, etc.)
- description : physical meaning of channel
- conversion: (optional) dictionary describing how to convert raw data into meaningful/physical data
mdf object main attribute: masterChannelList, a dict containing one list of channel names per datagroup


Mdfreader module methods:
=========================
Expand All @@ -37,8 +39,8 @@ Evaluated for Windows and Linux platforms (x86 and AMD64)
Requirements:
=============
Mdfreader is mostly relying on numpy/scipy/matplotlib.
If reading not byte aligned bitarray.
Reading channels defined by a formula will require sympy.
Cython is required to compile dataRead module for reading mdf4 not byte aligned data. However, if cython compilation fails, bitarray becomes required
Export requirements (optional): scipy, csv, h5py, xlwt(3), openpyxl, pandas
Mdfconverter user interface requires pyQT

Expand Down
2 changes: 1 addition & 1 deletion mdfreader/__init__.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
__author__ = 'Aymeric Rateau (aymeric.rateau@gmail.com)'
__copyright__ = 'Copyright (c) 2015 Aymeric Rateau'
__license__ = 'GPLV3'
__version__ = "0.1.9.1"
__version__ = "0.1.9.2"

#if it's run as a script or imported within python, this happens
if __name__ == 'mdfreader':
Expand Down
196 changes: 102 additions & 94 deletions setup.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,101 +5,109 @@
from distutils.extension import Extension
from Cython.Build import cythonize

here = path.abspath(path.dirname(__file__))
name='mdfreader'
version = '0.1.9.2'

description='A Measured Data Format file parser'

here = path.abspath(path.dirname(__file__))
# Get the long description from the relevant file
with open(path.join(here, 'README'), encoding='utf-8') as f:
long_description = f.read()

setup(
name='mdfreader',

# Versions should comply with PEP440. For a discussion on single-sourcing
# the version across setup.py and the project code, see
# https://packaging.python.org/en/latest/development.html#single-sourcing-the-version
version='0.1.9.1',

description='A Measured Data Format file parser',
long_description=long_description,

# The project's main homepage.
url='https://github.com/ratal/mdfreader',

# Author details
author='Aymeric Rateau',
author_email='aymeric.rateau@gmail.com',

# Choose your license
license='GPL3',

# See https://pypi.python.org/pypi?%3Aaction=list_classifiers
classifiers=[
# How mature is this project? Common values are
# 3 - Alpha
# 4 - Beta
# 5 - Production/Stable
'Development Status :: 4 - Beta',

# Indicate who your project is intended for
'Intended Audience :: Science/Research',
'Topic :: Scientific/Engineering',

# Pick your license as you wish (should match "license" above)
'License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)',

# Specify the Python versions you support here. In particular, ensure
# that you indicate whether you support Python 2, Python 3 or both.
'Programming Language :: Python :: 2',
'Programming Language :: Python :: 2.6',
'Programming Language :: Python :: 2.7',
'Programming Language :: Python :: 3',
'Programming Language :: Python :: 3.2',
'Programming Language :: Python :: 3.3',
'Programming Language :: Python :: 3.4',
],

# What does your project relate to?
keywords='Parser MDF file',

# You can just specify the packages manually here if your project is
# simple. Or you can use find_packages().
packages=find_packages(exclude=['contrib', 'docs', 'tests*']),

# List run-time dependencies here. These will be installed by pip when your
# project is installed. For an analysis of "install_requires" vs pip's
# requirements files see:
# https://packaging.python.org/en/latest/technical.html#install-requires-vs-requirements-files
install_requires=['numpy>=1.6', 'sympy', 'cython>=0.18'],

# List additional groups of dependencies here (e.g. development dependencies).
# You can install these using the following syntax, for example:
# $ pip install -e .[dev,test]
extras_require={
'export': ['scipy', 'h5py', 'xlwt', 'xlwt3', 'openpyxl', 'pandas'],
'converter': ['PyQt4'],
'experimental': ['bitarray'],
},

# If there are data files included in your packages that need to be
# installed, specify them here. If using Python 2.6 or less, then these
# have to be included in MANIFEST.in as well.
# package_data={
# 'sample': ['package_data.dat'],
#},

# Although 'package_data' is the preferred approach, in some case you may
# need to place data files outside of your packages.
# see http://docs.python.org/3.4/distutils/setupscript.html#installing-additional-files
# In this case, 'data_file' will be installed into '<sys.prefix>/my_data'
# data_files=[('my_data', ['data/data_file'])],

# To provide executable scripts, use entry points in preference to the
# "scripts" keyword. Entry points provide cross-platform support and allow
# pip to create the appropriate form of executable for the target platform.
entry_points={
'console_scripts': [
'mdfconverter=mdfconverter.mdfconverter:main',
],
},
ext_modules=cythonize(Extension('dataRead', ['mdfreader/dataRead.pyx'], include_dirs=[numpy.get_include()]))
)
long_description=long_description

# The project's main homepage.
url='https://github.com/ratal/mdfreader'

# Author details
author='Aymeric Rateau'
author_email='aymeric.rateau@gmail.com'

# Choose your license
license='GPL3'

# See https://pypi.python.org/pypi?%3Aaction=list_classifiers
classifiers=[
# How mature is this project? Common values are
# 3 - Alpha
# 4 - Beta
# 5 - Production/Stable
'Development Status :: 4 - Beta',

# Indicate who your project is intended for
'Intended Audience :: Science/Research',
'Topic :: Scientific/Engineering',

# Pick your license as you wish (should match "license" above)
'License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)',

# Specify the Python versions you support here. In particular, ensure
# that you indicate whether you support Python 2, Python 3 or both.
'Programming Language :: Python :: 2',
'Programming Language :: Python :: 2.6',
'Programming Language :: Python :: 2.7',
'Programming Language :: Python :: 3',
'Programming Language :: Python :: 3.2',
'Programming Language :: Python :: 3.3',
'Programming Language :: Python :: 3.4',
]

# What does your project relate to?
keywords='Parser MDF file'

# You can just specify the packages manually here if your project is
# simple. Or you can use find_packages().
packages=find_packages(exclude=['contrib', 'docs', 'tests*'])

# List run-time dependencies here. These will be installed by pip when your
# project is installed. For an analysis of "install_requires" vs pip's
# requirements files see:
# https://packaging.python.org/en/latest/technical.html#install-requires-vs-requirements-files
install_requires=['numpy>=1.6', 'sympy', 'cython>=0.21']

# List additional groups of dependencies here (e.g. development dependencies).
# You can install these using the following syntax, for example:
# $ pip install -e .[dev,test]
extras_require={
'export': ['scipy', 'h5py', 'xlwt', 'xlwt3', 'openpyxl', 'pandas'],
'converter': ['PyQt4'],
'experimental': ['bitarray'],
}

# If there are data files included in your packages that need to be
# installed, specify them here. If using Python 2.6 or less, then these
# have to be included in MANIFEST.in as well.
# package_data={
# 'sample': ['package_data.dat'],
#},

# Although 'package_data' is the preferred approach, in some case you may
# need to place data files outside of your packages.
# see http://docs.python.org/3.4/distutils/setupscript.html#installing-additional-files
# In this case, 'data_file' will be installed into '<sys.prefix>/my_data'
# data_files=[('my_data', ['data/data_file'])],

# To provide executable scripts, use entry points in preference to the
# "scripts" keyword. Entry points provide cross-platform support and allow
# pip to create the appropriate form of executable for the target platform.
entry_points={
'console_scripts': [
'mdfconverter=mdfconverter.mdfconverter:main',
],
}
ext_modules=cythonize(Extension('dataRead', ['mdfreader/dataRead.pyx'], include_dirs=[numpy.get_include()]))

try:
setup(name=name, version=version, description=description, long_description=long_description,
url=url, author=author, author_email=author_email, license=license, classifiers=classifiers,
keywords=keywords, packages=packages, install_requires=install_requires, extras_require=extras_require,
entry_points=entry_points, ext_modules=ext_modules)
except SystemExit: # in case cython failed
extras_require.pop('experimental')
install_requires.pop(-1) # removes cython requirement
install_requires.append('bitarray') # replaces cython requirement by bitarray
setup(name=name, version=version, description=description, long_description=long_description,
url=url, author=author, author_email=author_email, license=license, classifiers=classifiers,
keywords=keywords, packages=packages, install_requires=install_requires, extras_require=extras_require,
entry_points=entry_points)

0 comments on commit 058f977

Please sign in to comment.