wavekit 0.5.4__tar.gz → 0.5.6__tar.gz

{wavekit-0.5.4 → wavekit-0.5.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: wavekit
-Version: 0.5.4
+Version: 0.5.6
 Summary: a fundamental package for digital circuit waveform analysis
 License-File: LICENSE
 Author: cxzzzz
@@ -40,7 +40,10 @@ Description-Content-Type: text/markdown
 pip install wavekit
 ```
 
-**Note**: To read FSDB files, ensure the `VERDI_HOME` environment variable is set before installation.
+**Note**: To read FSDB files, the Verdi runtime library (`libNPI.so`) must be available at runtime. Configure via:
+- `WAVEKIT_NPI_LIB` — direct path to `libNPI.so`
+- `VERDI_HOME` — Verdi installation directory (searches `$VERDI_HOME/share/NPI/lib/...`)
+- `LD_LIBRARY_PATH` — system library search path
 
 ## 🚀 Quick Start
 
@@ -195,7 +198,7 @@ print(f"Stall durations: {stalls.duration.value} cycles")
 
 | Method | Description |
 |--------|-------------|
-| `VcdReader(file)` / `FsdbReader(file)` | Open a waveform file. Use as a context manager. `FsdbReader` requires `VERDI_HOME`. |
+| `VcdReader(file)` / `FsdbReader(file)` | Open a waveform file. Use as a context manager. `FsdbReader` requires Verdi runtime (`WAVEKIT_NPI_LIB`, `VERDI_HOME`, or `LD_LIBRARY_PATH`). |
 | `reader.load_waveform(signal, clock, ...)` | Load one signal sampled on every clock edge. Returns `Waveform`. |
 | `reader.load_matched_waveforms(pattern, clock_pattern, ...)` | Batch-load signals matching a brace/regex pattern. Returns `dict[tuple, Waveform]`. |
 | `reader.eval(expr, clock, mode='single'\|'zip', ...)` | Evaluate an arithmetic expression with embedded signal paths. |

{wavekit-0.5.4 → wavekit-0.5.6}/README.md

@@ -19,7 +19,10 @@
 pip install wavekit
 ```
 
-**Note**: To read FSDB files, ensure the `VERDI_HOME` environment variable is set before installation.
+**Note**: To read FSDB files, the Verdi runtime library (`libNPI.so`) must be available at runtime. Configure via:
+- `WAVEKIT_NPI_LIB` — direct path to `libNPI.so`
+- `VERDI_HOME` — Verdi installation directory (searches `$VERDI_HOME/share/NPI/lib/...`)
+- `LD_LIBRARY_PATH` — system library search path
 
 ## 🚀 Quick Start
 
@@ -174,7 +177,7 @@ print(f"Stall durations: {stalls.duration.value} cycles")
 
 | Method | Description |
 |--------|-------------|
-| `VcdReader(file)` / `FsdbReader(file)` | Open a waveform file. Use as a context manager. `FsdbReader` requires `VERDI_HOME`. |
+| `VcdReader(file)` / `FsdbReader(file)` | Open a waveform file. Use as a context manager. `FsdbReader` requires Verdi runtime (`WAVEKIT_NPI_LIB`, `VERDI_HOME`, or `LD_LIBRARY_PATH`). |
 | `reader.load_waveform(signal, clock, ...)` | Load one signal sampled on every clock edge. Returns `Waveform`. |
 | `reader.load_matched_waveforms(pattern, clock_pattern, ...)` | Batch-load signals matching a brace/regex pattern. Returns `dict[tuple, Waveform]`. |
 | `reader.eval(expr, clock, mode='single'\|'zip', ...)` | Evaluate an arithmetic expression with embedded signal paths. |

wavekit-0.5.6/build.py

@@ -0,0 +1,38 @@
+import numpy as np
+from Cython.Build import cythonize
+from setuptools import Extension, setup
+
+extensions = [
+    Extension(
+        'src.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'],
+        language='c++',
+    ),
+    Extension(
+        'src.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'],
+        language='c++',
+    ),
+]
+
+setup(
+    ext_modules=cythonize(
+        extensions,
+        compiler_directives={
+            'language_level': 3,
+            'embedsignature': True,
+            'boundscheck': False,
+            'wraparound': False,
+            'cdivision': True,
+            'nonecheck': False,
+        },
+    ),
+    script_args=['build_ext', '--inplace'],
+)

{wavekit-0.5.4 → wavekit-0.5.6}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "wavekit"
-version = "0.5.4"
+version = "0.5.6"
 description = "a fundamental package for digital circuit waveform analysis"
 authors = ["cxzzzz <cxz19961010@outlook.com>"]
 readme = "README.md"

{wavekit-0.5.4 → wavekit-0.5.6}/src/wavekit/__init__.py

@@ -37,32 +37,31 @@ __all__ = [
     'has_fsdb_support',
 ]
 
-# Detect if FSDB support is available (compiled with VERDI_HOME)
-import importlib.util
-
-_fsdb_available = (
-    importlib.util.find_spec('.readers.fsdb.npi_fsdb_reader', package=__name__) is not None
-)
-
-
-def has_fsdb_support() -> bool:
-    """Check if FsdbReader is available in the current installation."""
-    return _fsdb_available
-
+try:
+    from .readers.fsdb.npi_fsdb_reader import fsdb_runtime_available as _fsdb_runtime_available
+    from .readers.fsdb.reader import FsdbReader as FsdbReader
+except Exception as _fsdb_import_error:
+    _fsdb_available = False
 
-class _FsdbReaderStub:
-    """Placeholder that raises an error when FsdbReader is used without Verdi support."""
+    def has_fsdb_support() -> bool:
+        """Check whether the Verdi FSDB runtime is available."""
+        return False
 
-    def __init__(self, *args, **kwargs):
-        raise RuntimeError(
-            'FsdbReader requires Verdi to be installed and configured.\n\n'
-            '1. Set VERDI_HOME environment variable to your Verdi installation path.\n'
-            '2. Reinstall wavekit:\n'
-            '    pip install --force-reinstall --no-cache-dir --no-deps wavekit'
-        )
+    class _FsdbReaderStub:
+        """Placeholder that raises an error when the Verdi FSDB runtime is unavailable."""
 
+        def __init__(self, *args, **kwargs):
+            raise RuntimeError(
+                'FsdbReader requires the Verdi FSDB runtime (libNPI.so).\n\n'
+                'Set WAVEKIT_NPI_LIB to the library path, set VERDI_HOME to the Verdi '
+                'installation directory, or ensure libNPI.so is in LD_LIBRARY_PATH.\n\n'
+                f'Import error: {_fsdb_import_error}'  # noqa: F821
+            )
 
-if _fsdb_available:
-    from .readers.fsdb.reader import FsdbReader as FsdbReader
-else:
     FsdbReader = _FsdbReaderStub  # type: ignore[assignment]
+else:
+    _fsdb_available = True
+
+    def has_fsdb_support() -> bool:
+        """Check whether the Verdi FSDB runtime is available right now."""
+        return _fsdb_runtime_available()

wavekit-0.5.6/src/wavekit/readers/fsdb/npi_fsdb.pxd

@@ -0,0 +1,82 @@
+ctypedef unsigned long long NPI_UINT64
+ctypedef long long NPI_INT64
+ctypedef int NPI_INT32
+ctypedef unsigned int NPI_UINT32
+ctypedef short NPI_INT16
+ctypedef unsigned short NPI_UINT16
+ctypedef char NPI_BYTE8
+ctypedef unsigned char NPI_UBYTE8
+
+ctypedef void* npiFsdbFileHandle
+ctypedef void* npiFsdbScopeHandle
+ctypedef void* npiFsdbSigHandle
+ctypedef void* npiFsdbSigdbHandle
+ctypedef void* npiFsdbVctHandle
+ctypedef void* npiFsdbFtHandle
+
+ctypedef void* npiFsdbScopeIter
+ctypedef void* npiFsdbSigIter
+ctypedef void* npiFsdbEnumIter
+ctypedef NPI_UINT64 npiFsdbTime
+
+ctypedef enum npiFsdbValType:
+    npiFsdbBinStrVal
+    npiFsdbOctStrVal
+    npiFsdbDecStrVal
+    npiFsdbHexStrVal
+    npiFsdbSintVal
+    npiFsdbUintVal
+    npiFsdbRealVal
+    npiFsdbStringVal
+    npiFsdbEnumStrVal
+    npiFsdbSint64Val
+    npiFsdbUint64Val
+    npiFsdbObjTypeVal
+
+ctypedef struct npiFsdbValueValue:
+    char* str
+    int sint
+    unsigned int uint
+    long long sint64
+    unsigned long long uint64
+    double real
+
+ctypedef struct npiFsdbValue:
+    npiFsdbValType format
+    npiFsdbValueValue value
+
+ctypedef enum npiFsdbSigPropertyType:
+    npiFsdbSigName
+    npiFsdbSigFullName
+    npiFsdbSigIsReal
+    npiFsdbSigHasMember
+    npiFsdbSigLeftRange
+    npiFsdbSigRightRange
+    npiFsdbSigRangeSize
+    npiFsdbSigIsString
+    npiFsdbSigDirection
+    npiFsdbSigAssertionType
+    npiFsdbSigCompositeType
+    npiFsdbSigIsPacked
+    npiFsdbSigHasReasonCode
+    npiFsdbSigReasonCode
+    npiFsdbSigReasonCodeDesc
+    npiFsdbSigIsParam
+    npiFsdbSigHasEnum
+    npiFsdbSigPowerType
+    npiFsdbSigHasForceTag
+    npiFsdbSigSpType
+    npiFsdbSigEnumId
+
+ctypedef enum npiFsdbScopePropertyType:
+    npiFsdbScopeName
+    npiFsdbScopeFullName
+    npiFsdbScopeDefName
+    npiFsdbScopeType
+
+ctypedef enum npiFsdbSigCompositeType_e:
+    npiFsdbSigCtArray
+    npiFsdbSigCtStruct
+    npiFsdbSigCtUnion
+    npiFsdbSigCtTaggedUnion
+    npiFsdbSigCtRecord