diff --git a/doc/Makefile b/doc/Makefile index 7ca8ec6..d45a42f 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -2,7 +2,7 @@ # # You can set these variables from the command line. -SPHINXOPTS = +SPHINXOPTS = -W -T SPHINXBUILD = sphinx-build PAPER = BUILDDIR = ../build diff --git a/doc/application/README.rst b/doc/application/README.txt similarity index 100% rename from doc/application/README.rst rename to doc/application/README.txt diff --git a/doc/application/index.rst b/doc/application/application.rst similarity index 57% rename from doc/application/index.rst rename to doc/application/application.rst index 319a877..b6c944e 100644 --- a/doc/application/index.rst +++ b/doc/application/application.rst @@ -7,13 +7,10 @@ Otfmi bridges the physics of the model (in `FMI `__ f In the following applications, advanced computer experiments are performed on the FMUs. .. note:: - | Here we demonstrate the potential of using OpenTURNS on FMUs. - | For easier examples, see the section :doc:`Examples<../example/index>`. + Here we demonstrate the potential of using OpenTURNS on FMUs. + For easier examples, see the section :doc:`Examples<../example/index>`. .. toctree:: :maxdepth: 1 - :glob: - ../auto_application/plot_cantilever_beam - ../auto_application/plot_metamodel - ../demo_persalys/use_persalys + ../auto_application/index.rst diff --git a/doc/demo_persalys/use_persalys.rst b/doc/demo_persalys/use_persalys.rst index 756f4ab..db1d520 100644 --- a/doc/demo_persalys/use_persalys.rst +++ b/doc/demo_persalys/use_persalys.rst @@ -1,5 +1,5 @@ -Analyse the sensitivities with Persalys -======================================= +Sensitivity analysis with Persalys +================================== .. image:: ../_static/logo_persalys.png :align: left diff --git a/doc/example/README.rst b/doc/example/README.txt similarity index 100% rename from doc/example/README.rst rename to doc/example/README.txt diff --git a/doc/example/dynamic/README.rst b/doc/example/dynamic/README.txt similarity index 100% rename from doc/example/dynamic/README.rst rename to doc/example/dynamic/README.txt diff --git a/doc/example/index.rst b/doc/example/index.rst index 84e0cde..ea7e7b0 100644 --- a/doc/example/index.rst +++ b/doc/example/index.rst @@ -24,9 +24,7 @@ This mechanical model represents the deviation of a cantilever beam submitted to .. toctree:: :maxdepth: 1 - ../auto_example/static/plot_basics - ../auto_example/static/plot_init - ../auto_example/static/plot_set + ../auto_example/static/index.rst Explore dynamic FMUs -------------------- @@ -42,9 +40,7 @@ All dynamic examples rely on *epid.fmu*. This epidemiologic model represents the .. toctree:: :maxdepth: 1 - ../auto_example/dynamic/plot_dyn_basics - ../auto_example/dynamic/plot_dyn_init - ../auto_example/dynamic/plot_dyn_set + ../auto_example/dynamic/index.rst Common low-level functions -------------------------- @@ -58,10 +54,7 @@ Common low-level functions .. toctree:: :maxdepth: 1 - ../auto_example/low_level/plot_load_fmu - ../auto_example/low_level/plot_explore - ../auto_example/low_level/plot_simulate - ../auto_example/low_level/plot_initialize + ../auto_example/low_level/index.rst From OpenTURNS to FMI --------------------- @@ -76,5 +69,4 @@ the metamodel *instead of the FMU* in the simulation tool. .. toctree:: :maxdepth: 1 - ../auto_example/ot_to_fmu/plot_fmu_exporter - ../auto_example/ot_to_fmu/plot_model_exporter + ../auto_example/ot_to_fmu/index.rst diff --git a/doc/example/low_level/README.rst b/doc/example/low_level/README.txt similarity index 100% rename from doc/example/low_level/README.rst rename to doc/example/low_level/README.txt diff --git a/doc/example/low_level/plot_initialize.py b/doc/example/low_level/plot_initialize.py index 633e14a..c6bbd01 100644 --- a/doc/example/low_level/plot_initialize.py +++ b/doc/example/low_level/plot_initialize.py @@ -54,8 +54,8 @@ # ---------------------------- # %% -# | Initialization scripts can gather a large number of initial values. -# | The use of initialization scripts (*.mos* files) is common in Dymola : +# Initialization scripts can gather a large number of initial values. +# The use of initialization scripts (*.mos* files) is common in Dymola: # - to save the value of all the variables of a model after simulation, # - to restart simulation from a given point. diff --git a/doc/example/ot_to_fmu/README.rst b/doc/example/ot_to_fmu/README.txt similarity index 100% rename from doc/example/ot_to_fmu/README.rst rename to doc/example/ot_to_fmu/README.txt diff --git a/doc/example/ot_to_fmu/plot_model_exporter.py b/doc/example/ot_to_fmu/plot_model_exporter.py index e03816b..64ad7d8 100644 --- a/doc/example/ot_to_fmu/plot_model_exporter.py +++ b/doc/example/ot_to_fmu/plot_model_exporter.py @@ -9,7 +9,7 @@ # # Currently, the inclusion of a metamodel in # `OpenModelica GUI `_ -# has been performed once (see +# has been performed once (see # `this paper `_). # # ------------ diff --git a/doc/example/static/README.rst b/doc/example/static/README.txt similarity index 100% rename from doc/example/static/README.rst rename to doc/example/static/README.txt diff --git a/doc/example/static/plot_basics.py b/doc/example/static/plot_basics.py index 91fd802..a2ddaa0 100644 --- a/doc/example/static/plot_basics.py +++ b/doc/example/static/plot_basics.py @@ -4,24 +4,21 @@ """ # %% -# ``otfmi.FMUFunction`` enables to use OpenTURNS' high +# :class:`~otfmi.FMUFunction` enables to use OpenTURNS' high # level algorithms by wrapping the FMU into an :py:class:`openturns.Function` object. # %% # ------------ # %% -# | First, retrieve the path to the FMU *deviation.fmu*. -# Recall the deviation model is static, i.e. its output does not evolve over -# time. +# First, retrieve the path to the FMU *deviation.fmu*. +# Recall the deviation model is static, i.e. its output does not evolve over time. import openturns as ot import otfmi.example.utility - path_fmu = otfmi.example.utility.get_path_fmu("deviation") # %% # Wrap the FMU into an OpenTURNS function: - function = otfmi.FMUFunction( path_fmu, inputs_fmu=["E", "F", "L", "I"], outputs_fmu=["y"] ) @@ -29,18 +26,15 @@ # %% # Simulate the FMU on a point: - inputPoint = ot.Point([3.0e7, 30000, 200, 400]) outputPoint = function(inputPoint) print("y = {}".format(outputPoint)) # %% # Simulate the FMU on a sample: - inputSample = ot.Sample( [[3.0e7, 30000, 200, 400], [3.0e7, 30000, 250, 400], [3.0e7, 30000, 300, 400]] ) inputSample.setDescription(["E", "F", "L", "I"]) - outputSample = function(inputSample) print(outputSample) diff --git a/doc/fmus/index.rst b/doc/fmus/index.rst new file mode 100644 index 0000000..3e4aae4 --- /dev/null +++ b/doc/fmus/index.rst @@ -0,0 +1,8 @@ +Sample FMU files +================ + +.. toctree:: + :maxdepth: 1 + + deviation + epid diff --git a/doc/index.rst b/doc/index.rst index 2e7f352..d6c0da5 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -43,7 +43,17 @@ The core features of `Otfmi `__ are: :maxdepth: 1 :glob: - application/index + application/application + +.. toctree:: + :maxdepth: 1 + + fmus/index + +.. toctree:: + :maxdepth: 1 + + demo_persalys/use_persalys.rst --------------