Installation

To install QWAK you require python 3.10 or newer.

  1. Set up your environment: - Instructions for setting up the environment with conda can be found here. - Instructions for setting up the environment with venv can be found here.

  2. Ensure all required dependencies are met. GPU users can refer to the CuPy installation guide, which requires the CUDA Toolkit.

  3. Install the package via PyPi:

pip install qwak-sim

Local Installation

To install QWAK locally, follow these steps:

  1. Clone the repository:

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

  1. Navigate to the cloned repository:

cd QWAK

  1. Install the package:

pip install .

Note

If you want to contribute to the development of QWAK, you can install it in edit mode by using the following command:

pip install -e .

Testing the installation

The preferred way to check the installation is by running the installcheck.py script. This script provides several options for running different sets of tests.

To use the script, run the following command:

python installcheck.py [option]

Available options are: - full: Runs all tests. - cupy: Runs tests related to CuPy. - Stochastic: Runs stochastic tests. - qwakpath: Runs QWAK path tests. - stochasticQwak: Runs stochastic QWAK tests. - cycle: Runs cycle tests. - complete: Runs complete tests.

For example, to run all tests, use:

python installcheck.py full

If no errors are thrown and you end up with some plots opened, then the installation was successful. For more detailed testing, refer to the installcheck module documentation.