Projects
Projects are collaborative workspaces created in an organization to manage teams and resources.
What are projects?
All jobs are submitted to a project since all API keys must be attached to one. Anything submitted with that API key will automatically be associated with that project.
Projects can have many members added to them by an organization owner. Jobs in a project are visible by all members of that project, meaning its easy to share results and see how much budget is left for the team.
Organization owners and members of a project can see it exists or access the jobs in it. Users who are not members of a project cannot see that the project exists or access data for any of its jobs.
Projects can have a budget and backend access set by an organization owner, allowing them to allocate portions of their overall budget to specific teams or initiatives as well as designating projects to run on a specific QPU.
IonQ Quantum Cloud - View my projects
View your available projects on the IonQ Quantum Cloud.
Creating projects
Projects can only be created or managed by organization owners.
To create a new project, click “Create project” on the Projects page. When creating a project, you’ll be prompted to enter a project name, budget, backends access, and description.
Project budgets can be set to:
- Unlimited: No set budget limit for the project. Users can submit QPU jobs as long as the organization has a remaining budget.
- Limited: Constrained by the given dollar amount. Project members can run jobs until the limit is hit for the project. A budget limit of zero means that QPU jobs cannot be submitted to the project, but simulator jobs can still be run.
A project can have access to any or all of the QPU backends that are available to the organization. If no QPUs are selected, the project can still be used to run simulator jobs.
Personal projects
When a new account is created, a project named Personal Workspace ([email protected])
is automatically created as a workspace for the new user. It will have the organization’s default project budget and backend access. Organization owners can change these defaults from the organization settings page at any time, as well as changing the budget and backend access for individual existing projects.
The organization owner can rename a personal workspace project, change its budget and backend access, or add more members, just like they can for any other project.
Members
Project members are users that have been added to a project by an organization owner. Members can submit jobs to the project, view the project’s current available budget, see other members of the project, and view the results of any jobs that have been submitted.
While organization owners can view and manage projects and a project’s jobs, they must add themselves as a member of a project before they’ll be able to create an API key and submit a job to it.
Adding project members
To add project members, navigate to the “members” tab in a project workspace. Select the “Add members” button on the right side of the workspace. When adding a member, you’ll be prompted to select organization members.
Only existing members of an organization can be added to a project. An organization owner must add users to the organization before adding them to any projects.
If a user is removed from an organization, they lose access to any projects they were a member of, but the jobs they submitted to the projects remain there and can be viewed by other project members.
Tracking total member spend
The Members list on a project shows the aggregated spend (total job cost) for each member. These values represent the total of jobs submitted to this project by this user at any point in time.
Jobs
Submitting jobs to a project
When creating an API key, you must assign it to a project. Any job that is submitted using that API key will be submitted to that project. Only members of a project can assign an API key to a project, and thus submit jobs to it.
Viewing jobs in a project
Inside a project, the jobs page shows all of the jobs that have been submitted to the project. All members of a project are able to view any job submitted by any other member of the project.
Job results, including their histogram, can be viewed by clicking on them and selecting view job details
.
Total cost
At the top of the jobs page, the total project cost is displayed for all completed jobs that were run in the project. This is an aggregation of this value across all project members’ jobs submitted at any time.
Settings
To change the project settings navigate to the “settings tab”. You can update project name and project description, as well as backend access.
Adding or changing a project budget
To set up or change a project budget navigate to the “jobs” tab in a project workspace. Select the “change budget” button next to the project cost tracker. You can choose between limited and unlimited budget options.
If a user tries to submit a QPU job whose cost would cause the project’s total spend to exceed its budget, the job will fail with a QuotaExhaustedError
. This includes QPU jobs submitted to projects with zero budget. In this case, the user would not be able to run the job unless the organization owner increased the project budget.
Usage is also limited by the organization’s overall budget. If a user tries to submit a QPU job whose cost would cause the organization’s total spend to exceed its budget, the job will fail with a QuotaExhaustedError
, even if the project budget is unlimited or the project has sufficient budget remaining. The organization owner can view the overall budget and spend on the organization spend page.
Archiving a project
Archiving a project prevents project members from submitting additional jobs to it, and also cancels any jobs that were currently in queue.
To archive a project navigate to the “settings” tab. Select the “archive this project” button. You can unarchive it at any time from the same location.