Skip to content

Commit

Permalink
manual: update installing.rst.
Browse files Browse the repository at this point in the history
whitequark committed Oct 30, 2015
1 parent f0eed11 commit 62419c0
Showing 1 changed file with 27 additions and 4 deletions.
31 changes: 27 additions & 4 deletions doc/manual/installing.rst
Original file line number Diff line number Diff line change
@@ -29,7 +29,7 @@ If it prints the help of the ``conda`` command, your install is OK.
If not, then make sure your ``$PATH`` environment variable contains the path to anaconda3/bin (or miniconda3/bin)::

$ echo $PATH
/home/..../miniconda3/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/usr/games:/usr/local/games
/home/.../miniconda3/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin

If your ``$PATH`` misses reference the miniconda3/bin or anaconda3/bin you can fix this by typing::

@@ -38,14 +38,37 @@ If your ``$PATH`` misses reference the miniconda3/bin or anaconda3/bin you can f
Installing the host side software
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

For this, you need to add our binstar repository to your conda configuration::
For this, you need to add our Anaconda repository to your conda configuration::

$ conda config --add channels http://conda.anaconda.org/m-labs/channel/main
$ conda config --add channels http://conda.anaconda.org/m-labs/channel/dev

Then you can install the ARTIQ package, it will pull all the necessary dependencies::
Then you can install the ARTIQ package, it will pull all the necessary dependencies.

$ conda install artiq
* For the Pipistrello board::

$ ENV=$(date +artiq-%Y-%m-%d); conda create -n $ENV artiq-pipistrello-nist_qc1; \
echo "Created environment $ENV for ARTIQ"

* For the KC705 board::

$ ENV=$(date +artiq-%Y-%m-%d); conda create -n $ENV artiq-kc705-nist_qc1 artiq-kc705-nist_qc2; \

This comment has been minimized.

Copy link
@sbourdeauducq

sbourdeauducq Oct 30, 2015

Member

Users should install only one of those two, depending what hardware they have connected to the KC705.

This comment has been minimized.

Copy link
@whitequark

whitequark Oct 30, 2015

Author Contributor

I don't know those details. Would you write them down?

This comment has been minimized.

Copy link
@sbourdeauducq

sbourdeauducq Oct 30, 2015

Member

It's quite simple. QC1 is for the old hardware with SCSI cables and AD9858 DDS chips. QC2 is for the more recent hardware with the FMC backplane and AD9914 DDSes. They need different bitstream and runtime, and a lab uses one or the other.

This comment has been minimized.

Copy link
@whitequark

whitequark Oct 30, 2015

Author Contributor

Done

echo "Created environment $ENV for ARTIQ"

This creates a new Conda "environment" (i.e. an isolated installation) and prints its name.
If you ever need to upgrade ARTIQ, it is advised to install it again
in a new environment so that you can roll back to a version that is known to
work correctly.

After this, add the newly created environment to your ``$PATH``. This can be easily
done using the following command::

$ source activate artiq-[date]

You will need to invoke this command in every new shell. When in doubt, you can list
the existing environments using::

$ conda env list

Preparing the core device FPGA board
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

0 comments on commit 62419c0

Please sign in to comment.