From ac5572ccb6e396c19ee3bef6ae688f7e9b31751d Mon Sep 17 00:00:00 2001 From: scarrazza Date: Tue, 16 Jan 2024 18:30:39 +0100 Subject: [PATCH 1/2] minor changes --- README.md | 10 +++++----- doc/source/index.rst | 12 ++++++------ src/qibo_client/qibo_client.py | 2 +- src/qibo_client/tii.py | 5 ++--- 4 files changed, 14 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index f49bba5..9496526 100644 --- a/README.md +++ b/README.md @@ -8,27 +8,27 @@ The documentation of the project can be found Install first the package dependencies with the following commands. We recommend to start with a fresh virtual environment to avoid dependencies -conlficts with previously installed packages. +conflicts with previously installed packages. ```bash python -m venv ./env source activate ./env/bin/activate ``` -The `TiiQ Provider` package can be installed through `pip`: +The `qibo-client` package can be installed through `pip`: ```bash -pip install git+ssh://git@github.com/qiboteam/qibo-client.git +pip install qibo-client ``` -## Quickstart +## Quick start Once installed, the provider allows to run quantum circuit computations on the TiiQ remote server. :warning: Note: to run jobs on the remote cluster it is mandatory to own a validated account. -Please, sign up to [this link](http://http://login.qrccluster.com:8010/) to +Please, sign up to [this link](https://www.qrccluster.com) to obtain the needed token to run computations on the cluster. The following snippet provides a basic usage example. diff --git a/doc/source/index.rst b/doc/source/index.rst index 4d7fec3..eac66b6 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -3,10 +3,10 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -Welcome to qibo-client's documentation! -============================================= +What is qibo-client? +==================== -Qqibo-client is the front end interface to the Qibo labs. +Qibo-client is the front end interface to quantum computing labs using Qibo. The main purpose of the project is to create a client tool written in python able to launch quantum computations through HTTP. @@ -24,11 +24,11 @@ conlficts with previously installed packages. $ python -m venv ./env source activate ./env/bin/activate -The TiiQ Provider package can be installed through pip: +The qibo-client package can be installed through pip: .. code-block:: bash - pip install git+ssh://git@github.com/qiboteam/qibo-client.git + pip install qibo-client Tutorials @@ -40,7 +40,7 @@ remote server. .. note:: In order to run jobs on the remote cluster it is mandatory to own a validated account. Please, sign up to - `this link http://http://login.qrccluster.com:8010/`_ to obtain the needed + `this link https://www.qrccluster.com:8010/`_ to obtain the needed token to run computations on the cluster. The following example shows how to launch a computation on the TII cluster. diff --git a/src/qibo_client/qibo_client.py b/src/qibo_client/qibo_client.py index b15b4c2..8786e32 100644 --- a/src/qibo_client/qibo_client.py +++ b/src/qibo_client/qibo_client.py @@ -13,7 +13,7 @@ from .config import JobPostServerError, MalformedResponseError -RESULTS_BASE_FOLDER = os.environ.get("RESULTS_BASE_FOLDER", "/tmp/qibo_tii_provider") +RESULTS_BASE_FOLDER = os.environ.get("RESULTS_BASE_FOLDER", "/tmp/qibo_client") SECONDS_BETWEEN_CHECKS = os.environ.get("SECONDS_BETWEEN_CHECKS", 2) RESULTS_BASE_FOLDER = Path(RESULTS_BASE_FOLDER) diff --git a/src/qibo_client/tii.py b/src/qibo_client/tii.py index 22177c4..1984153 100644 --- a/src/qibo_client/tii.py +++ b/src/qibo_client/tii.py @@ -2,9 +2,8 @@ from .qibo_client import Client -QRCCLUSTER_IP = os.environ.get("QRCCLUSTER_IP", "login.qrccluster.com") -QRCCLUSTER_PORT = os.environ.get("QRCCLUSTER_PORT", "8010") -BASE_URL = f"http://{QRCCLUSTER_IP}:{QRCCLUSTER_PORT}/" +QRCCLUSTER_IP = os.environ.get("QRCCLUSTER_IP", "www.qrccluster.com") +BASE_URL = f"http://{QRCCLUSTER_IP}/" def TII(token: str) -> Client: From 6a5260f096f46265537b520519bcb3c3039ebb6b Mon Sep 17 00:00:00 2001 From: scarrazza Date: Wed, 17 Jan 2024 10:11:06 +0100 Subject: [PATCH 2/2] updating readme --- doc/source/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/source/index.rst b/doc/source/index.rst index eac66b6..c0aa181 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -40,7 +40,7 @@ remote server. .. note:: In order to run jobs on the remote cluster it is mandatory to own a validated account. Please, sign up to - `this link https://www.qrccluster.com:8010/`_ to obtain the needed + `this link https://www.qrccluster.com`_ to obtain the needed token to run computations on the cluster. The following example shows how to launch a computation on the TII cluster.