Dynamic system Tutorial
=======================

Access to example scripts on github: https://github.com/masfaraud/BMSpy/tree/master/scripts



The DynamicSystem Class is a python class defined by BMS core. It allows to define a complete model containing all the data for simulation.

Defining a model
----------------

First, we need to import bms:

.. code:: python

  import bms

Defining signals
^^^^^^^^^^^^^^^^

Inputs are special variable in the model which are not computed. See the :ref:`signals-reference` list in reference

Here we define a ramp named which name is e

.. code:: python

  from bms.signals.functions import Ramp
  e=Ramp('e',1.)

.. seealso::
 
  .. autoclass:: bms.signals.functions.Ramp
     :members:

Defining Variables
^^^^^^^^^^^^^^^^^^

Let's define a variable s which will be the output of a first order block

.. code:: python

  s=bms.Variable('s')

.. seealso::
 
  .. autoclass:: bms.Variable
     :members:


Defining Blocks
^^^^^^^^^^^^^^^
See the list of available :ref:`blocks-reference`

For this example, let's define a first order block:

.. code:: python

   from bms.blocks.continuous import ODE
   block=ODE(e,s,[1],[1,3])

.. seealso::
 
  .. autoclass:: bms.blocks.continuous.ODE
     :members:



Defining the model
^^^^^^^^^^^^^^^^^^

.. code:: python

    te=10# time of end in seconds
    ns=2000 # number of time steps
    model=bms.DynamicSystem(te,ns,[block])

.. seealso::
 
  .. autoclass:: bms.DynamicSystem

The blocks are given in a list as third argument.

Model methods
-------------


Simulating
^^^^^^^^^^

.. code:: python

    model.Simulate()

.. seealso::
  .. autoclass:: bms.DynamicSystem
     :members: Simulate

Plotting variables
^^^^^^^^^^^^^^^^^^

.. code:: python

    model.PlotVariables()

.. seealso::
  .. autoclass:: bms.DynamicSystem
     :members: PlotVariables


Accessing values
^^^^^^^^^^^^^^^^

Values of variables at a given time t is accessible by:

.. code:: python

  model.VariablesValues(t)

.. seealso::
  .. autoclass:: bms.DynamicSystem
     :members: VariablesValues


The time values vector of a variable is accessible via the values attribute:

.. code:: python

     import matplotlib.pyplot as plt
     plt.plot(model.t,e.values)
     plt.plot(model.t,s.values)