diff --git a/docs/contributing_to_qiskit.rst b/docs/contributing_to_qiskit.rst index 16a8bb00f9be..a87e0b406c10 100644 --- a/docs/contributing_to_qiskit.rst +++ b/docs/contributing_to_qiskit.rst @@ -805,85 +805,83 @@ using. Since Aer is a compiled C++ program with a Python interface, there are non-Python dependencies for building the Aer binary which can't be installed universally depending on operating system. -.. tabs:: +.. tabbed:: Linux - .. tab:: Linux + 3. Install compiler requirements. - 3. Install compiler requirements. + Building Aer requires a C++ compiler and development headers. - Building Aer requires a C++ compiler and development headers. + If you're using Fedora or an equivalent Linux distribution, + install using: - If you're using Fedora or an equivalent Linux distribution, - install using: + .. code:: sh - .. code:: sh + dnf install @development-tools - dnf install @development-tools + For Ubuntu/Debian install it using: - For Ubuntu/Debian install it using: + .. code:: sh - .. code:: sh + apt-get install build-essential - apt-get install build-essential + 4. Install OpenBLAS development headers. - 4. Install OpenBLAS development headers. + If you're using Fedora or an equivalent Linux distribution, + install using: - If you're using Fedora or an equivalent Linux distribution, - install using: + .. code:: sh - .. code:: sh + dnf install openblas-devel - dnf install openblas-devel + For Ubuntu/Debian install it using: - For Ubuntu/Debian install it using: + .. code:: sh - .. code:: sh + apt-get install libopenblas-dev - apt-get install libopenblas-dev +.. tabbed:: macOS - .. tab:: macOS + 3. Install dependencies. - 3. Install dependencies. + To use the `Clang `__ compiler on macOS, you need to install + an extra library for supporting `OpenMP `__. You can use `brew `__ + to install this and other dependencies. - To use the `Clang `__ compiler on macOS, you need to install - an extra library for supporting `OpenMP `__. You can use `brew `__ - to install this and other dependencies. + .. code:: sh - .. code:: sh + brew install libomp - brew install libomp + 4. Then install a BLAS implementation; `OpenBLAS `__ + is the default choice. - 4. Then install a BLAS implementation; `OpenBLAS `__ - is the default choice. + .. code:: sh - .. code:: sh + brew install openblas - brew install openblas + Next, install ``Xcode Command Line Tools``. - Next, install ``Xcode Command Line Tools``. + .. code:: sh - .. code:: sh + xcode-select --install - xcode-select --install +.. tabbed:: Windows - .. tab:: Windows + On Windows you need to use `Anaconda3 `__ + or `Miniconda3 `__ to install all the + dependencies. - On Windows you need to use `Anaconda3 `__ - or `Miniconda3 `__ to install all the - dependencies. + 3. Install compiler requirements. - 3. Install compiler requirements. + .. code:: sh - .. code:: sh + conda install --update-deps vs2017_win-64 vs2017_win-32 msvc_runtime - conda install --update-deps vs2017_win-64 vs2017_win-32 msvc_runtime + 4. Install binary and build dependencies. - 4. Install binary and build dependencies. + .. code:: sh - .. code:: sh - - conda install --update-deps -c conda-forge -y openblas cmake + conda install --update-deps -c conda-forge -y openblas cmake 5. Build and install qiskit-aer directly diff --git a/docs/getting_started.rst b/docs/getting_started.rst index b7f625fe3c9e..c5826328c065 100644 --- a/docs/getting_started.rst +++ b/docs/getting_started.rst @@ -149,8 +149,9 @@ Installation https://github.com/pypa/sample-namespace-packages/blob/master/table.md for the set of combinations of installation methods that work together. - Set up the Virtual Development Environment - ------------------------------------------ + .. raw:: html + +

Set up the Virtual Development Environment

.. code-block:: sh @@ -159,8 +160,9 @@ Installation .. _install-qiskit-terra: - Installing Terra from Source - ---------------------------- + .. raw:: html + +

Installing Terra from Source

Installing from source requires that you have a C++ compiler on your system that supports C++11. @@ -261,8 +263,9 @@ Installation .. _install-qiskit-aer: - Installing Aer from Source - -------------------------- + .. raw:: html + +

Installing Aer from Source

1. Clone the Aer repository. @@ -399,8 +402,9 @@ Installation .. _aer_wheel_build_options: - Custom options during wheel builds - ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + .. raw:: html + +

Custom options

The Aer build system uses `scikit-build `__ to run the compilation when building it with the Python interface. It acts as an interface for @@ -478,8 +482,9 @@ Installation .. _install-qiskit-ignis: - Installing Ignis from Source - ---------------------------- + .. raw:: html + +

Installing Ignis from Source

1. Clone the Ignis repository. @@ -516,8 +521,9 @@ Installation .. _install-qiskit-aqua: - Installing Aqua from Source - --------------------------- + .. raw:: html + +

Installing Aqua from Source

1. Clone the Aqua repository. @@ -554,8 +560,9 @@ Installation .. _install-qiskit-ibmq-provider: - Installing IBM Quantum Provider from Source - ------------------------------------------- + .. raw:: html + +

Installing IBM Quantum Provider from Source

1. Clone the qiskit-ibmq-provider repository.