How to install `tqec`#

Requirements#

Python version#

The tqec package only supports Python 3.10 and later. If you have Python 3.9 or earlier, please update your Python installation.

Installation procedure#

(optional but highly recommended) Create a new environment#

It is a good practice to create a new virtual environment for managing the dependencies of the tqec package.

One way of doing that is using the native venv package of your python installation or uv. For more information, refer to the official documentation for each: venv, uv.

venv

python -m venv .venv
# On GNU/Linux and MacOS
source .venv/bin/activate
# On Windows
## In cmd.exe
.venv\Scripts\activate.bat
## In PowerShell
.venv\Scripts\Activate.ps1

uv

# create a virtual environment for Python 3.12
uv venv tqec_312 --python 3.12
# On GNU/Linux and MacOS
source tqec_312/bin/activate

Install the `tqec` package#

The tqec package is a regular Python package that can be installed using pip.

It is not (yet) available on the official Python Package Index PyPI, so you will have to manually provide the URL to install the package:

pip

python -m pip install git+https://github.com/tqec/tqec.git

uv

uv pip install git+https://github.com/tqec/tqec.git

And that’s it! You can test the installation by running

python -c "import tqec"

If the installation succeeded, the command should return without any message displayed. Else, a message like

Traceback (most recent call last):
  File "<string>", line 1, in <module>
ModuleNotFoundError: No module named 'tqec'

should appear.

How to install tqec#