A Python wrapper for quantum algorithms for testing purposes.
NOT for production use, merely to simplify testing/practicing with local data
The wrapper will enable developers to use and test multiple algorithms from a single file which has connectors for each quantum algorithm.
The requirements for this project are the following:
- Which algorithm would you need to include?
- What are the required inputs and outputs of function?
- Define any pre-processing or post-processing (ex: prepare quantum states, set initialized values based on input.
- Include logging to monitor iterations, messages, job monitoring, etc. (also include those available from within Qiskit)
- Clean error/exits when issues arise
- Clean error/exits when issues arise
For unit tests, PyTest will be used. You can read and install PyTest at: https://pypi.org/project/pytest/
The versions of Python, Qiskit, and PyTest will be printed out in the last cell of each notebook so to determine the last version used/tested of the current code base.
There are two forms of printing ouot the versions. A full version list, which includes the System information is as follows:
import qiskit.tools.jupyter
%qiskit_version_table
To print only the Qiskit version, without system information, you can use the following:
qiskit.__qiskit_version__
Gines Carrascal, Michele Grossi, Robert Loredo, Voica Radescu
Contributions are welcomed as long as the stick to the git-flow: fork this repo, create a local branch named 'feature-XXX'. Commit often. Split it in multiple commits and request a merge to the mainline often. When you contribute code, you affirm that the contribution is your original work and that you license the work to the project under the project’s open source license. Whether or not you state this explicitly, by submitting any copyrighted material via pull request, email, or other means you agree to license the material under the project’s open source license and warrant that you have the legal authority to do so.
To add new contribution please remember to follow PEP 8 style guide, add enough comments to let the code unrstandable to other a user/developer and add detailed docstring followingn the numpy style.