Difference between revisions of "How to Build GridPACK"
(→Configuration) |
|||
| Line 1: | Line 1: | ||
== Prerequisite Software == | == Prerequisite Software == | ||
| − | GridPACK | + | Currently, GridPACK builds on Linux/UNIX sytems. Other operating systems are not supported at this time. |
| − | + | Building GridPACK is relatively complicated, primarily because it depends on several third-party software packages. These need to be built and installed prior to building GridPACK. Refer to the list of [[Software Required to Build GridPACK|required software]] for what is needed. | |
== Configuration == | == Configuration == | ||
| − | CMake is used to configure GridPACK for building. The process insures that required software is available and usable. CMake expects to configure GridPACK in a directory other than the one containing the source code. Typically, one makes an empty directory, called <code>build</code>, say, | + | Configuration is the most complicated part of the process. CMake is used to configure GridPACK for building. The process insures that required software is available and usable. CMake expects to configure GridPACK in a directory other than the one containing the source code. Typically, one makes an empty directory, called <code>build</code>, say, and executes |
| + | |||
| + | cmake [options] gridpack/source/directory | ||
| + | |||
| + | where <code>options</code> are used to locate [[Software Required to Build GridPACK|required software]] and set compiler options. The shell script <code>example_configuration.sh</code> shows some examples of configuration options for a few systems. | ||
== Building == | == Building == | ||
| + | |||
| + | Once configured, GridPACK is built with | ||
| + | |||
| + | make | ||
| + | |||
| + | which will take some time. If building on a multi-core system, building can go faster if multiple core are use, e.g., | ||
| + | |||
| + | make -j 8 | ||
| + | |||
| + | will use 8 simultaneous processes to build GridPACK. | ||
== Running Tests == | == Running Tests == | ||
| + | |||
| + | After a successful build, GridPACK unit tests can be run with | ||
| + | |||
| + | make test | ||
| + | |||
| + | which will produce a list of tests and whether they passed or failed. | ||
= Examples = | = Examples = | ||
Descriptions of building GridPACK on some specific machines: | Descriptions of building GridPACK on some specific machines: | ||
| − | + | * [[Building_on_MacOSX | Mac OS X with MacPorts]] | |
| − | + | * [[Building_on_RHEL5 | Red Hat Enterprise Linux 5]] | |
| − | + | * [[Building_on_Olympus | PNNL Olympus cluster]] | |
Revision as of 18:27, 31 October 2013
Prerequisite Software
Currently, GridPACK builds on Linux/UNIX sytems. Other operating systems are not supported at this time.
Building GridPACK is relatively complicated, primarily because it depends on several third-party software packages. These need to be built and installed prior to building GridPACK. Refer to the list of required software for what is needed.
Configuration
Configuration is the most complicated part of the process. CMake is used to configure GridPACK for building. The process insures that required software is available and usable. CMake expects to configure GridPACK in a directory other than the one containing the source code. Typically, one makes an empty directory, called build, say, and executes
cmake [options] gridpack/source/directory
where options are used to locate required software and set compiler options. The shell script example_configuration.sh shows some examples of configuration options for a few systems.
Building
Once configured, GridPACK is built with
make
which will take some time. If building on a multi-core system, building can go faster if multiple core are use, e.g.,
make -j 8
will use 8 simultaneous processes to build GridPACK.
Running Tests
After a successful build, GridPACK unit tests can be run with
make test
which will produce a list of tests and whether they passed or failed.
Examples
Descriptions of building GridPACK on some specific machines:
