If you have a RPM-based Linux distribution, note that RPM packages are provided for the latest versions of Fedora (e.g., 10) on the RMOL project download site. In that case, you do not have to bother with the installation from source code.
Otherwise, RMOL should compile without errors or warnings on most GNU/Linux systems, on UNIX systems like Solaris SunOS, and on POSIX based environments for Microsoft Windows like Cygwin or MinGW with MSYS. It can be also built on Microsoft Windows NT/2000/XP using Microsoft's Visual C++ .NET, but our support for this compiler is limited. For GNU/Linux, SunOS, Cygwin and MinGW we assume that you have at least the following GNU software installed on your computer:
`make --version'
)`gcc --version'
)To perform tests, two command line programs: sed
and diff
are required. Optionally, you might need a few additional programs, i.e. Doxygen, LaTeX, Dvips and Ghostscript, to generate the HTML documentation.
We strongly recommend that you use recent stable releases of the GCC, if possible. We do not actively work on supporting older versions of the GCC, and they may therefore (without prior notice) become unsupported in future releases of RMOL.
In order to use all functionality provided by the RMOL library, it is recommended that you have some external libraries compiled and installed in your computer, namely: GSL and Boost.
RMOL is released under the Lesser GNU General Public License (LGPL) and hence the source code of the RMOL library is available for free download. To obtain the RMOL source code, visit the project pages on SourceForge:
and download the file named rmol-<VERSION>
.tar.gz or rmol-<VERSION>
.tar.bz2, where <VERSION>
is the latest release number, e.g. 0.19.0.
Assuming that you have already downloaded the latest RMOL sources, untar and unpack the sources, and enter the unpacked directory. Depending on the package type you have downloaded, use the following commands:
% gzip -cd rmol-<VERSION>.tar.gz | tar xf - % cd rmol-<VERSION>
% bzip2 -cd rmol-<VERSION>.tar.bz2 | tar xf - % cd rmol-<VERSION>
Since version 0.2.0, the RMOL library uses autoconf, automake and libtool for preparing Makefiles and configuration script, so the compilation procedure resembles a standard, well-known GNU method, i.e.
% ./configure % make
The `configure'
command can be invoked with additional switches and options (run `./configure --help'
to get a list of them). The most important are:
`--prefix=PREFIX'
- set top installation directory to a certain PREFIX
value. By default it is set to `/usr/local'
, so `make install'
will install appropriate files into `/usr/local/include'
, `/usr/local/lib`
, etc.`--enable-debug'
- build an extra library named `librmol_debug
.*' using special debugging flags for compiler and linker (disabled by default)`--enable-exceptions'
- enable exceptions handling of run-time errors instead of aborting the program (disabled by default)`--disable-html-doc'
- do not generate and install the HTML documentation (enabled by default)`--disable-shared'
- do not build the shared version of the library (enabled by default for non Windows based platforms)`--disable-static'
- do not build the static version of the library (enabled by default for Windows based platforms)Plese note that each `--enable-<OPTION>'
switch can be replaced with its opposite switch `--disable-<OPTION>'
.
By default, the `configure'
script checks for a few external libraries, which might be used by the RMOL library (cf. RMOL Requirements).
If some external libraries are installed in a non-standard location in your system, e.g. GSL in `/opt/gsl-1.11'
, the `configure'
script will not detect them automatically. In such a case, you should specify their path to the configure script, using `--with-<LIBNAME>'
switches, where <LIBNAME>
is one of the following: `gsl'
or `boost'
:
% ./configure --with-gsl=/opt/gsl-1.11
It is recommended to set CXXFLAGS environment variable with some compiler- and platform-specific optimisation flags before invoking the `configure'
command. For example, in the case of using the Intel Pentium 4 processor one might employ the following flags:
% CXXFLAGS="-O3 -pipe -march=pentium4" ./configure
In the case of Sun's UltraSPARC 64-bit platform and GCC compiler, the flags might be set as follows:
% export CXXFLAGS="-O3 -pipe -mcpu=v9 -m64" % ./confiugre
If CXXFLAGS is not set in the environment, it will be initialised with the default flags, i.e. "-DASSERT_LEVEL=1 -O3 -pipe"
.
When the configuration process is finished, a status message is displayed. For instance, after having invoked the following configuration command on a recent Gentoo Linux system:
% ./configure
one can observe something like this:
------------------------------------------------------------------------------ rmol-0.19.0 library configuration: ------------------------------------------------------------------------------ Directories: - prefix ............ : /usr/local - exec_prefix ....... : ${prefix} - includedir ........ : ${prefix}/include - libdir ............ : ${exec_prefix}/lib - docdir ............ : ${datarootdir}/doc/rmol-0.19.0 - mandir ............ : ${datarootdir}/man - infodir ........... : ${datarootdir}/info Switches: - debug ............. : no - exceptions ........ : yes - use-nls ........... : yes - info-doc .......... : yes - html-doc .......... : yes - shared ............ : yes - static ............ : no Documentation tools: - texinfo ........... : - doxygen ........... : yes - latex ............. : yes - dvips ............. : yes - ghostscript ....... : yes Testing tools: - diff .............. : yes - sed ............... : yes Compiler/linker flags/libs/defs: - CXX ............... : g++ - CXXFLAGS .......... : -DASSERT_LEVEL=1 -O3 -pipe - CXXFLAGS_DEBUG .... : - CPPFLAGS .......... : - LDFLAGS ........... : - LIBS .............. : External libraries: - GSL ............... : /usr/bin/gsl-config o GSL_VERSION ..... : 1.11 o GSL_CFLAGS ...... : -I/usr/include o GSL_LIBS ........ : -lgsl -lgslcblas -lm - Boost ............. : o BOOST_VERSION ... : o BOOST_CFLAGS .... : -pthread -I/usr/include o BOOST_LIBS ...... : -L/usr/lib o BOOST_DT_LIB .... : -lboost_date_time o BOOST_PO_LIB .... : -lboost_program_options o BOOST_FS_LIB .... : -lboost_filesystem - CPPUNIT ........... : o CPPUNIT_VERSION . : 1.12.1 o CPPUNIT_CFLAGS .. : o CPPUNIT_LIBS .... : -lcppunit -ldl ------------------------------------------------------------------------------ Now type 'make && make install' to build and install rmol-0.19.0 library ------------------------------------------------------------------------------
Now, it is time for compiling and linking the RMOL library. To do so, please simply run the following command:
% make
RMOL should compile without any errors or warnings. If this is not the case, please submit a bug-report on the RMOL project page at SourceForge. Please include information about your OS, compiler version, external libraries and their versions, etc.
It is recommended that you check whether your library has been compiled and linked properly and works as expected. To do so, you should execute the testing process:
% make check
As a result, you should obtain a similar report:
OptimiseTestSuite::testOptimise. : OK OK (1 tests) PASS: OptimiseTestSuite SimulateTestSuite::testSimulate. : OK OK (1 tests) PASS: SimulateTestSuite ================== All 2 tests passed ==================
Check if all the executed tests PASSED. If not, please contact us by filling a bug-report.
Finally, you should install the compiled and linked library, include files and (optionally) HTML documentation by typing:
% make install
Depending on the PREFIX
settings during configuration, you might need the root (administrator) access to perform this step.
Eventually, you might invoke the following command
% make clean
to remove all files created during compilation process, or even
% make distclean
to remove all files generated by the `configure'
script.
To compile and use RMOL under Mac OS X, you should install the latest version of Apple's developer tools. The tools are delivered with MacOS X, but you may need to unpack them. The configuration procedure is similar to the one described above.
It is possible to compile and link the RMOL library using the Microsoft Visual C++ .NET compiler.
The next step is to compile and link the RMOL library. Assuming that you have already downloaded and unpacked the RMOL package, you should find a MSVC++ .NET project file rmol.vcproj
in the win32
sub-directory. Open this project file in the MSVC++ .NET environment. There are two default targets prepared for compilation and linking: Debug
and Release
. The former can be used to compile a non-optimised version of the library for debugging purposes, named rmol_debug.lib
, whereas the latter one should produce an optimised library named rmol.lib
. Both libraries are static ones and they should be created in win32/libs
sub-directory.
Finally, you can start using the RMOL library with your own programs and link them with RMOL and MKL. Observe that several things need to be correctly set up:
"Tools -> Options -> Projects and Solutions -> VC++
Directories -> Include files"
. Add a path to "<RMOL source directory>"
, e.g. "C:\rmol-3.10.4"
."Tools -> Options -> Projects and Solutions -> VC++
Directories -> Library files"
. Add a path to "<RMOL source directory>\win32\libs"
, e.g. "C:\rmol-3.10.4\win32\libs"
."C:\Program Files\GSL\1.11\lib"
."Project -> Properties -> Configuration
Properties -> Linker -> Input -> Additional Dependencies"
. There you need to add rmol_debug.lib
or rmol.lib
depending on whether Debug or Release mode are being used. Furthermore, you need to add gsl_dll.lib
.Multi-threaded Debug
or Multi-threaded
. This option can be set in the menu "Project -> Properties -> Configuration Properties -> C/C++
-> Code Generation -> Runtime Library"
._CRT_SECURE_NO_DEPRECATE
and _CRT_NONSTDC_NO_DEPRECATE
, which disable warnings on C Standard Library and POSIX-compilant function names, might be also added in "Project -> Properties -> Configuration Properties -> C/C++
-> Preprocessor -> Preprocessor Definitions"
.Please note that Project settings for your program must be made for both the Debug and Release modes.
Generated on Fri Jul 30 21:53:39 2010 for RMOL by Doxygen 1.6.1