wavekit 0.1.0__tar.gz → 0.1.2__tar.gz

wavekit-0.1.2/PKG-INFO

@@ -0,0 +1,92 @@
+Metadata-Version: 2.1
+Name: wavekit
+Version: 0.1.2
+Summary: a fundamental package for digital circuit waveform analysis
+Home-page: https://github.com/cxzzzz/wavekit
+Author: cxzzzz
+Author-email: cxz19961010@outlook.com
+Requires-Python: >=3.9,<4.0
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Dist: numpy (>=2.0.0,<3.0.0)
+Requires-Dist: pytest (>=8.2.2,<9.0.0)
+Requires-Dist: vcdvcd (>=2.3.5,<3.0.0)
+Project-URL: Repository, https://github.com/cxzzzz/wavekit
+Description-Content-Type: text/markdown
+
+# wavekit
+
+Wavekit is a fundamental Python package for digital circuit waveform analysis that provides convenient batch processing of signals and a wide range of mathematical operations for waveforms.
+
+## Features
+
+- Read various waveform files (VCD, FSDB, etc.), especially optimized for large FSDB files.
+- Extract waveforms in batches using absolute paths, brace expansions, and regular expressions.
+- Perform arithmetic, bitwise, functional, and other operations on waveforms.
+
+## Installation
+
+Install Wavekit with Python 3.9 or later.
+
+If you want to read FSDB files, please ensure that **"VERDI_HOME" environment variable is set** before installing the library.
+
+### Using PIP
+
+You can install the library using pip:
+
+```bash
+pip3 install wavekit
+```
+
+### From Source
+
+To install the library from the source, follow these steps:
+
+Clone the repository:
+
+```bash
+git clone https://github.com/cxzzzz/wavekit.git
+```
+
+Navigate to the project directory:
+
+```bash
+cd wavekit
+```
+
+Install the library using pip:
+
+```bash
+pip install .
+```
+
+## Quick Start
+
+Here is a simple [example](./example/fifo_average_occupancy_level/) demonstrating how to use the library to read a VCD file and calculate the average occupancy level of the FIFO :
+
+```python
+import numpy as np
+from wavekit import VcdReader
+
+
+with VcdReader("fifo_tb.vcd") as f: # open the VCD file
+    clock = "fifo_tb.s_fifo.clk"
+    depth = 8
+
+    #calculate the average FIFO occupancy level.
+    w_ptr = f.load_wave("fifo_tb.s_fifo.w_ptr[2:0]", clock=clock)   # load fifo write pointer signal
+    r_ptr = f.load_wave("fifo_tb.s_fifo.r_ptr[2:0]", clock=clock)   # load fifo read pointer signal
+    fifo_water_level = (w_ptr + depth - r_ptr) % depth              # calculate the occupancy level
+    average_fifo_water_level = np.mean(fifo_water_level.value)      # calculate the average occupancy level using numpy
+    print( f"average fifo occupancy level: {average_fifo_water_level}" )
+
+```
+
+## License
+
+This project is licensed under the MIT License. See the [LICENSE](./LICENSE) file for details.
+

wavekit-0.1.2/README.md

@@ -0,0 +1,71 @@
+# wavekit
+
+Wavekit is a fundamental Python package for digital circuit waveform analysis that provides convenient batch processing of signals and a wide range of mathematical operations for waveforms.
+
+## Features
+
+- Read various waveform files (VCD, FSDB, etc.), especially optimized for large FSDB files.
+- Extract waveforms in batches using absolute paths, brace expansions, and regular expressions.
+- Perform arithmetic, bitwise, functional, and other operations on waveforms.
+
+## Installation
+
+Install Wavekit with Python 3.9 or later.
+
+If you want to read FSDB files, please ensure that **"VERDI_HOME" environment variable is set** before installing the library.
+
+### Using PIP
+
+You can install the library using pip:
+
+```bash
+pip3 install wavekit
+```
+
+### From Source
+
+To install the library from the source, follow these steps:
+
+Clone the repository:
+
+```bash
+git clone https://github.com/cxzzzz/wavekit.git
+```
+
+Navigate to the project directory:
+
+```bash
+cd wavekit
+```
+
+Install the library using pip:
+
+```bash
+pip install .
+```
+
+## Quick Start
+
+Here is a simple [example](./example/fifo_average_occupancy_level/) demonstrating how to use the library to read a VCD file and calculate the average occupancy level of the FIFO :
+
+```python
+import numpy as np
+from wavekit import VcdReader
+
+
+with VcdReader("fifo_tb.vcd") as f: # open the VCD file
+    clock = "fifo_tb.s_fifo.clk"
+    depth = 8
+
+    #calculate the average FIFO occupancy level.
+    w_ptr = f.load_wave("fifo_tb.s_fifo.w_ptr[2:0]", clock=clock)   # load fifo write pointer signal
+    r_ptr = f.load_wave("fifo_tb.s_fifo.r_ptr[2:0]", clock=clock)   # load fifo read pointer signal
+    fifo_water_level = (w_ptr + depth - r_ptr) % depth              # calculate the occupancy level
+    average_fifo_water_level = np.mean(fifo_water_level.value)      # calculate the average occupancy level using numpy
+    print( f"average fifo occupancy level: {average_fifo_water_level}" )
+
+```
+
+## License
+
+This project is licensed under the MIT License. See the [LICENSE](./LICENSE) file for details.

{wavekit-0.1.0 → wavekit-0.1.2}/build.py

@@ -22,20 +22,19 @@ if VERDI_HOME := os.environ.get('VERDI_HOME'):
     npi_include_dir = os.path.join(VERDI_HOME,'share/NPI/inc')
     npi_library_dir = os.path.join(VERDI_HOME,'share/NPI/lib/LINUX64')
 
-    extensions = [
+    extensions.append(
         Extension(
             "src.wavekit.npi_fsdb_reader",
             sources=["src/wavekit/npi_fsdb_reader.pyx", ],
             include_dirs=[np.get_include(), npi_include_dir],
             library_dirs=[npi_library_dir],
-            libraries=["NPI"],
+            libraries=["NPI", "rt"],
             extra_compile_args=["-fpic","-O3", "-march=native"],
             extra_link_args=["-O3", "-march=native",f"-Wl,-rpath,{npi_library_dir}"],
             language="c++",
             #define_macros=[('CYTHON_TRACE', '1')] # open profiling
         )
-    ]
-
+    )
 
 setup(
     ext_modules=cythonize(extensions,

{wavekit-0.1.0 → wavekit-0.1.2}/pyproject.toml

@@ -1,9 +1,10 @@
 [tool.poetry]
 name = "wavekit"
-version = "0.1.0"
-description = ""
+version = "0.1.2"
+description = "a fundamental package for digital circuit waveform analysis"
 authors = ["cxzzzz <cxz19961010@outlook.com>"]
 readme = "README.md"
+repository = "https://github.com/cxzzzz/wavekit"
 build = "build.py"
 include = ["src/wavekit/*.so"]
 

{wavekit-0.1.0 → wavekit-0.1.2}/src/wavekit/__init__.py

@@ -5,7 +5,7 @@
 """Python Package Template"""
 from __future__ import annotations
 
-__version__ = "0.0.1"
+__version__ = "0.1.2"
 
 from .waveform import Waveform
 from .vcd_reader import VcdReader

{wavekit-0.1.0 → wavekit-0.1.2}/src/wavekit/reader.py

@@ -48,6 +48,8 @@ def traverse_scope(
 ) -> dict[tuple, str]:
 
     res = dict()
+    if len(descendant_scope_pattern_list) == 0:
+        return res
 
     for k, p in descendant_scope_pattern_list[0].items():
 

wavekit-0.1.0/PKG-INFO

@@ -1,63 +0,0 @@
-Metadata-Version: 2.1
-Name: wavekit
-Version: 0.1.0
-Summary: 
-Author: cxzzzz
-Author-email: cxz19961010@outlook.com
-Requires-Python: >=3.9,<4.0
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.13
-Requires-Dist: numpy (>=2.0.0,<3.0.0)
-Requires-Dist: pytest (>=8.2.2,<9.0.0)
-Requires-Dist: vcdvcd (>=2.3.5,<3.0.0)
-Description-Content-Type: text/markdown
-
-# wavekit
-
-This is a Python library for manipulating and analyzing digital circuit waveforms. The library provides tools to read, process, and perform various operations on waveform data, suitable for various digital circuit simulation and testing scenarios.
-
-## Features
-* Read various waveform file formats (e.g., VCD, FSDB, etc.)
-* Batch extraction of waveforms using absolute paths, brace expansions and regular expressions
-* Perform arithmetic operations, bitwise operations, functional operations and other operators on waveform data
-
-## Installation
-
-### Using pip
-You can install the library using pip:
-
-``` bash
-pip install wavekit
-```
-
-### From Source
-To install the library from the source, follow these steps:
-
-Clone the repository:
-
-```bash
-git clone https://github.com/cxzzzz/wavekit.git
-```
-
-Navigate to the project directory:
-``` bash
-cd wavekit
-```
-Install the library using pip:
-
-``` bash
-pip install .
-```
-
-## Quick Start
-Here is a simple example demonstrating how to use the library to read a VCD file and perform some operations on the waveform data:
-
-``` python
-```
-
-## License
-This project is licensed under the MIT License. See the [LICENSE] file for details.

wavekit-0.1.0/README.md

@@ -1,45 +0,0 @@
-# wavekit
-
-This is a Python library for manipulating and analyzing digital circuit waveforms. The library provides tools to read, process, and perform various operations on waveform data, suitable for various digital circuit simulation and testing scenarios.
-
-## Features
-* Read various waveform file formats (e.g., VCD, FSDB, etc.)
-* Batch extraction of waveforms using absolute paths, brace expansions and regular expressions
-* Perform arithmetic operations, bitwise operations, functional operations and other operators on waveform data
-
-## Installation
-
-### Using pip
-You can install the library using pip:
-
-``` bash
-pip install wavekit
-```
-
-### From Source
-To install the library from the source, follow these steps:
-
-Clone the repository:
-
-```bash
-git clone https://github.com/cxzzzz/wavekit.git
-```
-
-Navigate to the project directory:
-``` bash
-cd wavekit
-```
-Install the library using pip:
-
-``` bash
-pip install .
-```
-
-## Quick Start
-Here is a simple example demonstrating how to use the library to read a VCD file and perform some operations on the waveform data:
-
-``` python
-```
-
-## License
-This project is licensed under the MIT License. See the [LICENSE] file for details.