najaeda 0.1.7__cp312-cp312-macosx_11_0_arm64.whl → 0.1.8__cp312-cp312-macosx_11_0_arm64.whl

najaeda/docs/.readthedocs.yaml

@@ -11,18 +11,12 @@ version: 2
 # Set the OS, Python version and other tools you might need
 build:
   os: ubuntu-22.04
-  apt_packages:
-    - cmake
   tools:
     python: "3.12"
-    # You can also specify other tool versions:
-    # nodejs: "19"
-    # rust: "1.64"
-    # golang: "1.19"
 
 # Build documentation in the "docs/" directory with Sphinx
 sphinx:
-   configuration: docs/conf.py
+   configuration: src/najaeda/najaeda/docs/source/conf.py
 
 # Optionally build your docs in additional formats such as PDF and ePub
 # formats:
@@ -34,4 +28,4 @@ sphinx:
 # See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
 python:
     install:
-    - requirements: docs/requirements.txt
+    - requirements: src/najaeda/najaeda/docs/requirements.txt

najaeda/docs/requirements.txt

@@ -0,0 +1,7 @@
+docutils>=0.12
+Jinja2>=2.7.3
+MarkupSafe>=0.23
+Pygments>=1.6
+Sphinx>=4.0,!=5.0.0
+Breathe>=v4.35.0
+sphinx_rtd_theme>=1.3.0

najaeda/docs/source/api.rst

@@ -1,5 +1,5 @@
-najaeda API Documentation
-=========================
+najaeda Complete API Documentation
+==================================
 
 .. automodule:: najaeda.netlist
     :members:

najaeda/docs/source/conf.py

@@ -15,7 +15,7 @@ sys.path.insert(0, os.path.abspath('../../../'))
 project = 'najaeda'
 copyright = '2024, Naja authors'
 author = 'Naja authors'
-release = '0.1.6'
+release = '0.1.8'
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

najaeda/docs/source/equipotential.rst

@@ -0,0 +1,20 @@
+Equipotential Class
+===================
+
+.. automodule:: najaeda.equipotential
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Equipotential Overview
+----------------------
+
+The `Equipotential` class is responsible for managing equipotentials in the `najaeda` system.
+
+Equipotential Attributes
+------------------------
+
+.. autoclass:: najaeda.netlist.Equipotential
+    :members:
+    :undoc-members:
+    :show-inheritance:

najaeda/docs/source/index.rst

@@ -10,4 +10,8 @@ najaeda documentation
    :maxdepth: 2
    :caption: Contents:
 
+   instance
+   term
+   net
+   equipotential
    api

najaeda/docs/source/instance.rst

@@ -0,0 +1,23 @@
+Instance Class
+==============
+
+.. automodule:: najaeda.instance
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Instance Overview
+-----------------
+
+In `najaeda`, an `Instance` encapsulates the concept of an instance in its hierarchical context.
+
+When an `Instance` is modified through editing methods,
+`najaeda` will automatically manage the necessary uniquification.
+
+Instance Attributes
+-------------------
+
+.. autoclass:: najaeda.netlist.Instance
+    :members:
+    :undoc-members:
+    :show-inheritance:

najaeda/docs/source/net.rst

@@ -0,0 +1,20 @@
+Net Class
+=========
+
+.. automodule:: najaeda.net
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Net Overview
+------------
+
+The `Net` class is responsible for managing nets in the `najaeda` system.
+
+Net Attributes
+--------------
+
+.. autoclass:: najaeda.netlist.Net
+    :members:
+    :undoc-members:
+    :show-inheritance:

najaeda/docs/source/term.rst

@@ -0,0 +1,20 @@
+Term Class
+==========
+
+.. automodule:: najaeda.term
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Term Overview
+-------------
+
+The `Term` class is responsible for managing terms in the `najaeda` system.
+
+Term Attributes
+---------------
+
+.. autoclass:: najaeda.netlist.Term
+    :members:
+    :undoc-members:
+    :show-inheritance:

najaeda/netlist.py

@@ -32,7 +32,6 @@ def consistent_hash(obj):
             return b''.join(hash_object(i) for i in o)
         else:
             return hash_value(o)
-
     serialized_obj = default_serializer(obj)
     obj_bytes = hash_object(serialized_obj)
     return int(hashlib.sha256(obj_bytes).hexdigest(), 16)
@@ -71,6 +70,7 @@ class Equipotential:
 
     def __init__(self, term):
         snl_term = get_snl_term_for_ids(term.pathIDs, term.termIDs)
+        inst_term = None
         if isinstance(snl_term, snl.SNLBusTerm):
             raise ValueError("Equipotential cannot be constructed on bus term")
         if len(term.pathIDs) == 0:
@@ -82,10 +82,11 @@ class Equipotential:
             if inst_term is None:
                 self.equi = None
                 return
+            else:
+                snl_term = get_snl_term_for_ids(inst_term.pathIDs, inst_term.termIDs)
         else:
             inst_term = term
         path = get_snl_path_from_id_list(inst_term.pathIDs)
-        snl_term = get_snl_term_for_ids(inst_term.pathIDs, inst_term.termIDs)
         ito = snl.SNLNetComponentOccurrence(
             path.getHeadPath(),
             path.getTailInstance().getInstTerm(snl_term)
@@ -95,6 +96,9 @@ class Equipotential:
     def __eq__(self, value):
         return self.equi == value.equi
 
+    def dump_dot(self, path: str):
+        self.equi.dumpDotFile(path)
+
     def get_inst_terms(self):
         if self.equi is not None:
             for term in self.equi.getInstTermOccurrences():
@@ -106,7 +110,7 @@ class Equipotential:
     def get_top_terms(self):
         if self.equi is not None:
             for term in self.equi.getTerms():
-                yield Term(snl.SNLPath(), term)
+                yield Term([], term)
 
     def get_leaf_readers(self):
         if self.equi is not None:
@@ -151,10 +155,13 @@ class Net:
             raise ValueError(
                 "Only one of `net` or `net_concat` should be provided, not both."
             )
-        if path.size() > 0:
-            self.pathIDs = path.getPathIDs()
-        else:
-            self.pathIDs = []
+        if isinstance(path, snl.SNLPath):
+            if path.size() > 0:
+                self.pathIDs = path.getPathIDs()
+            else:
+                self.pathIDs = []
+        elif isinstance(path, list):
+            self.pathIDs = path.copy()
         if net is not None:
             self.net = net
         elif net_concat is not None:
@@ -235,11 +242,10 @@ class Net:
         return sum(1 for _ in self.net_concat)
 
     def get_bits(self):
-        path = get_snl_path_from_id_list(self.pathIDs)
         if hasattr(self, "net"):
             if isinstance(self.net, snl.SNLBusNet):
                 for bit in self.net.getBits():
-                    yield Net(path, bit)
+                    yield Net(self.pathIDs, bit)
             else:
                 yield self
         else:
@@ -247,30 +253,28 @@ class Net:
                 yield net
 
     def get_bit(self, index: int):
-        path = get_snl_path_from_id_list(self.pathIDs)
         if hasattr(self, "net"):
             if isinstance(self.net, snl.SNLBusNet):
-                return Net(path, self.net.getBit(index))
+                return Net(self.pathIDs, self.net.getBit(index))
             else:
                 return None
         if 0 <= index < len(self.net_concat):
-            return Net(path, self.net_concat[index])
+            return Net(self.pathIDs, self.net_concat[index])
         return None
 
     def get_inst_terms(self):
-        init_path = get_snl_path_from_id_list(self.pathIDs)
         if hasattr(self, "net_concat"):
             raise ValueError("Cannot get inst terms from a net_concat")
         for term in self.net.getInstTerms():
-            path = snl.SNLPath(init_path, term.getInstance())
+            path = self.pathIDs.copy()
+            path.append(term.getInstance().getID())
             yield Term(path, term.getBitTerm())
 
     def get_design_terms(self):
-        path = get_snl_path_from_id_list(self.pathIDs)
         if hasattr(self, "net_concat"):
             raise ValueError("Cannot get terms from a net_concat")
         for term in self.net.getBitTerms():
-            yield Term(path, term)
+            yield Term(self.pathIDs, term)
 
     def get_terms(self):
         for term in itertools.chain(self.get_design_terms(), self.get_inst_terms()):
@@ -306,10 +310,13 @@ class Term:
         else:
             self.termIDs = [term.getID(), term.getBit()]
 
-        if path.size() > 0:
-            self.pathIDs = path.getPathIDs()
-        else:
-            self.pathIDs = []
+        if isinstance(path, snl.SNLPath):
+            if path.size() > 0:
+                self.pathIDs = path.getPathIDs()
+            else:
+                self.pathIDs = []
+        elif isinstance(path, list):
+            self.pathIDs = path.copy()
 
     def __eq__(self, other) -> bool:
         return self.pathIDs == other.pathIDs and self.termIDs == other.termIDs
@@ -453,23 +460,21 @@ class Term:
         return None
 
     def get_lower_net(self) -> Net:
-        path = get_snl_path_from_id_list(self.pathIDs)
         """Return the lower net of the term."""
-        return self.__get_net(path, self.__get_snl_lower_bitnet)
+        return self.__get_net(self.pathIDs, self.__get_snl_lower_bitnet)
 
     def get_net(self) -> Net:
         """Return the net of the term."""
-        path = get_snl_path_from_id_list(self.pathIDs)
-        if path.empty():
+        head_path = self.pathIDs.copy()
+        if len(head_path) == 0:
             return None
         # path is one level up
-        head_path = path.getHeadPath()
+        head_path.pop()
         return self.__get_net(head_path, self.__get_snl_bitnet)
 
     def get_instance(self):
-        path = get_snl_path_from_id_list(self.pathIDs)
         """Return the instance of the term."""
-        return Instance(path)
+        return Instance(self.pathIDs)
 
     def get_flat_fanout(self):
         return self.get_equipotential().get_leaf_readers()
@@ -488,17 +493,16 @@ class Term:
         return snlterm.getDirection() == snl.SNLTerm.Direction.Output
 
     def get_bits(self):
-        path = get_snl_path_from_id_list(self.pathIDs)
         if isinstance(get_snl_term_for_ids(self.pathIDs, self.termIDs), snl.SNLBusTerm):
             for bit in get_snl_term_for_ids(self.pathIDs, self.termIDs).getBits():
-                yield Term(path, bit)
+                yield Term(self.pathIDs, bit)
         else:
             yield self
 
     def get_bit(self, index: int):
-        path = get_snl_path_from_id_list(self.pathIDs)
         if isinstance(get_snl_term_for_ids(self.pathIDs, self.termIDs), snl.SNLBusTerm):
-            return Term(path, get_snl_term_for_ids(self.pathIDs, self.termIDs).getBit(index))
+            return Term(self.pathIDs, get_snl_term_for_ids(
+                        self.pathIDs, self.termIDs).getBit(index))
         return None
 
     def disconnect(self):
@@ -564,10 +568,13 @@ class Instance:
     """
 
     def __init__(self, path=snl.SNLPath()):
-        if path.size() > 0:
-            self.pathIDs = path.getPathIDs()
-        else:
-            self.pathIDs = []
+        if isinstance(path, snl.SNLPath):
+            if path.size() > 0:
+                self.pathIDs = path.getPathIDs()
+            else:
+                self.pathIDs = []
+        elif isinstance(path, list):
+            self.pathIDs = path.copy()
 
     def __eq__(self, other) -> bool:
         return self.pathIDs == other.pathIDs
@@ -658,17 +665,26 @@ class Instance:
                     return found_model
         return None
 
+    def dump_full_dot(self, path: str):
+        """Dump the full dot file of this instance."""
+        self.__get_snl_model().dumpFullDotFile(path)
+
+    def dump_context_dot(self, path: str):
+        self.__get_snl_model().dumpContextDotFile(path)
+
     def get_child_instance(self, name: str):
+        """Return the child instance with the given name."""
         childInst = self.__get_snl_model().getInstance(name)
         if childInst is None:
             return None
-        path = get_snl_path_from_id_list(self.pathIDs)
-        return Instance(snl.SNLPath(path, childInst))
+        path = self.pathIDs.copy()
+        path.append(childInst.getID())
+        return Instance(path)
 
     def get_child_instances(self):
         for inst in self.__get_snl_model().getInstances():
-            path_init = get_snl_path_from_id_list(self.pathIDs)
-            path = snl.SNLPath(path_init, inst)
+            path = self.pathIDs.copy()
+            path.append(inst.getID())
             yield Instance(path)
 
     def get_number_of_child_instances(self) -> int:
@@ -691,24 +707,28 @@ class Instance:
     #                stack.append([inst_child, path_child])
 
     def get_nets(self):
-        path = get_snl_path_from_id_list(self.pathIDs)
+        """Return the nets of the instance.
+        This will iterate over all scalar nets and bus nets.
+        """
         for net in self.__get_snl_model().getNets():
-            yield Net(path, net)
+            yield Net(self.pathIDs, net)
 
     def get_flat_nets(self):
-        path = get_snl_path_from_id_list(self.pathIDs)
+        """Return the nets of the instance.
+        This will iterate over all scalar nets and bus net bits.
+        """
         for net in self.__get_snl_model().getNets():
             if isinstance(net, snl.SNLBusNet):
                 for bit in net.getBits():
-                    yield Net(path, bit)
+                    yield Net(self.pathIDs, bit)
             else:
-                yield Net(path, net)
+                yield Net(self.pathIDs, net)
 
     def get_net(self, name: str) -> Net:
-        path = get_snl_path_from_id_list(self.pathIDs)
+        """Return the net with the given name."""
         net = self.__get_snl_model().getNet(name)
         if net is not None:
-            return Net(path, net)
+            return Net(self.pathIDs, net)
         return None
 
     def is_primitive(self) -> bool:
@@ -716,60 +736,73 @@ class Instance:
         return self.__get_snl_model().isPrimitive()
 
     def get_terms(self):
-        path = get_snl_path_from_id_list(self.pathIDs)
+        """Return the terms of the instance.
+        This will iterate over all scalar terms and bus terms.
+        """
         for term in self.__get_snl_model().getTerms():
-            yield Term(path, term)
+            yield Term(self.pathIDs, term)
 
     def get_flat_terms(self):
-        path = get_snl_path_from_id_list(self.pathIDs)
+        """Return the flat terms of the instance.
+        This will iterate over all scalar terms and bus term bits.
+        """
         for term in self.__get_snl_model().getBitTerms():
-            yield Term(path, term)
+            yield Term(self.pathIDs, term)
 
     def get_term(self, name: str) -> Term:
-        path = get_snl_path_from_id_list(self.pathIDs)
+        """Return the term with the given name."""
         term = self.__get_snl_model().getTerm(name)
         if term is not None:
-            return Term(path, self.__get_snl_model().getTerm(name))
+            return Term(self.pathIDs, self.__get_snl_model().getTerm(name))
         return None
 
     def get_input_terms(self):
-        path = get_snl_path_from_id_list(self.pathIDs)
+        """Return the input terms of the instance.
+        This will iterate over all scalar input terms and bus input terms.
+        """
         for term in self.__get_snl_model().getTerms():
             if term.getDirection() != snl.SNLTerm.Direction.Output:
-                yield Term(path, term)
+                yield Term(self.pathIDs, term)
 
     def get_flat_input_terms(self):
-        path = get_snl_path_from_id_list(self.pathIDs)
+        """Return the flat input terms of the instance.
+        This will iterate over all scalar input terms and bus input term bits.
+        """
         for term in self.__get_snl_model().getTerms():
             if term.getDirection() != snl.SNLTerm.Direction.Output:
                 if isinstance(term, snl.SNLBusTerm):
                     for bit in term.getBits():
-                        yield Term(path, bit)
+                        yield Term(self.pathIDs, bit)
                 else:
-                    yield Term(path, term)
+                    yield Term(self.pathIDs, term)
 
     def get_output_terms(self):
-        path = get_snl_path_from_id_list(self.pathIDs)
+        """Return the output terms of the instance.
+        This will iterate over all scalar output terms and bus output terms.
+        """
         for term in self.__get_snl_model().getTerms():
             if term.getDirection() != snl.SNLTerm.Direction.Input:
-                yield Term(path, term)
+                yield Term(self.pathIDs, term)
 
     def get_flat_output_terms(self):
-        path = get_snl_path_from_id_list(self.pathIDs)
+        """Return the flat output terms of the instance.
+        This will iterate over all scalar output terms and bus output term bits.
+        """
         for term in self.__get_snl_model().getTerms():
             if term.getDirection() != snl.SNLTerm.Direction.Input:
                 if isinstance(term, snl.SNLBusTerm):
                     for bit in term.getBits():
-                        yield Term(path, bit)
+                        yield Term(self.pathIDs, bit)
                 else:
-                    yield Term(path, term)
+                    yield Term(self.pathIDs, term)
 
     def delete_instance(self, name: str):
-        init_path = get_snl_path_from_id_list(self.pathIDs)
+        """Delete the child instance with the given name."""
         if name == "":
             raise ValueError(
                 "Cannot delete instance with empty name. Try delete_instance_by_id instead."
             )
+        init_path = get_snl_path_from_id_list(self.pathIDs)
         path = snl.SNLPath(init_path, self.__get_snl_model().getInstance(name))
         snl.SNLUniquifier(path)
         if init_path.size() > 0:
@@ -777,6 +810,7 @@ class Instance:
             self.__get_snl_model().getInstance(name).destroy()
 
     def delete_instance_by_id(self, id: str):
+        """Delete the child instance with the given ID."""
         init_path = get_snl_path_from_id_list(self.pathIDs)
         path = snl.SNLPath(init_path, self.__get_snl_model().getInstanceByID(id))
         snl.SNLUniquifier(path)
@@ -784,19 +818,22 @@ class Instance:
         self.__get_snl_model().getInstanceByID(id).destroy()
 
     def get_design(self):
-        path = get_snl_path_from_id_list(self.pathIDs)
+        """Return the Instance containing this instance."""
+        path = self.pathIDs.copy()
         if len(self.pathIDs) == 1:
             return get_top()
-        return Instance(path.getHeadPath())
+        path.pop()
+        return Instance(path)
 
     def delete(self):
+        """Delete this instance."""
         path = get_snl_path_from_id_list(self.pathIDs)
         snl.SNLUniquifier(path)
         self.get_design().delete_instance_by_id(path.getTailInstance().getID())
 
     def get_name(self) -> str:
-        path = get_snl_path_from_id_list(self.pathIDs)
         """Return the name of the instance or name of the top is this is the top."""
+        path = get_snl_path_from_id_list(self.pathIDs)
         if self.is_top():
             return self.get_model_name()
         else:
@@ -807,10 +844,12 @@ class Instance:
         return self.__get_snl_model().getName()
 
     def get_model_id(self) -> tuple[int, int, int]:
+        """Return the ID of the model of the instance or ID of the top is this is the top."""
         model = self.__get_snl_model()
         return model.getDB().getID(), model.getLibrary().getID(), model.getID()
 
     def create_child_instance(self, model: str, name: str):
+        """Create a child instance with the given model and name."""
         path = get_snl_path_from_id_list(self.pathIDs)
         if path.size() > 0:
             snl.SNLUniquifier(path)
@@ -826,6 +865,7 @@ class Instance:
         return Instance(path)
 
     def create_term(self, name: str, direction: snl.SNLTerm.Direction) -> Term:
+        """Create a Term  in this Instance with the given name and direction."""
         path = get_snl_path_from_id_list(self.pathIDs)
         if path.size() > 0:
             snl.SNLUniquifier(path)
@@ -835,15 +875,19 @@ class Instance:
         return Term(path, newSNLTerm)
 
     def create_output_term(self, name: str) -> Term:
+        """Create an output Term in this Instance with the given name."""
         return self.create_term(name, snl.SNLTerm.Direction.Output)
 
     def create_input_term(self, name: str) -> Term:
+        """Create an input Term in this Instance with the given name."""
         return self.create_term(name, snl.SNLTerm.Direction.Input)
 
     def create_inout_term(self, name: str) -> Term:
+        """Create an inout Term in this Instance with the given name."""
         return self.create_term(name, snl.SNLTerm.Direction.InOut)
 
     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."""
         path = get_snl_path_from_id_list(self.pathIDs)
         if path.size() > 0:
             snl.SNLUniquifier(path)
@@ -853,15 +897,19 @@ class Instance:
         return Term(path, newSNLTerm)
 
     def create_inout_bus_term(self, name: str, msb: int, lsb: int) -> Term:
+        """Create an inout bus Term in this Instance with the given name, msb and lsb."""
         return self.create_bus_term(name, msb, lsb, snl.SNLTerm.Direction.InOut)
 
     def create_output_bus_term(self, name: str, msb: int, lsb: int) -> Term:
+        """Create an output bus Term in this Instance with the given name, msb and lsb."""
         return self.create_bus_term(name, msb, lsb, snl.SNLTerm.Direction.Output)
 
     def create_input_bus_term(self, name: str, msb: int, lsb: int) -> Term:
+        """Create an input bus Term in this Instance with the given name, msb and lsb."""
         return self.create_bus_term(name, msb, lsb, snl.SNLTerm.Direction.Input)
 
     def create_net(self, name: str) -> Net:
+        """Create a scalar Net in this Instance with the given name."""
         path = get_snl_path_from_id_list(self.pathIDs)
         if path.size() > 0:
             snl.SNLUniquifier(path)
@@ -871,6 +919,7 @@ class Instance:
         return Net(path, newSNLNet)
 
     def create_bus_net(self, name: str, msb: int, lsb: int) -> Net:
+        """Create a bus Net in this Instance with the given name, msb and lsb."""
         path = get_snl_path_from_id_list(self.pathIDs)
         if path.size() > 0:
             snl.SNLUniquifier(path)
@@ -880,6 +929,7 @@ class Instance:
         return Net(path, newSNLNet)
 
     def dump_verilog(self, path: str, name: str):
+        """Dump the verilog of this instance."""
         self.__get_snl_model().dumpVerilog(path, name)
 
 

najaeda/stats.py

@@ -0,0 +1,320 @@
+# SPDX-FileCopyrightText: 2024 The Naja authors <https://github.com/najaeda/naja/blob/main/AUTHORS>
+#
+# SPDX-License-Identifier: Apache-2.0
+
+import logging
+from najaeda import netlist
+
+
+class DesignsStats:
+    def __init__(self):
+        self.blackboxes = dict()
+        self.hier_designs = dict()
+
+
+class DesignStats:
+    def __init__(self):
+        self.name = ""
+        self.assigns = 0
+        self.flat_assigns = 0
+        self.basic_primitives = dict()
+        self.primitives = dict()
+        self.flat_basic_primitives = dict()
+        self.flat_primitives = dict()
+        self.blackboxes = dict()
+        self.flat_blackboxes = dict()
+        self.ins = dict()
+        self.flat_ins = dict()
+        self.terms = dict()
+        self.bit_terms = dict()
+        self.net_stats = dict()
+
+    def add_ins_stats(self, ins_stats):
+        self.flat_assigns += ins_stats.flat_assigns
+        for ins, nb in ins_stats.flat_ins.items():
+            self.flat_ins[ins] = self.flat_ins.get(ins, 0) + nb
+        for ins, nb in ins_stats.flat_blackboxes.items():
+            self.flat_blackboxes[ins] = self.flat_blackboxes.get(ins, 0) + nb
+        for primitive, nb in ins_stats.flat_primitives.items():
+            self.flat_primitives[primitive] = (
+                self.flat_primitives.get(primitive, 0) + nb
+            )
+        for primitive, nb in ins_stats.flat_basic_primitives.items():
+            self.flat_basic_primitives[primitive] = (
+                self.flat_basic_primitives.get(primitive, 0) + nb
+            )
+
+
+def is_basic_primitive(design):
+    return (
+        design.is_const0() or design.is_const1() or design.is_buf() or design.is_inv()
+    )
+
+
+def compute_design_stats(design, designs_stats):
+    if design.get_model_id() in designs_stats.hier_designs:
+        return designs_stats.hier_designs.get(design.get_model_id())
+    design_stats = DesignStats()
+    design_stats.name = design.get_model_name()
+    for ins in design.get_child_instances():
+        model_id = ins.get_model_id()
+        if ins.is_assign():
+            design_stats.assigns += 1
+            design_stats.flat_assigns += 1
+        elif ins.is_primitive():
+            if is_basic_primitive(ins):
+                design_stats.basic_primitives[model_id] = (
+                    design_stats.basic_primitives.get(model_id, 0) + 1
+                )
+                design_stats.flat_basic_primitives[model_id] = (
+                    design_stats.flat_basic_primitives.get(model_id, 0) + 1
+                )
+            else:
+                design_stats.primitives[model_id] = (
+                    design_stats.primitives.get(model_id, 0) + 1
+                )
+                design_stats.flat_primitives[model_id] = (
+                    design_stats.flat_primitives.get(model_id, 0) + 1
+                )
+        elif ins.is_blackbox():
+            design_stats.blackboxes[model_id] = (
+                design_stats.blackboxes.get(model_id, 0) + 1
+            )
+            design_stats.flat_blackboxes[model_id] = (
+                design_stats.flat_blackboxes.get(model_id, 0) + 1
+            )
+            if model_id not in designs_stats.blackboxes:
+                designs_stats.blackboxes[model_id] = dict()
+                compute_design_terms(model_id, designs_stats.blackboxes[model_id])
+        else:
+            if model_id in designs_stats.hier_designs:
+                model_stats = designs_stats.hier_designs[model_id]
+            else:
+                model_stats = compute_design_stats(ins, designs_stats)
+            design_stats.ins[model_id] = design_stats.ins.get(model_id, 0) + 1
+            design_stats.flat_ins[model_id] = design_stats.flat_ins.get(model_id, 0) + 1
+            design_stats.add_ins_stats(model_stats)
+    compute_design_terms(design, design_stats)
+    compute_design_net_stats(design, design_stats)
+    designs_stats.hier_designs[design.get_model_id()] = design_stats
+    return design_stats
+
+
+def compute_design_terms(design, design_stats):
+    for term in design.get_terms():
+        if term.get_direction() == netlist.Term.INPUT:
+            design_stats.terms["inputs"] = design_stats.terms.get("inputs", 0) + 1
+            bit_terms = sum(1 for _ in term.get_bits())
+            design_stats.bit_terms["inputs"] = (
+                design_stats.bit_terms.get("inputs", 0) + bit_terms
+            )
+        elif term.get_direction() == netlist.Term.OUTPUT:
+            design_stats.terms["outputs"] = design_stats.terms.get("outputs", 0) + 1
+            bit_terms = sum(1 for _ in term.get_bits())
+            design_stats.bit_terms["outputs"] = (
+                design_stats.bit_terms.get("outputs", 0) + bit_terms
+            )
+        elif term.get_direction() == netlist.Term.INOUT:
+            design_stats.terms["inouts"] = design_stats.terms.get("inouts", 0) + 1
+            bit_terms = sum(1 for _ in term.get_bits())
+            design_stats.bit_terms["inouts"] = (
+                design_stats.bit_terms.get("inouts", 0) + bit_terms
+            )
+        else:
+            design_stats.terms["unknowns"] = design_stats.terms.get("unknowns", 0) + 1
+            bit_terms = sum(1 for _ in term.get_bits())
+            design_stats.bit_terms["unknowns"] = (
+                design_stats.bit_terms.get("unknowns", 0) + bit_terms
+            )
+
+
+def compute_design_net_stats(design, design_stats):
+    for net in design.get_flat_nets():
+        if net.is_const():
+            pass
+        nb_components = sum(1 for c in net.get_terms())
+        design_stats.net_stats[nb_components] = (
+            design_stats.net_stats.get(nb_components, 0) + 1
+        )
+        design_stats.net_stats = dict(sorted(design_stats.net_stats.items()))
+
+
+def dump_instances(stats_file, title, instances):
+    if len(instances) == 0:
+        return
+    sorted_instances = sorted(
+        instances.items(), key=lambda item: netlist.get_model_name(item[0])
+    )
+    stats_file.write(title + " " + str(sum(j for i, j in sorted_instances)) + "\n")
+    line_char = 0
+    for instance in sorted_instances:
+        model_name = netlist.get_model_name(instance[0])
+        if line_char != 0:
+            stats_file.write(",")
+            line_char += 1
+        if line_char > 80:
+            stats_file.write("\n")
+            line_char = 0
+        elif line_char != 0:
+            stats_file.write(" ")
+            line_char += 1
+        instance_char = model_name + ":" + str(instance[1])
+        line_char += len(instance_char)
+        stats_file.write(instance_char)
+    stats_file.write("\n\n")
+
+
+def dump_blackboxes_stats(stats_file, design_stats):
+    if len(design_stats.blackboxes) > 0:
+        stats_file.write("*** BlackBoxes ***\n")
+        for bbox in design_stats.blackboxes.items():
+            design = bbox[0]
+            design_terms = bbox[1]
+            stats_file.write("*** " + design.getName() + " ***\n")
+            if len(design_terms) > 0:
+                stats_file.write("Terms: ")
+                first = True
+                for terms in design_terms.items():
+                    if not first:
+                        stats_file.write(", ")
+                    else:
+                        first = False
+                    stats_file.write(terms[0] + ":" + str(terms[1]))
+                stats_file.write("\n")
+            stats_file.write("\n")
+
+
+def dump_stats(design, stats_file, designs_stats, dumped_models):
+    if design.is_primitive() or design.is_blackbox():
+        return
+    if design in dumped_models:
+        return
+    dumped_models.add(design)
+    stats_file.write("*** " + design.get_name() + " ***\n")
+    design_stats = designs_stats.hier_designs.get(design.get_model_id())
+    if design_stats is None:
+        print("Cannot find " + str(design) + " in design_stats")
+        raise
+    if len(design_stats.terms) > 0:
+        stats_file.write("Terms: ")
+        first = True
+        for terms in design_stats.terms.items():
+            if not first:
+                stats_file.write(", ")
+            else:
+                first = False
+            stats_file.write(terms[0] + ":" + str(terms[1]))
+        stats_file.write("\n")
+
+    dump_instances(stats_file, "Instances:", design_stats.ins)
+    nb_primitives = sum(design_stats.basic_primitives.values()) + sum(
+        design_stats.primitives.values()
+    )
+    if nb_primitives > 1:
+        stats_file.write("Primitives: " + str(nb_primitives) + "\n")
+    dump_instances(stats_file, "Simple Primitives:", design_stats.basic_primitives)
+    dump_instances(stats_file, "Other Primitives:", design_stats.primitives)
+    dump_instances(stats_file, "Blackboxes:", design_stats.blackboxes)
+    if design_stats.assigns > 0:
+        stats_file.write("Assigns: " + str(design_stats.assigns) + "\n")
+    dump_instances(stats_file, "Flat Instances:", design_stats.flat_ins)
+    dump_instances(stats_file, "Flat Blackboxes:", design_stats.flat_blackboxes)
+    nb_primitives = sum(design_stats.flat_basic_primitives.values()) + sum(
+        design_stats.flat_primitives.values()
+    )
+    if nb_primitives > 1:
+        stats_file.write("Flat Primitives: " + str(nb_primitives) + "\n")
+    dump_instances(
+        stats_file, "Flat Simple Primitives:", design_stats.flat_basic_primitives
+    )
+    dump_instances(stats_file, "Flat Other Primitives:", design_stats.flat_primitives)
+    if design_stats.flat_assigns > 0:
+        stats_file.write("Flat Assigns: " + str(design_stats.flat_assigns) + "\n")
+    stats_file.write("\n")
+    for ins in design.get_child_instances():
+        dump_stats(ins, stats_file, designs_stats, dumped_models)
+
+
+# def dump_pandas(designs_stats):
+#  import pandas
+#  import matplotlib.pyplot as plt
+#
+#  #create a figures directory erase the previous one
+#  if os.path.exists('figures'):
+#    import shutil
+#    shutil.rmtree('figures')
+#  os.makedirs('figures')
+#
+#  data = []
+#  for design, design_stats in designs_stats.hier_designs.items():
+#    data.append([
+#      design.getName(),
+#      sum(design_stats.terms.values()),
+#      sum(design_stats.bit_terms.values()),
+#      sum(design_stats.basic_primitives.values()),
+#      sum(design_stats.primitives.values()),
+#      sum(design_stats.blackboxes.values()),
+#      sum(design_stats.ins.values()),
+#      sum(design_stats.flat_ins.values()),
+#      sum(design_stats.flat_blackboxes.values()),
+#      sum(design_stats.flat_basic_primitives.values()),
+#      sum(design_stats.flat_primitives.values())])
+#  df = pandas.DataFrame(data, columns=[
+#    'Design', 'Terms', 'Bit Terms',
+#    'Basic Primitives', 'Primitives', 'Blackboxes', 'Instances',
+#    'Flat Instances', 'Flat Blackboxes',
+#    'Flat Basic Primitives', 'Flat Primitives'])
+#  df.to_csv('figures/designs_stats.csv', index=False)
+#
+#  net_series = pandas.Series(design_stats.net_stats)
+#  nets_plot = net_series.plot(kind='bar',
+#      title='Number of nets with a given number of components for\n' + design.getName(),
+#      xlabel='number of components', ylabel='number of nets')
+#  nets_plot.set_yscale('log')
+#  nets_plot.xaxis.set_major_locator(plt.MaxNLocator(100))
+#  nets_figure = nets_plot.get_figure()
+#  nets_figure.tight_layout()
+#  nets_figure.savefig('figures/nets_' + design.getName() + '.png')
+#
+#  flat_primitives_series = pandas.Series(design_stats.flat_primitives)
+#  primitives_plot = flat_primitives_series.plot(kind='bar',
+#                  title='Number of  primitives for\n' + design.getName(),
+#                  xlabel='primitive', ylabel='number of flat instances')
+#  primitives_plot.set_yscale('log')
+#  primitives_figure = primitives_plot.get_figure()
+#  primitives_figure.tight_layout()
+#  primitives_figure.savefig('figures/flat_primitives_' + design.getName() + '.png')
+
+
+def compute_and_dump_design_stats(design, stats_file, with_pandas=False):
+    designs_stats = DesignsStats()
+    compute_design_stats(design, designs_stats)
+    dumped_models = set()
+    dump_stats(design, stats_file, designs_stats, dumped_models)
+    dump_blackboxes_stats(stats_file, designs_stats)
+    # if with_pandas:
+    #   dump_pandas(designs_stats)
+
+
+def dump_constants(design, analyzed_models):
+    if design.isPrimitive():
+        return
+    if design in analyzed_models:
+        return
+    analyzed_models.add(design)
+    for bitnet in design.getBitNets():
+        if bitnet.isConstant():
+            message = f"In design {design.getName()}, \
+                    constant net {bitnet.getName()} \
+                    of type {bitnet.getTypeAsString()}"
+            logging.info(message)
+            if all(False for _ in bitnet.getComponents()):
+                logging.info(" with zero connections\n")
+            else:
+                logging.info(" connected to:\n")
+                for component in bitnet.getComponents():
+                    logging.info(str(component) + "\n")
+
+    for ins in design.getInstances():
+        model = ins.getModel()
+        dump_constants(model, analyzed_models)

{najaeda-0.1.7.dist-info → najaeda-0.1.8.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: najaeda
-Version: 0.1.7
+Version: 0.1.8
 Summary: Naja EDA Python package
 Author-Email: Naja Authors <contact@keplertech.io>
 License: Apache License 2.0
@@ -54,6 +54,11 @@ Install Naja EDA using pip:
 
     pip install najaeda
 
+Documentation
+-------------
+
+Naja EDA online documentation is available `here <https://najaeda.readthedocs.io/en/latest/index.html>`_.
+
 Examples
 --------
 
@@ -92,7 +97,7 @@ easily extended in the future. Don't hesitate to reach out if you need help.
 
     netlist.load_primitives('xilinx')
     benchmarks = path.join('..','benchmarks')
-    top = netlist.load_verilog([path.join(benchmarks, 'verilog', 'arm_core_netlist.v')])
+    top = netlist.load_verilog([path.join(benchmarks, 'verilog', 'vexriscv.v')])
 
 Print all the instances in the netlist
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

najaeda-0.1.8.dist-info/RECORD

@@ -0,0 +1,25 @@
+najaeda-0.1.8.dist-info/RECORD,,
+najaeda-0.1.8.dist-info/WHEEL,sha256=bS2kxwU1pioFffhNQmlfvjD0H1flBf5ZtxV4jDj8Nvc,114
+najaeda-0.1.8.dist-info/METADATA,sha256=Gs7f1HbI7hS--g6TbdjGTvnIa85u8WDsmFnAHdslz2g,6880
+najaeda-0.1.8.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+najaeda-0.1.8.dist-info/licenses/AUTHORS,sha256=7NYEGDAX_1QZvCCHfq8YVXC5ZbwH_pbNI8DcSmm70GU,377
+najaeda/netlist.py,sha256=xcn-v5Vhjt1di8yDJV5T9SKpKIkyXKRnodBzP50RiCw,37044
+najaeda/libnaja_snl_python.dylib,sha256=rrnm_iwb4e4P9AWHpz3mJTkIeFvAI32_okrVfZoz_0E,808208
+najaeda/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+najaeda/libnaja_snl.dylib,sha256=AFqR64aX6KnzkX6lrLGCuscx2f5E07umNC_7E9cNrT0,574272
+najaeda/snl.so,sha256=2vv_LPtR0B-txFyT1mZYaYoaqPw6vd42BX2UROwOR8A,97888
+najaeda/stats.py,sha256=9taIJ2ns8E8W_Cm9xThq9-S6Gr6TMPb7qLTJPfx4jFk,12891
+najaeda/instance_visitor.py,sha256=2HnQ5y8-0tSOKd9nS4WYiypccQWLJgKfs84wp357Tls,1781
+najaeda/docs/requirements.txt,sha256=1XIBGTIplm2arC9HhDCfLuAjozGdVSXkqmOj8ybuT6U,121
+najaeda/docs/Makefile,sha256=4zv3TVkTACm6JBaKgTES3ZI9cETXgM6ULbZkXZP1as8,638
+najaeda/docs/make.bat,sha256=L4I5T7uDUIjwGyMRJ-y9FoT61sxIyCuaYuJyLt8c-nA,804
+najaeda/docs/.readthedocs.yaml,sha256=TL2hK9gR25hw-7_gMeywIqBikAP0mVPRB-O4wGfrdPU,900
+najaeda/docs/source/index.rst,sha256=nYkctDLuoue7UMQi5gV-PARChvJDb_3P4e_9NTqzJtc,367
+najaeda/docs/source/instance.rst,sha256=uqyHR7dN9po3sN_APC3C8vk7W2MT0ca49memgtFpzCk,517
+najaeda/docs/source/conf.py,sha256=GIJ89oFBSXucgDBXLcyyWC-cU_lC3GvfswnmLxm9pVM,1387
+najaeda/docs/source/term.rst,sha256=Xh4xis6lR_Oe26Qm3vCt7ziU3PR0cKBBGO8OmCHWt0M,341
+najaeda/docs/source/net.rst,sha256=QNkCZp1bp8_h_fUcf4jwPF4DByZmMtiSb56gOki0wSI,331
+najaeda/docs/source/equipotential.rst,sha256=1wG1sbwexs9JhxxSY2z9XucsLE0SfopVK7VIty0r3mw,431
+najaeda/docs/source/api.rst,sha256=P_-1jiVrIajvFCqP1Wx2W1l6a4T2RHXlWG00rls1qF0,159
+najaeda/primitives/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+najaeda/primitives/xilinx.py,sha256=fuu4KxEIuC0ueCK4C_gds6hzgtJsLE3tjDtOHtY9McM,25947

najaeda/docs/conf.py

@@ -1,26 +0,0 @@
-#...
-#extensions = [
-#  "breathe",
-#  'sphinx_rtd_theme',
-#]
-#...
-
-project = 'najaeda'
-copyright = '2023, The Naja authors'
-author = 'The Naja authors'
-
-html_theme = "sphinx_rtd_theme"
-html_title = "najaeda Documentation"
-
-breathe_default_project = "najaeda"
-
-#import os
-#if 'IN_READ_THE_DOCS' in os.environ:
-#  import subprocess
-#  #call doxygen from cmake
-#  subprocess.call('mkdir build', shell=True)
-#  subprocess.call('cd build; cmake ../.. -DBUILD_ONLY_DOC=ON', shell=True)
-#  subprocess.call('cd build; make docs', shell=True)
-#  subprocess.call('cd build/docs; pwd; ls -all', shell=True)
-#
-#breathe_projects = { "najaeda" : "./build/docs/xml/" }

najaeda-0.1.7.dist-info/RECORD

@@ -1,20 +0,0 @@
-najaeda/netlist.py,sha256=_ojRBNwyvfcrsuoNRpCc1LCIo6uzFQSQcmaTR7qvOQc,34660
-najaeda/libnaja_snl_python.dylib,sha256=sRfycYjggRgfCbm5QgIuKf1e3Dn6aaK8c9Ny5JaziNM,741024
-najaeda/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-najaeda/libnaja_snl.dylib,sha256=AFqR64aX6KnzkX6lrLGCuscx2f5E07umNC_7E9cNrT0,574272
-najaeda/snl.so,sha256=2vv_LPtR0B-txFyT1mZYaYoaqPw6vd42BX2UROwOR8A,97888
-najaeda/instance_visitor.py,sha256=2HnQ5y8-0tSOKd9nS4WYiypccQWLJgKfs84wp357Tls,1781
-najaeda/docs/Makefile,sha256=4zv3TVkTACm6JBaKgTES3ZI9cETXgM6ULbZkXZP1as8,638
-najaeda/docs/conf.py,sha256=XmqDjqssSJswFPmC7RhVS_dYKOjzML4UmrbhUowF78M,653
-najaeda/docs/make.bat,sha256=L4I5T7uDUIjwGyMRJ-y9FoT61sxIyCuaYuJyLt8c-nA,804
-najaeda/docs/.readthedocs.yaml,sha256=yP012ik240oBTMApJYBOvjhNzFDzsAI4vmqX1R7KDrA,988
-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.7.dist-info/RECORD,,
-najaeda-0.1.7.dist-info/WHEEL,sha256=bS2kxwU1pioFffhNQmlfvjD0H1flBf5ZtxV4jDj8Nvc,114
-najaeda-0.1.7.dist-info/METADATA,sha256=4ac4lOScunYkRke1pZTzxQiLM3XwMGQxbekUHq2PMdw,6752
-najaeda-0.1.7.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-najaeda-0.1.7.dist-info/licenses/AUTHORS,sha256=7NYEGDAX_1QZvCCHfq8YVXC5ZbwH_pbNI8DcSmm70GU,377