You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Right click on `this link <https://raw.githubusercontent.com/QCoDeS/Qcodes/master/environment.yml>`__
30
+
Installing the latest QCoDeS release
31
+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
32
+
First download the QCoDeSenvironment.yml file by right
33
+
clicking on `this link <https://raw.githubusercontent.com/QCoDeS/Qcodes/master/environment.yml>`__
34
34
and select save link as and download the file to a location
35
35
that you can find again.
36
-
Once Anaconda is installed and the environment.yml file downloaded
37
-
launch an Anaconda Prompt.
36
+
Next launch an Anaconda Prompt (start typing anaconda in the start menu and
37
+
click on *Anaconda Prompt*).
38
38
39
-
Now you are ready to install QCoDeS, type in the terminal.
39
+
Here type in the prompt:
40
40
41
41
.. code:: bash
42
42
43
43
conda env create -f environment.yml
44
+
activate qcodes
44
45
pip install qcodes
45
46
46
-
Enter QCoDes
47
-
------------
48
-
In general follow this steps to get a terminal back:
47
+
The first line creates a new anaconda environment that is called *qcodes*
48
+
and will install all the required dependendencies. The second line activates
49
+
this freshly created environment, so that the command in the third line will
50
+
install qcodes for this environment.
49
51
52
+
Installing QCoDeS from GitHub
53
+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
54
+
Clone the QCoDeS repository from GitHub from https://github.com/QCoDeS/Qcodes
55
+
Then create an environment, that contains all of the dependencies for QCoDeS,
56
+
from the *environment.yml* file in the root of the repository and activate it:
50
57
51
-
- Open navigator
52
-
- On the left side click on "Environments".
53
-
- Click qcodes to activate it
54
-
- Click the green arrow to open a terminal inside it.
58
+
.. code:: bash
55
59
56
-
Now go to the directory of your experiment, and start a notebook or spyder.
60
+
conda env create -f <path-to-environment.yml>
61
+
activate qcodes
62
+
63
+
Finally install QCoDeS add the repository via
57
64
58
65
.. code:: bash
59
66
60
-
cd my_experiment
61
-
jupyter notebook
67
+
pip install -e <path-to-repository>
68
+
62
69
63
-
or
70
+
Using QCoDes
71
+
------------
72
+
For using QCoDeS, as with any other python library, it is useful to use an
73
+
application that facilitates the editing and execution of python files. With
74
+
Anaconda there come two preinstalled options:
75
+
76
+
* **Jupyter**, a browser based notebook
77
+
* **Spyder**, an integrated development environment
78
+
79
+
To start either of them you can use the shortcuts in the start menu under
80
+
*Anaconda3* with a trailing *(qcodes)*.
81
+
82
+
For other options you can launch a terminal either via the *Anaconda Navigator*
83
+
by selecting *qcodes* in the *Environments tab* and left-clicking on the *play*
84
+
button or by entering
64
85
65
86
.. code:: bash
66
87
67
-
cd my_experiment
68
-
spyder
88
+
activate qcodes
89
+
90
+
in the *Anaconda prompt*
69
91
70
-
Then:
92
+
From the terminal you can then start any other application, such as *IPython* or
93
+
just plain old *Python*.
71
94
72
-
- build quantum computer
73
-
- profit
74
95
75
-
Usage
76
-
-----
96
+
Getting started
97
+
---------------
77
98
78
-
Read the :ref:`userguide`, and or browse the examples:
99
+
Have a look at :ref:`userguide`, and or browse the examples at:
0 commit comments