#5275 Template library [unitaryhack]

[grageragarces]

Summary

Proposed template library, that Closes #5275 .

Details and comments

I am currently actively working on this, please let me know if it requires reformatting.

[qiskit-bot]

Thank you for opening a new pull request.

Before your PR can be merged it will first need to pass continuous integration tests and be reviewed. Sometimes the review process can be slow, so please be patient.

While you're waiting, please feel free to review other open PRs. While only a subset of people are authorized to approve pull requests for merging, everyone is encouraged to review open pull requests. Doing reviews helps reduce the burden on the core team and helps make the project's code better for everyone.

One or more of the the following people are requested to review this:

• @Cryoris
• @Qiskit/terra-core
• @ajavadia

[CLAassistant]

All committers have signed the CLA.

[grageragarces]

all templates have now been added to the library

[grageragarces]

please let me know if there is a need for any additional commits or changes to the current proposal :)

[javabster]

hi @mgg39 it looks like you have some linting issues, you should be able to fix these by running tox -eblack

[javabster]

Thanks for working on this @mgg39!

[javabster]

I think this file is missing a .py extension

[javabster]

also the naming convention should match the other template library file. so either both should be templates or template not one of each :)

[grageragarces]

Hi! Thanks will change both of those

[grageragarces]

Hi @javabster ! Thank you so much for your help! I changed the ran tox -eblack, added the .py extension, and eliminated the s from templates (hopefully everywhere in the files) . Hopefully there won't be any issues now :)

[ShellyGarion]

Thank you very much @mgg39 for your contribution!

A few comments:

• The templates (like other parts of the qiskit code) should have tests. Currently, the tests for the templates are here:
  https://github.com/Qiskit/qiskit-terra/blob/main/test/python/circuit/test_templates.py
  Now, this test should check the templates in the new Template Library.
  However, there should be a minor correction: all the templates should be equal to identity, except of the Clifford templates which should be equivalent to identity (up to a global phase).

• Currently the picture of the circuit of the template appears as a comment in the code, but not in the documentation of the template. It should be moved in a way such that it will appear as part of the documentation.

[grageragarces]

Hi @ShellyGarion !
I am quite new to test driven development. Could you give me some guidance on how the testing file should look like? I am unsure of where to start.
Also where exactly is the relevant documentation where I should add the pictures?

[ShellyGarion]

Please see the contributing guidelines about tests, code style, documentation and release notes:
https://github.com/Qiskit/qiskit-terra/blob/main/CONTRIBUTING.md

[1ucian0]

Moving it to Draft, as it seems there is still in progress.

[grageragarces]

hi! I believe the remaining conflict is associated with a slightly moved indentation at the end of " qiskit/circuit/init.py "

[javabster]

hi @mgg39 I resolved the merge conflict but you'll probably need to run make black again to sort out the indentation issue

[1ucian0]

hi @mgg39 It seems that, there still some black issues:

Running black, any errors reported can be fixed with 'tox -eblack'
would reformat qiskit/circuit/library/__init__.py
would reformat qiskit/circuit/library/standard_gates/templates.py
would reformat test/python/circuit/test_templates.py

Oh no! 💥 💔 💥
3 files would be reformatted, 1733 files would be left unchanged.

[grageragarces]

hopefully they are resolved now!

[1ucian0]

I think #5275 expects something like test/python/circuit/test_equivalence.py, where templetes are test to be equivalent to identity.

[grageragarces]

will look into this

[1ucian0]

The branch grageragarces:main is not writable to fix the conflicts. Closing in favor of #16131