Metadata-Version: 2.1
Name: rocketlogger
Version: 1.1.6
Summary: RocketLogger Python Support
Home-page: https://rocketlogger.ethz.ch/
Author: Computer Engineering Group, ETH Zurich
Author-email: lukas.sigrist@tik.ee.ethz.ch
License: BSD 3-Clause
Keywords: rocketlogger data analysis
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering :: Information Analysis
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Requires-Python: >=3.4, <4
Requires-Dist: matplotlib
Requires-Dist: numpy

RocketLogger Python Support Library
===================================

This package provides RocketLogger data file handling support, basic data
processing and plotting of the data.

Dependencies:

* Python 3: version 3.4-3.7
* NumPy: version 1.11-1.17
* Matplotlib: version 1.5-3.1


Data Import
-----------

To import a RocketLogger data (.rld) file, simply do::

    >>> from rocketlogger.data import RocketLoggerData
    >>> rld = RocketLoggerData('data.rld')

To merge channels with auto-ranging, i.e. the current channels::

    >>> rld.merge_channels()

To get the loaded channel data (by name) and corresponding timestamps::

    >>> rld.get_data(['V1', 'I1'])
    >>> rld.get_time()

A list of the channels existing in the loaded file is provided by:

    >>> rld.get_channel_names()

To plot a preview of the data::

    >>> rld.plot()

You can also plot the (merged) file data a single command, e.g. for preview::

    >>> RocketLoggerData('data.rld').merge_channels().plot()

For more details on the individual functions, please refer to the
documentation at <https://rocketlogger.ethz.ch/python/>.


