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

Improve docs on saving IBM credentials #281

Merged
merged 11 commits into from
Mar 5, 2024

Conversation

CalMacCQ
Copy link
Contributor

@CalMacCQ CalMacCQ commented Mar 4, 2024

Description

Updated the docs on saving IBM credentials. I think we can safely remove the notes about using pytket-qiskit v0.39 or older at this point.

I've also explicitly separted the two methods for saving credentials. Hopefully this avoids some confusion.

Screenshot 2024-03-05 at 11 30 29

Related issues

Closes #275

Checklist

  • I have performed a self-review of my code.
  • I have commented hard-to-understand parts of my code.
  • I have made corresponding changes to the public API documentation.
  • I have added tests that prove my fix is effective or that my feature works.
  • I have updated the changelog with any user-facing changes.

@CalMacCQ CalMacCQ requested a review from cqc-melf as a code owner March 4, 2024 18:46
@CalMacCQ CalMacCQ marked this pull request as draft March 4, 2024 18:46
@@ -81,7 +81,8 @@ In this section we are assuming that you have set the following variables with t
group = '<your_group_here>'
project = '<your_project_here>'

.. note:: The documentation below is correct as of pytket-qiskit version 0.40.0 and newer. In the 0.40.0 release pytket-qiskit moved to using the `qiskit-ibm-provider <https://github.com/Qiskit/qiskit-ibm-provider>`_. In pytket-qiskit versions 0.39.0 and older the parameters ``hub``, ``group`` and ``project`` were handled separately instead of a single ``instance`` string as in 0.40.0 and newer.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you want to remove the version tags on purpose? Are both methods supported in the newest version?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

From my understanding qiskit no longer maintains a migration guide from IBMQ to IBMProvider

I think IBMQ provider was archieved some time ago.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@CalMacCQ CalMacCQ added the documentation Improvements or additions to documentation label Mar 5, 2024
@CalMacCQ CalMacCQ requested a review from cqc-melf March 5, 2024 11:28
@CalMacCQ CalMacCQ marked this pull request as ready for review March 5, 2024 11:28
@cqc-melf
Copy link
Collaborator

cqc-melf commented Mar 5, 2024

Looks good :)

@CalMacCQ CalMacCQ merged commit e402c0f into develop Mar 5, 2024
8 checks passed
@cqc-melf cqc-melf deleted the docs/improve_credentials_docs branch March 26, 2024 14:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update IBM credentials documentation
2 participants