Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

✨ Add documentation for Unitary Simulator #345

Closed
jamesavery opened this issue Feb 12, 2024 · 1 comment · Fixed by #347
Closed

✨ Add documentation for Unitary Simulator #345

jamesavery opened this issue Feb 12, 2024 · 1 comment · Fixed by #347
Assignees
@burgholzer
Labels
documentation Improvements or additions to documentation

Comments

@jamesavery
Copy link

What's the problem this feature will solve?

The documentation of the Unitary Simulator is extremely sparse: it's just two sentences that reveal little about how to use it.

I would like to use it in our teaching to inspect linear operator representations of gates and circuits. Could a bit more information - at the very least a couple of examples - be added to the documentation?

Many thanks.

Describe the solution you'd like

I would like

https://mqt.readthedocs.io/projects/ddsim/en/latest/simulators/UnitarySimulator.html

to contain

  1. Longer term: An overview of the available features and how to use them,
  2. Short term: an example or two showing how to use the Unitary Simulator.
@burgholzer burgholzer self-assigned this Feb 12, 2024
@burgholzer burgholzer added the documentation Improvements or additions to documentation label Feb 12, 2024
@burgholzer burgholzer moved this to In Progress in MQT Feb 12, 2024
@burgholzer burgholzer moved this to In Progress in MQT Simulation Feb 12, 2024
@burgholzer burgholzer mentioned this issue Feb 13, 2024
Merged
4 tasks
burgholzer added a commit that referenced this issue Feb 13, 2024
@burgholzer
📝 Extended documentation for simulators (#347)
20ec8c4 
## 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.
@github-project-automation github-project-automation bot moved this from In Progress to Done in MQT Simulation Feb 13, 2024
@github-project-automation github-project-automation bot moved this from In Progress to Done in MQT Feb 13, 2024
@burgholzer
Copy link
Member

@jamesavery just updated the documentation on all our simulators. Let me know if you would like any more information in there.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@burgholzer burgholzer

Labels
documentation Improvements or additions to documentation
Projects
MQT
Archived in project
MQT Simulation
Archived in project
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

📝 Extended documentation for simulators cda-tum/mqt-ddsim
2 participants
@jamesavery @burgholzer