wiki:Documentation

Abstract

The OpenTURNS documentation aims at guiding the user within the software. The OpenTURNS documentation is divided into three main categories:

  • Theory of Uncertainty Study,
  • Text User Interface,
  • Software Source.

In this page, we present the documents, their content and provide links to the up-to-date documents in HTML or PDF format.

FOR OLDER VERSIONS, SEE HERE.

Theory of Uncertainty Study

The documentation of this section presents everything the user needs to know in order to understand what performing an uncertainty study means.

OpenTURNS - Reference Guide

This document presents the Global Methodology to perform a probabilistic uncertainty treatment study. The different steps of the Global Methodology are described. The user is invited to follow them in the recommended order in the Global Methodology.

It also gives detailed information about all the methods used in the Global Methodology and available in OpenTURNS. Each method presents a form with the following items :

  • Mathematical Description : this field describes the mathematics of the algorithm and precises the vocabulary under wich the method is used in different domains.
  • Link with the OpenTURNS Methodology : this field recalls the position of the algorithm in the Global Methodology. It precises to which step of the Global Methodology it participates.
  • References and theoretical basics : this field gives some usefull references to the user who wants to know more about the method. It recalls, too, some limits in the use of the method.
  • Examples : this field applies the method on a simple example. Most of the forms of this documentation present the analytical example of a cantilever beam, of Young’s modulus E, length L, section modulus I, which undergoes a concentrated bending force at one end. We study then the vertical displacement of the extreme end.

To get an example of a particular algorithm use, or of a particular method, the user is invited to refer either to the documentation Reference Guide - OpenTURNS in its section Example or to the documentation Example Guide - OpenTURNS which puts into practice the Global Methodology on a particular example. Some hyperlinks are available to facilitate the navigation between the documentation Uncertainty Reference Guide - OpenTURNS and the other ones.

Text User Interface (TUI)

The documentation of this section presents all the elements needed by the user to perform an uncertainty study through the Text User Interface of OpenTURNS. This documentation gathers several documents:

  • Upcoming sphinx documentation (HTML). It will replace the User Manual.
  • User Manual for the Text User Interface is still available here (HTML) (PDF),
  • Use Cases Guide for the Text User Interface (HTML) (PDF).
  • Examples Guide for the Text User Interface (HTML) (PDF).

OpenTURNS - User Manual for Text User Interface

This document is superseeded by the sphinx documentation (HERE)

This document presents most of the objects present in the TUI of OpenTURNS. In particular, for each of them, it details the following topics:

  • Usage : how to create the object,
  • Arguments : the signification of each argument of the creation,
  • Methods : list of the methods proposed by the object, detailing their use, their arguments and the signification of their parameters.

This document also reviews some basic topics on oriented object languages and some basic informations on Python. The user is invited to refer to that documentation in particular to have information on the signification of the arguments of each object. It completes the Python documentation that the user may read in line.

OpenTURNS - Use Cases Guide for the Text User Interface

This document describes several OpenTURNS use cases. The user should find in this documentation the implementation through the TUI of most of the studies which are likely to be performed within a global uncertainty study. The presentation follows the recommended steps in the Global Methodology. The user is invited to consult this documentation before implementing a study through the TUI : he will probably find there an example of what he wants to perform. The documentation is made to let the user make some cut/copy from the documentation into his study. An example of a complete uncertainty study is given at the end of the documentation : the analytical example of a cantilever beam which undergoes a concentrated bending force at one end.

OpenTURNS - Examples Guide

This document puts into practice the whole Global Methodology on some examples. The user may find in this documentation complete probabilistic uncertainty treatment studies. More precisely, all the results are discussed and the documentation aims at emphasizing the interest of such studies.

Software Source

The documentation of this section presents the architecture of the source code of OpenTURNS in order to make easier new developments, and some elements to write easily an OpenTURNS wrapper.

  • Developer's Guide (HTML) (PDF), This documentation covers several topic:
    • Some elements to make the understanding of the OpenTURNS architecture easier.
    • How to interface an external simulation code with OpenTURNS
    • Clues to potential contributors for a successful integration of their contribution into the OpenTURNS mainstream
    • How to to develop a new functionality or a new module for OpenTURNS
    • Conventions and guidelines for C++ and python development
    • How to compile OpenTURNS and to generate an installer for the Windows platform (XP, Seven)
  • Reference Guide of Open TURNS' classes and library API (HTML) (no PDF for the moment).

See also

OpenTURNS provide a great number of features for uncertainty studies. When we do not find the feature we search for, we might be interested by the two following sources.

  • OpenTURNS modules : several OpenTURNS modules are available to provide new features which are compatible with OpenTURNS. These modules are available at :

Modules

  • Other Python packages : some of these modules are presented at :

Overview of uncertainty tools for Python

Last modified 5 days ago Last modified on 11/22/14 00:43:38