wiki:FAQ

Version 5 (modified by conty, 12 years ago) (diff)

Merge "ContributionFAQ" with "FAQ"

Frequently Asked Questions about OpenTURNS


  1. Troubleshooting
    1. Build & install process failure
      1. Failures during the 'make' stage - KernelSmoothing.cxx compilation error
      2. Failures during the 'make check' stage
      3. Failures during the 'make check' or 'make installcheck' stage
  2. Contribution
    1. Bug tracking
      1. I found a bug, how can i report it ?
      2. I found a bug and i have written the patch, how can i submit ?
      3. I found a lot of bugs and i have a lot of patches, how can i integrate them into OpenTURNS' upstream ?
    2. Examples, documentation & site content
      1. I'm OpenTURNS' user and i have written some examples to explain undocumented functions, what can i do ?
      2. I want to improve documentation which is included in OpenTURNS' release, how can i do ?
      3. I found some mistakes or i want to introduce some useful content on the website, can i edit them ?
    3. Source code
      1. How to join development team ?


Troubleshooting

Build & install process failure

Failures during the 'make' stage - KernelSmoothing.cxx compilation error

You may encounter failures during the compilation of KernelSmoothing.cxx around line 86 :

KernelSmoothing.cxx:86: error: type specifier omitted for parameter `bandwidth'

This bug is due to the poor parsing capability of gcc 3.3.5 and below, when compiling Open TURNS version 0.10.0 and below. You may either upgrade gcc to 3.3.6 (or higher) or upgrade Open TURNS to 0.11.0 (or higher).


Failures during the 'make check' stage

You probably forgot to install rotRPackage as described in the HowToInstall? page. Please install it.

R CMD INSTALL utils/rotRPackage_1.4.3.tar.gz

If you are using an instance of R installed in the system (ie, as root), you need to get root privileges to perform the rotRPackage installation or to install it in a non-standard location. Check your path to know which instance your are using. This instance must be the one you will pass to the configure script.
If you don't have the privileges to perform the installation with the preceeding command, use this one:

R CMD INSTALL --library=PRIVATE_DIRECTORY utils/rotRPackage_1.4.3.tar.gz

where PRIVATE_DIRECTORY is any directory you are allowed to write in (for example, $HOME/Rpackages). Then, set the environment variable R_LIBS to this directory (e.g. export R_LIBS=$HOME/Rpackages) if you use a version of R prior to 2.5.0, else it is better to use the environment variable R_LIBS_USER.
You can then test the installation by invoking R, then trying the following command:

$ R

R : Copyright 2006, The R Foundation for Statistical Computing
[...skip...]
Type 'q()' to quit R.

> library(rotRPackage)
>

If everything is ok, the command is executed without any error or warning.


Failures during the 'make check' or 'make installcheck' stage

Your installation of R cannot find gs, the ghostscript interpret. It is a problem related to the packaging of R, you can fix it by installing gs.


Contribution

You can find here answers to some of the most frequently asked questions about contributing into OpenTURNS' project.

Bug tracking

I found a bug, how can i report it ?

Two ways to do that :

  • Subscribe to the specific OpenTURNS's mailing-list : bugs@…
  • Send a mail containing the following details at this address :
    • a short description as mail subject
    • in mail body, put your affected version of your OpenTURNS (if you use a development version, please send the svn release version)
    • a full description of your bug
    • a way to to reproduce the bug

Or :

  • Send a login request at contact@…
  • Logon on this site and use our bug tracker

I found a bug and i have written the patch, how can i submit ?

The only constraint for submitting patches is to provide it under "GNU LGPL" compliant licence. If it is not explicitly specified, your patches will be considered licenced under the terms of "GNU LGPL".

The best way to submit patches is :

svn checkout https://svn.openturns.org/lib/trunk openturns
svn export openturns openturns.orig
svn export openturns opentunrs.patched

At this point, you modify the sources in the openturns.patched directory.

diff -Nura openturns.orig openturns.patched > mypatch.diff

Now, you can follow the previous instructions but don't forget to join your patch to the bug report.

Note: you can however use directly the svn repository if you are fluent in subversion.


I found a lot of bugs and i have a lot of patches, how can i integrate them into OpenTURNS' upstream ?

Join us ! And contribute to OpenTURNS's development (see below).


Examples, documentation & site content

I'm OpenTURNS' user and i have written some examples to explain undocumented functions, what can i do ?

Your writings must be under "GNU FDL", so you can submit your example and your comments to bugs@… after subscribing to this one.


I want to improve documentation which is included in OpenTURNS' release, how can i do ?

Currently, contributing to included documentation follows the same rules as contributing to source code (see how to join development team ??).


I found some mistakes or i want to introduce some useful content on the website, can i edit them ?

For the first time, post your suggestions as bugs, by following bug's reporting instructions.


Source code

How to join development team ?

Contact one of the OpenTURNS' developers or contact@…, and explain what you want to do in development team. After that, we'll contact you.