https://github.com/sco1/xbmini-py
Python Toolkit for the GCDC HAM
https://github.com/sco1/xbmini-py
data-analysis data-visualization python python3
Last synced: 2 months ago
JSON representation
Python Toolkit for the GCDC HAM
- Host: GitHub
- URL: https://github.com/sco1/xbmini-py
- Owner: sco1
- License: mit
- Created: 2022-09-27T22:31:42.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2025-05-07T00:43:24.000Z (2 months ago)
- Last Synced: 2025-05-07T22:47:18.486Z (2 months ago)
- Topics: data-analysis, data-visualization, python, python3
- Language: Python
- Homepage:
- Size: 818 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# xbmini-py
[](https://pypi.org/project/xbmini-py/)
[](https://pypi.org/project/xbmini-py/)
[](https://github.com/sco1/xbmini-py/blob/master/LICENSE)
[](https://results.pre-commit.ci/latest/github/sco1/xbmini-py/main)Python Toolkit for the [GCDC HAM](http://www.gcdataconcepts.com/ham.html)
## Known Firmware Compatibility
This package is currently tested against firmware versions `1379`, `2108`, and `2570`, compatibility with other firmware versions is not guaranteed.## Installation
Install from PyPi with your favorite `pip` invocation:```bash
$ pip install xbmini-py
```You can confirm proper installation via the `xbmini` CLI:
```
$ xbmini --help
Usage: xbmini [OPTIONS] COMMAND [ARGS]...Options:
--help Show this message and exit.Commands:
merge Combine multiple log sessions.
trim XBMini log trimming.
```## CLI Usage
### `xbmini merge batch`
Batch combine XBM files for each logger and dump a serialized `XBMLog` instance to a CSV in its respective logger's directory.
#### Input Parameters
| Parameter | Description | Type | Default |
|-----------------|--------------------------------------------------------|--------------|----------------------------------------|
| `--top-dir` | Path to top-level log directory to search.1 | `Path\|None` | GUI Prompt |
| `--log-pattern` | XBMini log file glob pattern.2 | `str` | `"*.CSV"` |
| `--dry-run` | Show processing pipeline without processing any files. | `bool` | `False` |
| `--skip-strs` | Skip files containing any of the provided substrings. | `list[str]` | `["processed", "trimmed", "combined"]` |1. Log searching will be executed recursively starting from the top directory
2. Case sensitivity is deferred to the host OS