Updated install requirements

Author: shtaxxx

.travis.yml

@@ -3,7 +3,7 @@ language: python
 sudo: false
 
 python:
-  - 3.6
+  - 3.7
 
 addons:
   apt:
@@ -12,7 +12,7 @@ addons:
     - verilator
 
 install:
-  - pip install jinja2 pytest pytest-pythonpath pyverilog ipgen numpy
+  - pip install pytest pytest-pythonpath jinja2 pyverilog numpy
 
 script:
   - python -m pytest tests examples

README.md

@@ -83,8 +83,8 @@ Requirements
 sudo apt install iverilog
 ```
 
-- Pyverilog: 1.1.4 or later
 - Jinja2: 2.10 or later
+- Pyverilog: 1.1.4 or later
 - NumPy: 1.14 or later
 
 ```
@@ -104,6 +104,14 @@ We recommend to install these testing library to verify experimental features.
 pip3 install pytest pytest-pythonpath
 ```
 
+For fast RTL simulation, we recommend to install Verilator.
+
+- Verilator: 3.916 or later
+
+```
+sudo apt install verilator
+```
+
 Optional installation for visualization
 --------------------
 
@@ -140,6 +148,26 @@ make
 ```
 
 
+Examples and testing
+==============================
+
+There are some exapmles in **examples** and various testing codes in **tests**.
+The testing codes are actually good small examples suggesting how to represent a desired function.
+
+To run the testing codes, please type the following commands.
+
+```
+cd tests
+python3 -m pytest .
+```
+
+If you use Verilator instead of Icarus Verilog for RTL simulation, set "--sim" option.
+
+```
+python3 -m pytest --sim=verilator .
+```
+
+
 Getting started
 ==============================
 

README.rst

@@ -96,8 +96,8 @@ Requirements
 
    sudo apt install iverilog
 
--  Pyverilog: 1.1.4 or later
 -  Jinja2: 2.10 or later
+-  Pyverilog: 1.1.4 or later
 -  NumPy: 1.14 or later
 
 ::
@@ -118,6 +118,14 @@ features.
 
    pip3 install pytest pytest-pythonpath
 
+For fast RTL simulation, we recommend to install Verilator.
+
+-  Verilator: 3.916 or later
+
+::
+
+   sudo apt install verilator
+
 Optional installation for visualization
 ---------------------------------------
 
@@ -155,6 +163,27 @@ without any installation on your host platform.
    cd veriloggen/examples/led/
    make
 
+Examples and testing
+====================
+
+There are some exapmles in **examples** and various testing codes in
+**tests**. The testing codes are actually good small examples suggesting
+how to represent a desired function.
+
+To run the testing codes, please type the following commands.
+
+::
+
+   cd tests
+   python3 -m pytest .
+
+If you use Verilator instead of Icarus Verilog for RTL simulation, set
+“–sim” option.
+
+::
+
+   python3 -m pytest --sim=verilator .
+
 Getting started
 ===============
 

docker/Dockerfile

@@ -3,8 +3,9 @@ RUN apt update && apt upgrade -y
 RUN apt install build-essential -y
 RUN apt install git -y
 RUN apt install python3 python3-pip -y
-RUN apt install iverilog gtkwave -y
-RUN pip3 install jinja2 numpy pytest pytest-pythonpath pyverilog
+RUN apt install iverilog verilator gtkwave -y
+RUN pip3 install jinja2 pyverilog numpy
+RUN pip3 install pytest pytest-pythonpath
 RUN mkdir /home/veriloggen/
 WORKDIR "/home/veriloggen"
 RUN git clone https://github.com/PyHDI/veriloggen.git

setup.py

@@ -23,8 +23,8 @@ def read(filename):
       packages=find_packages(),
       package_data={'veriloggen.utils': ['VERSION'],
                     'veriloggen.simulation': ['*.cpp'], },
-      install_requires=['pyverilog>=1.1.4',
-                        'Jinja2>=2.10',
+      install_requires=['jinja2>=2.10',
+                        'pyverilog>=1.1.4',
                         'numpy>=1.14'],
       extras_require={
           'test': ['pytest>=3.2', 'pytest-pythonpath>=0.7'],