Project

General

Profile

Installation » History » Version 27

Tony Ciavarella, 06/04/2012 08:06 PM

1 1 Tony Ciavarella
h1. Installation
2
3 5 Tony Ciavarella
h2. Obtaining the Source Code
4 1 Tony Ciavarella
5 2 Tony Ciavarella
h3. Release Tarballs
6
7 4 Tony Ciavarella
Release source tarballs are available on the "Files":http://oss.squalllinesoftware.com/projects/disorder/files page.  This is what you want if you are looking for stability and something ready for production use.  You'll probably want to use the most recent version found on that page.
8 2 Tony Ciavarella
9
h3. SCM
10
11 4 Tony Ciavarella
The Disorder source code is hosted in a "Bazaar":http://bazaar.canonical.com repository.  This is what you want if you are looking for the very latest bleeding edge of the code for contributing to Disorder or whatever other reason you may have.
12 2 Tony Ciavarella
13 27 Tony Ciavarella
Read the "Bazaar Documentation":http://doc.bazaar.canonical.com/en/ if you aren't familiar with that and you want to go this route.
14
15 2 Tony Ciavarella
To get a lightweight checkout of the latest version without all the history (not suitable for Disorder development):
16 25 Tony Ciavarella
<pre>bzr co --lightweight bzr://bzr.squalllinesoftware.com/disorder</pre>
17 2 Tony Ciavarella
18
To clone the repository including the full history:
19 25 Tony Ciavarella
<pre>bzr branch bzr://bzr.squalllinesoftware.com/disorder</pre>
20 2 Tony Ciavarella
21 1 Tony Ciavarella
h2. Prerequisites
22
23
The following third party things are required to use Disorder:
24 6 Tony Ciavarella
* "Boost":http://www.boost.org >= 1.49.0
25 8 Tony Ciavarella
* "Eigen":http://eigen.tuxfamily.org >= 3.0.5
26 7 Tony Ciavarella
* C++ version of the "SEDRIS SRM":http://www.sedris.org/srm_4.4/srm_c_cpp.htm >= 4.4.0 (optional but you will need some kind of sophisticated geospatial library)
27 1 Tony Ciavarella
* A "Python":http://www.python.org interpreter (needed to use the "waf":https://code.google.com/p/waf/ build system)
28
29 13 Tony Ciavarella
Build and install these things in accordance with the instructions for your operating system provided by each vendor.  Some hints for certain platforms follow.
30 1 Tony Ciavarella
31 8 Tony Ciavarella
h3. Debian Linux and Derivatives
32
33 13 Tony Ciavarella
Pat yourself on the back for using a good operating system.  All the dependencies are available via the package system.  To install the Boost and Eigen build dependencies on Debian and maybe other derivatives:
34 8 Tony Ciavarella
<pre>sudo apt-get install libboost-dev libboost-system-dev libboost-thread-dev libboost-date-time-dev libeigen3-dev</pre>
35 1 Tony Ciavarella
36
If you don't already have python, this will get the required bits of that:
37
<pre>sudo apt-get install python</pre>
38 13 Tony Ciavarella
39
h2. Configuration
40
41
If everything is setup properly, this step will be a breeze, but it is important to resolve any errors produced by the configuration step prior to attempting to compile Disorder.
42
43 15 Tony Ciavarella
h3. Linux
44 13 Tony Ciavarella
45
From inside the root of the Disorder tree do this in your favorite terminal emulator:
46
<pre>./waf configure --sedris-srm-root=<put the path to the SEDRIS SRM root here></pre>
47
For example, if your SEDRIS SRM is in /opt/sedris/srm:
48
<pre>./waf configure --sedris-srm-root=/opt/sedris/srm</pre>
49
50
That command will take several seconds and print a bunch of hopefully green stuff.  The output should end up looking something like this:
51
<pre>
52
Setting top to                           : /opt/disorder 
53
Setting out to                           : /opt/disorder/bin 
54
Checking for 'g++' (c++ compiler)        : /usr/bin/g++ 
55
Checking for program doxygen             : /usr/bin/doxygen 
56
Checking for program tar                 : /bin/tar 
57
Checking boost ABI tag                   :  
58
Checking boost includes                  : 1_49 
59
Checking boost libs                      : ok 
60
Checking for boost linkage               : ok 
61
Checking for header boost/asio.hpp       : yes 
62
Checking for header boost/bind.hpp       : yes 
63
Checking for header boost/date_time.hpp  : yes 
64
Checking for header boost/detail/endian.hpp : yes 
65
Checking for header boost/format.hpp        : yes 
66
Checking for header boost/function.hpp      : yes 
67
Checking for header boost/functional/factory.hpp : yes 
68
Checking for header boost/ptr_container/ptr_vector.hpp : yes 
69
Checking for header boost/scoped_ptr.hpp               : yes 
70
Checking for header boost/static_assert.hpp            : yes 
71
Checking for header boost/thread.hpp                   : yes 
72
Checking for program pkg-config                        : /usr/bin/pkg-config 
73
Checking for 'eigen3'                                  : yes 
74
Checking for header Eigen/Dense                        : yes 
75
Checking for SEDRIS SRM                                : /opt/sedris/srm 
76
Checking for SEDRIS SRM include directory              : /opt/sedris/srm/src/include 
77
Checking for SEDRIS SRM library directory              : /opt/sedris/srm/lib/linux-3.1.0-1-amd64-i386-gnu-/OPT 
78
SEDRIS SRM library                                     : /opt/sedris/srm/lib/linux-3.1.0-1-amd64-i386-gnu-/OPT/libsrm.so 
79
Checking for header srf_all.h                          : yes 
80
'configure' finished successfully (25.518s)
81
</pre>
82
83 18 Tony Ciavarella
If you get an error instead of that last line saying that 'configure' finished successfully, you must fix whatever is making it unhappy and try again.
84 13 Tony Ciavarella
85 19 Tony Ciavarella
h4. Clang++
86 16 Tony Ciavarella
87 19 Tony Ciavarella
To use the Clang C++ compiler instead of GCC, assuming clang++ is installed on the build system:
88 16 Tony Ciavarella
<pre>CXX=<put the path to clang++ here> ./waf configure --sedris-srm-root=<put the path to the SEDRIS SRM root here></pre>
89
90 19 Tony Ciavarella
For example:
91 16 Tony Ciavarella
<pre>CXX=/usr/bin/clang++ ./waf configure --sedris-srm-root=/opt/sedris/srm</pre>
92
93 13 Tony Ciavarella
h3. Windows
94
95
On windows, your $PATH environment variable needs to include the path to the Python interpreter.
96
97 24 Tony Ciavarella
Next, you'll probably want to modify the provided batch file to tell Disorder where your prerequisites live.  From inside the root of the disorder tree:
98 13 Tony Ciavarella
<pre>copy tools/configure.bat configure.bat</pre>
99
100
This file contains some stuff at the top you'll want to edit to match your system configuration.
101 10 Tony Ciavarella
102 1 Tony Ciavarella
h2. Compiling
103
104 20 Tony Ciavarella
The basic strategy for building Disorder is to invoke the waf build system with the desired build variant.
105 1 Tony Ciavarella
106 20 Tony Ciavarella
Disorder has two build variants:
107 23 Tony Ciavarella
* debug: produces a library that contains debugging symbols and disables most compiler optimizations
108
* optimized: produces a library stripped of debugging symbols and enables compiler optimizations for performance
109 1 Tony Ciavarella
110 23 Tony Ciavarella
It might be reasonable to use the @debug@ variant in a development environment and the @optimized@ variant in a production environment.
111 1 Tony Ciavarella
112 23 Tony Ciavarella
The @debug@ variant is produced by the @build_debug@ build target and the @optimized@ variant is produced by the @build_optimized@ build target.
113
114 26 Tony Ciavarella
The results of the build are put in the @bin@ subdirectory under the name of the variant.  
115 23 Tony Ciavarella
116 26 Tony Ciavarella
Both variants can coexist peacefully in the tree at the same time.
117 23 Tony Ciavarella
118 20 Tony Ciavarella
h3. Linux
119 1 Tony Ciavarella
120 23 Tony Ciavarella
On Linux, to build the Disorder @debug@ variant:
121 20 Tony Ciavarella
<pre>./waf build_debug</pre>
122
123
h3. Windows
124
125 23 Tony Ciavarella
On Windows, the waf script is invoked indirectly.  To build the @optimized@ variant:
126
<pre>python.exe waf build_optimized</pre>
127 12 Tony Ciavarella
128 1 Tony Ciavarella
h2. Building Against the Disorder Library