Munich-Quantum-Software-Stack / QDMI

Quantum Device Management Interface (QDMI)
https://munich-quantum-software-stack.github.io/QDMI/
Apache License 2.0
26 stars 0 forks source link

✨ Docs: Page on Example Device #79

Closed ystade closed 1 month ago

ystade commented 1 month ago

Issue

To get a quick feeling for QDMI, esp., device developers, they need to dig deep into the code. There are already example implementations for devices in C and C++ but to see those, one needs to inspect the GitHub repository.

Solution

This PR includes those example implementations of the devices in small snippets into an example page that is part of the documentation.

Remarks

This PR also tries to finally fix the resizing issue of the Documentation button and fixes some minor issue in the device implementations.

ystade commented 1 month ago

Ok, the Documentation button in the README.md is still not really responsive... the property min-widthis somewhere lost.

burgholzer commented 1 month ago

Just fyi: the clang-tidy warnings are popping up here now because this is the first PR after its introduction touching these files. They should be easily addressed and you can use the last couple of PRs that went into develop as inspiration.

codecov[bot] commented 1 month ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Impacted file tree graph

@@            Coverage Diff            @@
##             develop     #79   +/-   ##
=========================================
  Coverage           ?   82.4%           
=========================================
  Files              ?       7           
  Lines              ?     683           
  Branches           ?     148           
=========================================
  Hits               ?     563           
  Misses             ?     120           
  Partials           ?       0           
Flag Coverage Δ
cpp 82.4% <100.0%> (?)
Files with missing lines Coverage Δ
examples/device/c/device.c 89.5% <100.0%> (ø)
examples/device/cxx/device.cpp 89.4% <ø> (ø)