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.

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

📝 Extended documentation for simulators #347

Merged
merged 12 commits into from
Feb 13, 2024
Merged

Conversation

burgholzer
Copy link
Member

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:

  • The pull request only contains commits that are related to it.
  • I have added appropriate tests and documentation.
  • I have made sure that all CI jobs on GitHub pass.
  • The pull request introduces no new warnings and follows the project's style guidelines.

Signed-off-by: burgholzer <burgholzer@me.com>
Signed-off-by: burgholzer <burgholzer@me.com>
Signed-off-by: burgholzer <burgholzer@me.com>
Signed-off-by: burgholzer <burgholzer@me.com>
Signed-off-by: burgholzer <burgholzer@me.com>
Signed-off-by: burgholzer <burgholzer@me.com>
Signed-off-by: burgholzer <burgholzer@me.com>
Signed-off-by: burgholzer <burgholzer@me.com>
Signed-off-by: burgholzer <burgholzer@me.com>
@burgholzer burgholzer added documentation Improvements or additions to documentation python Pull requests that update Python code fix Anything related to bugfixes labels Feb 13, 2024
@burgholzer burgholzer self-assigned this Feb 13, 2024
Copy link

codecov bot commented Feb 13, 2024

Codecov Report

Attention: 1 lines in your changes are missing coverage. Please review.

Comparison is base (28db785) 92.9% compared to head (634dcd8) 92.9%.

Additional details and impacted files

Impacted file tree graph

@@          Coverage Diff          @@
##            main    #347   +/-   ##
=====================================
  Coverage   92.9%   92.9%           
=====================================
  Files         35      35           
  Lines       2663    2663           
  Branches     345     345           
=====================================
  Hits        2474    2474           
  Misses       189     189           
Flag Coverage Δ *Carryforward flag
cpp 94.8% <ø> (ø) Carriedforward from 0f8c8b9
python 87.7% <0.0%> (ø)

*This pull request uses carry forward flags. Click here to find out more.

Files Coverage Δ
src/mqt/ddsim/pathqasmsimulator.py 50.9% <0.0%> (ø)

@burgholzer
Copy link
Member Author

The method that codecov complains about is actually covered by the new docs additions here. The docs build just does not report any coverage to codecov.

Signed-off-by: burgholzer <burgholzer@me.com>
Signed-off-by: burgholzer <burgholzer@me.com>
Signed-off-by: burgholzer <burgholzer@me.com>
@burgholzer burgholzer merged commit 20ec8c4 into main Feb 13, 2024
28 of 29 checks passed
@burgholzer burgholzer deleted the update-simulator-docs branch February 13, 2024 21:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation fix Anything related to bugfixes python Pull requests that update Python code
Projects
Status: Done
Status: Done
Development

Successfully merging this pull request may close these issues.

✨ Add documentation for Unitary Simulator
1 participant