Difference between revisions of "Compile the Code Engines"

From OSUPDOCS
Jump to navigation Jump to search
Line 1: Line 1:
After checking out the [http://code.google.com/p/nairn-mpm-fea/ nairn-mpm-fea] project, the next step is to compile it. All code-engine source code is standard <tt>C++</tt>  and it should be possible to compile on a variety of systems. This page gives details on some common systems. Users are responsible for compilation on other systems.
After checking out the [http://code.google.com/p/nairn-mpm-fea/ nairn-mpm-fea] project, the next step is to compile it. All code-engine source codes are standard <tt>C++</tt>  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 ==
 
* [[Compiling in MacOS X]]
* [[Compiling in Windows]]
* [[Compiling in Linux]]
* [[Compiling Using Eclipse IDE]]


== Compiling in MacOS X ==
== Compiling in MacOS X ==

Revision as of 09:37, 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

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 command-line method is described below). A complete XCode project is located at

nairn-mpm-fea/Common/Projects/NairnMPM.xcodeproj

This project is called NairnMPM, but it includes all MPM and FEA source code in two targets named NairnMPM and NairnFEA. Once xerces is installed, open the NairnMPM.xcodeproj to compile the code by:

  1. Select the target to compile - either NairnMPM or NairnFEA
  2. 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 xerces library you installed. To fix this problem edit both the project and target settings and under the "Architectures" section, set the "Architectures" option to match the architecture you used when installing xerces or recompile xerces if needed.

Compiling Xerces on MacOS X

Before you can compile and run the project, however, you will need an installed version of the xerces library and a copy of the xerces header files. The XCode project and 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 nairn-mpm-fea project, this library must be xerces 3.0 or newer; prior to that revision, it had be xerces 2.8 or older. These libraries can be obtained by downloading the | xerces source code from the | Apache Software Foundation web site and then building and installing xerces with the following steps (after seeing potential startup issues on Lion or newer systems):

  1. Open Terminal app and navigate to the xerces source folder expanded from the downloaded file.
  2. Configure the code with the command:
    ./configure CFLAGS="-arch x86_64" CXXFLAGS="-arch x86_64"
    where the provided arch (or architecture) is the desired option for your machine. The main Mac options are i386 for 32 bit Intel processors, x86_64 for 64 bit Intel processors, ppc for 32 bit PowerPC chips, or ppc64 for 64 bit PowerPC64 chips. Although i386 will work on any Intel processor, you should use x86_64 if you have a 64 bit processor, because the code will run faster. To determine how many bits your Intel chip has, chose "About This Mac" from the Apple menu, click "More Info..." button, and look up the processor name in the hardware section. The "Intel Core Solo" and "Intel Core Duo" are 32 bit chips and most others are 64 bit chips.
  3. When the configuration is done, use the following commands:
    cd src
    make
    make install
    These commands make the library (but not the unneeded xerces examples). The final install command after make is done, installs both the library and the header files at the default locations listed above. If the make install shows a permission error, you can solve that by using sudo make install instead and provide your administrator password.
  4. When working with nairn-mpm-fea on a new Mac, the xerces installation only needs to be done once. The only reason to repeat it is when a new xerces version is available and/or the project requires a new version for compatibility.

MacOS X Command Line Compiling

It is easy to compile on MacOS X using a command line approach (after seeing potential startup issues on Lion or newer systems). First (and first time only) install xerces and its header files as explained above and make sure they are in the specified default locations. Once xerces is ready, you compile OSParticulas using:

cd nairn-mpm-fea/NairnMPM/build
make SYSTEM=mac CFLAGS="-c -O3 -arch x86_64" LFLAGS="-arch x86_64"

and compile NairnFEA using:

cd nairn-mpm-fea/NairnFEA/build
make SYSTEM=mac CFLAGS="-c -O3 -arch x86_64" LFLAGS="-arch x86_64"

Here the arch settings must match the one used when you installed xerces. The -c option is required. The -O3 option creates optimized code; this option can be changed or omitted.

All source code will be compiled and the executables will be installed in nairn-mpm-fea/NairnMPM/input or nairn-mpm-fea/NairnFEA/input, respectively. You can use an additional make install command to copy each compiled executable to your ~/bin folder if desired.

If the command-line compile does not work, the most likely explanation is a problem with the xerces installation. You either have to install it as specified above or edit the makefile to recognize your custom installation. The process is documented in the makefile and involves editing the xercesSo and headersPath 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 "Library" folder). With these changes, you cannot compile nairn-fea-mpm code engines or xerces or until you do some additional set up:

  1. You probably have to install XCode (even if you do not plan to use it).
  2. In XCode, use its preferences window to install "Command Line Tools".
  3. Most tools should now be available. You should be able to make and install the xerces project and then use the provided XCode project to build NairnMPM and NairnFEA.

One issue in the XCode project is that it might not find your xerces library, even if it is in the standard location. If it is not found, the library will be in red in the "External Frameworks and Libraries" 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 /usr/local/lib folder anymore (another new Apple "feature"). Here is a trick to get there:

  1. In the Finder, use the "Go to Folder..." menu command and enter "/usr/local".
  2. After it opens, choose the "Add To Sidebar" menu command. This folder will now appear in all file selection boxes.
  3. Go back to XCode and enter box to select the path the the xerces library.
  4. Go through your new "local" folder and select the xerces library file in /usr/local/lib.

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