Doc: Simplify API layout

openturns · Sep 21, 2024 · dd007a7 · dd007a7
1 parent 7b608a0
commit dd007a7
Show file tree

Hide file tree

Showing 57 changed files with 151 additions and 154 deletions.
diff --git a/doc/user_manual/user_manual.rst b/doc/user_manual/user_manual.rst
@@ -10,33 +10,33 @@ Reliability problems
     :toctree: _generated/
     :template: class.rst_t
 
-    ReliabilityBenchmarkProblem.ReliabilityBenchmarkProblem
-    AxialStressedBeamReliability.AxialStressedBeamReliability
-    RminusSReliability.RminusSReliability
-    FourBranchSerialSystemReliability.FourBranchSerialSystemReliability
-    ReliabilityProblem53.ReliabilityProblem53
-    ReliabilityProblem22.ReliabilityProblem22
-    ReliabilityProblem24.ReliabilityProblem24
-    ReliabilityProblem25.ReliabilityProblem25
-    ReliabilityProblem28.ReliabilityProblem28
-    ReliabilityProblem31.ReliabilityProblem31
-    ReliabilityProblem35.ReliabilityProblem35
-    ReliabilityProblem55.ReliabilityProblem55
-    ReliabilityProblem57.ReliabilityProblem57
-    ReliabilityProblem75.ReliabilityProblem75
-    ReliabilityProblem89.ReliabilityProblem89
-    ReliabilityProblem110.ReliabilityProblem110
-    ReliabilityProblem111.ReliabilityProblem111
-    ReliabilityProblem33.ReliabilityProblem33
-    ReliabilityProblem8.ReliabilityProblem8
-    ReliabilityProblem14.ReliabilityProblem14
-    ReliabilityProblem38.ReliabilityProblem38
-    ReliabilityProblem54.ReliabilityProblem54
-    ReliabilityProblem107.ReliabilityProblem107
-    ReliabilityProblem91.ReliabilityProblem91
-    ReliabilityProblem63.ReliabilityProblem63
-    ReliabilityProblem60.ReliabilityProblem60
-    ReliabilityProblem77.ReliabilityProblem77
+    ReliabilityBenchmarkProblem
+    AxialStressedBeamReliability
+    RminusSReliability
+    FourBranchSerialSystemReliability
+    ReliabilityProblem53
+    ReliabilityProblem22
+    ReliabilityProblem24
+    ReliabilityProblem25
+    ReliabilityProblem28
+    ReliabilityProblem31
+    ReliabilityProblem35
+    ReliabilityProblem55
+    ReliabilityProblem57
+    ReliabilityProblem75
+    ReliabilityProblem89
+    ReliabilityProblem110
+    ReliabilityProblem111
+    ReliabilityProblem33
+    ReliabilityProblem8
+    ReliabilityProblem14
+    ReliabilityProblem38
+    ReliabilityProblem54
+    ReliabilityProblem107
+    ReliabilityProblem91
+    ReliabilityProblem63
+    ReliabilityProblem60
+    ReliabilityProblem77
 
 Reliability methods
 -------------------
@@ -45,25 +45,24 @@ Reliability methods
     :toctree: _generated/
     :template: class.rst_t
 
-    FORM.FORM
-    SORM.SORM
-    SubsetSampling.SubsetSampling
-    ProbabilitySimulationAlgorithmFactory.ProbabilitySimulationAlgorithmFactory
-    LHS.LHS
-    ReliabilityBenchmarkMetaAlgorithm.ReliabilityBenchmarkMetaAlgorithm
-    ReliabilityBenchmarkResult.ReliabilityBenchmarkResult
-    ConditionalDistribution.ConditionalDistribution
-    CrossCutFunction.CrossCutFunction
-    CrossCutDistribution.CrossCutDistribution
-    DrawEvent.DrawEvent
+    FORM
+    SORM
+    SubsetSampling
+    ProbabilitySimulationAlgorithmFactory
+    LHS
+    ReliabilityBenchmarkMetaAlgorithm
+    ReliabilityBenchmarkResult
+    ConditionalDistribution
+    CrossCutFunction
+    CrossCutDistribution
+    DrawEvent
 
     :template: function.rst_t
 
     ReliabilityLibrary.ComputeLogRelativeError
     ReliabilityLibrary.ComputeAbsoluteError
     ReliabilityLibrary.ComputeRelativeError
     ReliabilityLibrary.ReliabilityBenchmarkProblemList
-    SensitivityLibrary.SensitivityBenchmarkProblemList
 
 Sensitivity problems
 --------------------
@@ -72,28 +71,32 @@ Sensitivity problems
     :toctree: _generated/
     :template: class.rst_t
 
-    SensitivityBenchmarkProblem.SensitivityBenchmarkProblem
-    BoreholeSensitivity.BoreholeSensitivity
-    BorgonovoSensitivity.BorgonovoSensitivity
-    OakleyOHaganSensitivity.OakleyOHaganSensitivity
-    DirichletSensitivity.DirichletSensitivity
-    FloodingSensitivity.FloodingSensitivity
-    NLOscillatorSensitivity.NLOscillatorSensitivity    
-    GaussianSumSensitivity.GaussianSumSensitivity
-    GaussianProductSensitivity.GaussianProductSensitivity
-    GSobolSensitivity.GSobolSensitivity
-    MorrisSensitivity.MorrisSensitivity
-    IshigamiSensitivity.IshigamiSensitivity
+    SensitivityBenchmarkProblem
+    BoreholeSensitivity
+    BorgonovoSensitivity
+    OakleyOHaganSensitivity
+    DirichletSensitivity
+    FloodingSensitivity
+    NLOscillatorSensitivity
+    GaussianSumSensitivity
+    GaussianProductSensitivity
+    GSobolSensitivity
+    MorrisSensitivity
+    IshigamiSensitivity
+
+    :template: function.rst_t
 
+    SensitivityLibrary.SensitivityBenchmarkProblemList
+
 Sensitivity methods
 -------------------
 
 .. autosummary::
     :toctree: _generated/
     :template: class.rst_t
 
-    SparsePolynomialChaosSensitivityAnalysis.SparsePolynomialChaosSensitivityAnalysis
-    SensitivityBenchmarkMetaAlgorithm.SensitivityBenchmarkMetaAlgorithm
-    SensitivityConvergence.SensitivityConvergence
-    SensitivityDistribution.SensitivityDistribution
-    JanonSensitivityAlgorithm.JanonSensitivityAlgorithm
+    SparsePolynomialChaosSensitivityAnalysis
+    SensitivityBenchmarkMetaAlgorithm
+    SensitivityConvergence
+    SensitivityDistribution
+    JanonSensitivityAlgorithm
diff --git a/otbenchmark/AxialStressedBeamReliability.py → otbenchmark/_AxialStressedBeamReliability.py b/otbenchmark/AxialStressedBeamReliability.py → otbenchmark/_AxialStressedBeamReliability.py
@@ -1,9 +1,7 @@
-#!/usr/bin/python
-# coding:utf-8
 # Copyright 2020 EDF
 """Class to define a axial stressed beam benchmark problem."""
 
-from otbenchmark.ReliabilityBenchmarkProblem import ReliabilityBenchmarkProblem
+from ._ReliabilityBenchmarkProblem import ReliabilityBenchmarkProblem
 import openturns as ot
 import numpy as np
 

diff --git a/otbenchmark/BoreholeSensitivity.py → otbenchmark/_BoreholeSensitivity.py b/otbenchmark/BoreholeSensitivity.py → otbenchmark/_BoreholeSensitivity.py
@@ -3,7 +3,7 @@
 # Copyright 2020 - 2021 EDF
 """Class to define a Borehole sensitivity benchmark problem."""
 
-from otbenchmark.SensitivityBenchmarkProblem import SensitivityBenchmarkProblem
+from ._SensitivityBenchmarkProblem import SensitivityBenchmarkProblem
 import openturns as ot
 
 

diff --git a/otbenchmark/BorgonovoSensitivity.py → otbenchmark/_BorgonovoSensitivity.py b/otbenchmark/BorgonovoSensitivity.py → otbenchmark/_BorgonovoSensitivity.py
@@ -3,7 +3,7 @@
 # Copyright 2021 EDF
 """Class to define a Borgonovo sensitivity benchmark problem."""
 
-from otbenchmark.SensitivityBenchmarkProblem import SensitivityBenchmarkProblem
+from ._SensitivityBenchmarkProblem import SensitivityBenchmarkProblem
 import openturns as ot
 
 

diff --git a/otbenchmark/ConditionalDistribution.py → otbenchmark/_ConditionalDistribution.py b/otbenchmark/ConditionalDistribution.py → otbenchmark/_ConditionalDistribution.py
diff --git a/otbenchmark/CrossCutDistribution.py → otbenchmark/_CrossCutDistribution.py b/otbenchmark/CrossCutDistribution.py → otbenchmark/_CrossCutDistribution.py
diff --git a/otbenchmark/CrossCutFunction.py → otbenchmark/_CrossCutFunction.py b/otbenchmark/CrossCutFunction.py → otbenchmark/_CrossCutFunction.py
diff --git a/otbenchmark/DirichletSensitivity.py → otbenchmark/_DirichletSensitivity.py b/otbenchmark/DirichletSensitivity.py → otbenchmark/_DirichletSensitivity.py
@@ -3,7 +3,7 @@
 # Copyright 2020 - 2021 EDF
 """Class to define a Dirichlet sensitivity benchmark problem."""
 
-from otbenchmark.SensitivityBenchmarkProblem import SensitivityBenchmarkProblem
+from ._SensitivityBenchmarkProblem import SensitivityBenchmarkProblem
 import openturns as ot
 import numpy as np
 import sys

diff --git a/otbenchmark/DrawEvent.py → otbenchmark/_DrawEvent.py b/otbenchmark/DrawEvent.py → otbenchmark/_DrawEvent.py
diff --git a/otbenchmark/FORM.py → otbenchmark/_FORM.py b/otbenchmark/FORM.py → otbenchmark/_FORM.py
diff --git a/otbenchmark/FloodingSensitivity.py → otbenchmark/_FloodingSensitivity.py b/otbenchmark/FloodingSensitivity.py → otbenchmark/_FloodingSensitivity.py
@@ -3,7 +3,7 @@
 # Copyright 2020 - 2021 EDF
 """Class to define a Flooding sensitivity benchmark problem."""
 
-from otbenchmark.SensitivityBenchmarkProblem import SensitivityBenchmarkProblem
+from ._SensitivityBenchmarkProblem import SensitivityBenchmarkProblem
 import openturns as ot
 
 

diff --git a/...mark/FourBranchSerialSystemReliability.py → ...ark/_FourBranchSerialSystemReliability.py b/...mark/FourBranchSerialSystemReliability.py → ...ark/_FourBranchSerialSystemReliability.py
@@ -3,7 +3,7 @@
 # Copyright 2020 EDF
 """Class to define the four-branch serial system from Waarts."""
 
-from otbenchmark.ReliabilityBenchmarkProblem import ReliabilityBenchmarkProblem
+from ._ReliabilityBenchmarkProblem import ReliabilityBenchmarkProblem
 import openturns as ot
 
 

diff --git a/otbenchmark/GSobolSensitivity.py → otbenchmark/_GSobolSensitivity.py b/otbenchmark/GSobolSensitivity.py → otbenchmark/_GSobolSensitivity.py
@@ -3,7 +3,7 @@
 # Copyright 2020 EDF
 """Class to define the g-sobol sensitivity benchmark problem."""
 
-from otbenchmark.SensitivityBenchmarkProblem import SensitivityBenchmarkProblem
+from ._SensitivityBenchmarkProblem import SensitivityBenchmarkProblem
 import openturns as ot
 
 

diff --git a/otbenchmark/GaussianProductSensitivity.py → otbenchmark/_GaussianProductSensitivity.py b/otbenchmark/GaussianProductSensitivity.py → otbenchmark/_GaussianProductSensitivity.py
@@ -3,7 +3,7 @@
 # Copyright 2020 EDF
 """Class to define a linear sum sensitivity benchmark problem."""
 
-from otbenchmark.SensitivityBenchmarkProblem import SensitivityBenchmarkProblem
+from ._SensitivityBenchmarkProblem import SensitivityBenchmarkProblem
 import openturns as ot
 
 

diff --git a/otbenchmark/GaussianSumSensitivity.py → otbenchmark/_GaussianSumSensitivity.py b/otbenchmark/GaussianSumSensitivity.py → otbenchmark/_GaussianSumSensitivity.py
@@ -3,7 +3,7 @@
 # Copyright 2020 EDF
 """Class to define a gaussian sum sensitivity benchmark problem."""
 
-from otbenchmark.SensitivityBenchmarkProblem import SensitivityBenchmarkProblem
+from ._SensitivityBenchmarkProblem import SensitivityBenchmarkProblem
 import openturns as ot
 
 

diff --git a/otbenchmark/IshigamiSensitivity.py → otbenchmark/_IshigamiSensitivity.py b/otbenchmark/IshigamiSensitivity.py → otbenchmark/_IshigamiSensitivity.py
@@ -1,9 +1,7 @@
-#!/usr/bin/python
-# coding:utf-8
 # Copyright 2020 EDF
 """Class to define a Ishigami sensitivity benchmark problem."""
 
-from otbenchmark.SensitivityBenchmarkProblem import SensitivityBenchmarkProblem
+from ._SensitivityBenchmarkProblem import SensitivityBenchmarkProblem
 import openturns as ot
 import numpy as np
 

diff --git a/otbenchmark/JanonSensitivityAlgorithm.py → otbenchmark/_JanonSensitivityAlgorithm.py b/otbenchmark/JanonSensitivityAlgorithm.py → otbenchmark/_JanonSensitivityAlgorithm.py
diff --git a/otbenchmark/LHS.py → otbenchmark/_LHS.py b/otbenchmark/LHS.py → otbenchmark/_LHS.py
diff --git a/otbenchmark/MorrisSensitivity.py → otbenchmark/_MorrisSensitivity.py b/otbenchmark/MorrisSensitivity.py → otbenchmark/_MorrisSensitivity.py
@@ -3,7 +3,7 @@
 """
 The non-monotonic function of Morris f: R^20 -> R.
 """
-from otbenchmark.SensitivityBenchmarkProblem import SensitivityBenchmarkProblem
+from ._SensitivityBenchmarkProblem import SensitivityBenchmarkProblem
 import openturns as ot
 import warnings
 

diff --git a/otbenchmark/NLOscillatorSensitivity.py → otbenchmark/_NLOscillatorSensitivity.py b/otbenchmark/NLOscillatorSensitivity.py → otbenchmark/_NLOscillatorSensitivity.py
@@ -3,7 +3,7 @@
 # Copyright 2020 - 2021 EDF
 """Class to define a Oscillator sensitivity benchmark problem."""
 
-from otbenchmark.SensitivityBenchmarkProblem import SensitivityBenchmarkProblem
+from ._SensitivityBenchmarkProblem import SensitivityBenchmarkProblem
 import openturns as ot
 import numpy as np
 

diff --git a/otbenchmark/OakleyOHaganSensitivity.py → otbenchmark/_OakleyOHaganSensitivity.py b/otbenchmark/OakleyOHaganSensitivity.py → otbenchmark/_OakleyOHaganSensitivity.py
@@ -3,7 +3,7 @@
 # Copyright 2021 EDF
 """Class to define a Oakley-O'Hagan sensitivity benchmark problem."""
 
-from otbenchmark.SensitivityBenchmarkProblem import SensitivityBenchmarkProblem
+from ._SensitivityBenchmarkProblem import SensitivityBenchmarkProblem
 import openturns as ot
 import numpy as np
 

diff --git a/.../ProbabilitySimulationAlgorithmFactory.py → ..._ProbabilitySimulationAlgorithmFactory.py b/.../ProbabilitySimulationAlgorithmFactory.py → ..._ProbabilitySimulationAlgorithmFactory.py
diff --git a/...mark/ReliabilityBenchmarkMetaAlgorithm.py → ...ark/_ReliabilityBenchmarkMetaAlgorithm.py b/...mark/ReliabilityBenchmarkMetaAlgorithm.py → ...ark/_ReliabilityBenchmarkMetaAlgorithm.py
diff --git a/otbenchmark/ReliabilityBenchmarkProblem.py → otbenchmark/_ReliabilityBenchmarkProblem.py b/otbenchmark/ReliabilityBenchmarkProblem.py → otbenchmark/_ReliabilityBenchmarkProblem.py
diff --git a/otbenchmark/ReliabilityBenchmarkResult.py → otbenchmark/_ReliabilityBenchmarkResult.py b/otbenchmark/ReliabilityBenchmarkResult.py → otbenchmark/_ReliabilityBenchmarkResult.py
diff --git a/otbenchmark/ReliabilityProblem107.py → otbenchmark/_ReliabilityProblem107.py b/otbenchmark/ReliabilityProblem107.py → otbenchmark/_ReliabilityProblem107.py
@@ -7,7 +7,7 @@
 Class to define the ReliabilityProblem107 benchmark problem.
 """
 
-from otbenchmark.ReliabilityBenchmarkProblem import ReliabilityBenchmarkProblem
+from ._ReliabilityBenchmarkProblem import ReliabilityBenchmarkProblem
 import openturns as ot
 
 

diff --git a/otbenchmark/ReliabilityProblem110.py → otbenchmark/_ReliabilityProblem110.py b/otbenchmark/ReliabilityProblem110.py → otbenchmark/_ReliabilityProblem110.py
@@ -7,7 +7,7 @@
 Class to define the ReliabilityProblem110 benchmark problem.
 """
 
-from otbenchmark.ReliabilityBenchmarkProblem import ReliabilityBenchmarkProblem
+from ._ReliabilityBenchmarkProblem import ReliabilityBenchmarkProblem
 import openturns as ot
 
 

diff --git a/otbenchmark/ReliabilityProblem111.py → otbenchmark/_ReliabilityProblem111.py b/otbenchmark/ReliabilityProblem111.py → otbenchmark/_ReliabilityProblem111.py
@@ -7,7 +7,7 @@
 Class to define the ReliabilityProblem111 benchmark problem.
 """
 
-from otbenchmark.ReliabilityBenchmarkProblem import ReliabilityBenchmarkProblem
+from ._ReliabilityBenchmarkProblem import ReliabilityBenchmarkProblem
 import openturns as ot
 
 

diff --git a/otbenchmark/ReliabilityProblem14.py → otbenchmark/_ReliabilityProblem14.py b/otbenchmark/ReliabilityProblem14.py → otbenchmark/_ReliabilityProblem14.py
@@ -8,7 +8,7 @@
 Class to define the ReliabilityProblem14 benchmark problem.
 """
 
-from otbenchmark.ReliabilityBenchmarkProblem import ReliabilityBenchmarkProblem
+from ._ReliabilityBenchmarkProblem import ReliabilityBenchmarkProblem
 import openturns as ot
 
 

diff --git a/otbenchmark/ReliabilityProblem22.py → otbenchmark/_ReliabilityProblem22.py b/otbenchmark/ReliabilityProblem22.py → otbenchmark/_ReliabilityProblem22.py
@@ -6,7 +6,7 @@
 Class to define the ReliabilityProblem22 benchmark problem.
 """
 
-from otbenchmark.ReliabilityBenchmarkProblem import ReliabilityBenchmarkProblem
+from ._ReliabilityBenchmarkProblem import ReliabilityBenchmarkProblem
 import openturns as ot
 
 

diff --git a/otbenchmark/ReliabilityProblem24.py → otbenchmark/_ReliabilityProblem24.py b/otbenchmark/ReliabilityProblem24.py → otbenchmark/_ReliabilityProblem24.py
@@ -7,7 +7,7 @@
 Class to define the ReliabilityProblem24 benchmark problem.
 """
 
-from otbenchmark.ReliabilityBenchmarkProblem import ReliabilityBenchmarkProblem
+from ._ReliabilityBenchmarkProblem import ReliabilityBenchmarkProblem
 import openturns as ot
 
 

diff --git a/otbenchmark/ReliabilityProblem25.py → otbenchmark/_ReliabilityProblem25.py b/otbenchmark/ReliabilityProblem25.py → otbenchmark/_ReliabilityProblem25.py
@@ -7,7 +7,7 @@
 Class to define the ReliabilityProblem25 benchmark problem.
 """
 
-from otbenchmark.ReliabilityBenchmarkProblem import ReliabilityBenchmarkProblem
+from ._ReliabilityBenchmarkProblem import ReliabilityBenchmarkProblem
 import openturns as ot
 
 

diff --git a/otbenchmark/ReliabilityProblem28.py → otbenchmark/_ReliabilityProblem28.py b/otbenchmark/ReliabilityProblem28.py → otbenchmark/_ReliabilityProblem28.py
@@ -7,7 +7,7 @@
 Class to define the ReliabilityProblem28 benchmark problem.
 """
 
-from otbenchmark.ReliabilityBenchmarkProblem import ReliabilityBenchmarkProblem
+from ._ReliabilityBenchmarkProblem import ReliabilityBenchmarkProblem
 import openturns as ot
 
 

diff --git a/otbenchmark/ReliabilityProblem31.py → otbenchmark/_ReliabilityProblem31.py b/otbenchmark/ReliabilityProblem31.py → otbenchmark/_ReliabilityProblem31.py
@@ -7,7 +7,7 @@
 Class to define the ReliabilityProblem31 benchmark problem.
 """
 
-from otbenchmark.ReliabilityBenchmarkProblem import ReliabilityBenchmarkProblem
+from ._ReliabilityBenchmarkProblem import ReliabilityBenchmarkProblem
 import openturns as ot
 
 

diff --git a/otbenchmark/ReliabilityProblem33.py → otbenchmark/_ReliabilityProblem33.py b/otbenchmark/ReliabilityProblem33.py → otbenchmark/_ReliabilityProblem33.py
@@ -7,7 +7,7 @@
 Class to define the ReliabilityProblem33 benchmark problem.
 """
 
-from otbenchmark.ReliabilityBenchmarkProblem import ReliabilityBenchmarkProblem
+from ._ReliabilityBenchmarkProblem import ReliabilityBenchmarkProblem
 import openturns as ot
 
 

diff --git a/otbenchmark/ReliabilityProblem35.py → otbenchmark/_ReliabilityProblem35.py b/otbenchmark/ReliabilityProblem35.py → otbenchmark/_ReliabilityProblem35.py
@@ -7,7 +7,7 @@
 Class to define the ReliabilityProblem35 benchmark problem.
 """
 
-from otbenchmark.ReliabilityBenchmarkProblem import ReliabilityBenchmarkProblem
+from ._ReliabilityBenchmarkProblem import ReliabilityBenchmarkProblem
 import openturns as ot
 
 

diff --git a/otbenchmark/ReliabilityProblem38.py → otbenchmark/_ReliabilityProblem38.py b/otbenchmark/ReliabilityProblem38.py → otbenchmark/_ReliabilityProblem38.py
@@ -8,7 +8,7 @@
 Class to define the ReliabilityProblem38 benchmark problem.
 """
 
-from otbenchmark.ReliabilityBenchmarkProblem import ReliabilityBenchmarkProblem
+from ._ReliabilityBenchmarkProblem import ReliabilityBenchmarkProblem
 import openturns as ot
 
 

diff --git a/otbenchmark/ReliabilityProblem53.py → otbenchmark/_ReliabilityProblem53.py b/otbenchmark/ReliabilityProblem53.py → otbenchmark/_ReliabilityProblem53.py
@@ -10,7 +10,7 @@
 
 """
 
-from otbenchmark.ReliabilityBenchmarkProblem import ReliabilityBenchmarkProblem
+from ._ReliabilityBenchmarkProblem import ReliabilityBenchmarkProblem
 import openturns as ot
 
 

diff --git a/otbenchmark/ReliabilityProblem54.py → otbenchmark/_ReliabilityProblem54.py b/otbenchmark/ReliabilityProblem54.py → otbenchmark/_ReliabilityProblem54.py
@@ -7,7 +7,7 @@
 Class to define the ReliabilityProblem54 benchmark problem.
 """
 
-from otbenchmark.ReliabilityBenchmarkProblem import ReliabilityBenchmarkProblem
+from ._ReliabilityBenchmarkProblem import ReliabilityBenchmarkProblem
 import openturns as ot