oml-plot-tools 0.8.0__tar.gz → 0.9.1__tar.gz

oml_plot_tools-0.9.1/.github/workflows/continuous-integration.yml

@@ -0,0 +1,65 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - master
+    tags:
+      - '*'
+  pull_request:
+    branches:
+      - master
+  schedule:
+    - cron:  '30 7 * * *'
+
+jobs:
+  build:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      max-parallel: 3
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest]
+        python-version: ['3.10', '3.13', '3.14']
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+        allow-prereleases: true
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        python -m pip install tox tox-gh-actions
+    - name: Test with tox
+      run: |
+        tox -e py$(echo ${{ matrix.python-version }} | tr -d .)-tests
+    - name: Test cli
+      run: |
+        tox -e py$(echo ${{ matrix.python-version }} | tr -d .)-cli
+    - name: Check style
+      if: ${{ matrix.python-version == '3.13' }}
+      run: |
+        tox -e py$(echo ${{ matrix.python-version }} | tr -d .)-lint
+        tox -e copying
+    - name: Upload coverage to Codecov
+      if: ${{ matrix.python-version == '3.13' }}
+      uses: codecov/codecov-action@v4
+      with:
+        token: ${{ secrets.CODECOV_TOKEN }}
+        fail_ci_if_error: true
+    - name: Build distribution
+      if: matrix.python-version == '3.13'
+      run: |
+        pip install build
+        python -m build
+    - name: Publish package to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1
+      if: >-
+        matrix.python-version == '3.13' &&
+        github.event_name == 'push' &&
+        startsWith(github.event.ref, 'refs/tags')
+      with:
+        password: ${{ secrets.pypi_password }}

oml_plot_tools-0.9.1/.gitignore

@@ -0,0 +1,65 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+env/
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*,cover
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+*.swp
+cover/
+
+# Generated json files
+*.json
+
+\.idea/

{oml_plot_tools-0.8.0 → oml_plot_tools-0.9.1}/PKG-INFO

@@ -1,22 +1,25 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: oml_plot_tools
-Version: 0.8.0
+Version: 0.9.1
 Summary: IoT-LAB OML plot tools
-Home-page: http://www.iot-lab.info
-Author: IoT-LAB Team
-Author-email: admin@iot-lab.info
+Project-URL: Homepage, http://www.iot-lab.info
+Project-URL: Download URL, http://github.com/iot-lab/oml-plot-tools/
+Author-email: IoT-LAB Team <admin@iot-lab.info>
 License: CeCILL v2.1
-Download-URL: http://github.com/iot-lab/oml-plot-tools/
-Platform: UNKNOWN
+License-File: AUTHORS
+License-File: COPYING
 Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: End Users/Desktop
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
-Classifier: Intended Audience :: End Users/Desktop
-Classifier: Environment :: Console
 Classifier: Topic :: Utilities
+Requires-Python: >=3.10
+Requires-Dist: iotlabcli>=3.3.0
+Requires-Dist: matplotlib
+Requires-Dist: numpy
+Requires-Dist: pillow
 Description-Content-Type: text/x-rst
-License-File: COPYING
-License-File: AUTHORS
 
 OML Plot Tools
 ==============
@@ -30,5 +33,3 @@ OML Plot Tools
 .. |Codecov| image:: https://codecov.io/gh/iot-lab/oml-plot-tools/branch/master/graph/badge.svg
    :target: https://codecov.io/gh/iot-lab/oml-plot-tools/branch/master
    :alt: Codecov coverage status
-
-

oml_plot_tools-0.9.1/codecov.yml

@@ -0,0 +1 @@
+comment: false

{oml_plot_tools-0.8.0 → oml_plot_tools-0.9.1}/oml_plot_tools/__init__.py

@@ -19,6 +19,6 @@
 # The fact that you are presently reading this means that you have had
 # knowledge of the CeCILL license and that you accept its terms.
 
-""" List of tools to display iot-lab oml generated files """
+"""List of tools to display iot-lab oml generated files"""
 
-__version__ = '0.8.0'
+__version__ = "0.9.1"

{oml_plot_tools-0.8.0 → oml_plot_tools-0.9.1}/oml_plot_tools/common.py

@@ -20,48 +20,48 @@
 # The fact that you are presently reading this means that you have had
 # knowledge of the CeCILL license and that you accept its terms.
 
-""" Common functions for all oml types """
+"""Common functions for all oml types"""
 
 # Issues with numpy
 # pylint:disable=no-member
 
-from collections import namedtuple, OrderedDict
+from collections import OrderedDict, namedtuple
 
-import numpy
 import matplotlib.pyplot as plt
+import numpy
 
 OML_HEADER_LEN = 9
 
 OML_TYPES = {
-    'consumption': 1,
-    'radio': 2,
-    'event': 3,
-    'sniffer': 4,
-    'robot_pose': 10,
+    "consumption": 1,
+    "radio": 2,
+    "event": 3,
+    "sniffer": 4,
+    "robot_pose": 10,
 }
 
-TIMESTAMP_LABEL = 'Sample Time (sec)'
+TIMESTAMP_LABEL = "Sample Time (sec)"
 OML_FIELDS = [
-    ('timestamp', float),
-    ('type', numpy.str_, 16),
-    ('num', int),
-    ('t_s', int),
-    ('t_us', int),
+    ("timestamp", float),
+    ("type", numpy.str_, 16),
+    ("num", int),
+    ("t_s", int),
+    ("t_us", int),
 ]
 
-MeasureTuple = namedtuple('MeasureTuple', ['name', 'type', 'label'])
+MeasureTuple = namedtuple("MeasureTuple", ["name", "type", "label"])
 
 
 def measures_dict(*measures_tuples):
-    """ Create a dict of 'MeasuresTuple' with given measures """
+    """Create a dict of 'MeasuresTuple' with given measures"""
     measures_list = [(m[0], MeasureTuple(*m)) for m in measures_tuples]
     return OrderedDict(measures_list)
 
 
 def oml_load(filename, meas_type, measures):
-    """ Load oml file
+    """Load oml file
     :returns: numpy array
-    :measures: list of MeasureTuple """
+    :measures: list of MeasureTuple"""
 
     meas_dtypes = [(m.name, m.type) for m in measures]
 
@@ -85,21 +85,21 @@ def oml_load(filename, meas_type, measures):
     return data
 
 
-def oml_plot_clock(data, title='Clock time verification'):
-    """ Print clock diff between measures
+def oml_plot_clock(data, title="Clock time verification"):
+    """Print clock diff between measures
     :params data: oml_load returned array
     """
-    time = data['timestamp']
+    time = data["timestamp"]
     clock_diff = numpy.diff(time) * 1000
 
-    print(f'Time from {time[0]:f} to {time[-1]:f}')
-    print('NB Points      =', len(time))
-    print('Duration    (s)=', time[-1] - time[0])
-    print('Steptime   (ms)=', 1000 * (time[-1] - time[0]) / len(time))
-    print('Clock mean (ms)=', numpy.mean(clock_diff))
-    print('Clock std  (ms)=', numpy.std(clock_diff))
-    print('Clock max  (ms)=', numpy.max(clock_diff))
-    print('Clock min  (ms)=', numpy.min(clock_diff))
+    print(f"Time from {time[0]:f} to {time[-1]:f}")
+    print("NB Points      =", len(time))
+    print("Duration    (s)=", time[-1] - time[0])
+    print("Steptime   (ms)=", 1000 * (time[-1] - time[0]) / len(time))
+    print("Clock mean (ms)=", numpy.mean(clock_diff))
+    print("Clock std  (ms)=", numpy.std(clock_diff))
+    print("Clock max  (ms)=", numpy.max(clock_diff))
+    print("Clock min  (ms)=", numpy.min(clock_diff))
 
     plt.figure()
     plt.title(title)
@@ -110,12 +110,12 @@ def oml_plot_clock(data, title='Clock time verification'):
 
 
 def plot(data, title, field, ylabel, xlabel=TIMESTAMP_LABEL):
-    """ Plot data """
+    """Plot data"""
     plt.title(title)
     plt.grid()
     plt.xlabel(xlabel)
     plt.ylabel(ylabel)
-    plt.plot(data['timestamp'], data[field])
+    plt.plot(data["timestamp"], data[field])
 
 
 def plot_show():
@@ -128,35 +128,42 @@ def plot_show():
 
 
 def _oml_read(filename, meas_type, fields_dtypes=()):
-    """ Read oml file
-    :measures: list of MeasureTuple """
+    """Read oml file
+    :measures: list of MeasureTuple"""
 
     # Select values
     dtypes = OML_FIELDS + list(fields_dtypes)
     names = [entry[0] for entry in dtypes]
 
     # Read values from file
-    c_meas_type = {names.index('type'): _valid_oml_f(meas_type)}
-    data = numpy.genfromtxt(filename, skip_header=OML_HEADER_LEN, names=names,
-                            dtype=dtypes, converters=c_meas_type,
-                            invalid_raise=False)
+    c_meas_type = {names.index("type"): _valid_oml_f(meas_type)}
+    data = numpy.genfromtxt(
+        filename,
+        skip_header=OML_HEADER_LEN,
+        names=names,
+        dtype=dtypes,
+        converters=c_meas_type,
+        invalid_raise=False,
+    )
 
     # Update 'timestamp' field with the cn calculated timestamp
-    for row in numpy.nditer(data, op_flags=['readwrite']):
-        timestamp = row['t_s'] + row['t_us'] / 1e6
-        row['timestamp'] = timestamp
+    for row in numpy.nditer(data, op_flags=["readwrite"]):
+        timestamp = row["t_s"] + row["t_us"] / 1e6
+        row["timestamp"] = timestamp
 
     return data
 
 
 def _valid_oml_f(meas_type):
-    """ Return a function that validates oml type """
+    """Return a function that validates oml type"""
+
     def _validate(value):
-        """ Check that 'meas_type' column matchs requested """
+        """Check that 'meas_type' column matchs requested"""
         value = int(value)
         if int(value) == OML_TYPES[meas_type]:
             return meas_type
         raise TypeError(f"OML file is not: {meas_type}")
+
     return _validate
 
 

{oml_plot_tools-0.8.0 → oml_plot_tools-0.9.1}/oml_plot_tools/consum.py

@@ -27,81 +27,107 @@ usage: plot_oml_consum [-h] -i DATA [-l TITLE] [-b BEGIN] [-e END] [-a] [-p]
 
 Plot iot-lab consumption OML files
 
-optional arguments:
-  -h, --help            show this help message and exit
-  -i DATA, --input DATA
-                        Node consumption values
-  -l TITLE, --label TITLE
-                        Graph title
-  -b BEGIN, --begin BEGIN
-                        Sample start
-  -e END, --end END     Sample end
+options:
+  -h, --help         show this help message and exit
+  -i, --input DATA   Node consumption values
+  -l, --label TITLE  Graph title
+  -b, --begin BEGIN  Sample start
+  -e, --end END      Sample end
 
 plot:
   Plot selection
 
-  -a, --all             Plot power/voltage/current on one figure (default)
-  -p, --power           Plot power
-  -v, --voltage         Plot voltage
-  -c, --current         Plot current
-  -t, --time            Plot time verification
-"""
-
+  -a, --all          Plot power/voltage/current on one figure (default)
+  -p, --power        Plot power
+  -v, --voltage      Plot voltage
+  -c, --current      Plot current
+  -t, --time         Plot time verification
+"""  # noqa: E501
 
 import argparse
 import sys
 
 import matplotlib.pyplot as plt
-from . import common
 
+from . import common
 
 # Selection variables
-_POWER = 'power'
-_VOLTAGE = 'voltage'
-_CURRENT = 'current'
-_ALL = 'all'
-_TIME = 'time'
-_TITLE = 'Node'
+_POWER = "power"
+_VOLTAGE = "voltage"
+_CURRENT = "current"
+_ALL = "all"
+_TIME = "time"
+_TITLE = "Node"
 
 
 MEASURES_D = common.measures_dict(
-    (_POWER, float, 'Power (W)'),
-    (_VOLTAGE, float, 'Voltage (V)'),
-    (_CURRENT, float, 'Current (A)'),
+    (_POWER, float, "Power (W)"),
+    (_VOLTAGE, float, "Voltage (V)"),
+    (_CURRENT, float, "Current (A)"),
 )
 
 
 def oml_load(filename):
-    """ Load consumption oml file """
-    data = common.oml_load(filename, 'consumption', MEASURES_D.values())
+    """Load consumption oml file"""
+    data = common.oml_load(filename, "consumption", MEASURES_D.values())
     return data
 
 
 PARSER = argparse.ArgumentParser(
-    prog='plot_oml_consum', description="Plot iot-lab consumption OML files")
-PARSER.add_argument('-i', '--input', dest='data', type=oml_load, required=True,
-                    help="Node consumption values")
-PARSER.add_argument('-l', '--label', dest='title', default=_TITLE,
-                    help="Graph title")
-PARSER.add_argument('-b', '--begin', default=0, type=int, help="Sample start")
-PARSER.add_argument('-e', '--end', default=-1, type=int, help="Sample end")
-
-_PLOT = PARSER.add_argument_group('plot', "Plot selection")
-_PLOT.add_argument('-a', '--all', dest='plot', const=_ALL,
-                   action='append_const',
-                   help="Plot power/voltage/current on one figure (default)")
-_PLOT.add_argument('-p', '--power', dest='plot', const=_POWER,
-                   action='append_const', help="Plot power")
-_PLOT.add_argument('-v', '--voltage', dest='plot', const=_VOLTAGE,
-                   action='append_const', help="Plot voltage")
-_PLOT.add_argument('-c', '--current', dest='plot', const=_CURRENT,
-                   action='append_const', help="Plot current")
-_PLOT.add_argument('-t', '--time', dest='plot', const=_TIME,
-                   action='append_const', help="Plot time verification")
+    prog="plot_oml_consum", description="Plot iot-lab consumption OML files"
+)
+PARSER.add_argument(
+    "-i",
+    "--input",
+    dest="data",
+    type=oml_load,
+    required=True,
+    help="Node consumption values",
+)
+PARSER.add_argument("-l", "--label", dest="title", default=_TITLE, help="Graph title")
+PARSER.add_argument("-b", "--begin", default=0, type=int, help="Sample start")
+PARSER.add_argument("-e", "--end", default=-1, type=int, help="Sample end")
+
+_PLOT = PARSER.add_argument_group("plot", "Plot selection")
+_PLOT.add_argument(
+    "-a",
+    "--all",
+    dest="plot",
+    const=_ALL,
+    action="append_const",
+    help="Plot power/voltage/current on one figure (default)",
+)
+_PLOT.add_argument(
+    "-p", "--power", dest="plot", const=_POWER, action="append_const", help="Plot power"
+)
+_PLOT.add_argument(
+    "-v",
+    "--voltage",
+    dest="plot",
+    const=_VOLTAGE,
+    action="append_const",
+    help="Plot voltage",
+)
+_PLOT.add_argument(
+    "-c",
+    "--current",
+    dest="plot",
+    const=_CURRENT,
+    action="append_const",
+    help="Plot current",
+)
+_PLOT.add_argument(
+    "-t",
+    "--time",
+    dest="plot",
+    const=_TIME,
+    action="append_const",
+    help="Plot time verification",
+)
 
 
 def consumption_plot(data, title, selection):
-    """ Plot consumption values according to selection
+    """Plot consumption values according to selection
 
     :param data: numpy array returned by oml_read
     :param title: Subplots title base
@@ -121,14 +147,14 @@ def consumption_plot(data, title, selection):
         oml_plot(data, title, MEASURES_D.values())
 
     # Clock verification
-    if 'time' in selection:
+    if "time" in selection:
         common.oml_plot_clock(data)
 
     common.plot_show()
 
 
 def oml_plot(data, title, meas_tuples):
-    """ Plot consumption value for 'meas_tuples'
+    """Plot consumption value for 'meas_tuples'
 
     :param data: numpy array returned by oml_read
     :param title: Subplots title base
@@ -141,19 +167,19 @@ def oml_plot(data, title, meas_tuples):
     for num, meas in enumerate(meas_tuples, start=1):
         plt.subplot(nbplots, 1, num)
 
-        _title = f'{title} {meas.name}'
+        _title = f"{title} {meas.name}"
         common.plot(data, _title, meas.name, meas.label)
 
 
 def main(args=None):
-    """ iotlab-plot consum command """
+    """iotlab-plot consum command"""
     args = args or sys.argv[1:]
 
     opts = PARSER.parse_args(args)
     # default to plot all
     selection = opts.plot or (_ALL)
     # select samples
-    data = opts.data[opts.begin:opts.end]
+    data = opts.data[opts.begin : opts.end]
     consumption_plot(data, opts.title, selection)
 
 

{oml_plot_tools-0.8.0 → oml_plot_tools-0.9.1}/oml_plot_tools/main.py

@@ -34,16 +34,15 @@ def main(args=None):
     args = args or sys.argv[1:]
 
     commands = {
-        'consum': oml_plot_tools.consum.main,
-        'radio': oml_plot_tools.radio.main,
-        'traj': oml_plot_tools.traj.main,
-        'help': None
+        "consum": oml_plot_tools.consum.main,
+        "radio": oml_plot_tools.radio.main,
+        "traj": oml_plot_tools.traj.main,
+        "help": None,
     }
 
     parser = ArgumentParser()
-    parser.add_argument('command', nargs='?',
-                        choices=commands.keys(), default='help')
-    commands['help'] = lambda args: parser.print_help()
+    parser.add_argument("command", nargs="?", choices=commands.keys(), default="help")
+    commands["help"] = lambda args: parser.print_help()
 
     opts, args = parser.parse_known_args(args)