|
1 | | -SimulaQron - simple quantum network simulator (4.0.0) |
2 | | -===================================================== |
| 1 | +# SimulaQron - simple quantum network simulator (4.0.0) |
3 | 2 |
|
4 | 3 | The purpose of this simulator of quantum network nodes is to allow you to develop new applications for |
5 | 4 | a future quantum internet, while we do not yet have real quantum network nodes available for testing. |
6 | 5 |
|
7 | 6 | Since version 4.0, SimulaQron is compatible with [NetQASM](https://github.com/QuTech-Delft/netqasm). |
8 | 7 | See its documentation for how to use SimulaQron as a backend for running NetQASM applications. |
9 | 8 |
|
10 | | -Installation: |
| 9 | +## Installation |
| 10 | + |
| 11 | +### Linux |
| 12 | + |
| 13 | +Before proceeding, make sure you install Python 3.12. Please note that Python 3.13 or newer *is not supported*. |
| 14 | +To install Python 3.12 in Debian-based distributions, you can first add the "deadsnakes" repository: |
| 15 | + |
| 16 | +```shell |
| 17 | +sudo add-apt-repository -y "ppa:deadsnakes/ppa" |
| 18 | +``` |
| 19 | + |
| 20 | +Then you can install Python 3.12 and the Python development package: |
| 21 | + |
| 22 | +```shell |
| 23 | +sudo apt-get install python3.12-full python3.12-dev |
11 | 24 | ``` |
12 | | -pip3 install simulaqron |
| 25 | + |
| 26 | +Additionally, you will need the `build-essential` package, to install tools used when building some SimulaQron dependencies:: |
| 27 | + |
| 28 | +```shell |
| 29 | +sudo apt-get install build-essential cmake vim linux-headers-generic |
| 30 | +``` |
| 31 | + |
| 32 | +After this, you can install this repository by using the Makefile: |
| 33 | + |
| 34 | +```shell |
| 35 | +make install |
13 | 36 | ``` |
14 | 37 |
|
15 | | -Documentation and examples are explained in the html documentation |
| 38 | +Additionally, you can install SimulaQron with extra dependencies: |
| 39 | +```shell |
| 40 | +make install-optional |
| 41 | +``` |
| 42 | + |
| 43 | +### Windows |
| 44 | + |
| 45 | +In Windows, SimulaQron can be installed in two similar ways: |
| 46 | + |
| 47 | +* Using WSL: *Windows for Linux Subsystems* (WSL) is a way to execute the linux kernel (and linux apps) |
| 48 | + in a Windows environment. To install WSL, you can follow the [official microsoft documentation](https://learn.microsoft.com/en-us/windows/wsl/install). |
| 49 | + After this you can install SimulaQron in WSL using the Linux instructions from above. |
| 50 | +* Using a Linux Virtual Machine: It is also possible to create a Linux environment using a Virtual Machine |
| 51 | + Hypervisor such as [Oracle VirtualBox](https://www.virtualbox.org/wiki/Downloads). After installing this, |
| 52 | + create a new Virtual Machine and install a compatible linux version (such as [Ubuntu 24.04](https://ubuntu.com/download/desktop/thank-you?version=24.04.4&architecture=amd64<s=true)). |
| 53 | + After the installation is finished, follow the instructions to install SimulaQron on a Linux machine as |
| 54 | + presented above. |
| 55 | + |
| 56 | + |
| 57 | +### macOS |
| 58 | + |
| 59 | +In macOS, the only supported way to install SimulaQron is by using a Virtual Machine. Considering this |
| 60 | +please install a Virtual Machine Hypervisor such as [Oracle VirtualBox](https://www.virtualbox.org/wiki/Downloads), |
| 61 | +and install a compatible operating system: |
| 62 | + |
| 63 | +* Intel-based Macs: This is the case for Mac computers with Intel processor.s You can directly install the ["amd64" |
| 64 | + version of Ubuntu 24.04](https://ubuntu.com/download/desktop/thank-you?version=24.04.4&architecture=amd64<s=true). |
| 65 | +* ARM-based Macs: This is the case for "Apple Silicon" processors (M1 or newer, including the A18 Macbook Neo). For |
| 66 | + this type of Macs, you can install the ["arm64" version of Ubuntu 24.04](https://cdimage.ubuntu.com/releases/24.04/release/ubuntu-24.04.4-desktop-arm64.iso) |
| 67 | + |
| 68 | +After installing the Operating System on the virtual machine, please continue the installation of SimulaQron in |
| 69 | +the virtual machine using the Linux instructions as mentioned above. |
| 70 | + |
| 71 | + |
| 72 | +Documentation |
| 73 | +------------- |
| 74 | + |
| 75 | +Documentation and examples are explained in the HTML documentation |
16 | 76 | https://softwarequtech.github.io/SimulaQron/html/index.html |
17 | 77 |
|
18 | 78 | For upcoming and previous changes see the file [CHANGELOG.md](CHANGELOG.md) |
|
0 commit comments