Difference between revisions of "Compiling"
(→Library dependencies) |
(update with instructions for the relatively new cmake build system) |
||
| Line 1: | Line 1: | ||
= Compiling BRL-CAD = | = Compiling BRL-CAD = | ||
| − | BRL-CAD source files contain an INSTALL file with general instructions. This page contains tips for building | + | BRL-CAD source files contain an [http://brlcad.svn.sourceforge.net/viewvc/brlcad/brlcad/trunk/INSTALL INSTALL] file with general instructions. This page contains simplified tips for building '''''quickly'''''. |
| − | == | + | == Obtain Dev Tools == |
| − | + | BRL-CAD uses the CMake build system and will compile with most compilers, so first up is to [http://www.cmake.org/cmake/resources/software.html download and install it]. If needed, compiling from their source distribution is actually very easy. | |
| − | |||
| − | |||
| − | |||
| − | + | If you're on a Debian/Ubuntu system, you can install pretty much everything you might want with aptitude: | |
<pre> | <pre> | ||
| + | aptitude install build-essential cmake | ||
aptitude install libxi-dev libncursesw5-dev libxt-dev libxslt1-dev libxmu-dev libxmu-headers byacc flex libtnt-dev libxext-dev libpng12-dev zlib1g-dev libsm-dev libx11-dev libxau-dev tk8.5-dev tcl8.5-dev tk8.4-dev tcl8.4-dev itcl3-dev | aptitude install libxi-dev libncursesw5-dev libxt-dev libxslt1-dev libxmu-dev libxmu-headers byacc flex libtnt-dev libxext-dev libpng12-dev zlib1g-dev libsm-dev libx11-dev libxau-dev tk8.5-dev tcl8.5-dev tk8.4-dev tcl8.4-dev itcl3-dev | ||
</pre> | </pre> | ||
| − | == | + | == Download BRL-CAD == |
| + | |||
| + | Release sources may be obtained from [https://sourceforge.net/projects/brlcad/files/BRL-CAD%20Source/ Sourceforge] or directory from Subversion: | ||
| + | |||
<pre> | <pre> | ||
| − | ./ | + | svn checkout https://brlcad.svn.sourceforge.net/svnroot/brlcad/brlcad/trunk brlcad |
| + | cd brlcad | ||
</pre> | </pre> | ||
| − | === | + | == Configure == |
| + | |||
| + | Next, we set up a build directory and configure our compilation. BRL-CAD adhere's to a high conformance standard and considers most warnings as errors, so we turn off that strict behavior just so the build doesn't halt on trivialities. | ||
| + | |||
| + | We could add -DCMAKE_BUILD_TYPE=Release to get an optimized build or -DCMAKE_BUILD_TYPE=Debug to get one better suited for development work. | ||
| + | |||
<pre> | <pre> | ||
| − | + | mkdir .build | |
| − | + | cd .build | |
| + | cmake .. -DBRLCAD_ENABLE_STRICT=OFF | ||
</pre> | </pre> | ||
| − | == | + | == Compile == |
| − | + | Compilation will usually take anywhere from a couple minutes to an hour depending on your hardware. If you had a quad-core CPU, you might run '"make -j4" to request compiling in parallel. | |
<pre> | <pre> | ||
| − | |||
| − | |||
make | make | ||
| + | make test | ||
</pre> | </pre> | ||
| − | If make | + | We run make test to see if all went well. If the build fails, it can be helpful to run make again capturing output to a log file. E.g., make > build.log 2>&1 |
| − | + | == Install == | |
| − | + | Depending on the version of sources you start with, BRL-CAD should install into /usr/brlcad/SUBDIR where SUBDIR is rel-VERSION or dev-VERSION. | |
| − | + | <pre> | |
| + | sudo make install | ||
| + | /usr/brlcad/rel-VERSION/bin/mged | ||
| + | </pre> | ||
| − | + | == Quick test == | |
| − | + | You don't have to install, though, and can just run binaries that are in the brlcad/.build/bin directory. | |
| + | |||
| + | <pre> | ||
| + | bin/benchmark | ||
| + | bin/mged | ||
| + | </pre> | ||
| − | + | That's it! If you have a Release compile, you can submit your benchmark results to benchmark at brlcad dot org. Be sure to check out the extensive [[Documentation]] and [[Main_Page]] for tutorials and [[Contributor Quickies]] for ways to get involved! | |
| − | |||
Revision as of 11:36, 14 September 2012
Contents
Compiling BRL-CAD
BRL-CAD source files contain an INSTALL file with general instructions. This page contains simplified tips for building quickly.
Obtain Dev Tools
BRL-CAD uses the CMake build system and will compile with most compilers, so first up is to download and install it. If needed, compiling from their source distribution is actually very easy.
If you're on a Debian/Ubuntu system, you can install pretty much everything you might want with aptitude:
aptitude install build-essential cmake aptitude install libxi-dev libncursesw5-dev libxt-dev libxslt1-dev libxmu-dev libxmu-headers byacc flex libtnt-dev libxext-dev libpng12-dev zlib1g-dev libsm-dev libx11-dev libxau-dev tk8.5-dev tcl8.5-dev tk8.4-dev tcl8.4-dev itcl3-dev
Download BRL-CAD
Release sources may be obtained from Sourceforge or directory from Subversion:
svn checkout https://brlcad.svn.sourceforge.net/svnroot/brlcad/brlcad/trunk brlcad cd brlcad
Configure
Next, we set up a build directory and configure our compilation. BRL-CAD adhere's to a high conformance standard and considers most warnings as errors, so we turn off that strict behavior just so the build doesn't halt on trivialities.
We could add -DCMAKE_BUILD_TYPE=Release to get an optimized build or -DCMAKE_BUILD_TYPE=Debug to get one better suited for development work.
mkdir .build cd .build cmake .. -DBRLCAD_ENABLE_STRICT=OFF
Compile
Compilation will usually take anywhere from a couple minutes to an hour depending on your hardware. If you had a quad-core CPU, you might run '"make -j4" to request compiling in parallel.
make make test
We run make test to see if all went well. If the build fails, it can be helpful to run make again capturing output to a log file. E.g., make > build.log 2>&1
Install
Depending on the version of sources you start with, BRL-CAD should install into /usr/brlcad/SUBDIR where SUBDIR is rel-VERSION or dev-VERSION.
sudo make install /usr/brlcad/rel-VERSION/bin/mged
Quick test
You don't have to install, though, and can just run binaries that are in the brlcad/.build/bin directory.
bin/benchmark bin/mged
That's it! If you have a Release compile, you can submit your benchmark results to benchmark at brlcad dot org. Be sure to check out the extensive Documentation and Main_Page for tutorials and Contributor Quickies for ways to get involved!
