cicwave 0.5.0__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,242 @@
1
+ Metadata-Version: 2.4
2
+ Name: cicwave
3
+ Version: 0.5.0
4
+ Summary: Advanced waveform viewer with PyQtGraph backend
5
+ Author-email: Carsten Wulff <carsten@wulff.no>
6
+ License: MIT
7
+ Project-URL: Homepage, https://github.com/wulffern/cicwave
8
+ Project-URL: Bug Tracker, https://github.com/wulffern/cicwave/issues
9
+ Classifier: Development Status :: 4 - Beta
10
+ Classifier: Intended Audience :: Developers
11
+ Classifier: Intended Audience :: Science/Research
12
+ Classifier: Natural Language :: English
13
+ Classifier: Operating System :: OS Independent
14
+ Classifier: Programming Language :: Python :: 3
15
+ Classifier: Programming Language :: Python :: 3.8
16
+ Classifier: Programming Language :: Python :: 3.9
17
+ Classifier: Programming Language :: Python :: 3.10
18
+ Classifier: Programming Language :: Python :: 3.11
19
+ Classifier: Topic :: Utilities
20
+ Classifier: Topic :: Scientific/Engineering
21
+ Classifier: Topic :: Scientific/Engineering :: Electronic Design Automation (EDA)
22
+ Classifier: Topic :: Scientific/Engineering :: Visualization
23
+ Requires-Python: >=3.8
24
+ Description-Content-Type: text/markdown
25
+ License-File: LICENSE
26
+ Requires-Dist: numpy
27
+ Requires-Dist: pandas
28
+ Requires-Dist: matplotlib
29
+ Requires-Dist: click
30
+ Requires-Dist: pyyaml
31
+ Requires-Dist: PySide6
32
+ Requires-Dist: pyqtgraph
33
+ Requires-Dist: PyOpenGL
34
+ Provides-Extra: parquet
35
+ Requires-Dist: pyarrow; extra == "parquet"
36
+ Provides-Extra: hdf5
37
+ Requires-Dist: tables; extra == "hdf5"
38
+ Dynamic: license-file
39
+
40
+ # cicwave
41
+
42
+ Waveform viewer with PyQtGraph backend for high-performance visualization of simulation data.
43
+
44
+ cicwave is a standalone package extracted from
45
+ [cicsim](https://github.com/wulffern/cicsim), focused on providing the
46
+ best possible waveform viewing experience with PyQtGraph and Qt6.
47
+
48
+ ## Background
49
+
50
+ I made my first waveform viewer (<https://github.com/wulffern/NextGenLab.Chart>)
51
+ back in 2001 during a summer internship. NextGenLab.Chart evolved into
52
+ <https://github.com/wulffern/SystemDotNet.Report> during my Ph.D. In I always
53
+ had in my plan to port SdnReport to Mac and Linux, but I never really did (no
54
+ coding time).
55
+
56
+ In December 2023 I needed a waveform viewer for cicsim (read ngspice raw files),
57
+ so I wrote one by hand. It was pretty basic.
58
+
59
+ Enter March 2026, and the advent of agentic coding. It was finally possible to
60
+ revive SdnReport in the form of a Qt port to cicwave. Initially it lived inside
61
+ cicsim, however, in May 2026 it became clear that cicwave deserved it's own
62
+ repo. As such, you're here.
63
+
64
+ ## Features
65
+
66
+ - **High-performance rendering** with PyQtGraph and GPU acceleration
67
+ - **Multiple file format support**:
68
+ - ngspice `.raw` files
69
+ - CSV, TSV, Excel spreadsheets
70
+ - Parquet, HDF5, Feather for big data
71
+ - VCD digital waveforms
72
+ - LitePoint `.iqvsa` IQ capture files
73
+ - **Multi-dimensional data pivoting** with YAML specifications
74
+ - **Digital waveform support** with separate analog/digital panes
75
+ - **Session save/restore** with `.cicwave.yaml` files
76
+ - **Export capabilities** to PDF, PNG, SVG formats
77
+ - **Engineering unit formatting** and auto-detection
78
+ - **GPU-accelerated plotting** for smooth interaction with large datasets
79
+
80
+ ## Installation
81
+
82
+ ```bash
83
+ pip install cicwave
84
+ ```
85
+
86
+ For development installation:
87
+
88
+ ```bash
89
+ git clone https://github.com/wulffern/cicwave.git
90
+ cd cicwave
91
+ pip install -e .
92
+ ```
93
+
94
+ ## Usage
95
+
96
+ ### Basic Usage
97
+
98
+ Open waveform files directly:
99
+
100
+ ```bash
101
+ # Single file
102
+ cicwave data.raw
103
+
104
+ # Multiple files
105
+ cicwave sim1.csv sim2.csv results.xlsx
106
+
107
+ # Glob patterns (useful on PowerShell)
108
+ cicwave --glob "results/*.csv" --glob "**/*.raw"
109
+ ```
110
+
111
+ ### Advanced Features
112
+
113
+ **Multi-dimensional data reshaping:**
114
+ ```bash
115
+ cicwave --pivot analysis.yaml dataset.csv
116
+ ```
117
+
118
+ **Session management:**
119
+ ```bash
120
+ # Save your current plot configuration in the GUI (File → Save Session)
121
+ cicwave --session my_analysis.cicwave.yaml
122
+
123
+ # Export plots without opening GUI
124
+ cicwave --session config.yaml --export results.pdf
125
+ ```
126
+
127
+ **Data exploration:**
128
+ ```bash
129
+ # Preview pivot dimensions before plotting
130
+ cicwave --pivot spec.yaml --pivot-info data.csv
131
+ ```
132
+
133
+ ## File Format Support
134
+
135
+ | Format | Extension | Description |
136
+ |--------|-----------|-------------|
137
+ | ngspice | `.raw` | Binary simulation results |
138
+ | CSV/TSV | `.csv`, `.tsv` | Comma/tab separated values |
139
+ | Excel | `.xlsx` | Spreadsheet format |
140
+ | Parquet | `.parquet` | Columnar storage (requires `pip install pyarrow`) |
141
+ | HDF5 | `.h5` | Hierarchical data (requires `pip install tables`) |
142
+ | VCD | `.vcd` | Digital simulation waveforms |
143
+ | LitePoint | `.iqvsa` | IQ capture data |
144
+
145
+ ## Environment Variables
146
+
147
+ - `CICWAVE_X` - Default X-axis column name
148
+
149
+ ## GUI Features
150
+
151
+ ### Waveform Interaction
152
+ - **Mouse wheel**: Zoom in/out
153
+ - **Middle click + drag**: Pan
154
+ - **Right click**: Context menu with analysis tools
155
+ - **Ctrl+A**: Auto-fit all waveforms
156
+ - **Ctrl+Mouse wheel**: Zoom X-axis only
157
+
158
+ ### Analysis Tools
159
+ - **Cursors**: Measure time/voltage differences
160
+ - **Math expressions**: Create derived signals
161
+ - **Digital analysis**: View bus values and timing
162
+ - **Export data**: Save currently visible waveforms
163
+
164
+ ### Session Management
165
+ - **File → Save Session**: Save current plot configuration
166
+ - **File → Load Session**: Restore previous analysis
167
+ - Sessions store: visible signals, zoom levels, cursor positions, analysis setup
168
+
169
+ ## Pivot Specifications
170
+
171
+ For multi-dimensional datasets, use YAML pivot specs to reshape data before visualization:
172
+
173
+ ```yaml
174
+ # analysis.yaml
175
+ index: time # X-axis (rows)
176
+ columns: [corner, temperature] # Create separate traces for each combination
177
+ values: ["v(out)", "v(in)"] # Y-axis signals to plot
178
+ conditions: # Filter data
179
+ frequency: 1e9
180
+ process: tt
181
+ ```
182
+
183
+ ```bash
184
+ cicwave --pivot analysis.yaml monte_carlo_results.csv
185
+ ```
186
+
187
+ ## Migrating from cicsim
188
+
189
+ If you previously used `cicsim wave` or the standalone `cicwave` from cicsim:
190
+
191
+ 1. **Install standalone cicwave**: `pip install cicwave`
192
+ 2. **Update workflows**: Replace `cicsim wave --backend pg` with just `cicwave`
193
+ 3. **Session files**: Existing `.cicwave.yaml` files are fully compatible
194
+ 4. **Tkinter users**: `cicsim wave --backend tk` still works in cicsim for lightweight usage
195
+
196
+ ## Development
197
+
198
+ ### Running Tests
199
+
200
+ ```bash
201
+ # Run all unit tests
202
+ python -m unittest discover -s tests/unittests/ -p 'test_*.py' -v
203
+
204
+ # Test specific functionality
205
+ python -m unittest tests.unittests.test_wavefiles_lazy -v
206
+ ```
207
+
208
+ ### Project Structure
209
+
210
+ ```
211
+ cicwave/
212
+ ├── src/cicwave/
213
+ │ ├── cli.py # Command-line interface
214
+ │ ├── wave_pg.py # Main PyQtGraph viewer
215
+ │ ├── wavefiles.py # File I/O and data loading
216
+ │ ├── ngraw.py # ngspice binary parser
217
+ │ ├── pivot.py # Data reshaping
218
+ │ ├── theme.py # Color themes
219
+ │ └── command.py # Logging utilities
220
+ ├── tests/unittests/ # Unit test suite
221
+ └── scripts/ # Windows shortcut generator
222
+ ```
223
+
224
+ ## License
225
+
226
+ MIT License - see LICENSE file for details.
227
+
228
+ ## Contributing
229
+
230
+ Contributions welcome! Please:
231
+
232
+ 1. Fork the repository
233
+ 2. Create a feature branch
234
+ 3. Add tests for new functionality
235
+ 4. Ensure all tests pass
236
+ 5. Submit a pull request
237
+
238
+ ## Related Projects
239
+
240
+ - **[cicsim](https://github.com/wulffern/cicsim)** - Simulation orchestration and lightweight tkinter viewer
241
+ - **[cicpy](https://github.com/wulffern/cicpy)** - Analog IC design transpiler
242
+ - **[PyQtGraph](https://pyqtgraph.readthedocs.io/)** - High-performance plotting library
@@ -0,0 +1,14 @@
1
+ cicwave/__init__.py,sha256=ggIfqqW-vBKS3oLOBBDXLz3cDc5CW8NkWmytVRakASQ,646
2
+ cicwave/cli.py,sha256=hI54RdksVg_vJrZck_2TfZXT03hYO3enkgIrJ31SB-M,6675
3
+ cicwave/command.py,sha256=6S0e8tjsOx5-r-G_3TSiqI4kxdRYUF-ZEbLHldmSH1o,2585
4
+ cicwave/ngraw.py,sha256=d3aVNDp4T_ZLdrXHgeq6JRK2G53-Xv3pkKXOHExFHyo,3823
5
+ cicwave/pivot.py,sha256=2LTSxWP5zDy63u-tuOMyyA9sRuLoTvHrYsvXoLvlxpg,7845
6
+ cicwave/theme.py,sha256=i-O7GvBXu5wOX9Av_HOHxOYvzn4819SWt6WjDRBo__c,3774
7
+ cicwave/wave_pg.py,sha256=0UF-5jtaT8-CuFLjFfo4RMLKvXgp1GWk54mIx56sX_0,151327
8
+ cicwave/wavefiles.py,sha256=QKImUsMdOaluJYTM8x5qQGo7cB769tfpwPmYkRZRtzc,33039
9
+ cicwave-0.5.0.dist-info/licenses/LICENSE,sha256=eLx893NEaYJSgIkJF9fPKPeN7VXUTgTfVh4yeZyrnAg,1091
10
+ cicwave-0.5.0.dist-info/METADATA,sha256=GnnIrk87sK2jzmm2s7HOp8VIF4FyhIrccJfsRWlCQ3A,7394
11
+ cicwave-0.5.0.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
12
+ cicwave-0.5.0.dist-info/entry_points.txt,sha256=Tu9KuD9MavcJySs7XDv1G1yEhEfUkxqnHCaC-ppyOZU,88
13
+ cicwave-0.5.0.dist-info/top_level.txt,sha256=Jjkx9aJQcj-89ctTNqYbinustbC0u_MCvzBkTJ7xLFU,8
14
+ cicwave-0.5.0.dist-info/RECORD,,
@@ -0,0 +1,5 @@
1
+ Wheel-Version: 1.0
2
+ Generator: setuptools (82.0.1)
3
+ Root-Is-Purelib: true
4
+ Tag: py3-none-any
5
+
@@ -0,0 +1,5 @@
1
+ [console_scripts]
2
+ cicwave = cicwave.cli:main
3
+
4
+ [gui_scripts]
5
+ cicwavew = cicwave.cli:main
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2020-2026 Carsten Wulff Software, Norway
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
@@ -0,0 +1 @@
1
+ cicwave