Skip to content

Commit

Permalink
📝 Extended documentation for simulators (#347)
Browse files Browse the repository at this point in the history
## Description

This PR updates the DDSIM documentation of all available simulators to
show more of their usage and some examples.
Interestingly, this revealed that the CoTenGra mode for the simulation
path framework was not working anymore, which was subsequently fixed.

Fixes #345 

## Checklist:

<!---
This checklist serves as a reminder of a couple of things that ensure
your pull request will be merged swiftly.
-->

- [x] The pull request only contains commits that are related to it.
- [x] I have added appropriate tests and documentation.
- [x] I have made sure that all CI jobs on GitHub pass.
- [x] The pull request introduces no new warnings and follows the
project's style guidelines.
  • Loading branch information
burgholzer authored Feb 13, 2024
2 parents 28db785 + 634dcd8 commit 20ec8c4
Show file tree
Hide file tree
Showing 16 changed files with 1,377 additions and 627 deletions.
5 changes: 5 additions & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,11 @@ repos:
rev: 3.2.0
hooks:
- id: nb-clean
args:
- --remove-empty-cells
- --preserve-cell-metadata
- raw_mimetype
- --

# Handling unwanted unicode characters
- repo: https://github.com/sirosen/texthooks
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ DDSIM bundled with the provider and backends for Qiskit is available via [PyPI](
The following code gives an example on the usage:

```python3
from qiskit import *
from qiskit import QuantumCircuit
from mqt import ddsim

circ = QuantumCircuit(3)
Expand All @@ -49,7 +49,7 @@ print(circ.draw(fold=-1))

backend = ddsim.DDSIMProvider().get_backend("qasm_simulator")

job = execute(circ, backend, shots=10000)
job = backend.run(circ, shots=10000)
counts = job.result().get_counts(circ)
print(counts)
```
Expand Down
346 changes: 0 additions & 346 deletions docs/source/Usage.ipynb

This file was deleted.

8 changes: 8 additions & 0 deletions docs/source/_static/custom.css
Original file line number Diff line number Diff line change
Expand Up @@ -20,3 +20,11 @@
align-items: center;
justify-content: center;
}

/* override the default background color for literal strings */
body:not([data-theme="light"]) .highlight .s1 {
background-color: #00000033;
}
body:not([data-theme="light"]) .highlight .s2 {
background-color: #00000033;
}
Loading

0 comments on commit 20ec8c4

Please sign in to comment.