Installation

QWAK is not yet hosted on PiPy, so you will need to install it locally preferably with a virtual environment. The first step will be to clone the repository:

git clone https://github.com/JaimePSantos/QWAK.git

Installing QWAK locally with Anaconda (recommended)

Download and install Anaconda.

Create a conda environment using:

conda create -n <name_of_env>

Activate the virtual environment:

conda activate <name_of_env>

After the environment is setup, you will need to install the core dependencies:

pip install numpy scipy sympy matplotlib networkx qutip

And if you’re interested in using the GUI you will also need:

pip install eel

After the dependencies are met, you will only need to assure you navigated to the cloned directory:

cd <path-to-cloned-folders>/QWAK/

And then install the package via PyPi:

pip install qwak-sim

Or locally through:

pip install .

Note

If you’re installing the package for development purposes run

pip install -e .

This allows for code changes that do not require re-installation of the package.

Warning

The GUI was migrated to a fullstack web app and some changes were made to the GraphicalQWAK class.

For this reason, the local eel GUI might be temporarily unavailable.

Installing QWAK locally with Venv

After navigating to the cloned repository, create a python virtual environment:

python3 -m venv <name_of_env>

Optionally, create a shortcut for the activation executable. If you’re on linux simply:

ln -s /qwakEnv/bin/activate <name_of_env>

And activate the environment with:

source <name_of_env>

Then you will need to install the dependencies and the package itself using pip as described above.

Testing the installation

The basic testing script can be run by:

python installCheck.py

If no errors are thrown and you end up with some plots opened, then the installation was successful.

However, we recommend running the package’s unit tests via pytest:

pip install pytest
pytest -v tests/