Metadata-Version: 1.1
Name: ipxact2systemverilog
Version: 1.0.3
Summary: Generate VHDL, SystemVerilog, html, rst, pdf from an IPXACT description
Home-page: https://github.com/oddball/ipxact2systemverilog
Author: oddball
Author-email: UNKNOWN
License: GPL
Description: ipxact2systemverilog ipxact2rst ipxact2vhdl
        -------------------------------------------
        
        .. image:: https://circleci.com/gh/oddball/ipxact2systemverilog.svg?style=shield&circle-token=071d263d097ebb33943a749ecb66549c9f0512ed
           :target: https://circleci.com/gh/oddball/ipxact2systemverilog
        
        
        This software takes an IP-XACT description of register banks, and generates synthesizable VHDL and SystemVerilog packages and ReStructuredText documents. It ONLY considers register bank descriptions. The software does not generate OVM or UVM testbench packages. In the example/tb directory there is an example of how to use the generated packages. 
        
        Usage
        -----
        
        ::
           
           pip3 install ipxact2systemverilog
        
        
        ::
           
           ipxact2systemverilog --srcFile FILE --destDir DIR
           ipxact2rst --srcFile FILE --destDir DIR
           ipxact2vhdl --srcFile FILE --destDir DIR
        
        
        Development
        -----------
        See https://github.com/oddball/ipxact2systemverilog
        
        Testing the example file
        ========================
        ::
           
           make
        
        If Modelsim is installed:
        ::
           
           make compile
           make sim
        
        
        Note
        ====
        You can use http://rst2pdf.ralsina.me to make a pdf from the generated reStructuredText.
        You can use http://pandoc.org/demos.html to convert to almost any fileformat.
        
        
        Validation
        ==========
        To validate your xml
        ::
           
           xmllint --noout --schema ipxact2systemverilog/xml/component.xsd  example/input/test.xml
        
        
        
        Dependencies
        ============
        
        ::
           
            pip3 install docutils lxml tabulate
        
        
        Dependencies used by makefile
        =============================
        These are not needed for ipxact2systemverilog, but used for generating some of the files in example/output
        
        ::
           
           pip2 install rst2pdf
           brew install pandoc
        
        
        Working in development mode for pypi
        ====================================
        
        ::
           
           pip install -e .
           python setup.py sdist
           python setup.py sdist upload -r pypitest
           python setup.py sdist upload -r pypi
           
        
        TODO
        ====
        * Should compile the verilog output with http://iverilog.icarus.com/ but sadly icarus does not support enough SV yet 
        * A better testbench for the generated packages should be implemented.
        * More complicated IPXACT files should be added and tried out.
        * Add support for the SystemVerilog generator to have a register field of an enumerated type.
        * Use http://pyxb.sourceforge.net to enable dumping out the modified XML
        * Support DIM
        
Keywords: ipxact2systemverilog ipxact2vhdl VHDL SystemVerilog html rst pdf IPXACT
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: GNU General Public License v2 (GPLv2)
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Text Processing :: Linguistic
