QCS Group Accounts
QCS group accounts provide a means for QCS users to share reservations and billing accounts.
Users may perform actions on behalf of a group, such as:
Creating a reservation for the group.
Executing a program on a QPU using a group's reservation.
Using a group for these actions allows multiple users to share resources and QPU time amongst each other. In these cases, QCS will bill the shared group account for the reservation and usage rather than the individual user accounts.
Creating a New Group Account
For information about setting up a group account please contact [email protected].
Using a Group Account
Updating Your Local Configuration Files
Once you belong to a group account, you can run the following command to add it to your QCS configuration file; this will work anywhere that the QCS CLI is installed.
qcs tools add-group-profile my-group-profile my-group
To confirm the operation successfully saved the new profile to your QCS configuration, you may run the following command:
qcs settings list-profiles
After confirmation, you may set the --profile-name
argument on any API command or set the QCS_PROFILE_NAME
environment variable to my-group-profile
to create a group reservation or a group engagement:
qcs --profile-name my-group-profile api create-reservation # ...
# or...
QCS_PROFILE_NAME=my-group-profile qcs api create-reservation # ...
If you would like to use your group profile by default you may run the following:
qcs settings set default_profile_name my-group-profile
Note, however, that setting the QCS_PROFILE_NAME
environment variable will override your default profile name.
Using Group Accounts in pyQuil
In many cases, you will be sending programs to a Rigetti QPU using pyQuil. In order to submit a QPU job on behalf of a group, you can set the QCS_PROFILE_NAME
as described above.
QCS_PROFILE_NAME=my-group-profile python my_pyquil_script.py
Note, this feature requires pyQuil >= 3.2.0.
Query Group Account Reservations and Balances
Below are some useful commands related to group accounts; each of these CLI commands has corresponding support in the qcs_api_client Python package. You can always use qcs api --help
for the latest, non-abridged list of available commands.
qcs api get-group-balance my-group
qcs api list-group-reservations my-group
qcs api list-group-users my-group
Last updated
Was this helpful?