Editing Installing STIR with CMake (section)

= Step 1: Download/install pre-requisites =
More detailed instructions are in the STIR User's Guide, but the following might get you going.

STIR relies on a few external libraries which you need to install first. 

* [http://www.boost.org Boost], a well-respected C++ library which forms the basis for many newer C++ features.
* [http://www.python.org/ python] is a scripting language. STIR currently only uses it in some of the SimSET scripts.
* The ECAT Matrix library from Merence Sibomana and Christian Michel. Only used to read/write data from old CTI PET scanners such as ECAT HR+. You might find this library at [ftp://ftp.topo.ucl.ac.be/pub/ecat a Louvain-la-Neuve university ftp-site]. It also comes with GATE.


== Unix-type systems ==
Linux systems use a package management system. Unfortunately, there are many different versions, and the packages
have slightly different names. Here is what we know:

=== debian/Ubuntu or others using APT ===
<pre>
apt-get install gcc g++ make  cmake-curses-gui libncurses-dev libx11-dev libboost-dev libpng-dev tcsh python
</pre>
(prefix with <tt>sudo</tt> for Ubuntu).
If you intend to build the python interface to STIR as well, you will need to add the <tt>python-dev</tt> package to the above list, and install some other useful packages. For instance
<pre>
apt-get install swig
apt-get install python-dev python-numpy ipython python-matplotlib mayavi2
</pre>
Note: on old Ubuntu/debian systems (e.g. Ubuntu 14.x) you need to install the <tt>swig3.0</tt> package, not <tt>swig</tt>.

If you will be compiling with MPI support, use
<pre>
apt-get install mpi-default-dev mpi-default-bin
</pre>
If you want to use ITK for extra IO capabilities (since STIR 3.0), use
<pre>
apt-get install libinsighttoolkit4-dev libtiff5-dev
</pre>

=== Fedora (and others?) using yum ===
The following might work when your system uses yum.
<pre>
sudo yum install gcc gcc-c++ make cmake cmake-gui ncurses-devel  libX11-devel boost boost-devel tcsh python
</pre>
If this fails, try to issue one "yum install" command for every package.

=== Arch using pacman ===
The following might work when your system uses pacman.
<pre>
$ su
# pacman -Sy gcc make cmake cmake-gui ncurses  libx11 boost boost-libs tcsh python
</pre>
If this fails, try to issue one "pacman -Ss" command for every package.

=== Mac OS X ===
You need the development environment. You would need for instance
* XCode https://developer.apple.com/xcode
It's probably a good idea to install [http://www.macports.org/ MacPorts]. Then you should be able to use the following:
<pre>
sudo port install boost cmake
</pre>
Alternatively, you could install extra software manually. See [[Installing_STIR_with_CMake#Other_systems_or_manual_download]].

=== cygwin on Windows ===
Use cygwin's setup to install ''gcc, g++, make, cmake, libncurses-devel, libX11-devel, libboost-devel, tcsh, python''.

== Other systems or manual download ==
You can use these also if you don't have super-user permission.

* Download CMake from http://www.cmake.org and install.
* Download Boost from http://www.boost.org. Currently, ''STIR'' only uses the include files from Boost so you do not need to build the boost libraries, only untar/unzip the boost package. You can put this anywhere you like, as long as you set the '''BOOST_ROOT''' flag accordingly (See below).
* Download SWIG http://www.swig.org if you want to use SWIG to build an interface between STIR and Python. Clearly, you would need Python then as well. For an interface between STIR and MATLAB, you need to compile another version of SWIG for which you can find the details at [[Installing the MATLAB interface to STIR]].