Project

General

Profile

Installation » History » Version 132

Tony Ciavarella, 09/28/2021 07:11 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 94 Tony Ciavarella
Disorder doesn't have any official releases yet.  If/when that happens, release source tarballs will be 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 72 Tony Ciavarella
The Disorder source code is hosted in a "Mercurial":https://www.mercurial-scm.org repository.  This is what you want if you are looking for the very latest bleeding edge of the code for contributing to Disorder, forking an evil fork, or whatever other reason you may have.
12 2 Tony Ciavarella
13 54 Tony Ciavarella
Read the "Mercurial Documentation":http://hgbook.red-bean.com/ if you aren't familiar with that and you want to go this route.
14 27 Tony Ciavarella
15 53 Tony Ciavarella
To clone the repository including the full history:
16 54 Tony Ciavarella
<pre>hg clone http://hg.squalllinesoftware.com/oss/disorder</pre>
17 2 Tony Ciavarella
18 126 Tony Ciavarella
There's also a git mirror for those of you who fail to acknowledge the existence of any other SCM tools:
19
<pre>git clone https://git.squallline.com/oss/disorder.git</pre>
20
21 1 Tony Ciavarella
h2. Prerequisites
22
23 38 Tony Ciavarella
Given the assumption that a somewhat sane build environment for C++ already exists on the build machine, the following third party things are required to build Disorder:
24 114 Tony Ciavarella
25
These dependencies require manual intervention if your system doesn't already have them:
26 121 Tony Ciavarella
* The "meson":https://mesonbuild.com/ build system >= 0.50
27 114 Tony Ciavarella
** The "ninja":https://ninja-build.org build system
28
** A "Python 3":http://www.python.org interpreter
29
* A C++ compiler capable of understanding the "ISO C++ 2011 Standard":http://www.iso.org/iso/iso_catalogue/catalogue_tc/catalogue_detail.htm?csnumber=50372
30
** "GCC":http://gcc.gnu.org >= 4.7.0
31
** "Clang++":http://clang.llvm.org >= 3.1.0
32 131 Tony Ciavarella
** Visual Studio >= 2017
33
*** If you intend to use Visual Studio to build this thing on Windows, you're going to need at least 2017.
34 114 Tony Ciavarella
*** gcc or clang can build disorder on windows in a "cygwin":http://cygwin.org/ environment.
35
** (optional) C++ version of the "SEDRIS SRM":http://www.sedris.org/srm_4.4/srm_c_cpp.htm >= 4.4.0
36
37
These dependencies will be acquired automatically during the build process if they aren't already on the build system:
38 82 Tony Ciavarella
* "ASIO":http://think-async.com >= 1.12.1
39 52 Tony Ciavarella
** Either the standalone version of ASIO or the one built into boost can be used.
40
* "Eigen":http://eigen.tuxfamily.org >= 3.0.5
41
* "Google Test/Mock":https://github.com/google/googletest >= 1.7.0
42 78 Tony Ciavarella
* At least one of the following geospatial conversion libraries:
43 63 Tony Ciavarella
** "GeographicLib":https://geographiclib.sourceforge.io >= 1.45
44 89 Tony Ciavarella
** Patches to support other geospatial conversion libraries are welcome
45 1 Tony Ciavarella
46 115 Tony Ciavarella
Some platform specific hints follow.
47 1 Tony Ciavarella
48 8 Tony Ciavarella
h3. Debian Linux and Derivatives
49
50 107 Tony Ciavarella
If you don't already have meson, get it and its dependencies (python 3 and ninja):
51 105 Tony Ciavarella
<pre>sudo apt-get install meson</pre>
52 1 Tony Ciavarella
53 105 Tony Ciavarella
That's it.  You can optionally install the Disorder build dependencies from the package manager.  If the dependencies aren't installed on the system, Disorder will automatically download their source code and build them with the library.
54 82 Tony Ciavarella
55 105 Tony Ciavarella
If you'd rather install them on your system:
56 1 Tony Ciavarella
<pre>sudo apt-get install libasio-dev libeigen3-dev libgeographic-dev googletest google-mock</pre>
57 82 Tony Ciavarella
58 105 Tony Ciavarella
This may install older packages than the ones that Disorder is known to work with.  That may not work out so awesome.  Consider yourself warned.
59 1 Tony Ciavarella
60 125 Tony Ciavarella
If you've got some of the dependencies installed on your system but you want Disorder to download and build the versions the library likes, specify the @-Dwrap_mode=forcefallback@ option to meson.  That will make it ignore your system libraries.
61 108 Tony Ciavarella
62 111 Tony Ciavarella
h3. Windows
63
64
You're going to need a python interpreter, meson, and ninja.  The "meson documentation":https://mesonbuild.com/Getting-meson.html describes how to get that done.
65
66 82 Tony Ciavarella
h2. Options
67 1 Tony Ciavarella
68 106 Tony Ciavarella
There are various options available to control things.  If you don't know what you want, you can skip this section as disorder will try to do something sane.  Don't worry, you can change options later and rebuild if you decide you really want something different than the default.
69 46 Tony Ciavarella
70 82 Tony Ciavarella
To get a list of available options:
71
<pre>meson configure</pre>
72 1 Tony Ciavarella
73 82 Tony Ciavarella
Here are some useful options:
74
|_. Option |_. Argument |_. Description |
75 127 Tony Ciavarella
| cpp_std | c++11, c++14, c++17, c++20 | select the desired C++ standard (default: c++11) |
76 109 Tony Ciavarella
| default_library | shared, static, both | select the type of library to make (default: static) |
77 120 Tony Ciavarella
| buildtype | plain, debug, debugoptimized, release, minsize, custom | type of build to produce see "Running Meson":https://mesonbuild.com/Running-Meson.html for more details (default: debug) |
78 124 Tony Ciavarella
| wrap_mode | default, nofallback, nodownload, forcefallback | controls how dependencies are found see "Meson FAQ":https://mesonbuild.com/FAQ.html#does-wrap-download-sources-behind-my-back for more details (default: default) |
79 118 Tony Ciavarella
| build_examples | true, false | whether or not to build the disorder examples (default: false) |
80 122 Tony Ciavarella
| build_tools | true, false | whether or not to build the disorder tools (default: false) |
81 80 Tony Ciavarella
82 116 Tony Ciavarella
Options are applied as arguments to meson setup when running the configuration step described below.  The options are specified as @-D<option>=<value>@ where <option> is the option to set and <value> is the value to set it to.  For example, to use the C++14 standard, supply @-Dcpp_std=c++14@ to meson.
83 1 Tony Ciavarella
84 82 Tony Ciavarella
h2. Configuration
85 13 Tony Ciavarella
86 82 Tony Ciavarella
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.
87 32 Tony Ciavarella
88 82 Tony Ciavarella
h3. General
89 13 Tony Ciavarella
90 82 Tony Ciavarella
The basic idea of configuration is to allow disorder to learn enough about your build platform to be able to compile.  Disorder uses the "meson":https://mesonbuild.com build system to configure and generate a "ninja":https://ninja-build.org recipe for compilation.
91 30 Tony Ciavarella
92 82 Tony Ciavarella
On Windows, meson will download all the dependencies, build, and utilize them out of the @subprojects@ subdirectory.
93 30 Tony Ciavarella
94 82 Tony Ciavarella
On linux-like systems, meson will attempt to find dependencies installed in the general system location falling back to downloading them and using them out of the @subprojects@ subdirectory.
95 1 Tony Ciavarella
96
If you don't want the default behavior on your platform, you can override it using options.  The options for configuring disorder's dependencies can be found via @meson configure@.
97
98
Some of said options are thusly enumerated for your convenience:
99
100
h4. ASIO
101
102
|_. Option |_. Argument |_. Description |
103
| asio | default, standalone, boost | Select the preferred version of the ASIO library.  The default option prefers the standalone version with a fallback to boost if the standalone version is not found. (default: default) |
104
| asio_root | path to the root of the standalone ASIO library (eg. /opt/asio-1.12.2) | Tells disorder where to find the standalone ASIO library. |
105
106 128 Tony Ciavarella
h4. Boost
107
108
|_. Option |_. Argument |_. Description |
109
| boost | auto, require, exclude | This option controls how the boost library is used.  The auto option prefers C++ standard things falling back to boost when possible.  The require option mandates boost header usage over system stuff.  The exclude option never uses boost. (default: auto) |
110 130 Tony Ciavarella
| boost_root | non-standard installation location of boost | This is a standard option provided by Meson.  Use this option or (boost_include and boost_librarydir) but not all three.  See the "Meson Manual":https://mesonbuild.com/Dependencies.html#boost for more details. |
111 129 Tony Ciavarella
| boost_include | non-standard installation location of boost headers | This is a standard option provided by Meson.  Use this option with boost_librarydir when boost_root isn't good enough.  See the "Meson Manual":https://mesonbuild.com/Dependencies.html#boost for more details. |
112
| boost_librarydir | non-standard installation location of boost libraries | This is a standard option provided by Meson.  Use this option with boost_include when boost_root isn't good enough.  See the "Meson Manual":https://mesonbuild.com/Dependencies.html#boost for more details. |
113 128 Tony Ciavarella
114 1 Tony Ciavarella
h4. Eigen
115
116 30 Tony Ciavarella
|_. Option |_. Argument |_. Description |
117 82 Tony Ciavarella
| eigen_root | path to the root of the Eigen library (eg. /opt/eigen-3.1.2) | Tells disorder where to find the Eigen library. |
118 90 Tony Ciavarella
119
h4. SEDRIS SRM
120
121
By default Disorder will use the "GeographicLib":https://geographiclib.sourceforge.io library.  If that's what you want, no extra setup is necessary.
122
123
If you want to use the SEDRIS SRM, there's a little more work to do.  Because the SEDRIS SRM creators don't give away their source code without forcing people to have an account in their system and agree to their license, Disorder is not distributed with the SEDRIS SRM and cannot automatically download it for you.
124
125
The following additional steps are required to use the SEDRIS SRM:
126
* Download the "SEDRIS SRM":http://www.sedris.org/srm_4.4/srm_c_cpp.htm source code .tgz file.  *NOTE*: Always pick the Unix version even on Windows.  They are the same except for the compression format.
127
* Put the srm_c_cpp_sdk_4.4.tgz file in a subdirectory off the root of the disorder source tree called subprojects/packagecache
128 117 Tony Ciavarella
* Use @-Denabled_geospatial_libraries=sedris_srm@ option when configuring disorder
129
** @-Denabled_geospatial_libraries=sedris_srm,geographic_lib@ can be used to include support for both libraries allowing run-time selection of the one that gets used
130
*** If both libraries are enabled and you want to use SEDIRS_SRM by default instead of GeographicLib, also apply the @-Dpreferred_geospatial_library=sedris_srm@ option
131 30 Tony Ciavarella
132 82 Tony Ciavarella
h3. Creating a Build Directory and Configuring Disorder
133 30 Tony Ciavarella
134 82 Tony Ciavarella
Once you've decided on the options, make a <build_dir> directory and configure disorder where <options> should be replaced with the desired options:
135
<pre>meson <build_dir> <options></pre>
136
For example to use the C++17 standard and a <build_dir> called "build-c++17":
137 116 Tony Ciavarella
<pre>meson build-c++17 -Dcpp_std=c++17</pre>
138 10 Tony Ciavarella
139 82 Tony Ciavarella
If you see an error message from that step, it must be fixed in order to proceed.
140 1 Tony Ciavarella
141 110 Tony Ciavarella
h2. Platform Specific Notes
142
143 82 Tony Ciavarella
h3. Linux
144
145 23 Tony Ciavarella
h4. Clang++
146 1 Tony Ciavarella
147 23 Tony Ciavarella
To use the "Clang":http://clang.llvm.org/ C++ compiler instead of "GCC":http://gcc.gnu.org/, assuming clang++ is installed on the build system:
148 82 Tony Ciavarella
<pre>CXX=<put the path to clang++ here> meson <build_dir> <options></pre>
149 23 Tony Ciavarella
150 104 Tony Ciavarella
For example, to make a release build using C++14 with a build directory of build-clang-c++14-release:
151 116 Tony Ciavarella
<pre>CXX=clang++ meson build-clang-c++14-release -Dcpp_std=c++14 -Dbuildtype=release</pre>
152 23 Tony Ciavarella
153 26 Tony Ciavarella
h3. Windows
154 23 Tony Ciavarella
155 20 Tony Ciavarella
On windows, your $PATH environment variable needs to include the path to the Python interpreter.
156 1 Tony Ciavarella
157 82 Tony Ciavarella
If you're using the Visual Studio compiler, you must run the configuration and compilation steps from within the appropriate Visual Studio command prompt for the configuration you want to build for.
158 20 Tony Ciavarella
159 101 Tony Ciavarella
Also, shared libraries cannot be used on windows as Disorder does not properly export symbols.  Patches welcome.
160
161 132 Tony Ciavarella
h4. Stepping into Disorder while Debugging in Visual Studio
162
163
Visual Studio doesn't make overall .pdb files for static libraries.  Instead, the default behavior is create .pdb files for each compilation unit and then put absolute path links to those .pdb files in each .o.  Those absolute paths wind up in the static library.  So, the debug information is only available if the debug session occurs on the same machine that built the static library and the build artifacts still exist in the original location or one recreates this mess on the machine one wishes to perform the debugging on.
164
165
The work around for this almost always unhelpful behavior is replace the /Zi argument sent to cl.exe with /Z7.  Meson does not provide a convenient way to do this, but it can be made to do it by slapping add_global_arguments('/Z7', language: 'cpp') in the meson.build at the top level of disorder and rebuilding it using -Dbuildtype=debug (for /MTd) or -Dbuildtype=debugoptimized (for /MT).  This will spew one warning per build file about how it's overriding /Zi with /Z7.  Cheerfully ignore that.  Then the resultant disorder static library will contain built-in debug information without any need for .pdb files.  You can install that and move it around however you want.  It will be significantly larger than before.  When you link the shared library into an .exe or .dll, the debug information will not be put in your product .exe or .dll, at that point it will go into your thing's .pdb file.
166
167 20 Tony Ciavarella
h2. Compiling
168
169 82 Tony Ciavarella
The basic strategy for building Disorder is to invoke the ninja build system from within the build directory produced by the configuration step.
170 23 Tony Ciavarella
171 82 Tony Ciavarella
This is generally all it takes:
172
<pre>cd build
173
ninja</pre>
174 43 Tony Ciavarella
175 44 Tony Ciavarella
h2. Ensuring Build Correctness
176 43 Tony Ciavarella
177 67 Tony Ciavarella
Due to the complexity of varied compilers and build configurations, it is imperative that you preform the necessary testing on your build to ensure that it performs correctly.
178
179 88 Tony Ciavarella
Don't fret.  It's easy and is well worth the time it takes for the peace of mind you gain.  Just tell ninja to run the unit test from inside your build directory like this:
180 82 Tony Ciavarella
<pre>ninja test</pre>
181 1 Tony Ciavarella
182 67 Tony Ciavarella
That should result in something like this:
183
<pre>
184 85 Tony Ciavarella
[0/1] Running all tests.
185 103 Tony Ciavarella
1/1 disorder unit test                      OK       0.42 s
186 1 Tony Ciavarella
187 84 Tony Ciavarella
Ok:                    1
188
Expected Fail:         0
189
Fail:                  0
190
Unexpected Pass:       0
191
Skipped:               0
192
Timeout:               0
193
194
Full log written to /usr/local/src/disorder/build/meson-logs/testlog.txt
195 73 Tony Ciavarella
</pre>
196 84 Tony Ciavarella
197 96 Tony Ciavarella
Ninja thinks there is only one test, but it ran the full test suite which contains thousands of tests.  Yes, it can do them all in less than a second depending on your hardware.  If you see something besides "OK" on line 2 and "Ok: 1" on line 4, things are not okay.  Look at the full log specified on the last output line to see exactly what went wrong.
198 43 Tony Ciavarella
199 93 Tony Ciavarella
If it's unhappy, please file a bug report and/or fix it yourself and send in a patch.  Under no circumstances should you attempt to use a build that fails the test suite.  A test failure means disorder isn't working as expected for some reason and that reason needs to be resolved for your simulation to function properly.  Disorder does not have any known flaky unit tests.  If a test doesn't work, something is broken.
200 43 Tony Ciavarella
201
h2. Building Against the Disorder Library
202
203 82 Tony Ciavarella
h3. Installing Disorder
204 28 Tony Ciavarella
205 112 Tony Ciavarella
Disorder can be installed somewhere on your system to make a neat little package out of all the things you'll need to build something against the library.  To do that, issue the @ninja install@ command from inside your build directory.  If you want to control where that sticks stuff, add @DESTDIR=<dest_dir>@ to the front that where <dest_dir> is where you want to install it.  For example, to install disorder under /opt in Linux:
206 1 Tony Ciavarella
<pre>DESTDIR=/opt ninja install</pre>
207 112 Tony Ciavarella
208
Windows wants you to type more stuff.  To install disorder under C:\best_libraries_ever:
209
<pre>set DESTDIR=C:\best_libraries_ever
210
ninja install
211 113 Tony Ciavarella
</pre>
212 28 Tony Ciavarella
213 82 Tony Ciavarella
h3. Compiling Your Project Against Disorder
214 28 Tony Ciavarella
215 82 Tony Ciavarella
In order to compile your goodness against the Disorder library, you'll need to have the installed header files in your compiler's include path.  The geospatial libraries aren't exposed so you don't need those in your include path.
216
217
h3. Linking Your Project With Disorder
218
219 97 Tony Ciavarella
Just link your program against Disorder's library that can be found in the @<build>/src/disorder@ directory.  If you've installed Disorder using ninja, the library will be in the appropriate location under the installation root path.