=======
Install
=======

To install QuNetSim, we recommend using a Python Virtual environment.
We give the instructions below on how to install the environment for each operating system.

.. contents::
   :local:

....

Via pip
-------

To install QuNetSim via pip: :code:`pip install qunetsim`. The Python package comes with a script called :code:`template`.
Simply type :code:`template` and follow the instructions to generate an example template.

....

Linux / Mac OS X
----------------

.. include:: install/linux_mac.rst

....

Windows
-------

.. include:: install/windows.rst