= Tartu School SasView Instructions =

= Installing for Windows or Mac =
Download and install the latest release of SasView for your platform (Windows 32bit / Windows 64bit / Mac) from: [https://github.com/SasView/sasview/releases/tag/v4.1.2]


= Running Sasview on Linux =
The following instructions concern Ubuntu 16.04 but should provide sufficient guidelines for any linux distribution. These instructions obviously reference the package manger on Debian based system (apt), so you should replace such commands with the correct ones for your distro.

== Download source code for !SasView and !SasModels == 
- To obtain the source code you need to have git running. if you haven't already got it, it can be obtained from Ubuntu repository
{{{
sudo apt-get install git
}}}
- The easy way to download the !SasView and !SasModels code is by simply cloning a git repository
{{{
mkdir sasview-code
cd sasview-code
git clone https://github.com/SasView/sasview
git clone https://github.com/SasView/sasmodels
}}}
- This will create a sasview-code folder in your current directory and then check out the latest version of the sasview and sasmodels code. However, we need to use a stable version and not the developer version. So we need to then do
{{{
cd sasview
git checkout v4.1.2
cd ../sasmodels
git checkout v0.96
}}}
- Each of !SasView and !SasModels should now be checked out at the current release version.

== Install dependencies using apt-get == 
- Scientific python packages (numpy, scipy) together with matplotlib, pylint and wxgtk2.8 can be installed by running
{{{
sudo apt-get install python-numpy python-scipy python-matplotlib pylint python-wxgtk3.0 pyopencl
}}}

== Install pip ==
- The remaining dependencies can be installed using pip, which can be obtained by running the following:
{{{
wget https://bootstrap.pypa.io/get-pip.py
sudo python get-pip.py
}}}

== Install dependencies using pip ==
- Once pip is obtained the remaining dependencies are installed by:
{{{
sudo pip install unittest-xml-reporting
sudo pip install bumps
sudo pip install periodictable
sudo pip install sphinx
}}}

== Run !SasView ==
- Then one can navigate to a !SasView source directory (most likely "cd sasview") and simply run
{{{
python run.py
}}}
- This should then build !SasModels as needed and run !SasView.

== Building the Help Docs ==
The process for building the help docs has been steadily evolving. The latest instructions might be found [http://trac.sasview.org/wiki/BuildDocs here]