Changeset 985

Show
Ignore:
Timestamp:
10/24/08 22:31:14 (2 months ago)
Author:
dutfoy
Message:

Moved ExampleGuide to ExamplesGuide.

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • branches/dutfoy/devel/doc/configure.ac

    r977 r985  
    113113           src/ReferenceGuide/Makefile 
    114114           src/ContributionGuide/Makefile 
    115            src/ExampleGuide/Makefile 
     115           src/ExamplesGuide/Makefile 
    116116]) 
    117117#           src/CodingRulesGuide/Makefile 

  • branches/dutfoy/devel/doc/src/DocumentationGuide/OpenTURNS_DocumentationGuide.tex

    r984 r985  
    7575\begin{itemize} 
    7676   \item[$\bullet$] {\itshape Open TURNS - Reference Guide}, 
    77   \item[$\bullet$] {\itshape Open TURNS - Example Guide}. 
     77  \item[$\bullet$] {\itshape Open TURNS - Examples Guide}. 
    7878\end{itemize} 
    7979 
    …… 
    8989  \item[$\bullet$] {\bf Link with the Open TURNS Methodology} : this field recalls the position of the algorithm in the Global Methodology. It precises to which step of the Global Methodology it participates. 
    9090  \item[$\bullet$] {\bf 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. 
    91   \item[$\bullet$] {\bf 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. 
    92 \end{itemize} 
    93  
    94 To have an example of the use of a particular algorithm or of a particular method, the User is invited to refer either to the documentation {\itshape Reference Guide - Open TURNS}  in its section {Example} or to the documentation {\itshape Example Guide - Open TURNS} which applies the Global Methodology on a particular example.\\ 
     91  \item[$\bullet$] {\bf Examples} : this field applies the method on some examples. 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. 
     92\end{itemize} 
     93 
     94To have an example of the use of a particular algorithm or of a particular method, the User is invited to refer either to the documentation {\itshape Reference Guide - Open TURNS}  in its section {Example} or to the documentation {\itshape Examples Guide - Open TURNS} which applies the Global Methodology on a particular example.\\ 
    9595 
    9696Some hyperlinks are present to facilitate the navigation between the documentation {\itshape Uncertainty Reference Guide - Open TURNS} and the others ones. 
    9797 
    9898 
    99         \subsection{ Example Guide} 
    100  
    101 This Guide applies the whole Global Methodology on the following analytical example :  the evaluation of the height of an embankment to protect from flows.\\ 
     99        \subsection{Examples Guide} 
     100 
     101This Guide applies the whole Global Methodology on some analytical examples. For now, there is only one example: the case of a cantilever beam wich undergoes a concentrated bending force at one end.\\ 
    102102 
    103103The User may find in this documentation a complete probabilistic uncertainty treatment study.\\ 
    104 The first example is performed on the analytical example of a cantilever beam wich undergoes a concentrated bending force at one end.\\ 
    105104 
    106105The User is invited to refer to that documentation in particular to apprehend properly the signification of the results of the methods preconised in the Globel Methodology.\\ 
    107106 
    108 Some links are present to facilitate the navigation between the documentation {\itshape Example Guide - Open TURNS} and the {\itshape Reference Guide - Open TURNS} one. 
     107Some links are present to facilitate the navigation between the documentation {\itshape Examples Guide - Open TURNS} and the {\itshape Reference Guide - Open TURNS} one. 
    109108 
    110109 
    …… 
    141140The presentation follows the steps preconised in the Global Methodology.\\ 
    142141 
    143 The User is invited to consult this documentation before implementating a study through the TUI : he will probably find there an example of what he wants to perform. The documentation is made to enable the User to make some cut/copy from the documentation into his study.\\ 
    144  
    145 An example of complete uncertainty study is given at the end of the documentation : the analytical example of a cantilever beam wich undergoes a concentrated bending force at one end. 
     142The User is invited to consult this documentation before implementating a study through the TUI : he will probably find there an example of what he wants to perform. The documentation is made to enable the User to make some cut/copy from the documentation into his study. 
    146143 
    147144\section{Software Source.} 
    …… 
    201198\item {\itshape Reference Guide} : \\ 
    202199source file $OpenTURNS\_ReferenceGuide.tex$, 
    203 \item {\itshape Example Guide} : \\ 
    204 source file $OpenTURNS\_ExampleGuide.tex$. 
     200\item {\itshape Examples Guide} : \\ 
     201source file $OpenTURNS\_ExamplesGuide.tex$. 
    205202\end{itemize} 
    206203  \item[$\bullet$] {\bf TextualUserInterface} :  

  • branches/dutfoy/devel/doc/src/ExamplesGuide/Makefile.am

    r984 r985  
    2626 
    2727EXTRA_DIST = \ 
    28         OpenTURNS_ExampleGuide.tex \ 
     28        OpenTURNS_ExamplesGuide.tex \ 
    2929        poutre.pdf \ 
    3030        convergenceGrapheDS.pdf\ 
    …… 
    4343        scriptExample_beam.py 
    4444 
    45 OpenTURNS_ExampleGuide.pdf : $(EXTRA_DIST) 
     45OpenTURNS_ExamplesGuide.pdf : $(EXTRA_DIST) 
    4646 
    47 pdf-local : OpenTURNS_ExampleGuide.pdf 
    48 doc_DATA = OpenTURNS_ExampleGuide.pdf 
     47pdf-local : OpenTURNS_ExamplesGuide.pdf 
     48doc_DATA = OpenTURNS_ExamplesGuide.pdf 

  • branches/dutfoy/devel/doc/src/Makefile.am

    r984 r985  
    2525include $(top_srcdir)/config/common.am 
    2626 
    27 SUBDIRS      =  ArchitectureGuide DocumentationGuide ReferenceGuide UseCasesGuide UserManual ExampleGuide WrapperGuide GNU_free_documentation_licence ContributionGuide ExampleGuide #CodingRulesGuide 
    28 DIST_SUBDIRS =  ArchitectureGuide DocumentationGuide ReferenceGuide UseCasesGuide UserManual ExampleGuide WrapperGuide GNU_free_documentation_licence ContributionGuide ExampleGuide #CodingRulesGuide 
     27SUBDIRS      =  ArchitectureGuide DocumentationGuide ReferenceGuide UseCasesGuide UserManual ExamplesGuide WrapperGuide GNU_free_documentation_licence ContributionGuide ExampleGuide #CodingRulesGuide 
     28DIST_SUBDIRS =  ArchitectureGuide DocumentationGuide ReferenceGuide UseCasesGuide UserManual ExamplesGuide WrapperGuide GNU_free_documentation_licence ContributionGuide ExampleGuide #CodingRulesGuide 
    2929 
    3030EXTRA_DIST   = logoOpenTURNS.jpg