diff --git a/README.md b/README.md index 0291d9c..5d6f8f0 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/examples/example_usage.png b/examples/example_usage.png new file mode 100644 index 0000000..53c8098 Binary files /dev/null and b/examples/example_usage.png differ