Difference between revisions of "Compiling"

(Compile)
(tighten up the steps a bit, remove installation, clarify which are optional for the vm)
(9 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 
= Compiling BRL-CAD =
 
= Compiling BRL-CAD =
  
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'''''.
+
This page contains simplified steps for building '''''quickly'''''.
  
== Obtain Dev Tools ==
+
== Install Dev Tools ==
  
If you downloaded the virtual machine disk image, YOU DON'T NEED TO INSTALL ANYTHING ELSE.  Skip this step.
+
''If you downloaded the virtual machine disk image, skip this step.''
  
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.
+
BRL-CAD uses the CMake build system and may be built with most compilers, so first step is to [http://www.cmake.org/cmake/resources/software.html download and install CMake].  If needed, compiling from their source distribution is actually very easy.
  
 
If you're on some other Debian/Ubuntu system, you can install pretty much everything you might want with aptitude:
 
If you're on some other Debian/Ubuntu system, you can install pretty much everything you might want with aptitude:
Line 13: Line 13:
 
<pre>
 
<pre>
 
aptitude install build-essential make cmake
 
aptitude install build-essential make cmake
 +
</pre>
 +
 +
== Install Dependencies ==
 +
 +
''If you downloaded the virtual machine disk image, skip this step.''
 +
 +
If you're on a Mac or Windows, you're good to go.  For Linux, BSD, and other package-managed systems, you'll want to install a few things.
 +
 +
Here's some of them for Debian/Ubuntu-style Linux:
 +
 +
<pre>
 
aptitude install sed byacc flex xsltproc
 
aptitude install sed byacc flex xsltproc
 
aptitude install libncursesw5-dev libfontconfig-dev  
 
aptitude install libncursesw5-dev libfontconfig-dev  
 
aptitude install xserver-xorg-dev
 
aptitude install xserver-xorg-dev
 
aptitude install libx11-dev libxi-dev libxt-dev libxau-dev libxext-dev libxmu-dev libxmu-headers
 
aptitude install libx11-dev libxi-dev libxt-dev libxau-dev libxext-dev libxmu-dev libxmu-headers
aptitude install libtnt-dev libpng12-dev zlib1g-dev libsm-dev tcl8.5-dev tk8.5-dev itcl3-dev
 
 
</pre>
 
</pre>
 
If you're on a Mac or Windows, you just need to install CMake and developer tools.
 
  
 
== Download BRL-CAD ==
 
== Download BRL-CAD ==
  
If you downloaded the virtual machine disk image, WE ALREADY DID THIS FOR YOU.  See the brlcad.svn directory.
+
''If you downloaded the virtual machine disk image, run this to make sure you have the latest sources:''
 
+
<pre>
Release sources may be obtained from [https://sourceforge.net/projects/brlcad/files/BRL-CAD%20Source/ Sourceforge] or directory from Subversion:
+
svn up brlcad-svn-trunk
 +
</pre>
  
 +
For everyone else, we recommend obtaining the latest sources from our repository:
 
<pre>
 
<pre>
svn checkout https://brlcad.svn.sourceforge.net/svnroot/brlcad/brlcad/trunk brlcad
+
svn checkout svn://svn.code.sf.net/p/brlcad/code/brlcad/trunk brlcad-svn-trunk
cd brlcad
+
 
</pre>
 
</pre>
  
== Configure ==
+
If you run into trouble, snapshot release sources may also be obtained from [https://sourceforge.net/projects/brlcad/files/BRL-CAD%20Source/ Sourceforge].
  
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.
+
== Configure your Build ==
  
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.
+
Next, set up a build directory and configure your compilation:
  
 
<pre>
 
<pre>
 +
cd brlcad-svn-trunk
 
mkdir .build
 
mkdir .build
 
cd .build
 
cd .build
cmake .. -DBRLCAD_ENABLE_STRICT=OFF
+
cmake .. -DBRLCAD_ENABLE_STRICT=NO -DBRLCAD_BUNDLED_LIBS=ON -DCMAKE_BUILD_TYPE=Release
 
</pre>
 
</pre>
  
== Compile ==
+
By default, our build enforces code standards that will halt on trivial issues, so we recommend turning off that strict behavior for your first compile.  By default, it will also search your system for dependencies, but this can be complicated so we tell the build to use our bundled versions.  When you graduate to doing development, you'll want to change the build type to -DCMAKE_BUILD_TYPE=Debug instead of Release.
  
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.
+
BRL-CAD source files contain an [http://brlcad.svn.sourceforge.net/viewvc/brlcad/brlcad/trunk/INSTALL INSTALL] file with more detailed instructions if you want to customize the build.
 +
 
 +
== Compile ==
  
 +
You're good to go, now it's time to compile:
 
<pre>
 
<pre>
 
make
 
make
make test
 
 
</pre>
 
</pre>
  
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
+
Compilation can 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.
  
If you run into trouble and 'make' fails, rerun cmake:
+
If the build fails, re-run make while capturing all output to a log: make > build.log 2>&1
 +
Please report any build failures.
  
<pre>
+
== Run! ==
cmake .. -DBRLCAD_BUNDLED_LIBS=ON -DBRLCAD_ENABLE_STRICT=OFF
+
</pre>
+
  
== Install ==
+
You don't have to install to run BRL-CAD.  You can just run the binaries you just finished compiling.  They are in the brlcad/.build/bin directory.  There are 400+ tools in BRL-CAD. Here's a couple to get started:
 
+
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>
 
<pre>
sudo make install
+
bin/benchmark run
ls -la /usr/brlcad
+
bin/mged
/usr/brlcad/*/bin/mged
+
bin/archer
 
</pre>
 
</pre>
  
== Quick test ==
+
The first command will evaluate your system performance.  If you made a Release build, please submit your benchmark results to benchmark at brlcad dot org.
  
You don't have to install, though, and can just run binaries that are in the brlcad/.build/bin directory.
+
The second command runs the main graphical interface. Be sure to check out the extensive [[Documentation]] and [[Main_Page]] for tutorials.
  
<pre>
+
The third runs our newer graphical interface that is under development.
bin/benchmark
+
 
bin/mged
+
== What now? ==
</pre>
+
 
 +
Help make BRL-CAD better!  There are many ways you can contribute to open source and you don't need to be an experienced programmer.  We do need software developers, but we also need artists, writers, designers, and managers.
  
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!
+
See [[Contributor Quickies]] for really easy ways to get started!

Revision as of 16:06, 16 September 2014

Compiling BRL-CAD

This page contains simplified steps for building quickly.

Install Dev Tools

If you downloaded the virtual machine disk image, skip this step.

BRL-CAD uses the CMake build system and may be built with most compilers, so first step is to download and install CMake. If needed, compiling from their source distribution is actually very easy.

If you're on some other Debian/Ubuntu system, you can install pretty much everything you might want with aptitude:

aptitude install build-essential make cmake

Install Dependencies

If you downloaded the virtual machine disk image, skip this step.

If you're on a Mac or Windows, you're good to go. For Linux, BSD, and other package-managed systems, you'll want to install a few things.

Here's some of them for Debian/Ubuntu-style Linux:

aptitude install sed byacc flex xsltproc
aptitude install libncursesw5-dev libfontconfig-dev 
aptitude install xserver-xorg-dev
aptitude install libx11-dev libxi-dev libxt-dev libxau-dev libxext-dev libxmu-dev libxmu-headers

Download BRL-CAD

If you downloaded the virtual machine disk image, run this to make sure you have the latest sources:

svn up brlcad-svn-trunk

For everyone else, we recommend obtaining the latest sources from our repository:

svn checkout svn://svn.code.sf.net/p/brlcad/code/brlcad/trunk brlcad-svn-trunk

If you run into trouble, snapshot release sources may also be obtained from Sourceforge.

Configure your Build

Next, set up a build directory and configure your compilation:

cd brlcad-svn-trunk
mkdir .build
cd .build
cmake .. -DBRLCAD_ENABLE_STRICT=NO -DBRLCAD_BUNDLED_LIBS=ON -DCMAKE_BUILD_TYPE=Release

By default, our build enforces code standards that will halt on trivial issues, so we recommend turning off that strict behavior for your first compile. By default, it will also search your system for dependencies, but this can be complicated so we tell the build to use our bundled versions. When you graduate to doing development, you'll want to change the build type to -DCMAKE_BUILD_TYPE=Debug instead of Release.

BRL-CAD source files contain an INSTALL file with more detailed instructions if you want to customize the build.

Compile

You're good to go, now it's time to compile:

make

Compilation can 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.

If the build fails, re-run make while capturing all output to a log: make > build.log 2>&1 Please report any build failures.

Run!

You don't have to install to run BRL-CAD. You can just run the binaries you just finished compiling. They are in the brlcad/.build/bin directory. There are 400+ tools in BRL-CAD. Here's a couple to get started:

bin/benchmark run
bin/mged
bin/archer

The first command will evaluate your system performance. If you made a Release build, please submit your benchmark results to benchmark at brlcad dot org.

The second command runs the main graphical interface. Be sure to check out the extensive Documentation and Main_Page for tutorials.

The third runs our newer graphical interface that is under development.

What now?

Help make BRL-CAD better! There are many ways you can contribute to open source and you don't need to be an experienced programmer. We do need software developers, but we also need artists, writers, designers, and managers.

See Contributor Quickies for really easy ways to get started!