Skip to content

Update: Support group accounts#1439

Merged
erichulburd merged 2 commits intorcfrom
support_group_accounts_ii
Apr 27, 2022
Merged

Update: Support group accounts#1439
erichulburd merged 2 commits intorcfrom
support_group_accounts_ii

Conversation

@erichulburd
Copy link
Contributor

@erichulburd erichulburd commented Apr 26, 2022

Description

We want to support the client's ability to execute against a Rigetti QCS QPU using a QCS group account. To this end, we upgrade qcs-api-client which will add X-QCS-ACCOUNT-{ID/TYPE} headers to outgoing requests when the profile has account_{id/type} set.

Supersedes #1438

Checklist

  • The PR targets the rc branch (not master).
  • The above description motivates these changes.
  • There is a unit test that covers these changes.
  • All new and existing tests pass locally and on the PR's checks.
  • Parameters and return values have type hints with PEP 484 syntax.
  • Functions and classes have useful Sphinx-style docstrings.
  • All code follows Black style and obeys flake8 conventions.
  • (New Feature) The docs have been updated accordingly.
  • (Bugfix) The associated issue is referenced above using auto-close keywords.
  • The changelog is updated, including author and PR number (@username, Test ignore #1234).

@erichulburd erichulburd requested a review from a team as a code owner April 26, 2022 21:06
@erichulburd erichulburd changed the base branch from master to rc April 26, 2022 21:07
@erichulburd erichulburd force-pushed the support_group_accounts_ii branch from 2c4fe20 to fe1efdb Compare April 26, 2022 21:15
@erichulburd erichulburd force-pushed the support_group_accounts_ii branch from fe1efdb to ecd3b11 Compare April 26, 2022 21:30
@dbanty
Copy link
Contributor

dbanty commented Apr 26, 2022

Great! So users are expected to configure this in their settings.toml somehow? Should we add something to the docs stating how to do that? And/or add a helper function to the config class that makes patching it (like you did in the test) easier?

Also, the description of this PR is out of date I think, still mentions get_qc

@erichulburd
Copy link
Contributor Author

@dbanty Good question about the docs. I'm inclined to say that client configuration documentation shouldn't leak into pyQuil. That said, we could probably be more explicit about configuration in the qcs-api-client documentation: https://qcs-api-client-python.readthedocs.io/en/latest/autoapi/qcs_api_client/index.html

There will be explicit documentation about configuring group accounts at https://docs.rigetti.com/qcs/. It will require something along the lines of:

qcs tools add-group-profile my-group-profile my-group

@dbanty
Copy link
Contributor

dbanty commented Apr 27, 2022

Maybe just a link from where config is mentioned in pyquil to the relevant API docs?

Although, I'm thinking now we should document all config-related things on the main docs website and link to there from everywhere else since the C and Rust SDKs also use the same file formats.

@erichulburd erichulburd force-pushed the support_group_accounts_ii branch from c4accf6 to 97fa90a Compare April 27, 2022 21:42
@erichulburd erichulburd force-pushed the support_group_accounts_ii branch from 97fa90a to 69c4b50 Compare April 27, 2022 22:55
@erichulburd
Copy link
Contributor Author

erichulburd commented Apr 27, 2022

We can probably add a bit more detail to this section in the docs, but probably the best entry point to configuration documentation that can link out to other documentation and sources.

https://docs.rigetti.com/qcs/guides/using-the-qcs-cli#configuring-credentials

@erichulburd erichulburd requested a review from dbanty April 27, 2022 23:09
Copy link
Contributor

@dbanty dbanty left a comment

Choose a reason for hiding this comment

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

LGTM

@erichulburd erichulburd merged commit 8a69011 into rc Apr 27, 2022
@erichulburd erichulburd deleted the support_group_accounts_ii branch April 27, 2022 23:33
@dbanty dbanty changed the title Support group accounts ii Update: Support group accounts Apr 27, 2022
dbanty pushed a commit that referenced this pull request Apr 27, 2022
* Update: support qcs account headers on engagement creation

* Docs: provide a link to QCS cli configuration
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 this pull request may close these issues.

2 participants