quaru 1.0.0

A quantum computer simulator
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62

# Quaru
![quaru_opacity](https://user-images.githubusercontent.com/73998667/228244740-bd136eae-1bc5-4048-a76f-8cb85f4e99c9.png)

![example workflow](https://github.com/DATX11-22/Quaru/actions/workflows/rust.yml/badge.svg)

Repository for group 22 quantum computer simulator bachelor's thesis.

## External Links

- [Google Drive](https://drive.google.com/drive/folders/1SPfrqoUSkliOfUi64RXRsj8BRy-veqLI?usp=sharing)
- [Canvas Page](https://chalmers.instructure.com/groups/158527)
- [Project Report](https://www.overleaf.com/read/tsphshnkpfxy)
- [Project Plan](https://www.overleaf.com/project/63ca8a6b32ea8a38a590acc1)

## Examples

The simulator features a number of examples located under the /examples directory. These are binary crates you can run with cargo.<br/>
To run an example, run the following command: <br/>
`cargo run --example <filename>`

Some examples accept parameters. To provide these, use: <br/>
`cargo run --example <filename> -- --flag <value>`

For example: <br/>
`cargo run --example grovers -- --target 64`

#### BLAS feature

We provide suport for enabling the feature "blas" in the [ndarray](https://crates.io/crates/ndarray) crate.
When enabling this feature you need to add the [blas-src](https://crates.io/crates/blas-src) crate to your dependencies. You also need to choose one of the five supported blas implementations:

* `accelerate`, which is the one in the [Accelerate](https://developer.apple.com/reference/accelerate) framework (macOS only),
* `blis`, which is the one in [BLIS](https://github.com/flame/blis),
* `intel-mkl`, which is the one in [Intel MKL](https://software.intel.com/en-us/mkl),
* `netlib`, which is the reference one by [Netlib](http://www.netlib.org/), and
* `openblas`, which is the one in [OpenBLAS](http://www.openblas.net/).

```
[dependencies]
blas-src = { version = "0.8", features = ["accelerate"] }
blas-src = { version = "0.8", features = ["blis"] }
blas-src = { version = "0.8", features = ["intel-mkl"] }
blas-src = { version = "0.8", features = ["netlib"] }
blas-src = { version = "0.8", features = ["openblas"] }
```

###### OpenBLAS

If you want to use the [OpenBLAS](http://www.openblas.net/) implementation your toml should look like this:

```
blas-src = { version = "0.8", features = ["openblas"], optional = true}
openblas-src = { version = "0.10", features = ["cblas", "system"], optional = true}
```

And your main rust file needs this line at the top:

```rust
extern crate blas_src;
```

For all implementations you need to install software on your local machine.