Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/guides/access-groups.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -214,7 +214,7 @@ Create a fourth policy for the same instance.
- **Roles and actions** - For Platform access, select **Administrator**. Click **Next**.
At the bottom, click **Add**, then click **Assign**.

Finally, add users to the access group. You can do this from the access group's **Users** page, or by using the IBM Quantum Platform [Access management](https://quantum.cloud.ibm.com/access-groups) page.
Finally, add users to the access group. You can do this from the access group's **Users** page, or by using the IBM Quantum Platform [Access management](/access-groups) page.

<Admonition type="note">
You can only invite users who are already members of the account. If you don't see a user on the Add users page, follow the steps in [Invite and manage users](/docs/guides/invite-and-manage-users#invite) to add them to the account first. After they accept the invitation, you can add them to the access group.
Expand Down
4 changes: 2 additions & 2 deletions docs/guides/algorithmiq-tem.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@
"source": [
"## Get started\n",
"\n",
"Authenticate using your [IBM Quantum Platform API key](http://quantum.cloud.ibm.com/), and select the TEM function as follows. (This snippet assumes you've already [saved your account](/docs/guides/functions#install-qiskit-functions-catalog-client) to your local environment.)"
"Authenticate using your [IBM Quantum Platform API key](/), and select the TEM function as follows. (This snippet assumes you've already [saved your account](/docs/guides/functions#install-qiskit-functions-catalog-client) to your local environment.)"
]
},
{
Expand Down Expand Up @@ -365,7 +365,7 @@
"\n",
"<Admonition type=\"tip\" title=\"Recommendations\">\n",
"\n",
"- [Request access to Algorithmiq Tensor-network error mitigation](https://quantum.cloud.ibm.com/functions?id=algorithmiq-tem)\n",
"- [Request access to Algorithmiq Tensor-network error mitigation](/functions?id=algorithmiq-tem)\n",
"\n",
"</Admonition>"
]
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/allocation-limits.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ An account might have allotted time on the Premium or Flex plan. Because each ac

The time that you allocate to instances is used by the fair-share algorithm to determine the priority in the queue, based on usage of all QPUs over a rolling time window of 28 days (for Premium Plan users) or over the subscription period (for Flex Plan users).

The allocation is set when creating the instance. However, you can view and change allocated time on the [instances page.](https://quantum.cloud.ibm.com/instances)
The allocation is set when creating the instance. However, you can view and change allocated time on the [instances page.](/instances)


## What happens when the limit is reached
Expand Down
4 changes: 2 additions & 2 deletions docs/guides/cloud-setup-invited.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ You can run workloads on IBM&reg; quantum processing units (QPUs) by setting up
Your user account is associated with one or more [instances](./instances), identified by _Cloud Resource Names_ (CRNs) that give access to IBM Quantum services. Additionally, a unique API token (also called a key) is assigned to each account, allowing for IBM Quantum access from Qiskit. For instructions to choose a specific instance, see [Connect to an instance](./instances#connect-instance).

<Admonition type="note">
The [IBM Quantum Platform dashboard](https://quantum.cloud.ibm.com) and the [Instances page](https://quantum.cloud.ibm.com/instances) list the instances that you can access.
The [IBM Quantum Platform dashboard](/) and the [Instances page](/instances) list the instances that you can access.
</Admonition>

<span id="cloud"></span>
Expand All @@ -26,7 +26,7 @@ Your user account is associated with one or more [instances](./instances), ident

1. Accept the email invitation.
1. Log in with an IBMid or Google account. Note that the profile that you use to log in to IBM Cloud or IBM Quantum Platform in this step is not your IBM Cloud account. After logging in, confirm your information and accept the invitation to join the account.
1. Navigate back to [IBM Quantum Platform.](https://quantum.cloud.ibm.com)
1. Navigate back to [IBM Quantum Platform.](/)
1. Make sure that the correct account and region are selected in the account switcher in the header, as shown in the following image.
* Choose the account that was invited in the email.
* The region controls where your jobs are run and where the job data is kept. You can access either region by using the same API key, but you can only see and access the instances that were created in the region that you're logged in to.
Expand Down
4 changes: 2 additions & 2 deletions docs/guides/cloud-setup-rest-api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ You can access quantum processors with REST APIs, enabling you to work with QPUs

### 1. Get access

1. If you do not already have a user account, get one at the [IBM Quantum login page.](https://quantum.cloud.ibm.com/login)
1. Create an API key (also called a token) on the [dashboard.](https://quantum.cloud.ibm.com) Note that the same API key can be used for either region.
1. If you do not already have a user account, get one at the [IBM Quantum login page.](/login)
1. Create an API key (also called a token) on the [dashboard.](/) Note that the same API key can be used for either region.
1. Generate an IBM Cloud Identity and Access Management (IAM) bearer token. This is a short-lived token used to authenticate requests to the REST API. To generate one, call the [IAM Identity Services API](https://cloud.ibm.com/apidocs/iam-identity-token-api#create-api-key) as shown in the following sample request:
<Tabs>

Expand Down
4 changes: 2 additions & 2 deletions docs/guides/cloud-setup-untrusted.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@ Follow these instructions if you are working with IBM Cloud or the IBM Qiskit Ru
<span id="access-credentials"></span>
## Find your access credentials

1. Find your API key (also referred to as an _API token_). From the [dashboard](https://quantum.cloud.ibm.com/), create your API key, then copy it to a secure location so you can use it for authentication. The token will not be visible again. Note that you can use a single API key to connect to any region.
2. Optional: Find the instance you want to use from the [Instances](https://quantum.cloud.ibm.com/instances) page. Hover over its CRN, click the icon to copy it, then save it in a secure location so you can use it to identify the instance.
1. Find your API key (also referred to as an _API token_). From the [dashboard](/), create your API key, then copy it to a secure location so you can use it for authentication. The token will not be visible again. Note that you can use a single API key to connect to any region.
2. Optional: Find the instance you want to use from the [Instances](/instances) page. Hover over its CRN, click the icon to copy it, then save it in a secure location so you can use it to identify the instance.

## Authenticate to IBM Cloud in an untrusted environment

Expand Down
8 changes: 4 additions & 4 deletions docs/guides/cloud-setup.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,11 @@ Your user account is associated with one or more [instances,](./instances) ident

### Before you begin

1. If you do not already have one, set up an [IBM Cloud account.](https://quantum.cloud.ibm.com/registration)
1. If you do not already have one, set up an [IBM Cloud account.](/registration)
<Admonition type="note">
You can be part of multiple IBM Cloud accounts. You can access any of your IBM Cloud accounts at any time from the account switcher in the header of the [IBM Quantum Platform](https://quantum.cloud.ibm.com) interface.
You can be part of multiple IBM Cloud accounts. You can access any of your IBM Cloud accounts at any time from the account switcher in the header of the [IBM Quantum Platform](/) interface.
</Admonition>
1. Log in to [IBM Quantum Platform](https://quantum.cloud.ibm.com) with an IBMid or Google account. If you don't have one, you are guided through creating one. (These login credentials are not your IBM Cloud account credentials.)
1. Log in to [IBM Quantum Platform](/) with an IBMid or Google account. If you don't have one, you are guided through creating one. (These login credentials are not your IBM Cloud account credentials.)
1. Make sure that the correct account and region are selected in the account switcher in the header, as shown in the following image.

The region controls where your jobs are run and where the job data is kept. You can access either region by using the same API key, but you can only see and access the instances that were created in the region that you're logged in to.
Expand All @@ -33,7 +33,7 @@ Your user account is associated with one or more [instances,](./instances) ident

### 1. Create an instance

You can create an instance from the IBM Quantum Platform [Instances](https://quantum.cloud.ibm.com/instances) page. See [Create an instance](/docs/guides/instances#add-instance) for detailed instructions.
You can create an instance from the IBM Quantum Platform [Instances](/instances) page. See [Create an instance](/docs/guides/instances#add-instance) for detailed instructions.

### 2. Optional: Save your access credentials

Expand Down
2 changes: 1 addition & 1 deletion docs/guides/common-parameters.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -214,7 +214,7 @@
"id": "d2034dd5-23e5-4473-89b8-aaf4233775c7",
"metadata": {},
"source": [
"You can use the [`plot_error_map`](/docs/api/qiskit/qiskit.visualization.plot_error_map) function to generate a diagram of the device graph with error information and with the physical qubits labeled. You can also view similar diagrams on the [Compute resources](https://quantum.cloud.ibm.com/computers) page."
"You can use the [`plot_error_map`](/docs/api/qiskit/qiskit.visualization.plot_error_map) function to generate a diagram of the device graph with error information and with the physical qubits labeled. You can also view similar diagrams on the [Compute resources](/computers) page."
]
},
{
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/composer.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ description: IBM Quantum Composer is a graphical programming tool. Drag and drop

## What is it?

[IBM Quantum&reg; Composer](https://quantum.cloud.ibm.com/composer) is a graphical quantum programming tool that lets you drag and drop operations to build quantum circuits and run them on quantum hardware.
[IBM Quantum&reg; Composer](/composer) is a graphical quantum programming tool that lets you drag and drop operations to build quantum circuits and run them on quantum hardware.

## What can it do?

Expand Down
2 changes: 1 addition & 1 deletion docs/guides/estimate-job-run-time.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@
"<span id=\"instance-usage\"></span>\n",
"## View instance usage\n",
"\n",
"You can view an instance's usage on the [Instances](https://quantum.cloud.ibm.com/instances) page, or, for those with the proper authority, the [Analytics](https://quantum.cloud.ibm.com/analytics) page. Note that the pages might show different usage numbers because they calculate usage differently.\n",
"You can view an instance's usage on the [Instances](/instances) page, or, for those with the proper authority, the [Analytics](/analytics) page. Note that the pages might show different usage numbers because they calculate usage differently.\n",
"\n",
"The Instances page shows real-time usage for the last 28 days (rolling), up to the current time on the current day. The Analytics page usage is re-calculated hourly and includes the last 28 full days; that is, it shows usage from 00:00 28 days ago to today, at the top of the hour.\n",
"\n",
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/function-template-chemistry-workflow.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@
"source": [
"### Authentication\n",
"\n",
"Use `qiskit-ibm-catalog` to authenticate to `QiskitServerless` with your API key (token), which can be found on the [IBM Quantum Platform](https://quantum.cloud.ibm.com) dashboard. This allows for the instantiation of the serverless client to upload or run the selected function:\n",
"Use `qiskit-ibm-catalog` to authenticate to `QiskitServerless` with your API key (token), which can be found on the [IBM Quantum Platform](/) dashboard. This allows for the instantiation of the serverless client to upload or run the selected function:\n",
"\n",
"```python\n",
"from qiskit_ibm_catalog import QiskitServerless\n",
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/function-template-hamiltonian-simulation.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -586,7 +586,7 @@
"## Deploy the function to IBM Quantum Platform\n",
"The previous section created a program to be run remotely. The code in this section uploads that program to Qiskit Serverless.\n",
"\n",
"Use `qiskit-ibm-catalog` to authenticate to `QiskitServerless` with your API key, which you can find on the [IBM Quantum Platform](https://quantum.cloud.ibm.com) dashboard, and upload the program.\n",
"Use `qiskit-ibm-catalog` to authenticate to `QiskitServerless` with your API key, which you can find on the [IBM Quantum Platform](/) dashboard, and upload the program.\n",
"\n",
"You can optionally use `save_account()` to save your credentials (see the [Set up your IBM Cloud account](/docs/guides/cloud-setup#cloud-save) guide). Note that this writes your credentials to the same file as [`QiskitRuntimeService.save_account()`.](/docs/api/qiskit-ibm-runtime/qiskit-runtime-service#save_account)"
]
Expand Down
4 changes: 2 additions & 2 deletions docs/guides/functions.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@
"\n",
"### Request a free trial for third-party Qiskit Functions\n",
"\n",
"To request a new free trial, navigate to the [Qiskit Functions Catalog](https://quantum.cloud.ibm.com/functions), and explore the details panel. Click on `Request a free trial` and fill out information required by the Functions partner, including the IBM Cloud `AccessGroupId`:\n",
"To request a new free trial, navigate to the [Qiskit Functions Catalog](/functions), and explore the details panel. Click on `Request a free trial` and fill out information required by the Functions partner, including the IBM Cloud `AccessGroupId`:\n",
"\n",
"1. Navigate to [IBM Cloud IAM.](http://cloud.ibm.com/iam/groups)\n",
"2. Verify eligibility.\n",
Expand All @@ -80,7 +80,7 @@
" ```\n",
" pip install qiskit-ibm-catalog\n",
" ```\n",
"1. Retrieve your API key from the [IBM Quantum Platform dashboard](https://quantum.cloud.ibm.com/), and activate your Python virtual environment. See the [installation instructions](/docs/guides/install-qiskit#local) if you do not already have a virtual environment set up.\n",
"1. Retrieve your API key from the [IBM Quantum Platform dashboard](/), and activate your Python virtual environment. See the [installation instructions](/docs/guides/install-qiskit#local) if you do not already have a virtual environment set up.\n",
"\n",
" <span id=\"save-account\"></span>**If you are working in a trusted Python environment (such as on a personal laptop or workstation),** use the `save_account()` method to save your credentials locally. ([Skip to the next step](#functions-untrusted) if you are not using a trusted environment, such as a shared or public computer, to authenticate to IBM Quantum Platform.)\n",
"\n",
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/get-qpu-information.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@
"source": [
"## List backends\n",
"\n",
"To view the backends you have access to, you can either view a list on the [Compute resources page,](https://quantum.cloud.ibm.com/computers) or you can use the [`QiskitRuntimeService.backends()`](../api/qiskit-ibm-runtime/qiskit-runtime-service#backends) method. This method returns a list of [`IBMBackend`](../api/qiskit-ibm-runtime/ibm-backend) instances:\n",
"To view the backends you have access to, you can either view a list on the [Compute resources page,](/computers) or you can use the [`QiskitRuntimeService.backends()`](../api/qiskit-ibm-runtime/qiskit-runtime-service#backends) method. This method returns a list of [`IBMBackend`](../api/qiskit-ibm-runtime/ibm-backend) instances:\n",
"\n",
"<Admonition type=\"note\">\n",
"If you are logged in to a specific instance or region, or if you initialized the service with a specific instance or region by using `QiskitRuntimeService()`, only the backends available to you on that instance or region are returned.\n",
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/global-data-quantum-optimizer.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -448,7 +448,7 @@
"id": "5028c729-6223-4108-bc1e-1c9d95a56bd6",
"metadata": {},
"source": [
"Authenticate using your [API key](https://quantum.cloud.ibm.com/) and select the Qiskit Function as follows. (This snippet assumes you've already [saved your account](/docs/guides/functions#install-qiskit-functions-catalog-client) to your local environment.)"
"Authenticate using your [API key](/) and select the Qiskit Function as follows. (This snippet assumes you've already [saved your account](/docs/guides/functions#install-qiskit-functions-catalog-client) to your local environment.)"
]
},
{
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/ibm-circuit-function.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@
"id": "f46c531c",
"metadata": {},
"source": [
"Authenticate using your [API key](http://quantum.cloud.ibm.com/) and select the Qiskit Function as follows. (This snippet assumes you've already [saved your account](/docs/guides/functions#install-qiskit-functions-catalog-client) to your local environment.)"
"Authenticate using your [API key](/) and select the Qiskit Function as follows. (This snippet assumes you've already [saved your account](/docs/guides/functions#install-qiskit-functions-catalog-client) to your local environment.)"
]
},
{
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ pip install qiskit_serverless

## Qiskit Functions

Qiskit Functions (`qiskit-ibm-catalog.QiskitFunctionsCatalog`) are abstracted services designed to accelerate algorithm discovery and application prototyping. Explore the [Qiskit Functions Catalog](https://quantum.cloud.ibm.com/functions), including:
Qiskit Functions (`qiskit-ibm-catalog.QiskitFunctionsCatalog`) are abstracted services designed to accelerate algorithm discovery and application prototyping. Explore the [Qiskit Functions Catalog](/functions), including:

- **Circuit functions**: Services that include transpilation, error suppression, error mitigation, and post-processing techniques that take abstract circuits and desired measurement observables as input. With Circuit functions, users can discover new algorithms and applications without needing to manage transpilation or quantum hardware performance.
- **Application functions**: Services that include entire quantum workflows, from mapping classical to quantum, optimizing for hardware, execution on hardware, and post-processing. Users can prototype industry applications with domain-familiar inputs and outputs.
Expand Down
6 changes: 3 additions & 3 deletions docs/guides/initialize-account.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Ensure that you have completed these steps:

1. Ensure that you are a member of an IBM Cloud account. See [Set up your IBM Cloud account](/docs/guides/cloud-setup) for instructions.
2. Create (or have access to) at least one instance. Follow these steps to verify:
1. Log in to [IBM Quantum Platform](https://quantum.cloud.ibm.com).
1. Log in to [IBM Quantum Platform](/).
1. Make sure that the correct account and region are selected in the account switcher in the header.
1. If you have one or more instances shown, you're done with this step. Otherwise, [create an instance.](/docs/guides/instances#add-instance)
1. Ensure you are working in an active Python environment with the [Qiskit SDK and Qiskit Runtime installed.](/docs/guides/install-qiskit#local)
Expand All @@ -30,8 +30,8 @@ Ensure that you have completed these steps:
<span id="access-credentials"></span>
## Find your access credentials

1. Find your API key (also referred to as an _API token_). From the [dashboard](https://quantum.cloud.ibm.com/), create your API key, then copy it to a secure location so you can use it for authentication. The token will not be visible again. Note that you can use a single API key to connect to any region.
2. Optional: Find the instance you want to use from the [Instances](https://quantum.cloud.ibm.com/instances) page. Hover over its CRN, click the icon to copy it, then save it in a secure location so you can use it to identify the instance.
1. Find your API key (also referred to as an _API token_). From the [dashboard](/), create your API key, then copy it to a secure location so you can use it for authentication. The token will not be visible again. Note that you can use a single API key to connect to any region.
2. Optional: Find the instance you want to use from the [Instances](/instances) page. Hover over its CRN, click the icon to copy it, then save it in a secure location so you can use it to identify the instance.


## Connect Qiskit with your Qiskit Runtime service instance
Expand Down
Loading