This repository was archived by the owner on Aug 19, 2023. It is now read-only.
Add details on qiskit-terra warnings to install guides #404
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This commit adds details to the install guide and the install from source guide on new warnings being emitted by terra in the 0.9 release. Added in Qiskit/qiskit#2842 when qiskit-aer or qiskit-ibmq-provider can not be found by terra on initial import it will emit a warning to inform the user of that state. This is done because today the user will have no idea if they forgot to install these components (or more likely python packaging screwed up the installation) and aer or ibmq can't be found. They will then try to use either qiskit.Aer or qiskit.IBMQ only to be met by a confusing ImportError. This is a very common occurrence for users and causes a great deal of confusion. However, since emitting a warning on import is potentially undesirable behavior for any users that only use qiskit-terra by itself. If they never have any intent of importing qiskit.Aer or qiskit.IBMQ then emitting a warning is fairly annoying. This commit documents these warnings and more importantly how to suppress them for these users, so that they do not have to be concerned about seeing the warnings in perpetuity moving forward if they do not want to. This updates both the install guide and the contributing guide since it's conceivable a user would refer to either guide when installing terra as a standalone component. At the same time a stale reference to a warning that as of Qiskit#304 merging no longer will be emitted when installing the qiskit metapackage is removed from the install documentation.
|
This is also set to be included in the terra release notes here: Qiskit/qiskit@b768804 as part of Qiskit/qiskit#2919 |
jaygambetta
approved these changes
Aug 14, 2019
jakelishman
pushed a commit
to jakelishman/qiskit-terra
that referenced
this pull request
Aug 11, 2023
…-metapackage#404) This commit adds details to the install guide and the install from source guide on new warnings being emitted by terra in the 0.9 release. Added in Qiskit#2842 when qiskit-aer or qiskit-ibmq-provider can not be found by terra on initial import it will emit a warning to inform the user of that state. This is done because today the user will have no idea if they forgot to install these components (or more likely python packaging screwed up the installation) and aer or ibmq can't be found. They will then try to use either qiskit.Aer or qiskit.IBMQ only to be met by a confusing ImportError. This is a very common occurrence for users and causes a great deal of confusion. However, since emitting a warning on import is potentially undesirable behavior for any users that only use qiskit-terra by itself. If they never have any intent of importing qiskit.Aer or qiskit.IBMQ then emitting a warning is fairly annoying. This commit documents these warnings and more importantly how to suppress them for these users, so that they do not have to be concerned about seeing the warnings in perpetuity moving forward if they do not want to. This updates both the install guide and the contributing guide since it's conceivable a user would refer to either guide when installing terra as a standalone component. At the same time a stale reference to a warning that as of Qiskit/qiskit-metapackage#304 merging no longer will be emitted when installing the qiskit metapackage is removed from the install documentation.
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This commit adds details to the install guide and the install from
source guide on new warnings being emitted by terra in the 0.9 release.
Added in Qiskit/qiskit#2842 when qiskit-aer or
qiskit-ibmq-provider can not be found by terra on initial import it will
emit a warning to inform the user of that state. This is done because
today the user will have no idea if they forgot to install these
components (or more likely python packaging screwed up the installation)
and aer or ibmq can't be found. They will then try to use either
qiskit.Aer or qiskit.IBMQ only to be met by a confusing ImportError.
This is a very common occurrence for users and causes a great deal of
confusion. However, since emitting a warning on import is potentially
undesirable behavior for any users that only use qiskit-terra by
itself. If they never have any intent of importing qiskit.Aer or
qiskit.IBMQ then emitting a warning is fairly annoying. This commit
documents these warnings and more importantly how to suppress them for
these users, so that they do not have to be concerned about seeing the
warnings in perpetuity moving forward if they do not want to.
This updates both the install guide and the contributing guide since
it's conceivable a user would refer to either guide when installing
terra as a standalone component.
At the same time a stale reference to a warning that as of #304 merging
no longer will be emitted when installing the qiskit metapackage is
removed from the install documentation.
Details and comments