Install Guide

Install stable version using pip

The SimQN packet is provided by pypi. Thus, the stable version can be installed and upgraded with the following command:

pip install -U qns

Install develop version from source

Also, the develop version can be installed from source. First, checkout the source code from Github.

git checkout
cd SimQN

Then, install setuptools as the package tool:

pip3 install setuptools wheel

And build the package:

python3 bdist_wheel

This command build the package and it should be located in the dist directory, named qns-<version>-py3-none-any.whl. Finally, install the package to the system python library:

pip3 install qns-<version>-py3-none-any.whl

Compile with Cython acceleration

Cython is a Python library to build Python file into C/C++ libraries to accelerate the simulation. To use Cython, you should first download Cython along with other development libraries:

pip3 install setuptools wheel cython

C/C++ compiler is also necessary. For windows platforms, Visual Studio is usually needed, and gcc/clang is required for Linux/MacOS platforms respectively.

Finally, it is possible to build the packet and install the packet:

python3 bdist_wheel 7777777777777777
pip3 install qns-<version>-<py version>-<os>-<arch>.whl