# RocketLogger Python Support Library
This package provides RocketLogger data file handling support, as well as
basic processing and plotting of the data. Further, it provides the necessary
support to generate calibration data from measurements.
**Dependencies**
* Python 3: version 3.6-3.11
* NumPy: version 1.13-1.25
**Optional dependencies**
* Matplotlib: for plotting data overview
* pandas: for pandas DataFrame export
**Compatibility**
* Data processing: supports all officially specified RLD file version (versions 2-4)
* Calibration: compatible with RocketLogger calibration file version 2
## Installation
The package is available from the [Python Package Index](https://pypi.org/project/rocketlogger/)
Install the package using pip:
```bash
python -m pip install rocketlogger
```
## Getting Started
### RocketLogger Data Processing
To import a RocketLogger data (`*.rld`) file, use the `RocketLoggerData` class:
```py
>>> from rocketlogger.data import RocketLoggerData
>>> rld = RocketLoggerData('data.rld')
```
To merge channels with auto-ranging, i.e. the current channels:
```py
>>> rld.merge_channels()
```
To get the loaded channel data (by name) and corresponding timestamps:
```py
>>> d = rld.get_data(['V1', 'I1'])
>>> t = rld.get_time()
```
For more details about the individual functions and their parameters, refer to
the documentation available at <https://github.com/ETHZ-TEC/RocketLogger/wiki/python>.
### RocketLogger Device Calibration
The `RocketLoggerCalibration` class from the `rocketlogger.calibration` module
provides the necessary support for generating RocketLogger device calibration.
See the [Calibration](https://github.com/ETHZ-TEC/RocketLogger/wiki/calibration) wiki section for more details on the calibration
procedure.
## Documentation
The documentation for the RocketLogger is found in the wiki pages at
<https://github.com/ETHZ-TEC/RocketLogger/wiki>.
## License
The RocketLogger Project is released under [3-clause BSD license](https://opensource.org/licenses/BSD-3-Clause).
For more details, refer the the [LICENSE](LICENSE) file.
Raw data
{
"_id": null,
"home_page": "https://github.com/ETHZ-TEC/RocketLogger#readme",
"name": "rocketlogger",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6, <4",
"maintainer_email": "",
"keywords": "rocketlogger,data analysis,calibration",
"author": "ETH Zurich, Computer Engineering Group",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/73/20/80d3445903b6f27f005bd2760f2ac619194e5f7f3b19fb2682b22cde458a/rocketlogger-2.1.2.tar.gz",
"platform": null,
"description": "# RocketLogger Python Support Library\n\nThis package provides RocketLogger data file handling support, as well as\nbasic processing and plotting of the data. Further, it provides the necessary\nsupport to generate calibration data from measurements.\n\n**Dependencies**\n* Python 3: version 3.6-3.11\n* NumPy: version 1.13-1.25\n\n**Optional dependencies**\n* Matplotlib: for plotting data overview\n* pandas: for pandas DataFrame export\n\n**Compatibility**\n* Data processing: supports all officially specified RLD file version (versions 2-4)\n* Calibration: compatible with RocketLogger calibration file version 2\n\n\n## Installation\n\nThe package is available from the [Python Package Index](https://pypi.org/project/rocketlogger/)\nInstall the package using pip:\n```bash\npython -m pip install rocketlogger\n```\n\n\n## Getting Started\n\n### RocketLogger Data Processing\n\nTo import a RocketLogger data (`*.rld`) file, use the `RocketLoggerData` class:\n```py\n>>> from rocketlogger.data import RocketLoggerData\n>>> rld = RocketLoggerData('data.rld')\n```\n\nTo merge channels with auto-ranging, i.e. the current channels:\n```py\n>>> rld.merge_channels()\n```\n\nTo get the loaded channel data (by name) and corresponding timestamps:\n```py\n>>> d = rld.get_data(['V1', 'I1'])\n>>> t = rld.get_time()\n```\n\nFor more details about the individual functions and their parameters, refer to\nthe documentation available at <https://github.com/ETHZ-TEC/RocketLogger/wiki/python>.\n\n\n### RocketLogger Device Calibration\n\nThe `RocketLoggerCalibration` class from the `rocketlogger.calibration` module\nprovides the necessary support for generating RocketLogger device calibration.\nSee the [Calibration](https://github.com/ETHZ-TEC/RocketLogger/wiki/calibration) wiki section for more details on the calibration\nprocedure.\n\n\n## Documentation\n\nThe documentation for the RocketLogger is found in the wiki pages at\n<https://github.com/ETHZ-TEC/RocketLogger/wiki>.\n\n\n## License\n\nThe RocketLogger Project is released under [3-clause BSD license](https://opensource.org/licenses/BSD-3-Clause).\nFor more details, refer the the [LICENSE](LICENSE) file.\n",
"bugtrack_url": null,
"license": "BSD 3-Clause",
"summary": "RocketLogger Python Support",
"version": "2.1.2",
"project_urls": {
"Documentation": "https://github.com/ETHZ-TEC/RocketLogger/wiki/python",
"Homepage": "https://github.com/ETHZ-TEC/RocketLogger#readme",
"Source": "https://github.com/ETHZ-TEC/RocketLogger",
"Tracker": "https://github.com/ETHZ-TEC/RocketLogger/issues"
},
"split_keywords": [
"rocketlogger",
"data analysis",
"calibration"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b78a0195e060d594a7158430828e348f82faf8b5b93d5e88850f7fe9cb963db1",
"md5": "4ce131604146d0f964883e03b9ad5ce1",
"sha256": "2c1dd61657e7806740eee72cc57350d17b7c3f926d8881161cba39045c958142"
},
"downloads": -1,
"filename": "rocketlogger-2.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4ce131604146d0f964883e03b9ad5ce1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6, <4",
"size": 22875,
"upload_time": "2023-08-01T15:05:54",
"upload_time_iso_8601": "2023-08-01T15:05:54.969144Z",
"url": "https://files.pythonhosted.org/packages/b7/8a/0195e060d594a7158430828e348f82faf8b5b93d5e88850f7fe9cb963db1/rocketlogger-2.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "732080d3445903b6f27f005bd2760f2ac619194e5f7f3b19fb2682b22cde458a",
"md5": "20ae1cacb4073e70a73f328a364abeae",
"sha256": "bb98e2de2cb67dbefe6241aefcacdb06178d7141d7bead4c479145dce38a4c38"
},
"downloads": -1,
"filename": "rocketlogger-2.1.2.tar.gz",
"has_sig": false,
"md5_digest": "20ae1cacb4073e70a73f328a364abeae",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6, <4",
"size": 10301857,
"upload_time": "2023-08-01T15:05:59",
"upload_time_iso_8601": "2023-08-01T15:05:59.630905Z",
"url": "https://files.pythonhosted.org/packages/73/20/80d3445903b6f27f005bd2760f2ac619194e5f7f3b19fb2682b22cde458a/rocketlogger-2.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-01 15:05:59",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ETHZ-TEC",
"github_project": "RocketLogger#readme",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "rocketlogger"
}
JSON
