Cleanup

openturns · Sep 21, 2024 · 802d682 · 802d682
1 parent dd007a7
commit 802d682
Show file tree

Hide file tree

Showing 137 changed files with 122 additions and 189 deletions.
diff --git a/ChangeLog b/ChangeLog
@@ -1,4 +1,4 @@
-== 0.2 release (in-progress) ==
+== 0.2 release (2024-09-21) ==
 
 - Fixed the number of X points in DrawEvent.draw() (PR #90)
 - Added Uncecomp 2021 examples in Jupyter Notebooks.
@@ -13,7 +13,8 @@
     - Added Borehole function for SA.
 - Fixed reference values of reliability problems: 
   RP14, RP22, RP25, RP31, RP35, RP75, FourBranch.
-- Updated to OpenTURNS v1.17.
+- Updated to OpenTURNS v1.23
+- Sphinx documentation
 
 == 0.1.1 release ==
 

diff --git a/doc/conf.py b/doc/conf.py
@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 #
 # otbenchmark documentation build configuration file, created by
 # sphinx-quickstart on Fri Jun 19 15:57:39 2015.
@@ -48,7 +47,7 @@
     'examples_dirs': ['examples'],
     'gallery_dirs': ['auto_examples'],
     'show_signature': False,
-    'ignore_pattern': 'rp8.py|rp33|drawevent|draw_cross_cuts|plot_bbrc'
+    'ignore_pattern': 'plot_bbrc'
 }
 
 if Version(sphinx_gallery.__version__) >= Version("0.17.0"):

diff --git a/doc/examples/README.txt b/doc/examples/README.txt
@@ -1,2 +1,2 @@
-Examples
-========
+General examples
+================
diff --git a/doc/examples/examples.rst b/doc/examples/examples.rst
@@ -0,0 +1,8 @@
+========
+Examples
+========
+
+.. toctree::
+   :maxdepth: 2
+
+   ../auto_examples/index.rst
diff --git a/doc/examples/plot_draw_cross_cuts.py b/doc/examples/plot_draw_cross_cuts.py
@@ -21,8 +21,9 @@
 event = problem.getEvent()
 g = event.getFunction()
 
-
-# ## Compute the bounds of the domain
+# %%
+# Compute the bounds of the domain
+# --------------------------------
 
 # %%
 inputVector = event.getAntecedent()

diff --git a/doc/examples/plot_drawevent.py b/doc/examples/plot_drawevent.py
@@ -96,7 +96,7 @@
 # %%
 graph = drawEvent.drawLimitStateCrossCut(bounds)
 graph.add(cloud)
-graph
+_ = otv.View(graph)
 
 # %%
 domain = drawEvent.fillEventCrossCut(bounds)

diff --git a/doc/examples/plot_uncecomp_ot_examples.py b/doc/examples/plot_uncecomp_ot_examples.py
@@ -3,12 +3,14 @@
 =================================
 """
 
+# %%
 # In the otbenchmark package, we use several objects that must be known in order to distinguish which objects
 # come from the OpenTURNS library or from otbenchmark.
 # For reliability problems, there are three objects that cannot be ignored:
-# * the `Distribution`,
-# * the `Function`,
-# * the `ThresholdEvent`.
+#
+# * the :class:`openturns.Distribution`,
+# * the :class:`openturns.Function`,
+# * the :class:`openturns.ThresholdEvent`.
 #
 
 # %%
@@ -85,7 +87,7 @@
 graph.setLegendPosition("topright")
 graph.setColors(ot.Drawable.BuildDefaultPalette(2))
 view = otv.View(graph, figure_kw={"figsize": (4.5, 3.5)})
-view.save("two_samples.pdf")
+# view.save("two_samples.pdf")
 
 # %%
 # Function
@@ -143,7 +145,7 @@
 graph.add(curve)
 graph.setColors(ot.Drawable.BuildDefaultPalette(2))
 view = otv.View(graph, figure_kw={"figsize": (4.5, 3.5)})
-view.save("histo_output.pdf")
+# view.save("histo_output.pdf")
 
 # %%
 graph = ot.KernelSmoothing().build(outputSample_ind).drawPDF()
@@ -154,7 +156,7 @@
 graph.add(curve)
 graph.setColors(ot.Drawable.BuildDefaultPalette(2))
 view = otv.View(graph, figure_kw={"figsize": (4.5, 3.5)})
-view.save("kernel_output.pdf")
+# view.save("kernel_output.pdf")
 
 # %%
 # ThresholdEvent

diff --git a/doc/examples/reliability_problems/plot_case_rs.py b/doc/examples/reliability_problems/plot_case_rs.py
@@ -46,7 +46,8 @@
 print("%.1f %% confidence interval :[%.4f,%.4f] " % (level * 100, pmin, pmax))
 
 # %%
-# ## Plot the contours of the function
+# Plot the contours of the function
+# ---------------------------------
 
 # %%
 inputVector = event.getAntecedent()
@@ -81,7 +82,8 @@
 _ = otv.View(distribution.drawPDF())
 
 # %%
-# ## Visualise the safe and unsafe regions on a sample
+# Visualise the safe and unsafe regions on a sample
+# -------------------------------------------------
 
 # %%
 sampleSize = 500
@@ -91,10 +93,11 @@
 
 # %%
 cloud = drawEvent.drawSampleCrossCut(sampleSize)
-cloud
+_ = otv.View(cloud)
 
 # %%
-# ## Draw the limit state surface
+# Draw the limit state surface
+# ----------------------------
 
 # %%
 bounds = ot.Interval(lowerBound, upperBound)
@@ -104,10 +107,11 @@
 # %%
 graph = drawEvent.drawLimitStateCrossCut(bounds)
 graph.add(cloud)
-graph
+_ = otv.View(graph)
 
 # %%
-# ## Fill the event domain with a color
+# Fill the event domain with a color
+# ----------------------------------
 
 # %%
 domain = drawEvent.fillEventCrossCut(bounds)

diff --git a/doc/examples/reliability_problems/plot_four_branch_serial_system_waarts.py b/doc/examples/reliability_problems/plot_four_branch_serial_system_waarts.py
@@ -61,7 +61,7 @@
 # %%
 graph = drawEvent.drawLimitStateCrossCut(bounds)
 graph.add(cloud)
-graph
+_ = otv.View(graph)
 
 # %%
 # Fill the event domain with a color

diff --git a/doc/examples/reliability_problems/plot_reliability_benchmark_table.py b/doc/examples/reliability_problems/plot_reliability_benchmark_table.py
@@ -149,7 +149,7 @@
     results[i][5] = benchmarkResult.computedProbability
 
 df = pd.DataFrame(results, index=problem_names, columns=metrics)
-df.to_csv("reliability_benchmark_table-output.csv")
+# df.to_csv("reliability_benchmark_table-output.csv")
 df
 
 # %%

diff --git a/doc/examples/reliability_problems/plot_rp110.py b/doc/examples/reliability_problems/plot_rp110.py
@@ -67,7 +67,7 @@
 nbPoints = [100, 100]
 figure = g.draw(lowerBound, upperBound, nbPoints)
 figure.setTitle(" Iso-values of limit state function")
-figure
+_ = otv.View(figure)
 
 # %%
 # Print the iso-values of the distribution
@@ -95,7 +95,7 @@
 # %%
 graph = drawEvent.drawLimitStateCrossCut(bounds)
 graph.add(cloud)
-graph
+_ = otv.View(graph)
 
 # %%
 domain = drawEvent.fillEventCrossCut(bounds)

diff --git a/doc/examples/reliability_problems/plot_rp111.py b/doc/examples/reliability_problems/plot_rp111.py
@@ -62,7 +62,7 @@
 nbPoints = [100, 100]
 figure = g.draw(lowerBound, upperBound, nbPoints)
 figure.setTitle(" Iso-values of limit state function")
-figure
+_ = otv.View(figure)
 
 # %%
 _ = otv.View(distribution.drawPDF())
@@ -85,7 +85,7 @@
 # %%
 graph = drawEvent.drawLimitStateCrossCut(bounds)
 graph.add(cloud)
-graph
+_ = otv.View(graph)
 
 # %%
 domain = drawEvent.fillEventCrossCut(bounds)

diff --git a/doc/examples/reliability_problems/plot_rp22.py b/doc/examples/reliability_problems/plot_rp22.py
@@ -68,8 +68,8 @@
 # %%
 nbPoints = [100, 100]
 figure = g.draw(lowerBound, upperBound, nbPoints)
-figure.setTitle(" Iso-values of limit state function")
-figure
+figure.setTitle("Iso-values of limit state function")
+_ = otv.View(figure)
 
 # %%
 # Print the iso-values of the distribution
@@ -99,8 +99,7 @@
 # %%
 graph = drawEvent.drawLimitStateCrossCut(bounds)
 graph.add(cloud)
-graph
-
+_ = otv.View(graph)
 
 # %%
 domain = drawEvent.fillEventCrossCut(bounds)

diff --git a/doc/examples/reliability_problems/plot_rp24.py b/doc/examples/reliability_problems/plot_rp24.py
@@ -67,7 +67,7 @@
 nbPoints = [100, 100]
 figure = g.draw(lowerBound, upperBound, nbPoints)
 figure.setTitle(" Iso-values of limit state function")
-figure
+_ = otv.View(figure)
 
 # %%
 # Print the iso-values of the distribution
@@ -94,7 +94,7 @@
 # %%
 graph = drawEvent.drawLimitStateCrossCut(bounds)
 graph.add(cloud)
-graph
+_ = otv.View(graph)
 
 
 # %%

diff --git a/doc/examples/reliability_problems/plot_rp25.py b/doc/examples/reliability_problems/plot_rp25.py
@@ -62,7 +62,7 @@
 nbPoints = [100, 100]
 figure = g.draw(lowerBound, upperBound, nbPoints)
 figure.setTitle(" Iso-values of limit state function")
-figure
+_ = otv.View(figure)
 
 # %%
 # Print the iso-values of the distribution
@@ -86,7 +86,7 @@
 # %%
 graph = drawEvent.drawLimitStateCrossCut(bounds)
 graph.add(cloud)
-graph
+_ = otv.View(graph)
 
 # %%
 domain = drawEvent.fillEventCrossCut(bounds)

diff --git a/doc/examples/reliability_problems/plot_rp28.py b/doc/examples/reliability_problems/plot_rp28.py
@@ -77,8 +77,8 @@
 # %%
 nbPoints = [100, 100]
 figure = g.draw(lowerBound, upperBound, nbPoints)
-figure.setTitle(" Iso-values of limit state function")
-figure
+figure.setTitle("Iso-values of limit state function")
+_ = otv.View(figure)
 
 # %%
 # Print the iso-values of the distribution
@@ -106,7 +106,7 @@
 # %%
 graph = drawEvent.drawLimitStateCrossCut(bounds)
 graph.add(cloud)
-graph
+_ = otv.View(graph)
 
 # %%
 domain = drawEvent.fillEventCrossCut(bounds)

diff --git a/doc/examples/reliability_problems/plot_rp31.py b/doc/examples/reliability_problems/plot_rp31.py
@@ -86,7 +86,7 @@
 # %%
 graph = drawEvent.drawLimitStateCrossCut(bounds)
 graph.add(cloud)
-graph
+_ = otv.View(graph)
 
 # %%
 domain = drawEvent.fillEventCrossCut(bounds)

diff --git a/doc/examples/reliability_problems/plot_rp35.py b/doc/examples/reliability_problems/plot_rp35.py
@@ -65,8 +65,8 @@
 # %%
 nbPoints = [100, 100]
 figure = g.draw(lowerBound, upperBound, nbPoints)
-figure.setTitle(" Iso-values of limit state function")
-figure
+figure.setTitle("Iso-values of limit state function")
+_ = otv.View(figure)
 
 # %%
 # Print the iso-values of the distribution
@@ -95,7 +95,7 @@
 # %%
 graph = drawEvent.drawLimitStateCrossCut(bounds)
 graph.add(cloud)
-graph
+_ = otv.View(graph)
 
 # %%
 domain = drawEvent.fillEventCrossCut(bounds)

diff --git a/doc/examples/reliability_problems/plot_rp53.py b/doc/examples/reliability_problems/plot_rp53.py
@@ -81,14 +81,13 @@
 # %%
 graph = drawEvent.drawLimitStateCrossCut(bounds)
 graph.add(cloud)
-graph
+_ = otv.View(graph)
 
 
 # %%
 domain = drawEvent.fillEventCrossCut(bounds)
 _ = otv.View(domain)
 
-
 # %%
 domain.add(cloud)
 _ = otv.View(domain)

diff --git a/doc/examples/reliability_problems/plot_rp55.py b/doc/examples/reliability_problems/plot_rp55.py
@@ -57,11 +57,11 @@
 # %%
 nbPoints = [100, 100]
 figure = g.draw(lowerBound, upperBound, nbPoints)
-figure.setTitle(" Iso-values of limit state function")
-figure
+figure.setTitle("Iso-values of limit state function")
+_ = otv.View(figure)
 
 # %%
-# Print the iso-values of the distribution
+# Plot the iso-values of the distribution
 # ----------------------------------------
 
 # %%
@@ -77,10 +77,11 @@
 
 # %%
 cloud = drawEvent.drawSampleCrossCut(sampleSize)
-cloud
+_ = otv.View(cloud)
 
 # %%
-# ## Draw the limit state surface
+# Draw the limit state surface
+# ----------------------------
 
 # %%
 bounds = ot.Interval(lowerBound, upperBound)
@@ -90,7 +91,7 @@
 # %%
 graph = drawEvent.drawLimitStateCrossCut(bounds)
 graph.add(cloud)
-graph
+_ = otv.View(graph)
 
 
 # %%

diff --git a/doc/examples/reliability_problems/plot_rp57.py b/doc/examples/reliability_problems/plot_rp57.py
@@ -87,7 +87,7 @@
 # %%
 graph = drawEvent.drawLimitStateCrossCut(bounds)
 graph.add(cloud)
-graph
+_ = otv.View(graph)
 
 # %%
 domain = drawEvent.fillEventCrossCut(bounds)