najaeda 0.1.11__cp312-cp312-macosx_11_0_arm64.whl → 0.1.12__cp312-cp312-macosx_11_0_arm64.whl

najaeda/docs/source/common_classes.rst

@@ -0,0 +1,11 @@
+Common Classes
+==============
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+.. autoclass:: najaeda.netlist.Attribute
+    :members:
+    :undoc-members:
+    :show-inheritance:

najaeda/docs/source/index.rst

@@ -11,9 +11,7 @@ najaeda documentation
    :caption: Contents:
 
    introduction
-   instance
-   term
-   net
-   equipotential
+   netlist_classes
+   common_classes
    examples
    api

najaeda/docs/source/netlist_classes.rst

@@ -0,0 +1,11 @@
+Netlist Classes
+===============
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+   
+   instance
+   term
+   net
+   equipotential

najaeda/netlist.py

@@ -727,12 +727,24 @@ class Attribute:
         return str(self.snlAttribute)
 
     def get_name(self):
+        """
+        :return: the name of the attribute.
+        :rtype: str
+        """
         return self.snlAttribute.getName()
 
     def has_value(self):
+        """
+        :return: True if the attribute has a value.
+        :rtype: bool
+        """
         return self.snlAttribute.hasValue()
 
     def get_value(self):
+        """
+        :return: the value of the attribute.
+        :rtype: str
+        """
         return self.snlAttribute.getValue()
 
 
@@ -774,6 +786,7 @@ class Instance:
     def get_leaf_children(self):
         """Iterate over the leaf children of this Instance.
         Equivalent to the underlying leaves of the instanciation tree.
+
         :return: an iterator over the leaf children Instance of this Instance.
         :rtype: Iterator[Instance]
         """
@@ -801,7 +814,7 @@ class Instance:
         return len(self.pathIDs) == 0
 
     def is_assign(self) -> bool:
-        """Example: (assign a=b) will create an instance of assign connecting
+        """(assign a=b) will create an instance of assign connecting
         the wire a to the output of the assign and b to the input.
 
         :return: True if this is an assign. Assigns are represented with
@@ -1041,8 +1054,11 @@ class Instance:
                 yield Term(self.pathIDs, term)
 
     def get_flat_output_terms(self):
-        """Return the flat output terms of the instance.
-        This will iterate over all scalar output terms and bus output term bits.
+        """Iterate over all scalar output terms and bus output term bits
+        of this Instance.
+
+        :return: the flat output terms of this Instance.
+        :rtype: Iterator[Term]
         """
         for term in self.__get_snl_model().getTerms():
             if term.getDirection() != snl.SNLTerm.Direction.Input:
@@ -1053,6 +1069,11 @@ class Instance:
                     yield Term(self.pathIDs, term)
 
     def get_attributes(self):
+        """Iterate over the attributes of this Instance.
+
+        :return: the attributes of this Instance.
+        :rtype: Iterator[Attribute]
+        """
         leaf_object = self.__get_leaf_snl_object()
         for attribute in leaf_object.getAttributes():
             yield Attribute(attribute)
@@ -1191,6 +1212,7 @@ class Instance:
 
     def create_bus_term(self, name: str, msb: int, lsb: int, direction) -> Term:
         """Create a bus Term in this Instance with the given name, msb, lsb and direction.
+
         :param str name: the name of the Term to create.
         :param int msb: the most significant bit of the Term to create.
         :param int lsb: the least significant bit of the Term to create.
@@ -1328,7 +1350,9 @@ def load_liberty(files: list):
 
 def load_primitives(name: str):
     """Loads a primitive library embedded in najaeda.
+
     Currently supported libraries are:
+
     - xilinx
     """
     if name == "xilinx":

najaeda-0.1.12.dist-info/METADATA

@@ -0,0 +1,79 @@
+Metadata-Version: 2.1
+Name: najaeda
+Version: 0.1.12
+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>`_.
+
+If you’re interested in this project, please consider starring it on GitHub.
+Feel free to reach out to us anytime at `contact@keplertech.io <mailto:contact@keplertech.io>`_.
+
+Installation
+------------
+
+Install Naja EDA using pip:
+
+.. code-block:: bash
+
+    pip install najaeda
+
+Documentation
+-------------
+
+Naja EDA online documentation is available `here <https://najaeda.readthedocs.io/en/latest/index.html>`_.
+
+Examples
+--------
+
+A list of examples can be found in this
+documentation `section <https://najaeda.readthedocs.io/en/latest/examples.html>`_.
+
+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.11.dist-info → najaeda-0.1.12.dist-info}/RECORD

@@ -1,19 +1,14 @@
-najaeda-0.1.11.dist-info/RECORD,,
-najaeda-0.1.11.dist-info/WHEEL,sha256=bS2kxwU1pioFffhNQmlfvjD0H1flBf5ZtxV4jDj8Nvc,114
-najaeda-0.1.11.dist-info/METADATA,sha256=Kl445PNmMAaclhm5MqkBms6A5AmGvDpGs8aFr36wyMw,7218
-najaeda-0.1.11.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-najaeda-0.1.11.dist-info/licenses/AUTHORS,sha256=7NYEGDAX_1QZvCCHfq8YVXC5ZbwH_pbNI8DcSmm70GU,377
-najaeda/netlist.py,sha256=xutSwtSsMHtXefn8vG1JVMUm_XZMOv_6wQfxywDvF8U,46275
-najaeda/libnaja_snl_python.dylib,sha256=MOxwcsPWDKcAMCg4fmDQo2RtC0SKLXg5Z4bc0XWzZtc,825616
+najaeda/netlist.py,sha256=8p0iHWDNbsMo-DndUBKLc43j7agtgb_jhlQdgkoYpvU,46750
+najaeda/libnaja_snl_python.dylib,sha256=4G2S6jvPYE2Us6x08zaELur4TbqfUYK7e3QVYkfiw_Q,825616
 najaeda/pandas_stats.py,sha256=yOb4ka965U7rN4D6AwvSGmRyeT_O7Ed-5cmT8BFbfeo,1070
 najaeda/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-najaeda/libnaja_snl.dylib,sha256=Vnih_WkRfWljfXKCkqkDY43NQ7RtHgCI7-YfS7i0vQY,574176
+najaeda/libnaja_snl.dylib,sha256=T76kBcwP4dGXUXS5aD1mcNr5hBAL8ou-nJGQNg7tXIA,574160
 najaeda/snl.so,sha256=v80hVD1Hzs7kL5p_rZVfno3pyUd_cuuL5F9IhI_I7D8,98272
 najaeda/stats.py,sha256=xWiIHa-S9yCHgAjyi6fVtx9C96o9v4MkYU7x5GdRKwA,16250
 najaeda/instance_visitor.py,sha256=JMsPSQaWNiDjxS05rxg83a0PIsrOIuTi9G35hkwdibs,1530
 najaeda/docs/requirements.txt,sha256=1XIBGTIplm2arC9HhDCfLuAjozGdVSXkqmOj8ybuT6U,121
 najaeda/docs/.readthedocs.yaml,sha256=nN_Psro-YdfPcIiueZkJcZepts68g23rqVThhKnmVRw,790
-najaeda/docs/source/index.rst,sha256=otNU_o72UQp2jEiF4ymADbfU8OeZqQme0K_JQz4kfSU,394
+najaeda/docs/source/index.rst,sha256=80VMfeEGHObnOUXRBxIzISQsG_HNkgT-pUpsDZsCfOY,387
 najaeda/docs/source/instance.rst,sha256=7B2IBB0p32Tb4qvOCE77OlrQaYpFADvmTlq1q8eyVqw,458
 najaeda/docs/source/conf.py,sha256=iSeerg2pJlZlhtwkJ9edRRYrLEdx3R1p7GWi78dHP1o,2019
 najaeda/docs/source/preprocessor.py,sha256=TK4LsTdNbv2dxkKQaJ7cEyo9PU5v_56vlrFCJYIPKf8,2625
@@ -21,8 +16,15 @@ najaeda/docs/source/term.rst,sha256=QKWT6u1xjEjusvcZYknKQ-M83ibohO5y1EYTQnnXqak,
 najaeda/docs/source/net.rst,sha256=i6YEir8ZOldSY8-UmPxgVJ4Ot3y-Q6seRkBr2H-KmXc,732
 najaeda/docs/source/visitors.rst,sha256=KScCr7BytrhFxWfZPyYWIrr3CEJuk5Tx-LjEuDnnBaA,227
 najaeda/docs/source/examples.rst.in,sha256=4ZStOA3N5VHbKZgdn2kaEQZL7wPoJwODS2E1BO54uFY,2091
+najaeda/docs/source/common_classes.rst,sha256=o20u3mcpFYINwy0sVdye90ZPMQcPqoH3V4ERKcG7SZI,181
 najaeda/docs/source/equipotential.rst,sha256=0MDi-4fPEsX7K_ezWj5DB3mCalnhqN-sicYbQKYQfNc,335
+najaeda/docs/source/netlist_classes.rst,sha256=Zrha9MQVEdEwxmP2zhgC0K3iioZXXerzeFoOz5SrOXM,132
 najaeda/docs/source/introduction.rst,sha256=kE4qxEJCgcAswiT3rIJS21oBYIMg1cyT_rKmOzQgvsI,2095
 najaeda/docs/source/api.rst,sha256=47VCPyF4Py_1cklZ3q9fmOMhqqI17rxwU_VUJETfCwY,151
 najaeda/primitives/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 najaeda/primitives/xilinx.py,sha256=fuu4KxEIuC0ueCK4C_gds6hzgtJsLE3tjDtOHtY9McM,25947
+najaeda-0.1.12.dist-info/RECORD,,
+najaeda-0.1.12.dist-info/WHEEL,sha256=bS2kxwU1pioFffhNQmlfvjD0H1flBf5ZtxV4jDj8Nvc,114
+najaeda-0.1.12.dist-info/METADATA,sha256=SlRgiK7xMLvNflXb_hKnXr7WamPV2wijr-qtmyqUH20,2475
+najaeda-0.1.12.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+najaeda-0.1.12.dist-info/licenses/AUTHORS,sha256=7NYEGDAX_1QZvCCHfq8YVXC5ZbwH_pbNI8DcSmm70GU,377

najaeda-0.1.11.dist-info/METADATA

@@ -1,203 +0,0 @@
-Metadata-Version: 2.1
-Name: najaeda
-Version: 0.1.11
-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
-
-Documentation
--------------
-
-Naja EDA online documentation is available `here <https://najaeda.readthedocs.io/en/latest/index.html>`_.
-
-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', 'vexriscv.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.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.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']}")
-
-DLE (Dead Logic Elimination)
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-This example demonstrates how to perform Dead Logic Elimination (DLE) on a netlist.
-
-.. code-block:: python
-
-    def apply_dle(top):
-        # Trace back from design outputs
-        visited = set()
-        traced_terms = top.get_flat_output_terms()
-        for leaf in top.get_leaf_children():
-            atrributes =  list(leaf.get_attributes())
-            for attr in atrributes:
-                if attr.get_name() == 'DONT_TOUCH' or attr.get_name() == 'KEEP' or attr.get_name() == 'preserve' or attr.get_name() == 'noprune':
-                    for term in leaf.get_flat_input_terms():
-                        traced_terms.append(term)
-        for termToTrace in traced_terms:
-            queue = deque([termToTrace])
-            while queue:
-                term = queue.popleft()
-                if term in visited:
-                    continue
-                visited.add(term)
-                equipotential = term.get_equipotential()
-                leaf_drivers = equipotential.get_leaf_drivers()
-                for driver in leaf_drivers:
-                    instance = driver.get_instance()
-                    instances.add(instance)
-                    input_terms = instance.get_flat_input_terms()
-                    queue.extend(input_terms)
-        
-        
-        to_delete = [leaf for leaf in top.get_leaf_children() if leaf not in instances]
-        for leaf in to_delete:
-            leaf.delete()
-        return to_delete
-
-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.