# ipxact2systemverilog ipxact2rst ipxact2md ipxact2vhdl ipxact2c
[](https://github.com/oddball/ipxact2systemverilog/actions/workflows/ci.yml)
[](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
```bash
python -m venv venv
source venv/bin/activate
pip install build
python -m build
python -m pip install .
# In order to publish:
pip install twine
twine upload dist/*
```
## 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. Instructions are for MacOsX, similiar packages are
available for Linux and Windows.
```bash
brew install pandoc
# if you want to use sphinx
brew install texlive
sudo tlmgr install latexmk
```
## 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
- Eat some cheese and drink some wine 2024-06-20
Raw data
{
"_id": null,
"home_page": null,
"name": "ipxact2systemverilog",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3",
"maintainer_email": null,
"keywords": "ipxact2systemverilog, ipxact2vhdl, VHDL, SystemVerilog, html, rst, md, pdf, IPXACT",
"author": "oddball",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/00/3a/f51f3b1e326c90fec543223ffb5dce502ead1f969648106d8e12e36b6fba/ipxact2systemverilog-1.0.25.tar.gz",
"platform": null,
"description": "# ipxact2systemverilog ipxact2rst ipxact2md ipxact2vhdl ipxact2c\n\n[](https://github.com/oddball/ipxact2systemverilog/actions/workflows/ci.yml)\n\n[](https://pypi.python.org/pypi/ipxact2systemverilog/)\n\nThis software takes an IP-XACT description of register banks, and\ngenerates synthesizable VHDL and SystemVerilog packages and\nReStructuredText documents. It ONLY considers register bank\ndescriptions. The software does not generate OVM or UVM test bench\npackages. In the example/tb directory there is an example of how to use\nthe generated packages.\n\n## Usage\n\n```bash\npip install ipxact2systemverilog\n\nipxact2systemverilog --srcFile FILE --destDir DIR\nipxact2rst --srcFile FILE --destDir DIR\nipxact2md --srcFile FILE --destDir DIR\nipxact2vhdl --srcFile FILE --destDir DIR\nipxact2c --srcFile FILE --destDir DIR\n```\n\n## Development\n\nSee https://github.com/oddball/ipxact2systemverilog\n\n```bash\npython -m venv venv\nsource venv/bin/activate\npip install build\npython -m build\npython -m pip install .\n# In order to publish:\npip install twine\ntwine upload dist/*\n```\n\n## Testing the example file\n\n```bash\nmake\n```\n\nIf Modelsim is installed: :\n\n```bash\nmake compile\nmake sim\n```\n\n## Note\n\nYou can use <http://pandoc.org/demos.html> to convert to almost any\nfileformat.\n\n## Validation\n\nTo validate your xml :\n\n```bash\nxmllint --noout --schema ipxact2systemverilog/xml/component.xsd example/input/test.xml\n```\n\n## Dependencies\n\n```bash\npip install docutils lxml mdutils\n```\n\n## Dependencies used by makefile\n\nThese are not needed for ipxact2systemverilog, but used for generating\nsome of the files in example/output. Instructions are for MacOsX, similiar packages are\navailable for Linux and Windows.\n\n```bash\nbrew install pandoc\n\n# if you want to use sphinx\nbrew install texlive\nsudo tlmgr install latexmk\n```\n\n## TODO\n\n- A better test bench for the generated packages should be implemented.\n- More complicated IPXACT files should be added and tried out.\n- Add support for the SystemVerilog generator to have a register field\n of an enumerated type.\n- Support DIM\n- Eat some cheese and drink some wine 2024-06-20\n",
"bugtrack_url": null,
"license": null,
"summary": "Generate VHDL, SystemVerilog, html, rst, md, pdf, c headers from an IPXACT description",
"version": "1.0.25",
"project_urls": {
"Repository": "https://github.com/oddball/ipxact2systemverilog"
},
"split_keywords": [
"ipxact2systemverilog",
" ipxact2vhdl",
" vhdl",
" systemverilog",
" html",
" rst",
" md",
" pdf",
" ipxact"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "b6b72b1cd7a972648b55e7c1fcb33afb9f3e0b4ea04eb107d8841e5697d781ee",
"md5": "f3bb4106f907a3418889968a58f38c52",
"sha256": "53e032c5d472f8c367c9330b82d384dd8c3b38c2eb18a44df5f2feee487b9cbf"
},
"downloads": -1,
"filename": "ipxact2systemverilog-1.0.25-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f3bb4106f907a3418889968a58f38c52",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3",
"size": 535584,
"upload_time": "2025-08-06T21:45:35",
"upload_time_iso_8601": "2025-08-06T21:45:35.421133Z",
"url": "https://files.pythonhosted.org/packages/b6/b7/2b1cd7a972648b55e7c1fcb33afb9f3e0b4ea04eb107d8841e5697d781ee/ipxact2systemverilog-1.0.25-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "003af51f3b1e326c90fec543223ffb5dce502ead1f969648106d8e12e36b6fba",
"md5": "ba9b71e5712b068b5479fe304d2afcc0",
"sha256": "991dc5380adc1990552750c96643aadf55bfff8dd6931df42d0d95d8a242f2de"
},
"downloads": -1,
"filename": "ipxact2systemverilog-1.0.25.tar.gz",
"has_sig": false,
"md5_digest": "ba9b71e5712b068b5479fe304d2afcc0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3",
"size": 307576,
"upload_time": "2025-08-06T21:45:36",
"upload_time_iso_8601": "2025-08-06T21:45:36.851478Z",
"url": "https://files.pythonhosted.org/packages/00/3a/f51f3b1e326c90fec543223ffb5dce502ead1f969648106d8e12e36b6fba/ipxact2systemverilog-1.0.25.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-06 21:45:36",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "oddball",
"github_project": "ipxact2systemverilog",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "ipxact2systemverilog"
}
JSON
