initial readme 3

This commit is contained in:
pswietojanski 2015-09-22 17:13:16 +01:00
parent c380de22ff
commit fd35da1b86

View File

@ -4,26 +4,22 @@
To run the notebooks (and later the code you are going to write within this course) To run the notebooks (and later the code you are going to write within this course)
you are expected to have installed the following packages: you are expected to have installed the following packages:
python 2.7+ <ul>
<li>python 2.7+</li>
numpy (anything above 1.6, 1.9+ recommended, optimally <li>numpy (anything above 1.6, 1.9+ recommended, optimally compiled with some BLAS library [MKL, OpenBLAS, ATLAS, etc.)</li>
compiled with some BLAS library [MKL, OpenBLAS, ATLAS, etc.) <li>scipy (optional, but may be useful to do some tests)</li>
<li>matplotlib (for plotting)</li>
scipy (optional, but may be useful to do some tests) <li>ipython (v3.0+, 4.0 recommended)</li>
<li>notebook (notebooks are in version 4.0)</li>
matplotlib (for plotting) </ul>
ipython (v3.0+, 4.0 recommended)
notebook (notebooks are in version 4.0)
You can install them straight away on your personal computer, You can install them straight away on your personal computer,
there is also a notebook tutorial (00_Introduction) on how to there is also a notebook tutorial (00_Introduction) on how to
do this on DICE, and what configuration you are expected to have. do this (particularly) on DICE, and what configuration you
For now, it suffices if you get the software working on your are expected to have installed. For now, it suffices if you
personal computers so you can start ipython notebook server get the software working on your personal computers so you can
and open the inital introductory tutorial (which will be make start ipython notebook server and open the inital introductory
publicitly available next Monday). tutorial (which will be made publicitly available next Monday).
### Installing the software on personal computers ### Installing the software on personal computers
@ -53,7 +49,7 @@ so you pick up the version of python you just installed
#### On DICE (we will do this during the first lab) #### On DICE (we will do this during the first lab)
### Setting up the repository ### Getting the mlpractical repository
Assuming ~/mlpractical is a target workspace you want to use during Assuming ~/mlpractical is a target workspace you want to use during
this course (where ~ denotes your home path, i.e. /home/user1). this course (where ~ denotes your home path, i.e. /home/user1).
@ -64,13 +60,13 @@ git clone https://github.com/CSTR-Edinburgh/mlpractical.git
(Note: you can do it from your git account if you have one as the (Note: you can do it from your git account if you have one as the
above just clone the repo as anonymous user, though it does not above just clone the repo as anonymous user, though it does not
matter at this point, as you probably will not submit pull requests) matter at this point, as you are not required to submit pull requests)
Naviagate to the checked out directory by typing cd ~/mlpractical and type: Naviagate to the checked out directory (cd ~/mlpractical) and type:
ipython notebook ipython notebook
This should start notebook server and open the browser with the page This should start ipython notebook server and open the browser with the page
listing files/subdirs in the current directory. listing files/subdirs in the current directory.
To update the repository (for example, on Monday), To update the repository (for example, on Monday),