Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Minor changes before first release #18

Merged
merged 2 commits into from
Jan 17, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
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
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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://[email protected]/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.
Expand Down
12 changes: 6 additions & 6 deletions doc/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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://[email protected]/qiboteam/qibo-client.git
pip install qibo-client


Tutorials
Expand All @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion src/qibo_client/qibo_client.py
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
5 changes: 2 additions & 3 deletions src/qibo_client/tii.py
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down