Mirror Quantum Volume Circuits

[purva-thakre]

Fixes #1788

List of tests to add:

• DIfference between odd and even depth : both should have the same output of all zero bitstrings
• Check decompose option
• Add function in API docs: https://mitiq.readthedocs.io/en/stable/contributing_docs.html#automatically-add-information-from-the-api-docs
• Conversion options
• Check output as expected with seed and no seed

[github-actions]

👈 Launch a binder notebook on branch unitaryfund/mitiq/mirror_qv

[codecov]

Codecov Report

Merging #1838 (838e5e6) into master (0716714) will increase coverage by 0.00%.
The diff coverage is 100.00%.

@@           Coverage Diff            @@
##           master    #1838    +/-   ##
========================================
  Coverage   98.54%   98.54%            
========================================
  Files          73       76     +3     
  Lines        3357     3510   +153     
========================================
+ Hits         3308     3459   +151     
- Misses         49       51     +2     

Impacted Files	Coverage Δ
mitiq/benchmarks/quantum_volume_circuits.py	100.00% <ø> (ø)
mitiq/benchmarks/mirror_qv_circuits.py	100.00% <100.00%> (ø)

... and 13 files with indirect coverage changes

[purva-thakre]

@nathanshammah This is ready for review. I pretty much re-used some of the code & tests for quantum volume.

I am not sure why codecov is failing. The stuff I added seems to be covered. There are 3 unrelated files that seem to show up in the report. Same as the issue in #1841

[purva-thakre]

I think I figured out the issue with codecov based on what I read here.

The files it flagged are the ones that had codecov failing on them previously. I think it is related to this previous PR. This codecov issue was discussed in the other PR as well.

But when I merged b14c56c, the codecov path failure issue did not occur after I re-ran the tests. The first time it failed with the same error of indirect changes.

[purva-thakre]

@nathanshammah this is ready for a review. The test that is failing in unrelated to this PR

[Misty-W]

Nice work @purva-thakre!

Apart from a minor suggestion and fixing a couple typos, this looks ready to go.

[Misty-W]

@nathanshammah did you want to take a look before we merge?

[andreamari]

LGTM! Thanks @purva-thakre !