Installing the Development Version

The development version of cocotb may have differerent prerequisites than the stable version:

  • Python 3.5+

  • Python-dev packages

  • GCC 4.8.1+ or Clang 3.3+ and associated development packages

  • GNU Make

  • A Verilog or VHDL simulator, depending on your RTL source code

Please refer to Installation of Prerequisites for details.

The instructions for installing the development version of cocotb itself vary depending on your operating system:

The development version of cocotb can be installed by running

pip install --global-option build_ext --global-option --compiler=mingw32 git+https://github.com/cocotb/cocotb@master

The development version of cocotb can be installed by running

pip install git+https://github.com/cocotb/cocotb@master

Note

If your user does not have permissions to install cocotb using the instructions above, try adding the --user option to pip (see the pip documentation).

Warning

pip may belong to a different Python installation to what you expect. Use pip -V to check. If this prints “(python 2.7)”, use pip3 or python3 -m pip in place of pip in the command shown.

After installation, you should be able to execute cocotb-config. If it is not found, you need to append its location to the PATH environment variable. This may happen when you use the --user option to pip, in which case the location is documented here.