wavekit 0.7.3__tar.gz → 0.8.0__tar.gz

{wavekit-0.7.3 → wavekit-0.8.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: wavekit
-Version: 0.7.3
+Version: 0.8.0
 Summary: High-level digital waveform analysis in Python
 License-File: LICENSE
 Author: cxzzzz
@@ -15,9 +15,7 @@ Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3.14
 Requires-Dist: lark (>=1.2,<2)
 Requires-Dist: numpy (>=2.0.0,<3.0.0)
-Requires-Dist: pylibfst (>=0.2.1,<0.3.0)
-Requires-Dist: pytest (>=8.2.2,<9.0.0)
-Requires-Dist: vcdvcd (>=2.3.5,<3.0.0)
+Requires-Dist: wavekit-pywellen (>=0.25.6)
 Project-URL: Documentation, https://cxzzzz.github.io/wavekit
 Project-URL: Repository, https://github.com/cxzzzz/wavekit
 Description-Content-Type: text/markdown
@@ -33,10 +31,9 @@ Description-Content-Type: text/markdown
 English | [中文](README_ZH.md)
 
 **Wavekit is a Python library for high-level digital waveform analysis.**
-Wavekit supports common digital waveform formats; by combining batch signal
-queries with analysis at the cycle and transaction levels, it helps users
-interpret recorded signal changes in terms of per-cycle state and temporal
-relationships.
+It loads signals from waveform files as clock-aligned `Waveform` objects,
+allowing users to query and operate on them at the cycle and transaction levels,
+making complex hardware behavior easier to analyze.
 
 > **AI integration:** [wavekit-mcp](https://github.com/cxzzzz/wavekit-mcp) exposes wavekit analysis through
 > MCP tools for AI-assisted workflows.
@@ -74,18 +71,12 @@ import numpy as np
 from wavekit import VcdReader
 
 with VcdReader('simulation.vcd') as r:
-    clock = 'tb.clk'
-    depth = 16
-
-    w_ptr = r.load_waveform(
-        'tb.u_fifo.w_ptr',
-        clock=clock,
-    )
-    r_ptr = r.load_waveform(
-        'tb.u_fifo.r_ptr',
-        clock=clock,
-    )
+    fifo = r['tb.u_fifo']
+    with r.clock_domain(clock='tb.clk'):
+        w_ptr = fifo['w_ptr'].w
+        r_ptr = fifo['r_ptr'].w
 
+    depth = 16
     occupancy = (w_ptr + depth - r_ptr) % depth
 
     print('Average occupancy:', np.mean(occupancy.value))

{wavekit-0.7.3 → wavekit-0.8.0}/README.md

@@ -9,10 +9,9 @@
 English | [中文](README_ZH.md)
 
 **Wavekit is a Python library for high-level digital waveform analysis.**
-Wavekit supports common digital waveform formats; by combining batch signal
-queries with analysis at the cycle and transaction levels, it helps users
-interpret recorded signal changes in terms of per-cycle state and temporal
-relationships.
+It loads signals from waveform files as clock-aligned `Waveform` objects,
+allowing users to query and operate on them at the cycle and transaction levels,
+making complex hardware behavior easier to analyze.
 
 > **AI integration:** [wavekit-mcp](https://github.com/cxzzzz/wavekit-mcp) exposes wavekit analysis through
 > MCP tools for AI-assisted workflows.
@@ -50,18 +49,12 @@ import numpy as np
 from wavekit import VcdReader
 
 with VcdReader('simulation.vcd') as r:
-    clock = 'tb.clk'
-    depth = 16
-
-    w_ptr = r.load_waveform(
-        'tb.u_fifo.w_ptr',
-        clock=clock,
-    )
-    r_ptr = r.load_waveform(
-        'tb.u_fifo.r_ptr',
-        clock=clock,
-    )
+    fifo = r['tb.u_fifo']
+    with r.clock_domain(clock='tb.clk'):
+        w_ptr = fifo['w_ptr'].w
+        r_ptr = fifo['r_ptr'].w
 
+    depth = 16
     occupancy = (w_ptr + depth - r_ptr) % depth
 
     print('Average occupancy:', np.mean(occupancy.value))

wavekit-0.7.3/build.py → wavekit-0.8.0/build_exts.py

@@ -1,3 +1,5 @@
+import os
+import sys
 from pathlib import Path
 
 import numpy as np
@@ -7,22 +9,37 @@ from setuptools import Extension, setup
 for artifact in Path('src/wavekit').glob('**/*.so'):
     artifact.unlink()
 
+if os.environ.get('PYODIDE'):
+    compile_args = ['-fpic', '-O3']
+    link_args = ['-O3']
+    fsdb_libraries = []
+elif sys.platform == 'linux':
+    compile_args = ['-fpic', '-O3']
+    link_args = ['-O3']
+    fsdb_libraries = ['dl']
+elif sys.platform == 'darwin':
+    compile_args = ['-fpic', '-O3']
+    link_args = ['-O3']
+    fsdb_libraries = []
+else:
+    raise RuntimeError(f'Unsupported platform: {sys.platform}')
+
 extensions = [
     Extension(
         'wavekit.readers.value_change',
         sources=['src/wavekit/readers/value_change.pyx'],
         include_dirs=[np.get_include()],
-        extra_compile_args=['-fpic', '-O3', '-march=native'],
-        extra_link_args=['-O3', '-march=native'],
+        extra_compile_args=compile_args,
+        extra_link_args=link_args,
         language='c++',
     ),
     Extension(
         'wavekit.readers.fsdb.npi_fsdb_reader',
         sources=['src/wavekit/readers/fsdb/npi_fsdb_reader.pyx'],
         include_dirs=[np.get_include()],
-        libraries=['dl'],
-        extra_compile_args=['-fpic', '-O3', '-march=native'],
-        extra_link_args=['-O3', '-march=native'],
+        libraries=fsdb_libraries,
+        extra_compile_args=compile_args,
+        extra_link_args=link_args,
         language='c++',
     ),
 ]

{wavekit-0.7.3 → wavekit-0.8.0}/pyproject.toml

@@ -1,12 +1,12 @@
 [tool.poetry]
 name = "wavekit"
-version = "0.7.3"
+version = "0.8.0"
 description = "High-level digital waveform analysis in Python"
 authors = ["cxzzzz <cxz19961010@outlook.com>"]
 readme = "README.md"
 repository = "https://github.com/cxzzzz/wavekit"
 documentation = "https://cxzzzz.github.io/wavekit"
-build = "build.py"
+build = "build_exts.py"
 include = [
     { path = "src/wavekit/**/*.so", format = "wheel" },
 ]
@@ -14,12 +14,11 @@ include = [
 [tool.poetry.dependencies]
 python = "^3.9"
 numpy = "^2.0.0"
-vcdvcd = "^2.3.5"
-pylibfst = "^0.2.1"
-pytest = "^8.2.2"
+wavekit-pywellen = ">=0.25.6"
 lark = ">=1.2,<2"
 
 [tool.poetry.group.dev.dependencies]
+pytest = "^8.2.2"
 ruff = "^0.6.2"
 mypy = "^1.11.2"
 

{wavekit-0.7.3 → wavekit-0.8.0}/src/wavekit/__init__.py

@@ -9,6 +9,7 @@ try:
 except metadata.PackageNotFoundError:
     __version__ = 'unknown'
 
+from .readers.clock_domain import ClockDomain as ClockDomain
 from .readers.fst.reader import FstReader as FstReader
 from .readers.hierarchy import Node as Node
 from .readers.hierarchy import Scope as Scope
@@ -28,6 +29,7 @@ __all__ = [
     'VcdReader',
     'FsdbReader',
     'FstReader',
+    'ClockDomain',
     'Node',
     'Scope',
     'Range',

{wavekit-0.7.3 → wavekit-0.8.0}/src/wavekit/pattern/compiler.py

@@ -28,7 +28,7 @@ from .steps import (
 def infer_declarative_axis(steps: list[Step]) -> Waveform | None:
     """Infer a minimal first-static-waveform scan axis hint from steps."""
     # Axis inference is intentionally minimal.  It only finds a static waveform
-    # so start/end_cycle can be translated to indices; full clock alignment
+    # so start/end_cycle can be translated to indices; full cycle-axis alignment
     # validation remains lazy in PatternRuntime.note_waveform().
     for step in steps:
         if isinstance(step, (WaitStep, ConsumeStep)):

{wavekit-0.7.3 → wavekit-0.8.0}/src/wavekit/pattern/result.py

@@ -85,7 +85,7 @@ class MatchRecords(Sequence[MatchRecord]):
     """Columnar batch of pattern match records.
 
     ``start`` and ``end`` are point waveforms: ``.value`` stores waveform-array
-    sample indices, ``.clock`` stores absolute cycle numbers, and ``.time`` stores
+    sample indices, ``.cycle`` stores absolute cycle numbers, and ``.time`` stores
     simulation timestamps. ``duration.value`` is ``end.value - start.value + 1``.
     """
 
@@ -116,7 +116,7 @@ class MatchRecords(Sequence[MatchRecord]):
         value = np.array(
             [isinstance(status, MatchStatus.OK) for status in self.status.value], dtype=bool
         )
-        return Waveform(value, self.start.clock.copy(), self.start.time.copy(), width=1)
+        return Waveform(value, self.start.cycle.copy(), self.start.time.copy(), width=1)
 
     @property
     def failed(self) -> Waveform:
@@ -131,7 +131,7 @@ class MatchRecords(Sequence[MatchRecord]):
         value = np.array(
             [not isinstance(status, MatchStatus.OK) for status in self.status.value], dtype=bool
         )
-        return Waveform(value, self.start.clock.copy(), self.start.time.copy(), width=1)
+        return Waveform(value, self.start.cycle.copy(), self.start.time.copy(), width=1)
 
     def filter_ok(self) -> MatchRecords:
         """Return records whose status is ``MatchStatus.OK``.
@@ -219,12 +219,12 @@ class MatchRecords(Sequence[MatchRecord]):
         return MatchRecord(
             start=MatchPoint(
                 index=int(self.start.value[index]),
-                cycle=int(self.start.clock[index]),
+                cycle=int(self.start.cycle[index]),
                 time=int(self.start.time[index]),
             ),
             end=MatchPoint(
                 index=int(self.end.value[index]),
-                cycle=int(self.end.clock[index]),
+                cycle=int(self.end.cycle[index]),
                 time=int(self.end.time[index]),
             ),
             status=self.status.value[index],

{wavekit-0.7.3 → wavekit-0.8.0}/src/wavekit/pattern/runtime.py

@@ -121,7 +121,7 @@ class PatternContext:
         Parameters
         ----------
         waveform:
-            Waveform to read. It must share the same clock axis as other observed
+            Waveform to read. It must share the same cycle axis as other observed
             pattern waveforms.
         offset:
             Relative sample offset from ``ctx.index``. ``0`` reads the current
@@ -142,17 +142,17 @@ class PatternContext:
         Parameters
         ----------
         waveform:
-            Waveform whose clock axis is read and validated.
+            Waveform whose cycle axis is read and validated.
         offset:
             Relative sample offset from ``ctx.index``.
 
         Returns
         -------
         Any
-            Scalar value from ``waveform.clock[ctx.index + offset]``.
+            Scalar value from ``waveform.cycle[ctx.index + offset]``.
         """
         index = self._waveform_index(waveform, offset)
-        return waveform.clock[index]
+        return waveform.cycle[index]
 
     def time(self, waveform: Waveform, offset: int = 0) -> Any:
         """Return a waveform timestamp at the current sample plus *offset*.
@@ -400,14 +400,14 @@ class PatternRuntime:
         if self._start_cycle is None:
             return 0
         axis = self._require_axis()
-        return int(np.searchsorted(axis.clock, self._start_cycle))
+        return int(np.searchsorted(axis.cycle, self._start_cycle))
 
     @cached_property
     def scan_end_index(self) -> int:
         axis = self._require_axis()
         if self._end_cycle is None:
             return len(axis.value)
-        return int(np.searchsorted(axis.clock, self._end_cycle))
+        return int(np.searchsorted(axis.cycle, self._end_cycle))
 
     def match(self, start_cycle: int | None = None, end_cycle: int | None = None) -> MatchRecords:
         completed = self._run(start_cycle, end_cycle)
@@ -426,20 +426,20 @@ class PatternRuntime:
                 continue
             raise PatternError(
                 f'Pattern failed with {inst.status}; '
-                f'start_cycle={axis.clock[inst.start_index]}, '
-                f'failure_cycle={axis.clock[inst.end_index]}'
+                f'start_cycle={axis.cycle[inst.start_index]}, '
+                f'failure_cycle={axis.cycle[inst.end_index]}'
             )
         return [inst.return_value for inst in completed if inst.return_value is not None]
 
     def _records(self, completed: list[PatternInstance]) -> MatchRecords:
         axis = self._require_axis()
-        completed.sort(key=lambda i: (int(axis.clock[i.start_index]), i.order))
+        completed.sort(key=lambda i: (int(axis.cycle[i.start_index]), i.order))
         start_index_arr = np.array([i.start_index for i in completed], dtype=np.int64)
         end_index_arr = np.array([i.end_index for i in completed], dtype=np.int64)
         start_cycle_arr = np.array(
-            [int(axis.clock[i.start_index]) for i in completed], dtype=np.int64
+            [int(axis.cycle[i.start_index]) for i in completed], dtype=np.int64
         )
-        end_cycle_arr = np.array([int(axis.clock[i.end_index]) for i in completed], dtype=np.int64)
+        end_cycle_arr = np.array([int(axis.cycle[i.end_index]) for i in completed], dtype=np.int64)
         start_time_arr = np.array(
             [int(axis.time[i.start_index]) for i in completed], dtype=np.int64
         )
@@ -493,10 +493,10 @@ class PatternRuntime:
             self._axis = waveform
             self._validated_waveform_ids.add(waveform_id)
             return
-        if len(waveform.clock) != len(self._axis.clock):
-            raise PatternError('Waveform clock arrays have different lengths')
-        if not np.array_equal(waveform.clock, self._axis.clock):
-            raise PatternError('Waveform clock arrays are not aligned')
+        if len(waveform.cycle) != len(self._axis.cycle):
+            raise PatternError('Waveform cycle arrays have different lengths')
+        if not np.array_equal(waveform.cycle, self._axis.cycle):
+            raise PatternError('Waveform cycle arrays are not aligned')
         self._validated_waveform_ids.add(waveform_id)
 
     def resolve_channel(