Equilibrium
===========

Computation of the system equilibrium using an iterative Newton method. For 
more information, see `Robotran theoretical framework <http://robotran-doc.git-page.immc.ucl.ac.be/RobotranBasic/Robotran_basics.pdf>`_.

Code sample
-----------

For running the equilibrium analysis, insert the following code in your main 
script and adapt it to your need:

.. code-block:: python

    mbs_data.process = 2
    mbs_equil = MbsysPy.MbsEquil(mbs_data)
    mbs_equil.set_options(method = 1, senstol = 1e-2, verbose = 1)
    mbs_equil.run()
    del mbs_equil

Use
---

.. py:currentmodule:: MBsysPy.mbsyspy.mbs_equil

The partitioning is performed by instancing an instance of :py:class:`MbsEquil`. 
Then partitioning is performed by calling the function :py:func:`MbsEquil.run`.

The options ot the partitioning module are set with the function :py:func:`MbsEquil.set_options`.