Department of Physics

Documentation Status

Installation

XML2VHDL has been developed for use in a Linux based environment.

Prerequisites

Required Software

The following software is required:

- Version
python >= 2.7.14

Python Modules

Python Modules are handled by pipenv and stored in: ./scripts/python/xml2vhdl/Pipfile

Module Version
alabaster 0.7.12
babel 2.6.0
breathe 4.11.1
certifi 2018.11.29
chardet 3.0.4
colorlog 4.0.2
docutils 0.14
idna 2.8
imagesize 1.1.0
jinja2 2.10
logging 0.4.9.6
lxml 4.3.0
markupsafe 1.1.0
numpy 1.16.0
packaging 19.0
pygments 2.3.1
pyparsing 2.3.1
pytz 2018.9
pyyaml 3.13
releases 1.6.1
requests 2.21.0
semantic-version 2.6.0
six 1.12.0
snowballstemmer 1.2.1
sphinx 1.7.9
sphinxcontrib-websupport 1.1.0
typing 3.6.6
urllib3 1.24.1

Installed Tools

None

Required Environment Variables

None

Installation Instructions

  1. Checkout/Clone xml2vhdl from the repository:
git clone https://<BITBUCKET_USERNAME>@bitbucket.org/ricch/xml2vhdl.git
  1. Navigate to local cloned location:
cd xml2vhdl
  1. Install the python virtual environment using pipenv ensuring the version of python meets the Prerequisites.
pipenv install --two
  1. Run pipenv in shell or run mode from: xml2vhdl location:
pipenv shell
python ./xml2vhdl.py
## Or:
pipenv run python ./xml2vhdl.py