SimpleITK/GettingStarted/Visual guide to building on Linux
This guide gives detailed instructions for building SimpleITK on Linux. It is written for beginners getting started with SimpleITK.
- Linux is freely available
- It has all the required tools
- Did I mention it's free?
Step 1: Get Linux
The first step is to install a Linux distribution. Some popular ones are:
There are many online tutorials explaining how to install your chosen Linux distribution:
If you are a Windows user, you may consider running Linux on a virtual machine. Some popular virtual machine environments are:
Again, there are heaps of tutorials:
- Installing Ubuntu inside Windows using VirtualBox
- How to Install Ubuntu on VirtualBox
- Install Linux Mint 12 in VirutalBox
- How to Install Linux Mint in Virtualbox (youtube)
This guide uses Linux Mint 12, but the steps are very similar for other Linux distributions.
Step 2: Install build tools
The next step is to install the required build tools.
Open a terminal window (Menu > Terminal) and run the following command:
sudo apt-get install cmake cmake-curses-gui gcc g++ git giggle python python2.7-dev ipython monodevelop
Confirm that you want to install the packages (press "y"), then wait for the installation to complete.
Alternatively, you could manually select each software package from the Software Manager (Menu > Software Manager).
Step 3: Get SimpleITK source code
The next step is to get the SimpleITK source code using git.
Decide where you want to put the source code. I'm putting mine in
cd ~ mkdir ITK cd ITK
Of course you can do this visually via the file manager (Menu > Files).
Now download the SimpleITK source code, by entering the following command in the Terminal:
git clone --recursive http://itk.org/SimpleITK.git
Now change to the SimpleITK directory:
Step 4: Build SimpleITK
The next step is to start building.
The recommended way to build is via the so-called "super build":
mkdir Build cd Build sudo cmake ../SuperBuild
If you prefer not to build with elevated privileges (i.e. omit
sudo) you can firstly install Python distribute:
sudo apt-get install curl curl -O http://python-distribute.org/distribute_setup.py sudo python distribute_setup.py
and then simply execute CMake:
The SuperBuild generates make files which takes care of downloading and building ITK, SWIG, and Lua, as well as SimpleITK. On my system, by default, wrappers were generated for C# and Lua.
To start the (long) build process, type:
On my laptop (Acer Aspire 5755G, Intel® Core™ i7-2630QM CPU @ 2.00GHz × 8, 2GB RAM) the build took about 4 hours.
After the build is finished, you need to add SimpleITK to your
You can now (optionally) check whether the build was successful:
cd SimpleITK-build ctest
All (or at least most) of the tests should pass.
Step 5: Use SimpleITK
A simple C# program
This section will describe how to create a simple C# application using SimpleITK from MonoDevelop.
Open MonoDevelop (Menu > Programming > MonoDevelop).
Select File > New > Solution.
Select C# > Console Project. Enter a suitable name e.g. "SimpleITK" and uncheck "Create directory for directory". Select "Forward" and then "OK".
In the Solution explorer, right-click "Selection" and select "Edit References...".
Select the ".Net Assembly" tab, navigate to "~/ITK/SimpleITK/Build/SimpleITK-build/Wrapping/CSharpBinaries", select "SimpleITKCSharpManaged.dll", click "Add", and then close the window by selecting "OK". This will copy "SimpleITKCSharpManaged.dll" to your build directory e.g. "bin/Debug" or "bin/Release". You must also manually copy "libSimpleITKCSharpNative.so" to your build directories:
mkdir ~/Projects/SimpleITK/bin/Debug mkdir ~/Projects/SimpleITK/bin/Release cp ~/ITK/SimpleITK/Build/SimpleITK-build/Wrapping/CSharpBinaries/libSimpleITKCSharpNative.so ~/Projects/SimpleITK/bin/Debug cp ~/ITK/SimpleITK/Build/SimpleITK-build/Wrapping/CSharpBinaries/libSimpleITKCSharpNative.so ~/Projects/SimpleITK/bin/Release
You have now added SimpleITK as a project reference.