Skip to main content

User toolkit for power quality data from EQ Wave sensors

Project description

equser

Python 3.10+ License: MIT

User toolkit for power quality data from EQ Wave sensors.

Overview

equser is a Python library for loading, analyzing, and visualizing continuous waveform (CPOW) and power monitoring (PMon) data from EQ Wave hardware. It provides:

  • Data loading (data): Load CPOW and PMon Parquet files with automatic scaling
  • Waveform analysis (analysis): Zero-crossing detection, cycle extraction
  • Visualization (plotting): Static plots for power quality data (requires [analysis])
  • API client (api): REST and WebSocket clients for EQ Synapse gateways (requires [analysis])
  • Live acquisition (pmon): Real-time sensor data acquisition (requires [daq])
  • CLI tools: Command-line interface for monitoring and conversion

Installation

Base installation (data loading + analysis)

pip install equser

With plotting and API support

pip install equser[analysis]

With JupyterLab notebook environment

pip install equser[jupyter]

With live sensor acquisition

pip install equser[daq]

Full installation (all features)

pip install equser[full]

Quick Start

Load and explore CPOW data

from equser.data import load_cpow_scaled

result = load_cpow_scaled('20250623_075056.parquet')
print(f"Voltage A peak: {result['VA'].max():.1f} V")
print(f"Start time: {result['start_time']}")
print(f"Sample rate: {result['sample_rate']} Hz")

Load PMon summary data

from equser.data import load_pmon

table = load_pmon('20250623_0750.parquet')
print(table.column_names)

Analyze waveform zero crossings

import numpy as np
from equser.data import load_cpow_scaled, SAMPLE_RATE_HZ
from equser.analysis import find_zero_crossings

result = load_cpow_scaled('cpow_data.parquet')
time = np.arange(len(result['VA'])) / SAMPLE_RATE_HZ
crossings, indices = find_zero_crossings(result['VA'], time)
print(f"Found {len(crossings)} zero crossings")

Plot data (requires [analysis])

from equser.plotting import PowerMonitorPlotter, WaveformPlotter

# Plot power monitor data
plotter = PowerMonitorPlotter()
plotter.plot_file('pmon_data.parquet')

# Plot waveform data
wf_plotter = WaveformPlotter()
wf_plotter.plot_file('cpow_data.parquet')

Query a gateway (requires [analysis])

from equser.api import SynapseClient

client = SynapseClient('http://gateway:8080')
devices = client.list_devices()
table = client.get_pmon_data(devices[0]['id'])

Command Line

# Start power monitoring (requires EQ Wave sensor + [daq])
equser pmon acquire -c config.yaml

# Convert Avro files to Parquet (requires [daq])
equser pmon convert data/*.avro --remove

# Plot data file (requires [analysis])
equser plot data.parquet

Configuration

equser looks for configuration in the following locations (in order):

  1. EQUSER_CONFIG environment variable
  2. ./equser.yaml (current directory)
  3. ~/.config/equser/config.yaml (XDG config)
  4. /etc/equser/config.yaml (system-wide)

Example configuration:

sensor:
  address: "192.168.10.10"
  port: 1535

pmon:
  connection:
    retry_delay: 3
  parquet:
    interval: 86400
    compression:
      method: ZSTD
      level: 4

Dependency Tiers

Extra Description Key Packages
(base) Data loading, analysis, CLI numpy, pyarrow, pyyaml, argcomplete, colorlog
[daq] Live sensor acquisition avro, fastavro
[analysis] Plotting + API client matplotlib, requests, websocket-client
[jupyter] Full notebook environment [analysis] + jupyterlab, duckdb, ipywidgets
[dev] Development tools pytest, ruff, mypy
[full] All of the above (except dev) -

Requirements

  • Python 3.10 or later
  • Linux (for hardware integration features)

Documentation

License

MIT License — © 2026 EQ Systems Inc.

About

equser is developed by Energy Quotient as part of the EQ Synapse platform for continuous waveform intelligence in power systems.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

equser-0.0.3.tar.gz (62.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

equser-0.0.3-py3-none-any.whl (79.8 kB view details)

Uploaded Python 3

File details

Details for the file equser-0.0.3.tar.gz.

File metadata

  • Download URL: equser-0.0.3.tar.gz
  • Upload date:
  • Size: 62.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for equser-0.0.3.tar.gz
Algorithm Hash digest
SHA256 8367422cd75c9255caacd1f13165d179e798c91a6fcd57fbc634f40da6bf79a2
MD5 e6f5bbb0e59f6bb26759b4b44dddc6d7
BLAKE2b-256 8d18c527ffbde6cdcbaf3ff70cf2a6a9d9a532f8c5c5882f52b871e66e1fb6fb

See more details on using hashes here.

File details

Details for the file equser-0.0.3-py3-none-any.whl.

File metadata

  • Download URL: equser-0.0.3-py3-none-any.whl
  • Upload date:
  • Size: 79.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for equser-0.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 6d667f04ca9071290db0d7ae330b68dc91e717b7af0aebffd474e0c9c2e9c8f5
MD5 e9b17efe701123478a1f7ed6137a3872
BLAKE2b-256 c216e7cb9d58031a3552edb55a467216a92ada0c514705c611880d6a956f674e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page