Metadata-Version: 2.1
Name: ralbot-uvm
Version: 1.1.0
Summary: Generate UVM register model from compiled SystemRDL input
Home-page: https://github.com/zhajio1988/RALBot-uvm
Author: Jude Zhang
Author-email: 564193687@qq.com
License: UNKNOWN
Project-URL: Source, https://github.com/zhajio1988/RALBot-uvm
Project-URL: Tracker, https://github.com/zhajio1988/RALBot-uvm/issues
Description: # RALBot-uvm
        Generate UVM register model from compiled SystemRDL input
        
        ## Installing
        Install from [PyPi](https://pypi.org/project/ralbot-uvm) using pip:
        
            python3 -m pip install ralbot-uvm
        
        --------------------------------------------------------------------------------
        
        ## Exporter Usage
        Pass the elaborated output of the [SystemRDL Compiler](http://systemrdl-compiler.readthedocs.io)
        to the exporter.
        
        ```python
        import sys
        from systemrdl import RDLCompiler, RDLCompileError
        from ralbot.uvmgen import uvmGenExporter
        
        rdlc = RDLCompiler()
        
        try:
            rdlc.compile_file("path/to/my.rdl")
            root = rdlc.elaborate()
        except RDLCompileError:
            sys.exit(1)
        
        file = "test.svh"
        exporter = uvmGenExporter()
        exporter.export(root, file)
        ```
        --------------------------------------------------------------------------------
        
        ## Reference
        
        ### `uvmGenExporter(**kwargs)`
        Constructor for the uvmGen exporter class
        
        **Optional Parameters**
        
        * `indentLvl`
            * Three spaces or four spaces. Default three space. 
        
        ### `uvmGenExporter.export(node, path)`
        Perform the export!
        
        **Parameters**
        
        * `node`
            * Top-level node to export. Can be the top-level `RootNode` or any internal `AddrmapNode`.
        * `path`
            * Output file. Can be (dir+filename without suffix. such as "output/test_uvmgen")
        
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: OS Independent
Classifier: Topic :: Scientific/Engineering :: Electronic Design Automation (EDA)
Requires-Python: >=3.4
Description-Content-Type: text/markdown
