QuickStart

The branches of the FW4SPL project

As we will see, the FW4SPL project uses Mercurial (hg) as version control system. The FW4SPL repository has several branches, here the descritpion of these branches.

Branches	Commentaire	Associated Bin packages
default	Do not use
fw4spl_0.4	It is the old branch of the project.	binpkgs_xxxx
fw4spl_0.5.x	There are the old branches of the project.	binpkgs_xxxx
fw4spl_0.6.x	There are the last branches of the project (uses only wxWidgets).	binpkgs_xxxx
fw4spl_0.7.0	It is the development branch of the project(uses wxWidgets and Qt).	BinPkgs_xxxx_868c87c9685c
experimentalXXX	These branches are used to test new concept. It can be unstable. So it's better to not used it.

To be noted: On the bin package archive name, xxxx represent a string which give the compiler used, its mode (ebug or release), the OS (Linux, MacOSx or Windows ) and the plateforme type (32, 64 bits).

Requirements for MS Window users

• Install the Visual C++ 2008 Express Edition.

Requirements for Linux users

• Install the uuid-dev package.
• Install gcc.

Requirements for MacOS users

• Install the latest XCode available.

Common requirements for Window, Linux and MacOS

• Install Python 2.6 minimum (cf http://www.python.org/).
• Install SCons 1.3.1 (cf http://www.scons.org/).
• Install Mercurial (cf http://mercurial.selenic.com/wiki/Download).

FW4SPL Installation

All pictures presented here come form MSWindow but can be easily transposed to others OS.

This installation procedure is based on the fw4spl branch 0.7.0 and sconspiracy branch 0.3.0

• Create your development folder (DEV_FOLDER) and move into.
• Create your build folder (DEV_FOLDER/Build).
• Create your install folder (DEV_FOLDER/Install).
• Inside install folder (DEV_FOLDER/Install), create a lib folder (DEV_FOLDER/Install/lib).
• Create your extern package folder (DEV_FOLDER/BinPkgs).
• Create a directory !Src (DEV_FOLDER/Src).

After this step with DEV_FOLDER = C:\DEV, you must have something like that:

Now we are going to fill the directories.

• Download binpkgs for your os/compiler/mode and untar it on the folder BinPkgs created before => http://code.google.com/p/fw4spl/downloads/list

• Install sconspiracy (cf http://code.google.com/p/sconspiracy/source/checkout ):
• Open a shell console and go to your development folder préviously created (DEV_FOLDER).
• Type hg clone https://sconspiracy.googlecode.com/hg/ sconspiracy -r sconspiracy_0.3.0

• Install fw4spl (cf http://code.google.com/p/fw4spl/source/checkout ):
• Open a shell console and go to your Src folder previously created (DEV_FOLDER/Src).
• Type hg clone https://fw4spl.googlecode.com/hg/ fw4spl -r fw4spl_0.7.0

• copy sconspiracy/Config/user.options-dist and rename it to user.options.
• set the right pathes in your user.options (normaly you just have to change the dev_dir variable).

Extra steps for Windows users

• Add sconspiracy bin folder in your environment path variable.
• Add RACY_CONFIG_DIR variable in your environment and set it to the path of SConspiracy Config folder.
• Set the MSVC_VERSION variable in your user.options (DEV_FOLDER/sconspiracy/Config/user.options) to '9.0'.
• Add the path DEV_FOLDER/Install/lib in your environment path variable.

At the end of the installation, we will have something like that:

In this example, we are under Windows, our DEV_FOLDER = D:\FW4SPL and we use Binary package for Visual C++ Express Edition (cl 9.0).

Build

ok your configuration is done! Now, you can build our first example called Tuto01Basic:

• Type racy Tuto01Basic (default build is debug, if you want release, add DEBUG=release in your command-line)

• Important: The new environment variables are taking to account after the shell console is restarted on Windows or a source command under Linux/Unix.

Image samples to run Tutorials

• Download the file Sample.tar.bz2 on http://code.google.com/p/fw4spl/downloads/list.
• Uncompress the file on the folder DEV_FOLDER/Install/TutoData which has been created before.
• To be noted : it is possible to uncompress the file where ever you want but in this case you must modify the Tuto02DataServiceBasic configuration file to adapt the path of the vtk file used in the sample.

Run

Now you can run the demo application :

• move to your DEV_FOLDER/Install
• use the following command-line (with xxx:win/lin/osx, yy:32/64 bits, zzzz:gcc4/vc9-0 ):
• for WxWidgets Gui version: type ./bin/launcher_0-1_xxx_yy_zzzz_D Bundles/<Tutorial_name>_0-1/profile.xml
• for Qt Gui version: type ./bin/launcher_0-1_xxx_yy_zzzz_D Bundles/<Tutorial_name>_0-1/profileQt.xml

For example in MSWindows, it will be :

• for WxWidgets Gui version: type .\bin\launcher_0-1_win_32_cl9-0_D.exe .\Bundles\Tuto01Basic_0-1\profile.xml
• for Qt Gui version: type .\bin\launcher_0-1_win_32_cl9-0_D.exe .\Bundles\Tuto01Basic_0-1\profileQt.xml

To be noted: with Linux, it is better to give the LD_LIBRARY_PATH in the launch command like this :

• for WxWidgets Gui version: type LD_LIBRARY_PATH=./lib .\bin\launcher_0-1_win_32_cl9-0_D .\Bundles\Tuto01Basic_0-1\profile.xml
• for Qt Gui version: type LD_LIBRARY_PATH=./lib .\bin\launcher_0-1_win_32_cl9-0_D .\Bundles\Tuto01Basic_0-1\profileQt.xml