Skip to content

Commit

Permalink
updating installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
scarrazza committed Oct 13, 2021
1 parent 5831fe9 commit 3b4f2ae
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 27 deletions.
53 changes: 31 additions & 22 deletions doc/source/getting-started/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,18 @@ 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
""""""""""""""""""""""
Expand Down Expand Up @@ -101,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
""""""""""""""""""""""
Expand Down Expand Up @@ -281,28 +312,6 @@ please do:
_______________________

.. _conda:

Installing with conda
---------------------

We provide conda packages for ``qibo`` and ``qibojit`` through the `conda-forge
<https://anaconda.org/conda-forge>`_ channel.

To install the ``qibo`` package with conda run:

.. code-block:: bash
conda install -c conda-forge qibo
Similarly, in order to install the ``qibojit`` package do:

.. code-block:: bash
conda install -c conda-forge qibojit
_______________________

.. _docker:

Using the code with docker
Expand Down
17 changes: 12 additions & 5 deletions doc/source/getting-started/quickstart.rst
Original file line number Diff line number Diff line change
@@ -1,18 +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.

.. note::
The ``qibo`` package includes a lightweight ``numpy`` simulator for
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 in order to install more advanced simulators.
documentation for more details about simulation backends.

Here an example of Quantum Fourier Transform (QFT) to test your installation:

Expand Down

0 comments on commit 3b4f2ae

Please sign in to comment.