Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update installation instructions #841

Merged
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 26 additions & 27 deletions docs/start/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,46 +10,38 @@ Getting Started
Requirements
------------

For scientist we require to install anaconda, because it makes
For scientist we require to install Anaconda, because it makes
easy to get all dependencies.
Download and install `here <https://www.continuum.io/downloads>`_.
Make sure to download the latest version with python 3.5.
Download and install `here <https://www.anaconda.com/download>`_.
Make sure to download the latest version with python 3.6.

Once you download, install anaconda according to the instructions on screen.
Once you download, install Anaconda according to the instructions on screen.

If you use \*nix, you really should use the source.

The next section will guide you through the installation of qcodes
on windows, although most of the things also work for osx and Linux.
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)

Installation
------------
Once installed launch the anaconda navigator.

- On the left side click on "Environments".
- Then on the "new" icon, on the bottom.
- Select a name: for this example we use qcodes
- Finally click "create", and wait until done.
- The enviroment is now created, click on its name to activate it
- Click the green arrow to open a terminal inside it.
To setup an Anaconda environment for QCoDeS it's convenient to download
QCoDeS environment.yml file from
`here https://github.com/QCoDeS/Qcodes/blob/master/environment.yml`_.
Right click on raw 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.

Now you are ready to install QCoDeS, type in the terminal.

.. code:: bash

conda install h5py
conda install matplotlib
pip install pyqtgraph
conda env create -f environment.yml
pip install qcodes


It's nice to have both plotting libraries because pyqtgraph provides nice
interactive plots, and matplotlib publication ready figures (and also embedded
live updating plots in the notebook).


Enter QCoDes
------------
In general follow this steps to get a terminal back:
Expand All @@ -60,13 +52,20 @@ In general follow this steps to get a terminal back:
- Click qcodes to activate it
- Click the green arrow to open a terminal inside it.

Now go to the directory of your experiment, and start a notebook.
Now go to the directory of your experiment, and start a notebook or spyder.

.. code:: bash

cd my_experiment
jupyter notebook

or

.. code:: bash

cd my_experiment
jupyter notebook
cd my_experiment
spyder

Then:

- build quantum computer
Expand All @@ -77,4 +76,4 @@ Usage

Read the :ref:`userguide`, and or browse the examples:

https://github.com/QCoDeS/Qcodes/tree/master/docs/examples
https://github.com/QCoDeS/Qcodes/tree/master/docs/examples
2 changes: 1 addition & 1 deletion environment.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ dependencies:
- pyqt=5.6.0
- numpy
- jupyter=1.0.0
- typing
- hypothesis
- pytest
- pytest-runner
- spyder