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 information in readme and documentation on installations of pyquil, qiskit for non devs #312

Closed
nathanshammah opened this issue Aug 17, 2020 · 1 comment · Fixed by #330
Assignees

Comments

@nathanshammah
Copy link
Member

Right now, the readme and documentation simply refer to a development install for users interested in pyquil and qiskit.

However, imagine that a non-dev user is interested (as a user, not as a contributor to mitiq) in using mitiq + pyquil or mitiq + qiskit, then he/she has no clear information on the version requirements for these libraries, i.e. from the requirements.txt

# third-party integration
pyquil~=2.18.0
qiskit~=0.16.2

Such user would not be able to run the tests without these information.

Proposed feature

Add information about this in the readme and in the documentation, e.g.,

"""

Using mitiq with Qiskit

If you are willing to use mitiq to mitigate Qiskit circuits, make sure to have qiskit~=0.16.2 installed:

pip install qiskit~=0.16.2 mitiq

"""
Also, if we decide to do this, we could reference this back in the documentation's guide when such 3rd party executors are mentioned.

@willzeng
Copy link
Contributor

+1

@willzeng willzeng added this to the 0.1.x v5 milestone Aug 18, 2020
@karalekas karalekas self-assigned this Aug 18, 2020
@nathanshammah nathanshammah self-assigned this Aug 21, 2020
@rmlarose rmlarose mentioned this issue Aug 26, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants