ColdAtomProvider

class ColdAtomProvider(credentials=None)[source]

Provider for cold atomic backends. To access the devices, the user has to specify the url of the backend, a username and an access token. With these credentials, the provider can be accessed like this:

from qiskit_cold_atom.providers import ColdAtomProvider
# save account with personal credentials
ColdAtomProvider.save_account(url="my_url", username="my_name", token="my_url")
# load account
provider = ColdAtomProvider.load_account()
# access backends
backends = provider.backends()

Constructor of the cold atom provider. Using the given credentials, the provider tries to access the remote backends and adds all backends that can be reached to the available backends.

Parameters:
  • credentials (Optional[Dict[str, Union[str, List[str]]]]) – A dictionary of the shape

  • ['http ({'urls' =) – //…’, …] ‘username’ = ‘…’, ‘token’ = ‘…’}

  • url (The value to the url key could also be a single) –

Raises:

QiskitColdAtomError – If the credentials file specified does not match the expected format

Attributes

ColdAtomProvider.version

Methods

ColdAtomProvider.active_account()

Return the credentials in use for the session.

ColdAtomProvider.add_url(url[, filename])

Add a url to the existing credentials stored on disk

ColdAtomProvider.backends([name, filters])

Abstract method of the Base Provider class

ColdAtomProvider.delete_account([filename])

Delete any credentials saved locally at filename.

ColdAtomProvider.enable_account(url, ...)

Create provider from credentials given at runtime without storing credentials

ColdAtomProvider.get_backend([name])

Return a single backend matching the specified filtering.

ColdAtomProvider.load_account([filename])

Check for stored credentials and return a provider instance.

ColdAtomProvider.save_account(url, username, ...)

Save credentials to a file locally

ColdAtomProvider.stored_account([filename])

Retrieve the credentials stored on disk.