.. MBsysPy documentation master file, created by
   sphinx-quickstart on Tue Jan 21 08:31:32 2020.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to MBsysPy's documentation!
===================================

The modelling and analysis of multibody systems can be achieved by interfacing
the C libraries of MBsysC. It allows to prevent for the user any compilation 
steps while keeping the efficiency computation of core function written in the 
C programming language.
 
For complexe or large multibody systems, the overhead due to python to C 
interface can be reduced by writing and compiling some part of the multibody 
systems in C programming language. At the end the whole system can be provided 
as C compiled libraries, while the interface is only used to start the 
computation process and changeing some parameters in the model.


The MBsysPy package allow to perform different dynamic and kinematic analysis 
on the multibody system. Each analysis uses a specific class instance dependent 
on the MbsData instance containing the system definition.




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

In this documentation, some code samples are given. The code samples assume 
that `MBsysPy` has already been imported. Some samples may use `np` to call 
functions (or classes) from the `numpy` package:

.. code-block:: python

    import MBsysPy
    import numpy as np
    
.. py:module:: MBsysPy.mbsyspy.mbs_data

More over some sample use an instance of the class :py:class:`MbsData`, that is
contained in a variable named `mbs_data`.

Contents
--------

.. toctree::
   :maxdepth: 1
   
   pages/load
   pages/part
   pages/equil
   pages/modal
   pages/dirdyn
   pages/solvekin
   pages/invdyn
   pages/user_functions
   pages/trajectories_functions

Indices and tables
------------------

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`