najaeda 0.1.4__cp312-cp312-macosx_11_0_arm64.whl → 0.1.6__cp312-cp312-macosx_11_0_arm64.whl

najaeda/docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

najaeda/docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

najaeda/docs/source/api.rst

@@ -0,0 +1,7 @@
+najaeda API Documentation
+=========================
+
+.. automodule:: najaeda.netlist
+    :members:
+    :undoc-members:
+    :show-inheritance:

najaeda/docs/source/conf.py

@@ -0,0 +1,40 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+import sys
+import os
+
+# Add the src directory to sys.path
+sys.path.insert(0, os.path.abspath('../../../'))
+
+project = 'najaeda'
+copyright = '2024, Naja authors'
+author = 'Naja authors'
+release = '0.1.6'
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = [
+    'sphinx.ext.autodoc',       # Enables the automodule directive
+    'sphinx.ext.napoleon',      # (Optional) Supports Google and NumPy-style docstrings
+    'sphinx.ext.viewcode',      # (Optional) Links to source code in docs
+    'sphinx.ext.todo',          # (Optional) For TODOs in the documentation
+]
+
+autodoc_mock_imports = ["najaeda.snl"]
+templates_path = ['_templates']
+exclude_patterns = []
+
+
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = 'sphinx_rtd_theme'
+html_static_path = ['_static']

najaeda/docs/source/index.rst

@@ -0,0 +1,13 @@
+.. najaeda documentation master file, created by
+   sphinx-quickstart on Mon Dec 16 16:39:26 2024.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+najaeda documentation
+=====================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   api

najaeda/instance_visitor.py

@@ -0,0 +1,51 @@
+# SPDX-FileCopyrightText: 2024 The Naja authors
+# <https://github.com/najaeda/naja/blob/main/AUTHORS>
+#
+# SPDX-License-Identifier: Apache-2.0
+
+from typing import Callable
+from najaeda import netlist
+
+
+class VisitorConfig:
+    def __init__(
+        self,
+        enter_condition: Callable[[netlist.Instance], bool] = lambda node: True,
+        callback: Callable[..., None] = lambda node, *args, **kwargs: None,
+        args: tuple = (),
+        kwargs: dict = None,
+    ):
+        """
+        :param enter_condition: A callable that takes a node (dict)
+        and returns True if the visitor should enter.
+        :param callback: A callable that takes a node (dict) and performs an operation on it.
+        :param args: Positional arguments to pass to the callback.
+        :param kwargs: Keyword arguments to pass to the callback.
+        """
+        self.enter_condition = enter_condition
+        self.callback = callback
+        self.args = args
+        self.kwargs = kwargs or {}
+
+
+class Visitor:
+    def __init__(self, instance: netlist.Instance):
+        """
+        :param netlist: The hierarchical netlist to be traversed.
+        """
+        self.instance = instance
+
+    def visit(self, instance: netlist.Instance, config: VisitorConfig):
+        """
+        Recursively visits nodes in the netlist hierarchy.
+
+        :param instance: The current node in the netlist instance hierarchy.
+        :param config: VisitorConfig object defining conditions and callbacks.
+        """
+        # Execute the callback
+        config.callback(instance, *config.args, **config.kwargs)
+
+        # Check if we should proceed to children
+        if config.enter_condition(instance):
+            for child in instance.get_child_instances():
+                self.visit(child, config)

najaeda/netlist.py

@@ -35,13 +35,13 @@ class Equipotential:
 
     def get_top_terms(self):
         for term in self.equi.getTerms():
-            yield Term(snl.SNLPath(), term.getBitTerm())
+            yield Term(snl.SNLPath(), term)
 
     def get_all_leaf_readers(self):
         for term in self.equi.getInstTermOccurrences():
             direction = term.getInstTerm().getDirection()
             if direction != snl.SNLTerm.Direction.Output:
-                if term.getInstTerm().getInstance().getModel().isPrimitive():
+                if term.getInstTerm().getInstance().getModel().isLeaf():
                     yield Term(
                         snl.SNLPath(term.getPath(), term.getInstTerm().getInstance()),
                         term.getInstTerm().getBitTerm(),
@@ -161,14 +161,14 @@ class Net:
             path = snl.SNLPath(self.path, term.getInstance())
             yield Term(path, term.getBitTerm())
 
-    def get_terms(self):
+    def get_design_terms(self):
         if hasattr(self, "net_concat"):
             raise ValueError("Cannot get terms from a net_concat")
         for term in self.net.getBitTerms():
             yield Term(self.path, term)
 
-    def get_components(self):
-        for term in itertools.chain(self.get_terms(), self.get_inst_terms()):
+    def get_terms(self):
+        for term in itertools.chain(self.get_design_terms(), self.get_inst_terms()):
             yield term
 
 
@@ -438,8 +438,8 @@ class Instance:
     def __repr__(self) -> str:
         return f"Instance({self.path})"
 
-    def __hash__(self):
-        return hash(self.path)
+    # def __hash__(self):
+    #    return hash(self.path)
 
     def is_top(self) -> bool:
         """Return True if this is the top design."""
@@ -452,6 +452,10 @@ class Instance:
         """Return True if this is a blackbox."""
         return self.__get_snl_model().isBlackBox()
 
+    def is_leaf(self) -> bool:
+        """Return True if this is a leaf."""
+        return self.__get_snl_model().isLeaf()
+
     def is_const0(self) -> bool:
         """Return True if this is a constant 0 generator."""
         return self.__get_snl_model().isConst0()

najaeda-0.1.6.dist-info/METADATA

@@ -0,0 +1,161 @@
+Metadata-Version: 2.1
+Name: najaeda
+Version: 0.1.6
+Summary: Naja EDA Python package
+Author-Email: Naja Authors <contact@keplertech.io>
+License: Apache License 2.0
+Project-URL: Homepage, https://github.com/najaeda/naja
+Requires-Python: >=3.8
+Description-Content-Type: text/x-rst
+
+Naja EDA Python Package
+=======================
+
+Naja EDA is a Python package that provides data structures and APIs for developing post-synthesis Electronic Design Automation (EDA) algorithms.
+
+Naja EDA provides a powerful yet simple framework designed to help software
+and hardware developers efficiently navigate and manipulate electronic
+design automation (EDA) workflows.
+
+With Naja EDA, you can:
+
+* Explore Netlists with Ease:
+
+  * Navigate netlist hierarchy and connectivity effortlessly.
+  * Browse at multiple levels of detail:
+
+    * Bit-level or bus-level granularity.
+    * Instance-by-instance exploration or flattened views at the primitives level.
+    * Localized per-instance connections or comprehensive equipotential views.
+
+* Perform ECO (Engineering Change Order) Transformations:
+
+  * Seamlessly apply and manage changes to your designs.
+
+* Prototype EDA Ideas Quickly:
+
+  * Use an intuitive API to experiment with new EDA concepts and workflows.
+
+* Develop Custom EDA Tools:
+
+  * Build fast, tailored tools for solving specific challenges without relying on costly, proprietary EDA software.
+
+Naja EDA empowers developers to innovate, adapt, and accelerate their EDA
+processes with minimal overhead.
+
+Naja EDA is the Python counterpart of the `Naja C++ project <https://github.com/najaeda/naja>`_.
+
+Installation
+------------
+
+Install Naja EDA using pip:
+
+.. code-block:: bash
+
+    pip install najaeda
+
+Examples
+--------
+
+Load a design from a liberty file and a Verilog file
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Following snippet shows how to load primitive cells from a liberty file and
+a netlist from a Verilog file.
+
+.. code-block:: python
+
+    benchmarks = path.join('..','benchmarks')
+    liberty_files = [
+        'NangateOpenCellLibrary_typical.lib',
+        'fakeram45_1024x32.lib',
+        'fakeram45_64x32.lib'
+    ]
+    liberty_files = list(map(lambda p:path.join(benchmarks, 'liberty', p), liberty_files))
+        
+    netlist.load_liberty(liberty_files)
+    top = netlist.load_verilog([path.join(benchmarks, 'verilog', 'tinyrocket.v')])
+    
+    top.dump_verilog('.', 'tinyrocket_naja.v')
+
+Load a design with pre-existing libraries
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+In FPGA design environments, Liberty files are often unavailable.
+
+To address this, the following example demonstrates how to load primitives
+without relying on Liberty files.
+
+Naja EDA comes with pre-configured libraries to simplify this process.
+Currently, it includes support for partial Xilinx primitives, but this can be
+easily extended in the future. Don't hesitate to reach out if you need help.
+
+.. code-block:: python
+
+    netlist.load_primitives('xilinx')
+    benchmarks = path.join('..','benchmarks')
+    top = netlist.load_verilog([path.join(benchmarks, 'verilog', 'arm_core_netlist.v')])
+
+Print all the instances in the netlist
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Next example shows how to browse all the netlist and print all its content recursively.
+
+.. code-block:: python
+
+    def print_netlist(instance):
+        for child_instance in instance.get_child_instances():
+            print(f"{child_instance}:{child_instance.get_model_name()}")
+            print_netlist(child_instance)
+
+Similar to the previous example, but utilizing an instance visitor.
+This approach allows you to perform operations on each instance while
+also defining conditions for stopping or continuing exploration.
+
+.. code-block:: python
+
+    def print_instance(instance):
+        print(f"{instance}:{instance.get_model_name()}")
+    visitor_config = instance_visitor.VisitorConfig(callback=print_instance)
+    instance_visitor.Visitor(top).visit(top, visitor_config)
+
+Counting the Number of Leaves in a Netlist
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+The instance visitor provides a tool for collecting various types of information
+about a netlist.
+
+The following example demonstrates how to use the visitor’s callback
+function to transmit user-defined arguments, allowing for flexible data processing.
+
+This specific use case shows how to count the number of leaf instances in a netlist.
+
+.. code-block:: python
+
+    leaves = {"count": 0, "assigns": 0, "constants": 0}
+    def count_leaves(instance, leaves):
+        if instance.is_leaf():
+            if instance.is_assign():
+                leaves["assigns"] += 1
+            elif instance.is_const():
+                leaves["constants"] += 1
+            else:
+                leaves["count"] += 1
+    visitor_config = instance_visitor.VisitorConfig(callback=count_leaves, args=(leaves,))
+    instance_visitor.Visitor(top).visit(top, visitor_config)
+    print(f"{top} leaves count")
+    print(f"nb_assigns={leaves['assigns']}")
+    print(f"nb constants={leaves['constants']}")
+    print(f"nb other leaves={leaves['count']}")
+
+Documentation
+-------------
+Naja EDA is a work in progress, and the documentation is still under development.
+
+Naja documentation is available on the `Naja GitHub repository <https://github.com/najaeda/naja>`_.
+
+Support
+-------
+If you encounter any issues or have questions, please report them on the
+`Naja issue tracker <https://github.com/najaeda/naja/issues>`_.
+
+License
+-------
+This project is licensed under the Apache License 2.0. \
+See the `LICENSE <https://github.com/najaeda/naja/blob/main/LICENSE>`_ file for details.

najaeda-0.1.6.dist-info/RECORD

@@ -0,0 +1,18 @@
+najaeda/netlist.py,sha256=Lg0JHaYD1xJl-tOFxdUorkev8TonBP8RNqDnxViOsxg,25751
+najaeda/libnaja_snl_python.dylib,sha256=B-L2hEAoNpBVgg5DVp0jXNPkDZfyGZ9UC6e_CZcIyYw,740160
+najaeda/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+najaeda/libnaja_snl.dylib,sha256=8Ei7KKU0b14IqlvH_8yQSSCpH0rjbxpeRaXgyfSemMY,574112
+najaeda/snl.so,sha256=2vv_LPtR0B-txFyT1mZYaYoaqPw6vd42BX2UROwOR8A,97888
+najaeda/instance_visitor.py,sha256=2HnQ5y8-0tSOKd9nS4WYiypccQWLJgKfs84wp357Tls,1781
+najaeda/docs/Makefile,sha256=4zv3TVkTACm6JBaKgTES3ZI9cETXgM6ULbZkXZP1as8,638
+najaeda/docs/make.bat,sha256=L4I5T7uDUIjwGyMRJ-y9FoT61sxIyCuaYuJyLt8c-nA,804
+najaeda/docs/source/index.rst,sha256=VBWfJySZ9v8mWfWt3kuSCZh7Gp0zUrFjXGQH7tZZfy0,323
+najaeda/docs/source/conf.py,sha256=3qkykCg12ZYqawHl8VEg2Fti6rc3G-soGYM0L6zL3CU,1387
+najaeda/docs/source/api.rst,sha256=H2Bw0JmHS9z-NhQARepmH74wsWHzjSVPbeXppSmtgCQ,141
+najaeda/primitives/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+najaeda/primitives/xilinx.py,sha256=fuu4KxEIuC0ueCK4C_gds6hzgtJsLE3tjDtOHtY9McM,25947
+najaeda-0.1.6.dist-info/RECORD,,
+najaeda-0.1.6.dist-info/WHEEL,sha256=bS2kxwU1pioFffhNQmlfvjD0H1flBf5ZtxV4jDj8Nvc,114
+najaeda-0.1.6.dist-info/METADATA,sha256=BNHiU6acY0ppMEC7I66Q34H4oDDalUoepVBas2Oqr5E,5608
+najaeda-0.1.6.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+najaeda-0.1.6.dist-info/licenses/AUTHORS,sha256=7NYEGDAX_1QZvCCHfq8YVXC5ZbwH_pbNI8DcSmm70GU,377

najaeda-0.1.4.dist-info/METADATA

@@ -1,86 +0,0 @@
-Metadata-Version: 2.1
-Name: najaeda
-Version: 0.1.4
-Summary: Naja EDA Python package
-Author-Email: Naja Authors <contact@keplertech.io>
-License: Apache License 2.0
-Project-URL: Homepage, https://github.com/najaeda/naja
-Requires-Python: >=3.8
-Description-Content-Type: text/x-rst
-
-Naja EDA Python Package
-=======================
-
-Naja EDA is a Python package that provides data structures and APIs for developing post-synthesis Electronic Design Automation (EDA) algorithms.
-It serves as the Python counterpart to the `Naja C++ project <https://github.com/najaeda/naja>`_.
-
-Installation
-------------
-
-Install Naja EDA using pip:
-
-.. code-block:: bash
-
-    pip install najaeda
-
-Examples
---------
-
-Load a design from a liberty file and a Verilog file
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Following snippet shows how to load primitive cells from a liberty file and
-a netlist from a Verilog file.
-
-.. code-block:: python
-
-    benchmarks = path.join('..','benchmarks')
-    liberty_files = [
-        'NangateOpenCellLibrary_typical.lib',
-        'fakeram45_1024x32.lib',
-        'fakeram45_64x32.lib'
-    ]
-    liberty_files = list(map(lambda p:path.join(benchmarks, 'liberty', p), liberty_files))
-        
-    netlist.load_liberty(liberty_files)
-    top = netlist.load_verilog([path.join(benchmarks, 'verilog', 'tinyrocket.v')])
-    
-    top.dump_verilog('.', 'tinyrocket_naja.v')
-
-Load a design with pre-existing libraries
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-In FPGA design environments, Liberty files are often unavailable.
-To address this, the following example demonstrates how to load primitives
-without relying on Liberty files.
-
-najaeda comes with pre-configured libraries to simplify this process.
-Currently, it includes support for partial Xilinx primitives, but this can be
-easily extended in the future. Don't hesitate to reach out if you need help.
-
-.. code-block:: python
-
-    netlist.load_primitives('xilinx')
-    benchmarks = path.join('..','benchmarks')
-    top = netlist.load_verilog([path.join(benchmarks, 'verilog', 'arm_core_netlist.v')])
-    #
-
-Print all the instances in the netlist
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Next example shows how to browse all the netlist and print all its content.
-
-.. code-block:: python
-
-    def print_netlist(instance):
-        for child_instance in instance.get_child_instances():
-            print(f"{child_instance}:{child_instance.get_model_name()}")
-            print_netlist(child_instance)
-
-Documentation
--------------
-najaeda is a work in progress, and the documentation is still under development.
-
-Naja documentation is available on the `Naja GitHub repository <https://github.com/najaeda/naja>`_.
-
-License
--------
-
-This project is licensed under the Apache License 2.0. See the `LICENSE <https://github.com/najaeda/naja/blob/main/LICENSE>`_ file for details.

najaeda-0.1.4.dist-info/RECORD

@@ -1,12 +0,0 @@
-najaeda-0.1.4.dist-info/RECORD,,
-najaeda-0.1.4.dist-info/WHEEL,sha256=bS2kxwU1pioFffhNQmlfvjD0H1flBf5ZtxV4jDj8Nvc,114
-najaeda-0.1.4.dist-info/METADATA,sha256=rpver3Febf2UhLXS-HAceNHU3YnNLGKde1icywDK_-Y,2842
-najaeda-0.1.4.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-najaeda-0.1.4.dist-info/licenses/AUTHORS,sha256=7NYEGDAX_1QZvCCHfq8YVXC5ZbwH_pbNI8DcSmm70GU,377
-najaeda/netlist.py,sha256=ena4A9S1UxQV-pO1XWxO_qbG-4ELnorKInJgX0zN3M0,25633
-najaeda/libnaja_snl_python.dylib,sha256=GR1KlfHbg2X3aYcQKgjWbWnwEorGvrANrcYh8KEkdbg,740160
-najaeda/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-najaeda/libnaja_snl.dylib,sha256=8Ei7KKU0b14IqlvH_8yQSSCpH0rjbxpeRaXgyfSemMY,574112
-najaeda/snl.so,sha256=2vv_LPtR0B-txFyT1mZYaYoaqPw6vd42BX2UROwOR8A,97888
-najaeda/primitives/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-najaeda/primitives/xilinx.py,sha256=fuu4KxEIuC0ueCK4C_gds6hzgtJsLE3tjDtOHtY9McM,25947