View source for OpenIGTLink/Library/Build

[[OpenIGTLink | &lt;&lt; OpenIGTLink]] | [[OpenIGTLink/Library | Library]]

== Linux / Mac OS X ==

First obtain the source code from the repository. Open the terminal and run:

  $ svn co http://svn.na-mic.org/NAMICSandBox/trunk/OpenIGTLink OpenIGTLink

Then configure using CMake. The library requires CMake version higher than 2.4.
  $ mkdir OpenIGTLink-build
  $ cd OpenIGTLink-build
  $ cmake -DBUILD_EXAMPLES:BOOL=ON ../OpenIGTLink
  $ make

You may install the library into your disk (optional). The default target directory is /usr/local, but you can configure it from the CMake configuration screen. To install the files, run

  $ make install

You might need super user access.

== Sun OS ==

For Sun OS (Solaris), you may follow the instruction for Linux/Mac OS X described above. If you want to explicitly specify Sun CC instead of GNU CC, options for cmake look like:
  cmake -DCMAKE_C_COMPILER:STRING=/opt/SUNWspro/bin/cc -DCMAKE_CXX_COMPILER:STRING=/opt/SUNWspro/bin/CC -DBUILD_EXAMPLES:BOOL=ON ../OpenIGTLink

== Windows ==
* Download [http://tortoisesvn.net/downloads SVN Windows client] if you don't have one already
* You will also need [http://www.cmake.org/HTML/Download.html CMake] and a C/C++ compiler as [http://www.microsoft.com/express/vc/ Microsoft Visual C++]
* Download the source code from SVN
** Create a directory, ex. C:\Devel\OpenIGT\OpenIGTLink
** Right click on this directory (OpenIGTLink)
** From the menu select "SVN Checkout..."
** URL of repository: http://www.na-mic.org/svn/NAMICSandBox/trunk/OpenIGTLink/
** Click OK
* Run CMake
** Where is the source code: C:\Devel\OpenIGT\OpenIGTLink
** Where to build the binaries: C:\Devel\OpenIGT\build
** Click "Configure" and select your compiler (usually just click "OK")
** Message: "Build directory does not exit, should I create it?" - click "OK"
** It might give a "pdflatex" error, just ignore it for now
** Click "Configure"
** Click "OK" to close CMake
* Start Visual C and compile the project (C:\Devel\OpenIGT\build\OpenIGTLink.sln)

If all went OK you will have the executable and the library:
* C:\Devel\OpenIGT\build\bin\debug\igtlSocketTest.exe
* C:\Devel\OpenIGT\build\bin\debug\OpenIGTLink.lib

== <font color="red">!!Note on Windows!!</font color="red"> ==
If you planning to link the OpenIGTLink Library with IGSTK, or 3D Slicer OpenIGTLinkIF module, please make sure that you use windows version of CMake (not one in the Cygwin environment) and Visual Studio. Since IGSTK and 3D Slicer are compiled with Visual Studio, the OpenIGTLink library built in cygwin environment using GCC cannot be linked with those software.