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: 6 days 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 (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-10-17T19:35:18.000Z (22 days ago)
• Last Synced: 2024-10-20T04:18:18.431Z (19 days ago)
• Topics: data-analysis, data-visualization, python, python3
• Language: Python
• Homepage:
• Size: 377 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# xbmini-py

[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/xbmini-py/0.3.0?logo=python&logoColor=FFD43B)](https://pypi.org/project/xbmini-py/)

[![PyPI](https://img.shields.io/pypi/v/xbmini-py)](https://pypi.org/project/xbmini-py/)

[![PyPI - License](https://img.shields.io/pypi/l/xbmini-py?color=magenta)](https://github.com/sco1/xbmini-py/blob/master/LICENSE)

[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/sco1/xbmini-py/main.svg)](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:

  batch-combine  Batch combine XBM files for each logger and dump a...

```

## CLI Usage

### `xbmini batch-combine`

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