From ffa240e78d279af0ef16e672bae21da9156547fc Mon Sep 17 00:00:00 2001 From: Matthew Treinish Date: Mon, 10 Jun 2019 10:28:45 -0400 Subject: [PATCH] Cleanup terra install doc and fix broken links (Qiskit/qiskit-metapackage#316) There was one section of the terra install guide that was misleading, you do not need to use an editable install to run the examples. An editable install allows you to make changes to the repo and have that take effect immediately without requiring an uninstall. [1][2] For running examples it doesn't make a difference how you install terra. At the same time the links at the bottom of the repo are updated to point to the new locations for the CONTRIBUTING.md files. [1] https://pip.pypa.io/en/stable/reference/pip_install/#editable-installs [2] https://setuptools.readthedocs.io/en/latest/setuptools.html#development-mode --- docs/contributing_to_qiskit.rst | 26 ++++++++++++++------------ 1 file changed, 14 insertions(+), 12 deletions(-) diff --git a/docs/contributing_to_qiskit.rst b/docs/contributing_to_qiskit.rst index 9ae4e1769e89..d500a0ae0c14 100644 --- a/docs/contributing_to_qiskit.rst +++ b/docs/contributing_to_qiskit.rst @@ -147,7 +147,7 @@ The following steps show the installation process for Ignis. pip install -e qiskit-ignis Install Terra from Source --------------------------------- +------------------------- Installing from source requires that you have a c++ compiler on your system that supports c++-11. On most Linux platforms, the necessary GCC compiler is already installed. @@ -209,24 +209,26 @@ Install Qiskit Terra pip install . - -* To get the examples working, install and run them with the following commands. +* If you want to install it in editable mode, meaning that code changes to the + project don't require a reinstall to be applied you can do this with: .. code:: sh pip install -e . + +* You can then run the code examples working after installing terra. You can + run the example with the following command. + +.. code:: sh + python examples/python/using_qiskit_terra_level_0.py After you've installed Terra, you can install Aer as an add-on to run additional simulators. -* `Qiskit Aer `__ +* `Qiskit Ignis `_ +* `Qiskit Aqua `__ +* `Qiskit Chemistry `__ +* `Qiskit IBMQ Provider `__ -* `Qiskit Ignis `_ -* `Qiskit Aqua `__ -* `Qiskit Chemistry `__ -* `Qiskit IBMQ Provider `__