Merge pull request #493 from qiboteam/docsreferee

updating docs
qiboteam · Oct 14, 2021 · d8bd2d3 · d8bd2d3
2 parents 90bb1db + 3b4f2ae
commit d8bd2d3
Show file tree

Hide file tree

Showing 3 changed files with 51 additions and 20 deletions.
diff --git a/doc/source/appendix/benchmarks.rst b/doc/source/appendix/benchmarks.rst
@@ -39,13 +39,13 @@ respective default simulation precision and supported hardware configurations.
    * - `TFQ 0.3.0 <https://github.com/tensorflow/quantum>`_
      - single
      - single-thread CPU
-   * - `Qiskit 0.14.2 <https://github.com/Qiskit>`_
+   * - `Qiskit 0.16.1 <https://github.com/Qiskit>`_
      - double
      - single-thread CPU
    * - `PyQuil 2.20.0 <https://github.com/rigetti/pyquil>`_
      - double
      - single-thread CPU
-   * - `IntelQS 0.14.2 <https://github.com/iqusoft/intel-qs>`_
+   * - `IntelQS 2.0.0 <https://github.com/iqusoft/intel-qs>`_
      - double
      - multi-thread CPU
    * - `QCGPU 0.1.1 <https://github.com/libtangle/qcgpu>`_

diff --git a/doc/source/getting-started/installation.rst b/doc/source/getting-started/installation.rst
@@ -47,19 +47,33 @@ Make sure you have Python 3.6 or greater, then use ``pip`` to install ``qibo`` w
 The ``pip`` program will download and install all the required
 dependencies for Qibo.
 
+Installing with conda
+"""""""""""""""""""""
+
+We provide conda packages for ``qibo`` through the `conda-forge
+<https://anaconda.org/conda-forge>`_ channel.
+
+To install both packages ``qibo`` package with conda run:
+
+.. code-block:: bash
+
+      conda install -c conda-forge qibo
+
 
 Installing from source
 """"""""""""""""""""""
 
-The installation procedure presented in this section is useful when you have to develop the code from source.
+The installation procedure presented in this section is useful when you have to
+develop the code from source.
 
-In order to install Qibo from source, you can simply clone the GitHub repository with
+In order to install Qibo from source, you can simply clone the GitHub repository
+with
 
 .. code-block::
 
       git clone https://github.com/qiboteam/qibo.git
       cd qibo
-      pip install . # or pip install -e .
+      pip install .
 
 _______________________
 
@@ -99,6 +113,25 @@ In order to install the package use the following command:
       instructions from the `official website
       <https://docs.cupy.dev/en/stable/install.html>`_ for your GPU hardware.
 
+Installing with conda
+"""""""""""""""""""""
+
+We provide conda packages for ``qibo`` through the `conda-forge
+<https://anaconda.org/conda-forge>`_ channel.
+
+To install both packages ``qibo`` package with conda run:
+
+.. code-block:: bash
+
+      conda install -c conda-forge qibojit
+
+.. note::
+      The ``conda`` program will download and install all the required
+      dependencies except `cupy <https://cupy.dev/>`_ which is required for GPU
+      acceleration. Please install `cupy <https://cupy.dev/>`_ by following the
+      instructions from the `official website
+      <https://docs.cupy.dev/en/stable/install.html>`_ for your GPU hardware or
+      use the respective conda package.
 
 Installing from source
 """"""""""""""""""""""
@@ -113,25 +146,12 @@ In order to install the package perform the following steps:
       git clone https://github.com/qiboteam/qibojit.git
       cd qibojit
 
-then proceed with the installation of requirements with:
-
-.. code-block::
-
-      pip install -r requirements.txt
-
 Then proceed with the ``qibojit`` installation using ``pip``
 
 .. code-block::
 
       pip install .
 
-or if you prefer to manually execute all installation steps:
-
-.. code-block::
-
-      # builds binaries
-      python setup.py deve
-
 _______________________
 
 .. _installing-qibotf:

diff --git a/doc/source/getting-started/quickstart.rst b/doc/source/getting-started/quickstart.rst
@@ -1,14 +1,25 @@
 Quick start
 -----------
 
-To quickly install Qibo, open a terminal with python > 3.6 and type:
+To quickly install Qibo and a high performance simulator for CPU, open a
+terminal with python > 3.6 and type:
 
 .. code-block:: bash
 
-      pip install qibo
+      pip install qibo[qibojit]
 
 This will install the basic primitives to start coding quantum applications.
 
+Instead, if you use `conda <https://anaconda.org/>`_ type:
+
+.. code-block:: bash
+
+      conda install -c conda-forge qibo qibojit
+
+.. warning::
+    The ``qibo`` package alone includes a lightweight ``numpy`` simulator for
+    single-thread CPU. Please visit the `backends <backend-drivers>`_
+    documentation for more details about simulation backends.
 
 Here an example of Quantum Fourier Transform (QFT) to test your installation: