Advanced waveform viewer with PyQtGraph backend
Project description
cicwave
Waveform viewer with PyQtGraph backend for high-performance visualization of simulation data.
cicwave is a standalone package extracted from cicsim, focused on providing the best possible waveform viewing experience with PyQtGraph and Qt6.
Background
I made my first waveform viewer (https://github.com/wulffern/NextGenLab.Chart) back in 2001 during a summer internship. NextGenLab.Chart evolved into https://github.com/wulffern/SystemDotNet.Report during my Ph.D. In I always had in my plan to port SdnReport to Mac and Linux, but I never really did (no coding time).
In December 2023 I needed a waveform viewer for cicsim (read ngspice raw files), so I wrote one by hand. It was pretty basic.
Enter March 2026, and the advent of agentic coding. It was finally possible to revive SdnReport in the form of a Qt port to cicwave. Initially it lived inside cicsim, however, in May 2026 it became clear that cicwave deserved it's own repo. As such, you're here.
Features
- High-performance rendering with PyQtGraph and GPU acceleration
- Multiple file format support:
- ngspice
.rawfiles - CSV, TSV, Excel spreadsheets
- Parquet, HDF5, Feather for big data
- VCD digital waveforms
- LitePoint
.iqvsaIQ capture files
- ngspice
- Multi-dimensional data pivoting with YAML specifications
- Digital waveform support with separate analog/digital panes
- Session save/restore with
.cicwave.yamlfiles - Export capabilities to PDF, PNG, SVG formats
- Engineering unit formatting and auto-detection
- GPU-accelerated plotting for smooth interaction with large datasets
Installation
pip install cicwave
For development installation:
git clone https://github.com/wulffern/cicwave.git
cd cicwave
pip install -e .
Usage
Basic Usage
Open waveform files directly:
# Single file
cicwave data.raw
# Multiple files
cicwave sim1.csv sim2.csv results.xlsx
# Glob patterns (useful on PowerShell)
cicwave --glob "results/*.csv" --glob "**/*.raw"
Advanced Features
Multi-dimensional data reshaping:
cicwave --pivot analysis.yaml dataset.csv
Session management:
# Save your current plot configuration in the GUI (File → Save Session)
cicwave --session my_analysis.cicwave.yaml
# Export plots without opening GUI
cicwave --session config.yaml --export results.pdf
Data exploration:
# Preview pivot dimensions before plotting
cicwave --pivot spec.yaml --pivot-info data.csv
File Format Support
| Format | Extension | Description |
|---|---|---|
| ngspice | .raw |
Binary simulation results |
| CSV/TSV | .csv, .tsv |
Comma/tab separated values |
| Excel | .xlsx |
Spreadsheet format |
| Parquet | .parquet |
Columnar storage (requires pip install pyarrow) |
| HDF5 | .h5 |
Hierarchical data (requires pip install tables) |
| VCD | .vcd |
Digital simulation waveforms |
| LitePoint | .iqvsa |
IQ capture data |
Environment Variables
CICWAVE_X- Default X-axis column name
GUI Features
Waveform Interaction
- Mouse wheel: Zoom in/out
- Middle click + drag: Pan
- Right click: Context menu with analysis tools
- Ctrl+A: Auto-fit all waveforms
- Ctrl+Mouse wheel: Zoom X-axis only
Analysis Tools
- Cursors: Measure time/voltage differences
- Math expressions: Create derived signals
- Digital analysis: View bus values and timing
- Export data: Save currently visible waveforms
Session Management
- File → Save Session: Save current plot configuration
- File → Load Session: Restore previous analysis
- Sessions store: visible signals, zoom levels, cursor positions, analysis setup
Pivot Specifications
For multi-dimensional datasets, use YAML pivot specs to reshape data before visualization:
# analysis.yaml
index: time # X-axis (rows)
columns: [corner, temperature] # Create separate traces for each combination
values: ["v(out)", "v(in)"] # Y-axis signals to plot
conditions: # Filter data
frequency: 1e9
process: tt
cicwave --pivot analysis.yaml monte_carlo_results.csv
Migrating from cicsim
If you previously used cicsim wave or the standalone cicwave from cicsim:
- Install standalone cicwave:
pip install cicwave - Update workflows: Replace
cicsim wave --backend pgwith justcicwave - Session files: Existing
.cicwave.yamlfiles are fully compatible - Tkinter users:
cicsim wave --backend tkstill works in cicsim for lightweight usage
Development
Running Tests
# Run all unit tests
python -m unittest discover -s tests/unittests/ -p 'test_*.py' -v
# Test specific functionality
python -m unittest tests.unittests.test_wavefiles_lazy -v
Project Structure
cicwave/
├── src/cicwave/
│ ├── cli.py # Command-line interface
│ ├── wave_pg.py # Main PyQtGraph viewer
│ ├── wavefiles.py # File I/O and data loading
│ ├── ngraw.py # ngspice binary parser
│ ├── pivot.py # Data reshaping
│ ├── theme.py # Color themes
│ └── command.py # Logging utilities
├── tests/unittests/ # Unit test suite
└── scripts/ # Windows shortcut generator
License
MIT License - see LICENSE file for details.
Contributing
Contributions welcome! Please:
- Fork the repository
- Create a feature branch
- Add tests for new functionality
- Ensure all tests pass
- Submit a pull request
Related Projects
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file cicwave-0.5.0.tar.gz.
File metadata
- Download URL: cicwave-0.5.0.tar.gz
- Upload date:
- Size: 62.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
5eb42a32300791553e125d2edfa495326fef8e9b590a5b8bad4001de040ce5dd
|
|
| MD5 |
bb40512b82924e988ae2fef132120052
|
|
| BLAKE2b-256 |
69836db9b1f5666c73a3db9bd2a0f85de5284c3780029f1d9eba561292f1736e
|
File details
Details for the file cicwave-0.5.0-py3-none-any.whl.
File metadata
- Download URL: cicwave-0.5.0-py3-none-any.whl
- Upload date:
- Size: 63.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
6f6c0ee71f63ce9ad8ab59a5265e6e6d4ac245a5197b42ced7919e8049789103
|
|
| MD5 |
7f6fd879259976e73909914629a3f1cf
|
|
| BLAKE2b-256 |
fd08821ed77a26981a6baa2df0aa8e38771ddb301e6a4c7a296dddb7efd80a3d
|