From cb16aaf8ebc310dae489b4ed40583af32195e0a7 Mon Sep 17 00:00:00 2001 From: Sylvain Girard Date: Fri, 7 Jun 2024 16:59:08 +0200 Subject: [PATCH] Fix typos in doc --- doc/application/plot_cantilever_beam.py | 6 +++--- doc/example/low_level/plot_simulate.py | 4 ++-- doc/fmus/deviation.rst | 2 +- doc/index.rst | 3 +-- 4 files changed, 7 insertions(+), 8 deletions(-) diff --git a/doc/application/plot_cantilever_beam.py b/doc/application/plot_cantilever_beam.py index ba72c11..8f90f3d 100644 --- a/doc/application/plot_cantilever_beam.py +++ b/doc/application/plot_cantilever_beam.py @@ -53,7 +53,7 @@ F = ot.LogNormal() F.setParameter(ot.LogNormalMuSigma()([30.0e3, 9e3, 15.0e3])) L = ot.Uniform(250.0, 260.0) -II = ot.Beta(2.5, 4.0, 310.0, 450.0) +I = ot.Beta(2.5, 4.0, 310.0, 450.0) # %% # According to the laws of mechanics, when the length L increases, the moment @@ -86,8 +86,8 @@ # %% # And we endly create the composed input probability distribution. -inputDistribution = ot.ComposedDistribution([E, F, L, II], mycopula) -inputDistribution.setDescription(("E", "F", "L", "I")) +inputDistribution = ot.ComposedDistribution([E, F, L, I], mycopula) +inputDistribution.setDescription(model_fmu.getInputDescription()) # %% # Create the event whose probability we want to estimate: diff --git a/doc/example/low_level/plot_simulate.py b/doc/example/low_level/plot_simulate.py index 4212d6d..3870b3f 100644 --- a/doc/example/low_level/plot_simulate.py +++ b/doc/example/low_level/plot_simulate.py @@ -21,7 +21,7 @@ # .. note:: # | *model* is a PyFMI object, loaded with Otfmi’s overlay. # | As such, ``model.simulate()`` is a pure PyFMI method. -# | Use ``òtfmi.fmi.simulate(model)`` to benefit from Otfmi’s overlay. +# | Use ``otfmi.fmi.simulate(model)`` to benefit from Otfmi’s overlay. # %% @@ -56,6 +56,6 @@ plt.show() # %% -# | The interest of the higher-level functions TODO are: +# | The interest of the higher-level functions are: # | - avoid the *for* loop on the points of the design of experiment, # | - automatic formatting of the simulation outputs. diff --git a/doc/fmus/deviation.rst b/doc/fmus/deviation.rst index bd5cdfd..a753b97 100644 --- a/doc/fmus/deviation.rst +++ b/doc/fmus/deviation.rst @@ -33,7 +33,7 @@ This model is implemented in Modelica language: input Real L (start=250); input Real I (start=400); equation - y=(F*L**3)/(3.0*E*I); + y=(F*L^3)/(3.0*E*I); end deviation; .. note:: diff --git a/doc/index.rst b/doc/index.rst index d6c0da5..e31bd22 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -119,8 +119,7 @@ Contact | You can contribute to the project or signal issues on `Otfmi GitHub repository `__. | For questions on the code, contact `Sylvain - Girard `__ or `Claire-Eleuthèriane - Gerrer `__. + Girard `__. | For questions or remarks concerning the documentation, contact `Claire-Eleuthèriane Gerrer `__.