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 - Copyright (c) 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.1.tar.gz (53.5 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.1-py3-none-any.whl (68.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: equser-0.0.1.tar.gz
  • Upload date:
  • Size: 53.5 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.1.tar.gz
Algorithm Hash digest
SHA256 da532dd7e09f52337dca78fde1bf4bb690f7a513717489b703be053f45b9276c
MD5 14c56faa837b92fedaa7f966dac15900
BLAKE2b-256 18dbe52d4bc15a128cb78e2a510c92e96f8d883d771c4ab0073bc773aaaaac46

See more details on using hashes here.

File details

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

File metadata

  • Download URL: equser-0.0.1-py3-none-any.whl
  • Upload date:
  • Size: 68.5 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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 7580250c6773627567dfe064674fb5fc37928e9764e3dedaa2d967234cf216fb
MD5 723f1def5cf920fb27e7f5eab131faef
BLAKE2b-256 639f92cf9f69999fae1681f925ceba0a532482b5c1b725b8ba17d77260818ab5

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