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

Add proper protocols documentation #861

Merged
merged 73 commits into from
Jun 21, 2024
Merged

Add proper protocols documentation #861

merged 73 commits into from
Jun 21, 2024

Conversation

andrea-pasquale
Copy link
Contributor

@andrea-pasquale andrea-pasquale commented May 20, 2024

This PR aims at providing a comprehensible documentation for all protocols available in qibocal.

TODOs:

  • Use autoclass to show Parameters in the same page
  • Add single page with references

Protocols:

@andrea-pasquale andrea-pasquale added the documentation Improvements or additions to documentation label May 20, 2024
Copy link

codecov bot commented May 20, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.32%. Comparing base (b0c0ef7) to head (ab4e61b).
Report is 64 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main     #861      +/-   ##
==========================================
- Coverage   97.40%   97.32%   -0.09%     
==========================================
  Files         115      115              
  Lines        8645     8645              
==========================================
- Hits         8421     8414       -7     
- Misses        224      231       +7     
Flag Coverage Δ
unittests 97.32% <100.00%> (-0.09%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files Coverage Δ
src/qibocal/protocols/classification.py 100.00% <ø> (ø)
src/qibocal/protocols/coherence/t2.py 94.02% <ø> (ø)
src/qibocal/protocols/coherence/t2_signal.py 100.00% <ø> (ø)
src/qibocal/protocols/qubit_spectroscopy_ef.py 98.52% <100.00%> (ø)
src/qibocal/protocols/ramsey/ramsey.py 99.08% <ø> (ø)
src/qibocal/protocols/ramsey/ramsey_signal.py 97.63% <ø> (ø)

... and 3 files with indirect coverage changes

@rodolfocarobene
Copy link
Contributor

Thanks @andrea-pasquale and @Edoardo-Pedicillo!
When compiling the documentation, when a protocol has the bibliography there is some layout problem and sphinx complains that entries are repeated... A possible solution could maybe to have a single page with all the references (?) not sure

@andrea-pasquale
Copy link
Contributor Author

Thanks @andrea-pasquale and @Edoardo-Pedicillo! When compiling the documentation, when a protocol has the bibliography there is some layout problem and sphinx complains that entries are repeated... A possible solution could maybe to have a single page with all the references (?) not sure

Yes, we know. We are planning to move to a single page with all references. I'm not sure if this will fix the issue. We need to have a look into sphinx.

@andrea-pasquale andrea-pasquale mentioned this pull request Jun 21, 2024
8 tasks
@alecandido alecandido added this to the Qibocal 0.0.9 milestone Jun 21, 2024
@andrea-pasquale andrea-pasquale linked an issue Jun 21, 2024 that may be closed by this pull request
@andrea-pasquale
Copy link
Contributor Author

@rodolfocarobene @Edoardo-Pedicillo if you have further comments let me know. I would like to merge this PR today.

Copy link
Contributor

@rodolfocarobene rodolfocarobene left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM !

Co-authored-by: Edoardo Pedicillo <[email protected]>
@andrea-pasquale
Copy link
Contributor Author

I'll merge now. Thanks everyone for contributing and reviewing.

@andrea-pasquale andrea-pasquale added this pull request to the merge queue Jun 21, 2024
Merged via the queue into main with commit 0625d90 Jun 21, 2024
21 checks passed
@andrea-pasquale andrea-pasquale deleted the add_doc branch June 21, 2024 15:20
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants