wiki:HowToInstall

Version 39 (modified by lapointe@…, 9 years ago) (diff)

--

How to install OpenTURNS

This guide can be very useful to install OpenTURNS on GNU/Linux. If you want a development version, please follow instructions which describe How-To install a development version.

Download

If you want to use OpenTURNS, we highly recommend you to pick up the lastest stable release.

You may download a bundle of precompiled packages according to your Linux distribution (Debian, Ubuntu, etc.) or download the lastest OpenTURNS' release archive from SourceForge.net in the download section. In this latter case, please check you have all the dependencies listed below before attempting to build Open TURNS.

Dependencies

To compile your OpenTURNS platform, you need some additional libraries, headers (development files) and tools. Use the development versions of the packages (libfoo-dev rather than libfoo). Of course, you can use your favorite package-manager to download and install these requirements.

Till 0.12.1 included:

Since 0.12.2:

Generic instructions to install Open TURNS

OpenTURNS project use autotools and gcc suite to configure and build the sources.

Step 1 : Extract the files

In this example we use version 0.12.3, if you use another version, just substitute version numbers.

Extract files from downloaded archive :

tar xvzf openturns-0.12.3.tar.gz

if you use gzip compressor, or

tar xjvf openturns-0.12.3.tar.bz2

if you use bzip2 compressor.

Step 2 : Install the R additional packages

In order to have some internal Open TURNS functionalities work correctly, especially statistical ones, you need to install some extra R packages. Some are provided by Open TURNS, others are available as traditional R packages:

  • rotRPackage: an Open TURNS' package giving access to R functions
  • boot: a R package providing bootstrap functions
  • sensitivity: a R package providing sensitivity analysis methods

The R packages are available through the CRAN. For french users, you can directly get them at:

See R project website for more information.

To install a R package, go to its source directory (for the demonstration, we use a fictive 'myRpackage')

cd /where/myRpackage/lives

Here you must have a package named like myRpackage_X.Y.Z.tar.gz where X.Y.Z stands for the version number. You will find rotRPackage in the utils/ subdirectory.

Then you have to perform the installation:

R CMD INSTALL myRPackage_X.Y.Z.tar.gz

When R is installed in a directory for which you haven't write permissions, you can use a workaround as described in the FAQ.

For example, if we make the hypothesis that all the R packages (the one provided by Open TURNS and the ones you have downloaded) live in utils, you can simply do:

cd utils
R CMD INSTALL boot_1.2.34.tar.gz sensitivity_1.3.0.tar.gz rotRPackage_1.4.4.tar.gz

Step 3 : Configure Open TURNS

To configure building for all OpenTURNS parts - library, TUI, and GUI -, just do:

cd openturns-0.12.3
./configure

Open TURNS will be installed in system directories (/usr, /etc) owned by root. If you want to install the platform anywhere else, run:

./configure --prefix=/where/you/want

Note: you need write permissions for the destination directory.

If you want to disable some parts (TUI, GUI, or both), take a look at

./configure --help

You can also see the options accepted by the sub-modules with:

./configure --help=recursive

Note: At the end the configure script summaries what it has found on your system and activate or not some Open TURNS features. Please check carefully what was found and, if some dependency was found missing, read back the configure output to see what happened. It may be due to some uninstalled software or some erroneous command line option (incorrect path, syntax error, etc.). Before going further, rerun configure in a correct manner.

Step 4 : Build & install

Though not recommended, the quick way is:

make
make install

We encourage you to run the checks before and after installing. Doing so will prevent you from installing a platform that doesn't run correctly (there may be bugs), but if all run successfully, you will have a great confidence in what you've installed.

It is true that running the check will take some time. On a hyperthreaded dual-2.4 GHz host, it will take about 25 minutes for the whole process = configuration + compilation + check tests + installation + installcheck tests.

You can take advantage of the parallel make in using the -j option followed by a number that represents the amount of concurrent compilations. On a 4-way SMP, try 'make -j4' instead of bare 'make'.

make
make check
make install
make installcheck

Step 5 : Post installation

OpenTURNS needs to know where the R executable is and where to store temporary files. These information can be found in the configuration file openturns.conf, which is located in $prefix/etc. This file has been created according to what was found at configuration time, so you needn't have to change it most of the time.

But if you want to change the default values, you have to create the directories $HOME/openturns/etc and to copy the openturns.conf file in $HOME/openturns/etc. It is a text file that you can adapt to your needs. Remember that OpenTURNS is not (yet) capable of expanding environment variables, so if you want to define the temporary directory as being $HOME/tmp, you have to expand the path by yourself and write /home/your_name/tmp, assuming that $HOME is /home/your_name.

Specific instructions

Since 0.11.1, Debian and Ubuntu/Kubuntu/Xubuntu packages are provided by the OpenTURNS team.

If you have one of theses distributions, you can follow the associated specific HowTo:

Note: RPM support is coming soon but a friendly user successfully built Open TURNS on Fedora 10. Here are the instructions he gave us. Thanks to Romain François.

Frequently Asked Questions (FAQ)

You may see some more instructions here.