manual:compileauryn
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
manual:compileauryn [2016/08/16 22:23] – [Building Auryn from source] zenke | manual:compileauryn [2022/08/19 09:24] (current) – [Building Auryn from source] Remove forum link zenke | ||
---|---|---|---|
Line 9: | Line 9: | ||
- | ===== Meeting the preliminaries | + | ===== Requirements |
- | Apart from a standard C++ build environment you will need to meet certain requirements. Auryn currently depends on the [[http:// | + | Apart from a standard C++ build environment you will need the [[http:// |
+ | With these preliminaries met, you can proceed as follows. | ||
- | + | ==== Getting the source with git ==== | |
- | ===== Getting the source with git ===== | + | First clone Auryn' |
- | If you know how to use git you can simply | + | |
< | < | ||
git clone https:// | git clone https:// | ||
Line 21: | Line 21: | ||
This will create a new directory '' | This will create a new directory '' | ||
- | ===== Getting the source as a zip archive or tar ball ===== | ||
- | You can download zips or tar archives of the latest releases from GitHub | + | ==== Getting the source as a zip archive or tar ball ==== |
+ | Alternatively, | ||
To unpack a tgz compressed | To unpack a tgz compressed | ||
Line 34: | Line 34: | ||
===== Building Auryn from source ===== | ===== Building Auryn from source ===== | ||
- | To facilitate compiling Auryn on other systems, Auryn uses the cmake build system. For this to work you have to install '' | + | Once you have downloaded the sources, compile |
To build Auryn using cmake simply run: | To build Auryn using cmake simply run: | ||
< | < | ||
Line 41: | Line 41: | ||
</ | </ | ||
- | Instead you can also invoke cmake directly: | + | Instead |
< | < | ||
cmake ../../ -DCMAKE_BUILD_TYPE=Release && make | cmake ../../ -DCMAKE_BUILD_TYPE=Release && make | ||
Line 48: | Line 48: | ||
If you want to specify an install prefix add the option '' | If you want to specify an install prefix add the option '' | ||
- | Either way you find the library '' | + | Either way you will find the compiled |
- | **Frustrated?? | ||
- | ===== Running a test simulation | + | ===== Running a test ===== |
If you compiled Auryn using the existing Makefile (the old way) you can test the setup by issuing from within the '' | If you compiled Auryn using the existing Makefile (the old way) you can test the setup by issuing from within the '' | ||
< | < | ||
Line 74: | Line 73: | ||
</ | </ | ||
These are the output files of the simulation. Their meaning is described in more detail in the [[examples: | These are the output files of the simulation. Their meaning is described in more detail in the [[examples: | ||
+ | |||
+ | ==== Generate Doxygen code documentation ==== | ||
+ | |||
+ | Now might be a good time to also compile the [[doxygen]] docs. | ||
+ | |||
+ | |||
+ | ==== Building your own simulations/ | ||
+ | |||
+ | See the [[CompileAndRunAurynSimulations]] guide to see how you can conveniently link your own simulations against the Auryn library. | ||
+ | |||
====== Building other versions ====== | ====== Building other versions ====== | ||
- | ==== Auryn development version ==== | + | ===== Auryn development version |
Some of the newest features might only be available in the development version. If you want to compile the development version, simply clone and compile Auryn as follows: | Some of the newest features might only be available in the development version. If you want to compile the development version, simply clone and compile Auryn as follows: | ||
Line 88: | Line 97: | ||
+ | ===== Building Auryn without MPI ===== | ||
- | ==== Building | + | Starting from v0.8 you can build Auryn without MPI if need be. To do so, open the file '' |
+ | <code c++> | ||
+ | #define AURYN_CODE_USE_MPI | ||
+ | </ | ||
+ | |||
+ | This will disable any dependence on MPI in the source code. Then in the '' | ||
+ | < | ||
+ | FIND_PACKAGE(MPI REQUIRED) | ||
+ | </ | ||
+ | and comment it out or remove the '' | ||
+ | |||
+ | ===== Building Auryn with debug symbols (reduces performance) | ||
To create a debug run instead use: | To create a debug run instead use: | ||
< | < | ||
- | cmake ../../ -DCMAKE_BUILD_TYPE=Debug | + | cd build/ |
+ | cmake ../../ -DCMAKE_BUILD_TYPE=Debug | ||
+ | make | ||
</ | </ | ||
+ | or alternatively | ||
+ | < | ||
+ | cd build/debug | ||
+ | ./bootstrap && make | ||
+ | </ | ||
+ | |||
This will turn off all optimizations and compile all binaries with the " | This will turn off all optimizations and compile all binaries with the " | ||
Line 103: | Line 132: | ||
to show compiler warnings. | to show compiler warnings. | ||
- | ===== Other ways of building Auryn ===== | ||
- | The github user sanjayankur31 maintains an autotool version of Auryn with the standard gnu build toolchain (i.e. configure and make) which can be found here | ||
- | [[https:// | ||
- | ==== Building older versions of Auryn (< | + | ===== Building older versions of Auryn (< |
See instructions [[BuildWithMakefile|here]]. | See instructions [[BuildWithMakefile|here]]. | ||
- | ==== Generate Doxygen code documentation ==== | ||
- | |||
- | Now might be a good time to also compile the [[doxygen]] docs. | ||
- | |||
- | |||
- | ===== Building your own simulations/ | ||
- | |||
- | See the [[CompileAndRunAurynSimulations]] guide to see how you can conveniently link your own simulations against the Auryn library. | ||
manual/compileauryn.1471386193.txt.gz · Last modified: 2016/08/16 22:23 by zenke