Difference between revisions of "Compile the Code Engines"

From OSUPDOCS
Jump to navigation Jump to search
Line 7: Line 7:
* [[Compiling in Linux]]
* [[Compiling in Linux]]
* [[Compiling Using Eclipse IDE]]
* [[Compiling Using Eclipse IDE]]
== Compiling in MacOS X ==
==== Using XCode ====
Most development of [[OSParticulas]] and [[NairnFEA]] is done in MacOS X and thus compiling on MacOS X is easy. The preferred method is to use XCode (a [[#MacOS X Command Line Compiling|command-line method]] is described below). A complete XCode project is located at
nairn-mpm-fea/Common/Projects/NairnMPM.xcodeproj
This project is called <tt>NairnMPM</tt>, but it includes all MPM and FEA source code in two targets named <tt>NairnMPM</tt> and <tt>NairnFEA</tt>. Once [[#Compiling Xerces on MacOS X|<tt>xerces</tt> is installed]], open the <tt>NairnMPM.xcodeproj</tt> to compile the code by:</p>
# Select the target to compile - either <tt>NairnMPM</tt> or <tt>NairnFEA</tt>
# Choose build and they will compile and saved in XCode's derived data folder.
If a linking error occurs, you might have conflicting architectures between the XCode settings and the [[#Compiling Xerces on MacOS X|<tt>xerces</tt> library you installed]]. To fix this problem edit <i>both</i> the project and target settings and under the &quot;Architectures&quot; section, set the &quot;Architectures&quot; option to match the architecture you used when [[#Compiling Xerces on MacOS X|installing <tt>xerces</tt>]] or recompile <tt>xerces</tt> if needed.</li>
==== Compiling Xerces on MacOS X ====
Before you can compile and run the project, however, you will need an installed version  of the <tt>xerces</tt> library and a copy of the <tt>xerces</tt> header files. The XCode project and [[#MacOS X Command Line Compiling|command-line method]] below both assume they are installed in the default locations for MacOS X or at
/usr/local/lib/libxerces-c.dylib
for the library and at
/usr/local/include
for the header files. These can be changed if needed by editing the project and target settings. Since revision 274 of the <code>nairn-mpm-fea</code> project, this library must be <tt>xerces 3.0</tt> or newer; prior to that revision, it had be <tt>xerces 2.8</tt> or older. These libraries can be obtained by downloading the
[http://xml.apache.org/xerces-c/index.html | xerces source code] from the [http://www.apache.org/ | Apache Software Foundation] web site and then building and installing <tt>xerces</tt> with the following steps (after seeing potential [[#MacOS X Lion or Newer Command Line Tools|startup issues on Lion or newer systems]]):
<ol>
<li>Open Terminal app and navigate to the xerces source folder expanded from the downloaded file.</li>
<li>Configure the code with the command:
<pre>./configure CFLAGS="-arch x86_64" CXXFLAGS="-arch x86_64"</pre>
where the provided <tt>arch</tt> (or architecture) is the desired option for your machine. The main Mac options are <tt>i386</tt> for 32 bit Intel processors, <tt>x86_64</tt> for 64 bit Intel processors,  <tt>ppc</tt> for 32 bit PowerPC chips, or <tt>ppc64</tt> for 64 bit PowerPC64 chips. Although <tt>i386</tt> will work on any Intel processor, you should use <tt>x86_64</tt> if you have a 64 bit processor, because the code will run faster. To determine how many bits your Intel chip has, chose &quot;About This Mac&quot; from the Apple menu, click &quot;More Info...&quot; button, and look up the processor name in the hardware section. The &quot;Intel Core Solo&quot; and &quot;Intel Core Duo&quot; are 32 bit chips and most others are 64 bit chips.</li>
<li>When the configuration is done, use the following commands:
<pre>cd src
make
make install</pre>
These commands make the library (but not the unneeded <tt>xerces</tt> examples). The final install command after <tt>make</tt> is done, installs both the library and the header files at the default locations listed above. If the <tt>make install</tt> shows a permission error, you can solve that by using <tt>sudo make install</tt> instead and provide your administrator password.</li>
<li>When working with <tt>nairn-mpm-fea</tt> on a new Mac, the <tt>xerces</tt> installation only needs to be done once. The only reason to repeat it is when a new <tt>xerces</tt> version is available and/or the project requires a new version for compatibility.</li>
</ol>
==== MacOS X Command Line Compiling ====
It is easy to compile on MacOS X using a command line approach (after seeing potential [[#MacOS X Lion or Newer Command Line Tools|startup issues on Lion or newer systems]]). First (and first time only) install <tt>xerces</tt> and its header files as [[#Compiling Xerces on MacOS X|explained above]] and make sure they are in the specified default locations. Once <tt>xerces</tt> is ready, you compile <tt>OSParticulas</tt> using:
<pre>cd nairn-mpm-fea/NairnMPM/build
make SYSTEM=mac CFLAGS=&quot;-c -O3 -arch x86_64&quot; LFLAGS=&quot;-arch x86_64&quot;
</pre>
and compile <tt>NairnFEA</tt> using:
<pre>cd nairn-mpm-fea/NairnFEA/build
make SYSTEM=mac CFLAGS=&quot;-c -O3 -arch x86_64&quot; LFLAGS=&quot;-arch x86_64&quot;
</pre>
Here the <tt>arch</tt> settings must match the one used when you [[#Compiling Xerces on MacOS X|installed <tt>xerces</tt>]]. The <tt>-c</tt> option is required. The <tt>-O3</tt> option creates optimized code; this option can be changed or omitted.
All source code will be compiled and the executables will be installed in <tt>nairn-mpm-fea/NairnMPM/input</tt> or <tt>nairn-mpm-fea/NairnFEA/input</tt>, respectively. You can use an additional <tt>make install</tt> command to copy each compiled executable to your <tt>~/bin</tt> folder if desired.
If the command-line compile does not work, the most likely explanation is a problem with the <tt>xerces</tt> installation. You either have to install it as specified [[#Compiling Xerces on MacOS X|above]] or edit the <tt>makefile</tt> to recognize your custom installation. The process is documented in the <tt>makefile</tt> and involves editing the <tt>xercesSo</tt> and <tt>headersPath</tt> variables for your different settings.
==== MacOS X Lion or Newer Command Line Tools ====
Apple choose not to install command line tools on Lion (or newer systems such as Mountain Lion) and makes it hard to access some very useful folders (such as your home &quot;Library&quot; folder). With these changes, you cannot compile [[#Using XCode|<tt>nairn-fea-mpm</tt> code engines]] or [[#Compiling Xerces on MacOS X|<tt>xerces</tt>]] or until you do some additional set up:
# You probably have to install XCode (even if you do not plan to use it).
# In XCode, use its preferences window to install &quot;Command Line Tools&quot;.
# Most tools should now be available. You should be able to make and install the <tt>xerces</tt> project and then use the provided XCode project to build <tt>NairnMPM</tt> and <tt>NairnFEA</tt>.
One issue in the XCode project is that it might not find your <tt>xerces</tt> library, even if it is in the standard location. If it is not found, the library will be in <font color="red">red</font> in the &quot;External Frameworks and Libraries&quot; folder. You have to select the library, view its properties, and then click to set the path on your computer. The problem is that you cannot navigate to the <tt>/usr/local/lib</tt> folder anymore (another new Apple &quot;feature&quot;). Here is a trick to get there:
# In the Finder, use the &quot;Go to Folder...&quot; menu command and enter &quot;<tt>/usr/local</tt>&quot;.
# After it opens, choose the &quot;Add To Sidebar&quot; menu command. This folder will now appear in all file selection boxes.
# Go back to XCode and enter box to select the path the the <tt>xerces</tt> library.
# Go through your new &quot;local&quot; folder and select the <tt>xerces</tt> library file in <tt>/usr/local/lib</tt>.
Apple seems to creating road blocks to keep you from using you computer for interesting programming. With a few tricks it is still possible to get around their road blocks. Hopefully these tricks will continue to work in the future.
== Compiling in Windows Using cygwin ==
== Compiling Using Eclipse IDE ==
== Compiling in Linux ==
== Compiling Parallel Code with OpenMP ==

Revision as of 08:41, 28 August 2013

After checking out the nairn-mpm-fea project, the next step is to compile it. All code-engine source codes are standard C++ and it should be possible to compile on a variety of systems. This links on this page provide details on some common systems. Users are responsible for compilation on other systems.

Compilation on Various Operating Systems

Retrieved from "http://osupdocs.forestry.oregonstate.edu/index.php?title=Compile_the_Code_Engines&oldid=382"