Python support for using the FlockLab testbed (flocklab CLI, creating flocklab xml, visualization).
Project description
FlockLab Tools
This Python package provides tools for working with the FlockLab testbed.
Features:
- Python API for managing FlockLab tests
- Command-line interface (CLI) for Interfacing with FlockLab
- Programmatic creation of FlockLab test xml files (in python)
- Visualization of FlockLab test results
Installation
Dependencies:
python3.6+
pip
Install with
python -m pip install flocklab-tools
or
pip install flocklab-tools
Uninstall
python3 -m pip uninstall flocklab-tools
Usage
Command Line Interface (CLI)
System wide command:
flocklab -h
Alternative (using the python module):
python -m flocklab -h
Command Line Options:
-h, --help show this help message and exit -v <testconfig.xml>, --validate <testconfig.xml> validate test config -c <testconfig.xml>, --create <testconfig.xml> create / schedule new test -a <testid>, --abort <testid> abort test -d <testid>, --delete <testid> delete test -g <testid>, --get <testid> get test results (via https) -f <testid>, --fetch <testid> fetch test results (via webdav) [NOT IMPLEMENTED YET!] -o <platform>, --observers <platform> get a list of the currently available (online) observers -p, --platforms get a list of the available platforms -x <result directory>, --visualize <result directory> Visualize FlockLab result data
Visualization of FlockLab Results
flocklab -x <result directory>
Python Support
Example
from flocklab import Flocklab as fl from flocklab import * testId = 0 fl.getResults(testId) fc = FlocklabXmlConfig() fc.generalConf.name = 'Example Test' fc.generalConf.description = 'Description of example test' fc.generalConf.duration = 60 # duration in seconds # ...
Development
Bug Reports / Feature Requests
Please send bug reports and feature requests to rtrueb@ethz.ch.
Installation for Development
Clone this repository and run the following from inside the root folder of the project (where setup.py
is located):
python -m pip install -e .
You can edit the source files and the module will reflect the changes automatically (the -e
option which means editable install).
License & Copyright
Licensed under the term of MIT License (MIT). See file LICENSE.
Copyright (c) 2019, ETH Zurich, Computer Engineering Group (TEC)
List of Contributors
- Roman Trub
- Matthias Meyer
- Reto Da Forno
Project details
Release history Release notifications
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Filename, size | File type | Python version | Upload date | Hashes |
---|---|---|---|---|
Filename, size flocklab_tools-0.1.1-py3-none-any.whl (15.1 kB) | File type Wheel | Python version py3 | Upload date | Hashes View hashes |
Filename, size flocklab-tools-0.1.1.tar.gz (12.1 kB) | File type Source | Python version None | Upload date | Hashes View hashes |
Hashes for flocklab_tools-0.1.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c5b55319c2b8cec5e3f901ef3755a59fef70b766ee0c8b0fd0b1dfebf4369e18 |
|
MD5 | 60bd1265cbae7d07725d722f027490f7 |
|
BLAKE2-256 | 4443e4d8f09eb320a2455a63c657d4d87eaa4baa323ae776d2fb55ed5b1256fa |