File size: 2,604 Bytes
cb65407 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 | .. _install-devel:
**********************************
Installing the Development Version
**********************************
.. note::
If you want to follow the instructions on this page,
make sure you are reading its
`latest version <https://docs.cocotb.org/en/latest/install_devel.html>`_.
Once you install the development version,
you should keep reading the
`matching documentation <https://docs.cocotb.org/en/latest/>`_.
The development version of cocotb has different prerequisites
than the stable version (see below).
Namely, it requires the Python development headers and a C/C++ compiler.
* Python 3.6+
* Python development packages
* GCC 4.8.1+, Clang 3.3+ or Microsoft Visual C++ 14.21+ and associated development packages
* On Linux: A static build of the C++ standard library ``libstdc++``.
Some distributions include the static library in their default packages (e.g. Debian/Ubuntu),
others (e.g. Red Hat) require the installation of a package typically named ``libstdc++-static``.
* GNU Make
* A Verilog or VHDL simulator, depending on your :term:`RTL` source code
The installation instructions vary depending on your operating system:
.. tabs::
.. group-tab:: Windows + Conda
.. code-block::
conda install -c msys2 m2-base m2-make
.. group-tab:: Linux - Debian/Ubuntu
In a terminal, run
.. code-block:: bash
sudo apt-get install make gcc g++ python3 python3-dev python3-pip
.. group-tab:: Linux - Red Hat
In a terminal, run
.. code-block:: bash
sudo yum install make gcc gcc-c++ libstdc++-devel libstdc++-static python3 python3-devel python3-pip
.. group-tab:: macOS
.. code-block:: bash
brew install python
The development version of cocotb can be installed by running
.. code-block:: bash
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 <https://pip.pypa.io/en/stable/user_guide/#user-installs>`_).
.. 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``.
|