mirror of
https://github.com/ARM-software/devlib.git
synced 2025-01-31 10:10:46 +00:00
63d2fb53fc
Add BaylibreAcmeInstrument, a new instrument providing support for the Baylibre ACME board as a wrapper for the IIO interface. This class provides better access to the ACME hardware (e.g. the ability to control the sampling frequency) and to the retrieved samples than what the other instrument, AcmeCapeInstrument, provides. Furthermore, it removes an unnecessary and limiting dependency by interfacing directly with the IIO drivers instead of relying on an intermediate script ("iio-capture") potentially introducing unexpected bugs. Finally, it allows handling multiple probes (the ACME can have up to 8) through an easy-to-use single instance of this class instead of having to have an instance of AcmeCapeInstrument per channel potentially (untested) leading to race conditions between the underlying scripts for accessing the hardware. This commit does not overwrite AcmeCapeInstrument as BaylibreAcmeInstrument does not provide interface compatibility with that class. Anyhow, we believe that anything that can be achieved with AcmeCapeInstrument can be done with BaylibreAcmeInstrument (the reciprocal is not true) so that BaylibreAcmeInstrument might eventually replace AcmeCapeInstrument. Add BaylibreAcmeInstrument documentation detailing the class interface and the ACME instrument itself and discussing the way it works and its potential limitations.
140 lines
4.3 KiB
Python
140 lines
4.3 KiB
Python
# Copyright 2013-2015 ARM Limited
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
#
|
|
|
|
import imp
|
|
import os
|
|
import sys
|
|
import warnings
|
|
from itertools import chain
|
|
|
|
try:
|
|
from setuptools import setup
|
|
from setuptools.command.sdist import sdist as orig_sdist
|
|
except ImportError:
|
|
from distutils.core import setup
|
|
from distutils.command.sdist import sdist as orig_sdist
|
|
|
|
|
|
devlib_dir = os.path.join(os.path.dirname(__file__), 'devlib')
|
|
|
|
sys.path.insert(0, os.path.join(devlib_dir, 'core'))
|
|
|
|
# happends if falling back to distutils
|
|
warnings.filterwarnings('ignore', "Unknown distribution option: 'install_requires'")
|
|
warnings.filterwarnings('ignore', "Unknown distribution option: 'extras_require'")
|
|
|
|
try:
|
|
os.remove('MANIFEST')
|
|
except OSError:
|
|
pass
|
|
|
|
|
|
with open(os.path.join(devlib_dir, '__init__.py')) as fh:
|
|
# Extract the version by parsing the text of the file,
|
|
# as may not be able to load as a module yet.
|
|
for line in fh:
|
|
if '__version__' in line:
|
|
parts = line.split("'")
|
|
__version__ = parts[1]
|
|
break
|
|
else:
|
|
raise RuntimeError('Did not see __version__')
|
|
|
|
vh_path = os.path.join(devlib_dir, 'utils', 'version.py')
|
|
# can load this, as it does not have any devlib imports
|
|
version_helper = imp.load_source('version_helper', vh_path)
|
|
commit = version_helper.get_commit()
|
|
if commit:
|
|
__version__ = '{}+{}'.format(__version__, commit)
|
|
|
|
|
|
packages = []
|
|
data_files = {}
|
|
source_dir = os.path.dirname(__file__)
|
|
for root, dirs, files in os.walk(devlib_dir):
|
|
rel_dir = os.path.relpath(root, source_dir)
|
|
data = []
|
|
if '__init__.py' in files:
|
|
for f in files:
|
|
if os.path.splitext(f)[1] not in ['.py', '.pyc', '.pyo']:
|
|
data.append(f)
|
|
package_name = rel_dir.replace(os.sep, '.')
|
|
package_dir = root
|
|
packages.append(package_name)
|
|
data_files[package_name] = data
|
|
else:
|
|
# use previous package name
|
|
filepaths = [os.path.join(root, f) for f in files]
|
|
data_files[package_name].extend([os.path.relpath(f, package_dir) for f in filepaths])
|
|
|
|
params = dict(
|
|
name='devlib',
|
|
description='A framework for automating workload execution and measurment collection on ARM devices.',
|
|
version=__version__,
|
|
packages=packages,
|
|
package_data=data_files,
|
|
url='https://github.com/ARM-software/devlib',
|
|
license='Apache v2',
|
|
maintainer='ARM Ltd.',
|
|
install_requires=[
|
|
'python-dateutil', # converting between UTC and local time.
|
|
'pexpect>=3.3', # Send/recieve to/from device
|
|
'pyserial', # Serial port interface
|
|
'wrapt', # Basic for construction of decorator functions
|
|
'future', # Python 2-3 compatibility
|
|
'pandas',
|
|
'numpy',
|
|
],
|
|
extras_require={
|
|
'daq': ['daqpower'],
|
|
'doc': ['sphinx'],
|
|
'monsoon': ['python-gflags'],
|
|
'acme': ['pandas', 'numpy'],
|
|
},
|
|
# https://pypi.python.org/pypi?%3Aaction=list_classifiers
|
|
classifiers=[
|
|
'Development Status :: 4 - Beta',
|
|
'License :: OSI Approved :: Apache Software License',
|
|
'Operating System :: POSIX :: Linux',
|
|
'Programming Language :: Python :: 2.7',
|
|
],
|
|
)
|
|
|
|
all_extras = list(chain(iter(params['extras_require'].values())))
|
|
params['extras_require']['full'] = all_extras
|
|
|
|
|
|
class sdist(orig_sdist):
|
|
|
|
user_options = orig_sdist.user_options + [
|
|
('strip-commit', 's',
|
|
"Strip git commit hash from package version ")
|
|
]
|
|
|
|
def initialize_options(self):
|
|
orig_sdist.initialize_options(self)
|
|
self.strip_commit = False
|
|
|
|
|
|
def run(self):
|
|
if self.strip_commit:
|
|
self.distribution.get_version = lambda : __version__.split('+')[0]
|
|
orig_sdist.run(self)
|
|
|
|
|
|
params['cmdclass'] = {'sdist': sdist}
|
|
|
|
setup(**params)
|