Difference between revisions of "OpenIGTLink/Library/Build"

From NAMIC Wiki
Jump to: navigation, search
(CMake download page has apparently moved.)
 
(23 intermediate revisions by 2 users not shown)
Line 3: Line 3:
 
== Linux / Mac OS X ==
 
== Linux / Mac OS X ==
  
First obtain the source code from the repository. Open the terminal and run:
+
First, obtain the source code from the repository using Git. To simply download the code, run the following command from a terminal:
  
   $ svn co http://svn.na-mic.org/NAMICSandBox/trunk/OpenIGTLink OpenIGTLink
+
   $ git clone git://github.com/openigtlink/OpenIGTLink.git
 +
 
 +
If you have any plan to contribute your source code to the repository, please do:
 +
 
 +
  $ git clone git@github.com:openigtlink/OpenIGTLink.git
 +
 
 +
Note that your SSH public key must be registered to the repository prior to the access. Please send a key to [[User:Tokuda|Junichi Tokuda]] with your contact information.
  
 
Then configure using CMake. The library requires CMake version higher than 2.4.
 
Then configure using CMake. The library requires CMake version higher than 2.4.
 
   $ mkdir OpenIGTLink-build
 
   $ mkdir OpenIGTLink-build
 
   $ cd OpenIGTLink-build
 
   $ cd OpenIGTLink-build
   $ ccmake ../OpenIGTLink
+
   $ cmake -DBUILD_EXAMPLES:BOOL=ON ../OpenIGTLink
 
 
Then CMake configuration screen shows up on your terminal. Normally, you don't need to change any options. Just press the 'c' key (configure) followed by the 'g' key (generate). and quit the configuration screen. Now you are ready to build the software.
 
 
 
 
   $ make
 
   $ make
  
Line 21: Line 24:
  
 
You might need super user access.
 
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 ==
 
== Windows ==
* Download [http://tortoisesvn.net/downloads SVN Windows client] if you don't have one already
+
* Download Git 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++]
+
* You will also need [http://www.cmake.org/download CMake] and a C/C++ compiler as [http://www.microsoft.com/express/vc/ Microsoft Visual C++]
* Download out the source code from SVN
+
* Download the source code from Git repository.
** Create a directory, ex. C:\Devel\OpenIGT\OpenIGTLink
+
** URL of repository: git://github.com/openigtlink/OpenIGTLink.git
** 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
 
** Click OK
 
* Run CMake
 
* Run CMake
 
** Where is the source code: C:\Devel\OpenIGT\OpenIGTLink
 
** Where is the source code: C:\Devel\OpenIGT\OpenIGTLink
** Where to build the binaries: C:\Devel\OpenIGT\build
+
** Where to build the binaries: C:\Devel\OpenIGT\OpenIGTLink-build
 
** Click "Configure" and select your compiler (usually just click "OK")
 
** Click "Configure" and select your compiler (usually just click "OK")
 
** Message: "Build directory does not exit, should I create it?" - 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 "Configure"
 
** Click "OK" to close CMake
 
** Click "OK" to close CMake
* Start Visual C and compile the project (C:\Devel\OpenIGT\build\OpenIGTLink.sln)
+
* Start Visual C and compile the project (C:\Devel\OpenIGT\OpenIGTLink-build\OpenIGTLink.sln)
  
 
If all went OK you will have the executable and the library:
 
If all went OK you will have the executable and the library:
* C:\Devel\OpenIGT\build\Testing\debug\igtlSocketTest.exe
+
* C:\Devel\OpenIGT\OpenIGTLink-build\bin\debug\igtlSocketTest.exe
* C:\Devel\OpenIGT\build\Source\debug\OpenIGTLink.lib
+
* C:\Devel\OpenIGT\OpenIGTLink-build\bin\debug\OpenIGTLink.lib
 +
 
 +
== <font color="red">!!Note on Windows!!</font color="red"> ==
 +
If you are planning to link the OpenIGTLink Library with IGSTK, or the 3D Slicer OpenIGTLinkIF module, please make sure that you use the Windows version of CMake (not the one contained in the Cygwin environment) and Visual Studio 2008. 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.
 +
 
 +
 
 +
 
 +
== iOS (iPhone and iPod) ==
 +
NOTE: OpenIGTLinkIF is tested on iOS with the following condition:
 +
Target: iOS 5.0.1
 +
Host: Mac OS X 10.7.2 with Xcode 4.2
 +
CMake: 2.8.6
 +
OpenIGTLink: git@github.com:openigtlink/OpenIGTLink.git (commit 68e903965f3f2dde8c0303f6c41cdc81a68d28f4)
 +
 
 +
Suppose we have a copy of the OpenIGTLink source files in IGTL_SOURCE_DIR and will build the library in IGTL_BINARY_DIR.
 +
First, create a XCode project with CMake:
 +
cd IGTL_BINARY_DIR
 +
ccmake -GXcode IGTL_SOURCE_DIR
 +
No option needs to be edited in the ccmake interface. Simply press 'c' twice and then 'g' to generate a project file and other necessary files for XCode.
 +
 
 +
Once the files are generated, open "OpenIGTLink.xcodeproj" from XCode. <font color=red>Before building OpenIGTLink for iOS, we generate binary for Mac OS X.</font>
 +
At the left-top of XCode window, choose "OpenIGTLink > My Mac 64-bit" as a target from a pull down-menu and press "Run" just next to the pull-down. If everything goes well, the status window at the center of the window top shows "Build ALL_BUILD: Succeeded."
 +
 
 +
[[Image:OpenIGTLink_Library_Build_iOS_1.png]]
 +
 
 +
 
 +
The next step is to build a binary for iOS simulator. Choose "OpenIGTLink" from "PROJECT" column and change Base SDK to "iOS 5"  in Build settings.
 +
 
 +
[[Image:OpenIGTLink_Library_Build_iOS_2.png|600px]]
 +
 
 +
[[Image:OpenIGTLink_Library_Build_iOS_3.png|600px]]
 +
 
 +
After making sure that the target is set to "OpenIGTLink > iPhone 5.0 Simulator," press run button to start compilation process. If everything goes well, the binary file "libOpenIGTLink.a" is stored in IGTL_BINARY_DIR/bin/Debug. It may be a good idea to change the name of "Debug" directory to something like "Sim5.0Debug", since you will need to have also a binary for actual device and switch between two binaries (or four binaries if you build Release version as well).
 +
 
 +
To use the binary file from your iPhone program, specify the following directories as "Header Search Path":
 +
* IGTL_SOURCE_DIR/Source
 +
* IGTL_SOURCE_DIR/Source/igtlutil
 +
* IGTL_BINARY_DIR/
 +
Also, add the binary file ("libOpenIGTLink.a") under a new group "OpenIGTLink" in the navigation area in on the left of XCode Window.
  
 +
[[Image:OpenIGTLink_Library_Build_iOS_4.png]]
  
You need to use Visual Studio to compile the OpenIGTLink module
 
as long as the Slicer binary is generated by Visual Studio (VS).
 
I don't think the binaries generated by VS and cygwin is compatible.
 
  
To compile the OpenIGTLink module on windows,
+
Reference
please use CMake for windows and do the same as Linux.
+
*Shabash B, Hamarneh G, Huang ZF, Ibanez L, ITK on the iOS, http://www.sfu.ca/~zfh/IJ_755_1_BuildingITKinTheiPhone.pdf
After the CMake generates VC files, open them in the VC and
 
build it.
 

Latest revision as of 16:50, 17 February 2015

Home < OpenIGTLink < Library < Build

<< OpenIGTLink | Library

Linux / Mac OS X

First, obtain the source code from the repository using Git. To simply download the code, run the following command from a terminal:

 $ git clone git://github.com/openigtlink/OpenIGTLink.git

If you have any plan to contribute your source code to the repository, please do:

 $ git clone git@github.com:openigtlink/OpenIGTLink.git

Note that your SSH public key must be registered to the repository prior to the access. Please send a key to Junichi Tokuda with your contact information.

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 Git Windows client, if you don't have one already
  • You will also need CMake and a C/C++ compiler as Microsoft Visual C++
  • Download the source code from Git repository.
  • Run CMake
    • Where is the source code: C:\Devel\OpenIGT\OpenIGTLink
    • Where to build the binaries: C:\Devel\OpenIGT\OpenIGTLink-build
    • Click "Configure" and select your compiler (usually just click "OK")
    • Message: "Build directory does not exit, should I create it?" - click "OK"
    • Click "Configure"
    • Click "OK" to close CMake
  • Start Visual C and compile the project (C:\Devel\OpenIGT\OpenIGTLink-build\OpenIGTLink.sln)

If all went OK you will have the executable and the library:

  • C:\Devel\OpenIGT\OpenIGTLink-build\bin\debug\igtlSocketTest.exe
  • C:\Devel\OpenIGT\OpenIGTLink-build\bin\debug\OpenIGTLink.lib

!!Note on Windows!!

If you are planning to link the OpenIGTLink Library with IGSTK, or the 3D Slicer OpenIGTLinkIF module, please make sure that you use the Windows version of CMake (not the one contained in the Cygwin environment) and Visual Studio 2008. 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.


iOS (iPhone and iPod)

NOTE: OpenIGTLinkIF is tested on iOS with the following condition:

Target: iOS 5.0.1
Host: Mac OS X 10.7.2 with Xcode 4.2
CMake: 2.8.6
OpenIGTLink: git@github.com:openigtlink/OpenIGTLink.git (commit 68e903965f3f2dde8c0303f6c41cdc81a68d28f4)

Suppose we have a copy of the OpenIGTLink source files in IGTL_SOURCE_DIR and will build the library in IGTL_BINARY_DIR. First, create a XCode project with CMake:

cd IGTL_BINARY_DIR
ccmake -GXcode IGTL_SOURCE_DIR

No option needs to be edited in the ccmake interface. Simply press 'c' twice and then 'g' to generate a project file and other necessary files for XCode.

Once the files are generated, open "OpenIGTLink.xcodeproj" from XCode. Before building OpenIGTLink for iOS, we generate binary for Mac OS X. At the left-top of XCode window, choose "OpenIGTLink > My Mac 64-bit" as a target from a pull down-menu and press "Run" just next to the pull-down. If everything goes well, the status window at the center of the window top shows "Build ALL_BUILD: Succeeded."

OpenIGTLink Library Build iOS 1.png


The next step is to build a binary for iOS simulator. Choose "OpenIGTLink" from "PROJECT" column and change Base SDK to "iOS 5" in Build settings.

OpenIGTLink Library Build iOS 2.png

OpenIGTLink Library Build iOS 3.png

After making sure that the target is set to "OpenIGTLink > iPhone 5.0 Simulator," press run button to start compilation process. If everything goes well, the binary file "libOpenIGTLink.a" is stored in IGTL_BINARY_DIR/bin/Debug. It may be a good idea to change the name of "Debug" directory to something like "Sim5.0Debug", since you will need to have also a binary for actual device and switch between two binaries (or four binaries if you build Release version as well).

To use the binary file from your iPhone program, specify the following directories as "Header Search Path":

  • IGTL_SOURCE_DIR/Source
  • IGTL_SOURCE_DIR/Source/igtlutil
  • IGTL_BINARY_DIR/

Also, add the binary file ("libOpenIGTLink.a") under a new group "OpenIGTLink" in the navigation area in on the left of XCode Window.

OpenIGTLink Library Build iOS 4.png


Reference