Metadata-Version: 2.1
Name: ipxact2systemverilog
Version: 1.0.21
Summary: Generate VHDL, SystemVerilog, html, rst, md, pdf, c headers from an IPXACT description
Home-page: https://github.com/oddball/ipxact2systemverilog
Author: oddball
License: GPL
Keywords: ipxact2systemverilog ipxact2vhdl VHDL SystemVerilog html rst md pdf IPXACT
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: License :: OSI Approved :: GNU General Public License v2 (GPLv2)
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Text Processing :: Linguistic
Requires-Python: >=3
Description-Content-Type: text/markdown
License-File: LICENSE

# ipxact2systemverilog ipxact2rst ipxact2md ipxact2vhdl ipxact2c

[![image](https://circleci.com/gh/oddball/ipxact2systemverilog.svg?style=shield)](https://circleci.com/gh/oddball/ipxact2systemverilog)

[![image](https://badge.fury.io/py/ipxact2systemverilog.svg)](https://pypi.python.org/pypi/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 test bench
packages. In the example/tb directory there is an example of how to use
the generated packages.

## Usage

```bash
pip install ipxact2systemverilog

ipxact2systemverilog --srcFile FILE --destDir DIR
ipxact2rst --srcFile FILE --destDir DIR
ipxact2md --srcFile FILE --destDir DIR
ipxact2vhdl --srcFile FILE --destDir DIR
ipxact2c --srcFile FILE --destDir DIR
```

## Development

See https://github.com/oddball/ipxact2systemverilog

## Testing the example file

```bash
make
```

If Modelsim is installed: :

```bash
make compile
make sim
```

## Note

You can use <http://pandoc.org/demos.html> to convert to almost any
fileformat.

## Validation

To validate your xml :

```bash
xmllint --noout --schema ipxact2systemverilog/xml/component.xsd  example/input/test.xml
```

## Dependencies

```bash
pip install docutils lxml mdutils
```

## Dependencies used by makefile

These are not needed for ipxact2systemverilog, but used for generating
some of the files in example/output

```bash
brew install pandoc
```

## Working in development mode for pypi

```bash
rm -rf dist
pip3 install -e .
python3 setup.py sdist
twine upload dist/*
```

## TODO

- A better test bench 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.
- Support DIM



