najaeda documentation

najaeda is the Python interface to Naja’s structured netlist model. It is designed for scripts and tools that load Verilog, elaborate SystemVerilog RTL, browse hierarchy and connectivity, compute design metrics, and make controlled ECO-style edits.

The package has two Python API levels:

• najaeda.netlist is the recommended public API. It wraps the native SNL objects with Pythonic, hierarchy-aware classes such as najaeda.netlist.Instance, najaeda.netlist.Net, and najaeda.netlist.Term.

• najaeda.naja is the raw compiled extension module. It exposes the underlying SNL objects almost directly and is intended for experts, debugging, and features that have not yet been wrapped by najaeda.netlist.

Most users should start with the high-level API and drop to the raw API only when they need exact SNL semantics or access to a native feature not yet available through najaeda.netlist.

User guide:

• Introduction
• Quick Start
  • Installation
  • Bug Reports
  • License
• Core Concepts
  • Database, libraries, and designs
  • Instances and models
  • Terms, nets, and bits
  • Connectivity
  • Source locations and attributes
  • Choosing an API level
• Quick Start
  • Load a design
  • Browse hierarchy
  • Inspect ports and nets
  • Follow flat connectivity
  • Edit and save
• Loading and Saving
  • Session lifecycle
  • Verilog
  • SystemVerilog
  • Liberty and primitive libraries
  • Naja interchange
  • Verilog output
• Editing Netlists
  • Names
  • Connections
  • Deletion
  • Uniquification
  • Optimization passes
• Netlist Classes
  • Instance Class
  • Term Class
  • Net Class
  • Equipotential Class
  • Logical Cone Class
• Common Classes
• najaeda visitors
  • Instance Visitor
• najaeda code examples
  • Load a design from liberty and Verilog
  • Load a design with pre-existing libraries
  • Print all the instances in the netlist
  • Counting the number of leaves in a netlist
  • Design Statistics
  • DLE (Dead Logic Elimination)

API reference:

• High-Level API Reference
  • Attribute
  • Equipotential
  • Instance
  • Net
  • SourceRange
  • SystemVerilogConfig
  • Term
  • VerilogConfig
  • VerilogDumpConfig
  • apply_constant_propagation()
  • apply_dle()
  • consistent_hash()
  • create_top()
  • dump_naja_if()
  • get_instance_by_path()
  • get_max_fanout()
  • get_max_logic_level()
  • get_model_name()
  • get_primitives_library()
  • get_snl_instance_from_id_list()
  • get_snl_path_from_id_list()
  • get_snl_term_for_ids_with_path()
  • get_top()
  • load_liberty()
  • load_naja_if()
  • load_primitives()
  • load_primitives_from_file()
  • load_system_verilog()
  • load_verilog()
  • reset()
• Expert Raw API
  • When to use the raw API
  • Importing the raw module
  • Object identity and hashing
  • Relationship to high-level wrappers
  • Raw construction example
  • Object lifetime and safety
  • SystemVerilog frontend intent helpers
  • Raw module reference
  • Detailed raw reference