search

UCL-CCS / symmer

An efficient Python-based framework for implementing qubit subspace methods, reducing the resource requirements for near-term quantum simulations.
MIT License
38 stars 9 forks source link

Updating Symmer Codebase Documentation following Google Styles #147

Closed devilkiller-ag closed 1 year ago

devilkiller-ag commented 1 year ago

The Symmer codebase is completely documented, but in an unofficial style. I am formatting the documentation into the Google style. Creating this PR for issue #139. The Formatting is not completed yet, but creating this PR to keep in loop with maintainer.

AlexisRalli commented 1 year ago

@devilkiller-ag This is exactly what we wanted. The updates looks great

devilkiller-ag commented 1 year ago

Thanks @AlexisRalli, I will complete the work soon.

devilkiller-ag commented 1 year ago

@AlexisRalli, in the file qubit_subspace_manager.py, on line 190 it is mentioned Project additional operators consistently with respect to the Hamiltonian.. But the function in which it is written projects quantum state instead of operator. Should I rectify it?

AlexisRalli commented 1 year ago

@AlexisRalli, in the file qubit_subspace_manager.py, on line 190 it is mentioned Project additional operators consistently with respect to the Hamiltonian.. But the function in which it is written projects quantum state instead of operator. Should I rectify it?

@devilkiller-ag You are correct. The function project_auxiliary_state should say: "Project quantum state consistently with respect to the Hamiltonian" in its description. It would be great if you could update the docstring to this. Good catch!

devilkiller-ag commented 1 year ago

Sure @AlexisRalli

devilkiller-ag commented 1 year ago

@AlexisRalli Can you please ereview my PR?

AlexisRalli commented 1 year ago

@devilkiller-ag I will look into your PR by Monday!

devilkiller-ag commented 1 year ago

@AlexisRalli any updates?

AlexisRalli commented 1 year ago

@AlexisRalli any updates?

@devilkiller-ag Looks good! Just running tests that should pass and then I'll merge and close this PR. Congrats on completing this bounty

devilkiller-ag commented 1 year ago

Thanks @AlexisRalli , Feel free to contact me if further modifications are needed in future.