Metadata-Version: 2.4
Name: sscm_reader
Version: 0.1.0
Summary: Converts sound sensor SSCM files to pandas DataFrames.
Author-email: Lion Cassens <lionc@posteo.de>
License-Expression: MIT
Project-URL: Homepage, https://github.com/solar-soundscape-sensor/sscm-reader
Project-URL: Issues, https://github.com/solar-soundscape-sensor/sscm-reader/issues
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE.txt
Requires-Dist: pandas
Dynamic: license-file

# sscm_reader

Converts sound sensor `*.sscm` files to pandas DataFrames.

## Installation

```bash
pip install sscm_reader
```

## Usage

```python
from sscm_reader import read_sscm, read_sscm_folder

sensor_name, loudness, sharpness, source, voltage, event_log = read_sscm(
    "path/to/file.sscm",
    add_tz_hours=0,
)

sensor_names, merged_loudness, merged_sharpness, merged_sources, merged_voltage, merged_event_log = read_sscm_folder(
    "path/to/folder",
    add_tz_hours=0,
)
```
