Mapytex/documentation/source/index.rst

.. Mapytex documentation master file, created by
   sphinx-quickstart on Thu Apr 23 10:44:48 2015.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Karibou dans la documentation de Mapytex
========================================

Mapytex est un ensemble de modules écris en Python qui vise à faciliter et automatiser la conception d'exercices de math et leurs corrections. 

Le module est séparé en 3 parties:

- *calculus*: Cette partie gère les expressions mathématiques et leurs calculs.

  À la différence d'un logiciel de calcul formel classique (comme `sympy <sympy.org>`_), Mapytex va non seulement être capable de simplifier des calculs mais surtout d'expliquer comme un élève les étapes qui permettent d'arriver au résultat.

  Voici un exemple de création d'un exercice calculatoire avec des fractions.

  .. code-block:: python

        >>> from mapytex import Expression
        >>> ajout_fraction = Expression.random("{a} + {b} / {c}")
        >>> print(ajout_fraction)
        - 1 + \frac{9}{- 5}
        >>> res = ajout_fraction.simplify()
        >>> print(res)
        \frac{14}{- 5}
        >>> for i in res.explain():
        ...        print(i)
        - 1 + \frac{9}{- 5}
        \frac{- 1}{1} + \frac{9}{- 5}
        \frac{- 1 \times - 5}{1 \times - 5} + \frac{9}{- 5}
        \frac{5}{- 5} + \frac{9}{- 5}
        \frac{5 + 9}{- 5}
        \frac{14}{- 5}


  Ce qui donne une fois compilé avec Latex

    .. math::
        \begin{align*}
            - 1 + \frac{9}{- 5}\\
            \frac{- 1}{1} + \frac{9}{- 5}\\
            \frac{- 1 \times - 5}{1 \times - 5} + \frac{9}{- 5}\\
            \frac{5}{- 5} + \frac{9}{- 5}\\
            \frac{5 + 9}{- 5}\\
            \frac{14}{- 5}
        \end{align*}

  Pour en savoir plus: `présentation des outils de calculs <presentation_calculs.html>`_

- *stat*: Cette partie gère la gestion de donnée (création et analyse)

  .. code-block:: python

        >>> from pytmath import Dataset
        >>> w = Dataset.random(10)
        >>> w
        [-0.14, 0.3, -0.55, 1.02, -2.02, -1.17, 1.47, 1.22, -1.38, 0.02]
        >>> w.mean()
        -0.12

  Pour en savoir plus: `présentation des outils stat <presentation_stat.html>`_

- *geometry*: Partie rudimentaire! Pour le moment, elle ne permet que de créer des triplets de Pythagore!

Sommaire
========

.. toctree::
   :maxdepth: 2

   presentation_calculs
   presentation_stat
   construction
   polynom
   code/pymath



Indices and tables
==================

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