From a423938a8a576f4c35d3af39b506e38a4a157c8f Mon Sep 17 00:00:00 2001 From: Dominik Vogel Date: Fri, 8 Dec 2017 12:41:03 +0100 Subject: [PATCH 1/2] corrected activate env --- docs/start/index.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/start/index.rst b/docs/start/index.rst index 731526a95ac..bf82f5951ae 100644 --- a/docs/start/index.rst +++ b/docs/start/index.rst @@ -11,7 +11,7 @@ Requirements ------------ For scientist we require to install Anaconda, because it makes -easy to get all dependencies. +easy to get all dependencies. Download and install `here `_. Make sure to download the latest version with python 3.6. @@ -41,6 +41,7 @@ Now you are ready to install QCoDeS, type in the terminal. .. code:: bash conda env create -f environment.yml + activate qcodes pip install qcodes Enter QCoDes From cd80132231b0fa99717484854f5b58052b85871c Mon Sep 17 00:00:00 2001 From: Dominik Vogel Date: Fri, 8 Dec 2017 13:26:05 +0100 Subject: [PATCH 2/2] updated installation instructions --- docs/start/index.rst | 92 +++++++++++++++++++++++++++----------------- 1 file changed, 56 insertions(+), 36 deletions(-) diff --git a/docs/start/index.rst b/docs/start/index.rst index bf82f5951ae..32488c7ddd4 100644 --- a/docs/start/index.rst +++ b/docs/start/index.rst @@ -10,33 +10,33 @@ Getting Started Requirements ------------ -For scientist we require to install Anaconda, because it makes -easy to get all dependencies. -Download and install `here `_. -Make sure to download the latest version with python 3.6. +You need a working python 3.x installation to be able to use QCoDeS. We highly +recommend installing Anaconda, which takes care of installing Python and +managing packages. In the following it will be assumed that you use Anaconda. +Download and install it from `here `_. Make +sure to download the latest version with python 3.6. -Once you download, install Anaconda according to the instructions on screen. - -If you use \*nix, you really should use the source. +Once you download, install Anaconda according to the instructions on screen, +choosing the single user installation option. The next section will guide you through the installation of QCoDeS -on Windows, although most of the things also work for osx and Linux. -(that is, assuming you did not change your $PATH, and or have virtual envs, -but in that case you should once more just use the source) +on Windows, although most of the things also work for macOS and Linux. Installation ------------ +Before you install QCoDeS you have to decide whether you want to install the +latest stable release or if you want to get the developer version from GitHub. -To setup an Anaconda environment for QCoDeS it's convenient to download -QCoDeS environment.yml file from -`here `__. -Right click on `this link `__ +Installing the latest QCoDeS release +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +First download the QCoDeS environment.yml file by right +clicking on `this link `__ and select save link as and download the file to a location that you can find again. -Once Anaconda is installed and the environment.yml file downloaded -launch an Anaconda Prompt. +Next launch an Anaconda Prompt (start typing anaconda in the start menu and +click on *Anaconda Prompt*). -Now you are ready to install QCoDeS, type in the terminal. +Here type in the prompt: .. code:: bash @@ -44,38 +44,58 @@ Now you are ready to install QCoDeS, type in the terminal. activate qcodes pip install qcodes -Enter QCoDes ------------- -In general follow this steps to get a terminal back: +The first line creates a new anaconda environment that is called *qcodes* +and will install all the required dependendencies. The second line activates +this freshly created environment, so that the command in the third line will +install qcodes for this environment. + +Installing QCoDeS from GitHub +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Clone the QCoDeS repository from GitHub from https://github.com/QCoDeS/Qcodes +Then create an environment, that contains all of the dependencies for QCoDeS, +from the *environment.yml* file in the root of the repository and activate it: +.. code:: bash -- Open navigator -- On the left side click on "Environments". -- Click qcodes to activate it -- Click the green arrow to open a terminal inside it. + conda env create -f + activate qcodes -Now go to the directory of your experiment, and start a notebook or spyder. +Finally install QCoDeS add the repository via .. code:: bash - cd my_experiment - jupyter notebook + pip install -e + -or +Using QCoDes +------------ +For using QCoDeS, as with any other python library, it is useful to use an +application that facilitates the editing and execution of python files. With +Anaconda there come two preinstalled options: + + * **Jupyter**, a browser based notebook + * **Spyder**, an integrated development environment + +To start either of them you can use the shortcuts in the start menu under +*Anaconda3* with a trailing *(qcodes)*. + +For other options you can launch a terminal either via the *Anaconda Navigator* +by selecting *qcodes* in the *Environments tab* and left-clicking on the *play* +button or by entering .. code:: bash - cd my_experiment - spyder + activate qcodes + +in the *Anaconda prompt* -Then: +From the terminal you can then start any other application, such as *IPython* or +just plain old *Python*. - - build quantum computer - - profit -Usage ------ +Getting started +--------------- -Read the :ref:`userguide`, and or browse the examples: +Have a look at :ref:`userguide`, and or browse the examples at: https://github.com/QCoDeS/Qcodes/tree/master/docs/examples