Fix readme

This commit is contained in:
KenwoodFox 2025-10-18 22:53:48 -04:00
parent 890c71e3f2
commit 56a0b8d971
2 changed files with 9 additions and 5 deletions

View File

@ -5,7 +5,7 @@ owon scope or the Gwinstek scopes at the lab. Both semi-standard CSV style expor
This package is just neat enough to combine those together.
Supports pulling the metadata, time encoding and etc from each of the loadable
types.
types. All data is normalized to standard SI units (volts and seconds) for consistency.
## Instalation
```bash
@ -35,15 +35,19 @@ data = parse_owon_data("your_file.CSV") # or parse_gwinstek_data, etc
channel = data['CH1']
# Get voltage and time arrays
voltage = channel.voltage_values # in mV
time = channel.time_values # in seconds
voltage = channel.voltage_values # in volts (V)
time = channel.time_values # in seconds (s)
# Access metadata
print(f"Frequency: {channel.frequency} Hz")
print(f"Peak-to-Peak: {channel.vpp} mV")
print(f"Average: {channel.average} mV")
print(f"Peak-to-Peak: {channel.vpp} V")
print(f"Average: {channel.average} V")
```
## Example Image
![Example Image](examples/example_usage.png)
## License
MIT License

BIN
examples/example_usage.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 92 KiB