Recent changes to BuildGuide

WikiPage BuildGuide modified by Stephan Meister

Stephan Meister — Thu, 14 Feb 2013 12:41:47 -0000

--- v5
+++ v6
@@ -38,7 +38,7 @@
     bzr branch lp:bzr-builder ~/.bazaar/plugins/builder

-Windows users have to enter their bazaar config directiory (typically %AppData%\bazaar\2.0)
+Windows users have to enter their bazaar config directory (typically %AppData%\bazaar\2.0)

 Then create a simple text file with a build recipe and save it as *charon-suite.recipe* or
 download it here.
@@ -65,7 +65,7 @@
 Hit *configure* and select your prefered build tools.
 You will probably get some errors due to missing third party libraries, especially on Windows. 

-Check the *advanced* and *grouped* boxes and enter library, include and search paths for all 3rd party libraries you wan't to use.
+Check the *advanced* and *grouped* boxes and enter library, include and search paths for all 3rd party libraries you want to use.
 You can switch off individual charon components under the **BUILD** Option (not recommended) or deactivate individual 3rd party libraries with the **USE** Options.
 Especially Lapack or Petsc can be problematic. Deactivate them if you don't need them.

@@ -89,7 +89,7 @@

 Open the .sln file in the build directory and issue a build command from the *build* menu.
 If everything worked, build the additional INSTALL target.
-Additionaly you should run the provided unit test by building the **RUN_TESTS** build target.
+Additionally you should run the provided unit test by building the **RUN_TESTS** build target.
 Repeat this process in **RELEASE** configuration as needed.

WikiPage BuildGuide modified by Stephan Meister

Stephan Meister — Thu, 14 Feb 2013 12:40:30 -0000

--- v4
+++ v5
@@ -40,10 +40,11 @@

 Windows users have to enter their bazaar config directiory (typically %AppData%\bazaar\2.0)

-Then create a simple text file with a build recipe and save it as *charon-meta.recipe*.
-The recipes' content is as follows:
+Then create a simple text file with a build recipe and save it as *charon-suite.recipe* or
+download it here.
+The recipes' content is as follows (you may need unix style line endings):

-    # bzr-builder format 0.3
+    # bzr-builder format 0.3 deb-version 1.0
     lp:~charon-developers/+junk/charon-meta
     nest charon-core lp:charon-core charon-core
     nest charon-utils lp:charon-utils charon-utils
@@ -53,7 +54,7 @@

 Then run

-    bzr build charon-meta.recipe 
+    bzr build charon-suite.recipe 

 This should open multiple ssh connection and checkout the code.

WikiPage BuildGuide modified by Stephan Meister

Stephan Meister — Wed, 05 Dec 2012 15:16:41 -0000

--- v3
+++ v4
@@ -40,7 +40,8 @@
 
 Windows users have to enter their bazaar config directiory (typically %AppData%\bazaar\2.0)
 
-Then create a build recipe with the following content and save it as *charon-meta.recipe*:
+Then create a simple text file with a build recipe and save it as *charon-meta.recipe*.
+The recipes' content is as follows:
 
     # bzr-builder format 0.3
     lp:~charon-developers/+junk/charon-meta

WikiPage BuildGuide modified by Stephan Meister

Stephan Meister — Wed, 05 Dec 2012 14:50:17 -0000

--- v2
+++ v3
@@ -6,7 +6,7 @@
 * [Bazaar](http://wiki.bazaar.canonical.com/Download)
 * [CMake](http://www.cmake.org/)
 
-* A launchpad account(https://launchpad.net/)
+* A [launchpad] (https://launchpad.net/) account (optional)
     * You must supply launchpad with an ssh key to branch code (https://help.launchpad.net/YourAccount/CreatingAnSSHKeyPair)
 
 * 3rd party libraries (mandatory)
@@ -27,9 +27,11 @@
 Get the source code
 ===================
 
-First check that the *bzr* executable is in your path and that bazaar is configured to use launchpad. Windows users also have to use pagent.
+First check that the *bzr* executable is in your path and that bazaar is configured to use launchpad. If you don't have an launchpad account, the code checkout will work but you may get some warning messages. If you provide an launchpad login with the following line
 
     bzr launchpad-login userid
+
+you will have to supply launchpad with your public ssh key. See the launchpad site for details. Windows users may also have to use pagent.
 
 Then install the bazaar builder plugin

WikiPage BuildGuide modified by Stephan Meister

Stephan Meister — Tue, 27 Nov 2012 16:59:33 -0000

--- v1
+++ v2
@@ -1,4 +1,3 @@
-
 Prerequisites
 =============
 Get the following programs/accounts/libraries:
@@ -23,6 +22,7 @@
     * [MathGL](http://mathgl.sourceforge.net/)
     * [Doxygen](http://www.stack.nl/~dimitri/doxygen/)
     * LaTeX (TeX Live, Miktex, etc.)
+    * Lapack
 
 Get the source code
 ===================
@@ -38,7 +38,7 @@
 
 Windows users have to enter their bazaar config directiory (typically %AppData%\bazaar\2.0)
 
-Then create a build recipe with the following content and save it as *charon-meta.build*:
+Then create a build recipe with the following content and save it as *charon-meta.recipe*:
 
     # bzr-builder format 0.3
     lp:~charon-developers/+junk/charon-meta
@@ -50,33 +50,66 @@
 
 Then run
 
-    bzr build charon-meta.build 
+    bzr build charon-meta.recipe 
 
 This should open multiple ssh connection and checkout the code.
 
 Setting up the build environment
 ================================
 
-Start *cmake-gui* and select your freshly checked out charon-meta directory as the source directory and another one as the build directory (we strongly recommend out-of-source builds).
+Start *cmake-gui* and select your freshly checked out charon-meta directory as the source directory (1) and another one as the build directory (2) (we strongly recommend out-of-source builds).
 Hit *configure* and select your prefered build tools.
 You will probably get some errors due to missing third party libraries, especially on Windows. 
 
 Check the *advanced* and *grouped* boxes and enter library, include and search paths for all 3rd party libraries you wan't to use.
 You can switch off individual charon components under the **BUILD** Option (not recommended) or deactivate individual 3rd party libraries with the **USE** Options.
+Especially Lapack or Petsc can be problematic. Deactivate them if you don't need them.
 
-Also, set the CMAKE_INSTALL_PREFIX variable. The Windows default (%PROGRAMFILES%) will not work unless you build the INSTALL target with elevated administrator rights.
+Also, set the CMAKE_INSTALL_PREFIX variable.
+This is the path charon will be installed in when you build the INSTALL target.
+ The Windows default (%PROGRAMFILES%) will not work unless you build the INSTALL target with elevated administrator rights.
+
+
+
+ 
+
 
 Compile
 =======
 
-Start your IDE and compile or invoke make in your build directory.
+Windows
+-------
+
+We assume that you use Microsoft Visual Studio Professional.
+(2008 or 2010 as well as the Express versions are fine. 2012 is untested yet.)
+
+Open the .sln file in the build directory and issue a build command from the *build* menu.
 If everything worked, build the additional INSTALL target.
 Additionaly you should run the provided unit test by building the **RUN_TESTS** build target.
+Repeat this process in **RELEASE** configuration as needed.
 
-Repeast this process in **RELEASE** configuration as needed.
+
+ 
+
+
+Unix
+----
+
+in the build directory issue the following command
+
+    make
+    make test
+    make install
+
+You can also do multithreaded builds to speed up the process
+
+    make -j4
+
 
 Remarks
 =======
 
 * There is a known bug in tuchulcha which occurs when paths with special characters are used (e.g. umlauts). Try to avoid those.
 * Define the **CHARON_DIR** environment variable and set it to the location of the *cmake* directory in your install directory.
+
+

WikiPage BuildGuide modified by Stephan Meister

Stephan Meister — Tue, 27 Nov 2012 16:15:10 -0000

Prerequisites ============= Get the following programs/accounts/libraries: * [Bazaar](http://wiki.bazaar.canonical.com/Download) * [CMake](http://www.cmake.org/) * A launchpad account(https://launchpad.net/) * You must supply launchpad with an ssh key to branch code (https://help.launchpad.net/YourAccount/CreatingAnSSHKeyPair) * 3rd party libraries (mandatory) * [Qt](http://http://qt.digia.com/) * 3rd party libraries (optional) * [Boost](http://www.boost.org/) * [HDF5](http://www.hdfgroup.org/HDF5/) * [Vigra](http://hci.iwr.uni-heidelberg.de/vigra/) * [Libpng](http://www.libpng.org/pub/png/libpng.html) * [libtiff](http://www.libtiff.org/) * [PETSC](http://www.mcs.anl.gov/petsc/) (mandatory for optical flow evaluation) * [Qwt](http://qwt.sourceforge.net/) (mandatory for visualization) * [MathGL](http://mathgl.sourceforge.net/) * [Doxygen](http://www.stack.nl/~dimitri/doxygen/) * LaTeX (TeX Live, Miktex, etc.) Get the source code =================== First check that the *bzr* executable is in your path and that bazaar is configured to use launchpad. Windows users also have to use pagent. bzr launchpad-login userid Then install the bazaar builder plugin bzr branch lp:bzr-builder ~/.bazaar/plugins/builder Windows users have to enter their bazaar config directiory (typically %AppData%\bazaar\2.0) Then create a build recipe with the following content and save it as *charon-meta.build*: # bzr-builder format 0.3 lp:~charon-developers/+junk/charon-meta nest charon-core lp:charon-core charon-core nest charon-utils lp:charon-utils charon-utils nest charon-flow lp:charon-flow charon nest tuchulcha lp:tuchulcha tuchulcha nest charon-templates lp:charon-templates templategenerator Then run bzr build charon-meta.build This should open multiple ssh connection and checkout the code. Setting up the build environment ================================ Start *cmake-gui* and select your freshly checked out charon-meta directory as the source directory and another one as the build directory (we strongly recommend out-of-source builds). Hit *configure* and select your prefered build tools. You will probably get some errors due to missing third party libraries, especially on Windows. Check the *advanced* and *grouped* boxes and enter library, include and search paths for all 3rd party libraries you wan't to use. You can switch off individual charon components under the **BUILD** Option (not recommended) or deactivate individual 3rd party libraries with the **USE** Options. Also, set the CMAKE_INSTALL_PREFIX variable. The Windows default (%PROGRAMFILES%) will not work unless you build the INSTALL target with elevated administrator rights. Compile ======= Start your IDE and compile or invoke make in your build directory. If everything worked, build the additional INSTALL target. Additionaly you should run the provided unit test by building the **RUN_TESTS** build target. Repeast this process in **RELEASE** configuration as needed. Remarks ======= * There is a known bug in tuchulcha which occurs when paths with special characters are used (e.g. umlauts). Try to avoid those. * Define the **CHARON_DIR** environment variable and set it to the location of the *cmake* directory in your install directory.