Skip to content

Commit a81baa9

Browse files
setup connections script refined
1 parent e051f3d commit a81baa9

File tree

2 files changed

+9
-7
lines changed

2 files changed

+9
-7
lines changed

docs/getting-started.rst

+2-7
Original file line numberDiff line numberDiff line change
@@ -53,18 +53,13 @@ Setup remote connection
5353

5454
After you installed MPQP package using ``pip install``, the script
5555
:mod:`setup_connections.py<mpqp.execution.connection.setup_connections>` can be
56-
called from everywhere, not only in ``mpqp`` folder, using the following command
57-
line:
56+
called to setup your connection to the remote backends supported, using the
57+
following command:
5858

5959
.. code-block:: console
6060
6161
$ setup_connections
6262
63-
This script will allow you to configure and save your personal account to
64-
connect to remote machines. Depending on the provider, different credentials can
65-
be asked. Information concerning which provider is configured and related
66-
credentials are stored in the ``~/.mpqp`` file.
67-
6863
IBM Quantum
6964
^^^^^^^^^^^
7065

mpqp/execution/connection/setup_connections.py

+7
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,11 @@
11
#! /usr/bin/env python3
2+
"""This script helps you configuring the connections for all the supported
3+
remote backends. In time, it will also guide you to retrieve the tokens,
4+
passwords, etc... but for now, it is a prerequisite that you already have these
5+
credentials to use this script.
6+
7+
Information concerning which provider is configured and related
8+
credentials are stored in the ``~/.mpqp`` file."""
29

310
import mpqp.execution.connection.aws_connection as awsc
411
import mpqp.execution.connection.env_manager as env_m

0 commit comments

Comments
 (0)