Doc: update README
This commit is contained in:
parent
ed9191a3f1
commit
788e6c8add
127
README.md
127
README.md
|
|
@ -1,87 +1,58 @@
|
|||
Mapytex
|
||||
=======
|
||||
# Mapytex
|
||||
|
||||
Mapytex est un module python qui permet la manipulation d'expressions
|
||||
mathématiques. Voici ce qu'il est capable de faire:
|
||||
Formal calculus with explanation python module.
|
||||
|
||||
- *Calculer comme un collégien*: Pour faire de la correction
|
||||
automatisé d'exercice, un logiciel de calcul formel ne suffit pas.
|
||||
Si les étapes de calculs ne sont pas présentes, l'élève ne pourra
|
||||
pas analyser ses erreurs ou s'inspirer de la correction.
|
||||
[French wiki](https://opytex.org/pymath)
|
||||
|
||||
``` python
|
||||
>>> from mapytex import Expression
|
||||
>>> ajout_fractions = Expression("2 / 5 + 2 / 3")
|
||||
>>> resultat = ajout_fractions.simplify()
|
||||
>>> print(resultat)
|
||||
\frac{ 16 }{ 15 }
|
||||
>>> for i in resultat.explain():
|
||||
... print(i)
|
||||
...
|
||||
\frac{ 2 }{ 5 } + \frac{ 2 }{ 3 }
|
||||
\frac{ 2 \times 3 }{ 5 \times 3 } + \frac{ 2 \times 5 }{ 3 \times 5 }
|
||||
\frac{ 6 }{ 15 } + \frac{ 10 }{ 15 }
|
||||
\frac{ 6 + 10 }{ 15 }
|
||||
\frac{ 16 }{ 15 }
|
||||
```
|
||||
## Installing
|
||||
|
||||
- *Créer des exercices aléatoirement*: Pour faire des devoirs
|
||||
personnels, des fiches de révisions ou des exercices en classe, un
|
||||
générateur d'expressions est inclus.
|
||||
Install and update with [pip](pypi.org)
|
||||
|
||||
``` python
|
||||
>>> from mapytex import Expression
|
||||
>>> ajout_fraction = Expression.random("{a} + {b} / {c}")
|
||||
>>> print(ajout_fraction)
|
||||
2 + \frac{ 3 }{ 5 }
|
||||
```
|
||||
```
|
||||
pip install -U mapytex
|
||||
```
|
||||
|
||||
- *Gérer différents type de données*: Pour le moment, Mapytex est
|
||||
capable de gérer les entiers naturels, les rationnels (sous forme
|
||||
de fractions) et les polynômes. L'utilisation des nombres à virgules
|
||||
et des racines devraient être ajoutés dans les prochaines versions.
|
||||
## Examples
|
||||
|
||||
``` python
|
||||
>>> from mapytex import Fraction
|
||||
>>> une_fraction = Fraction(1,2)
|
||||
>>> print(une_fraction)
|
||||
1 / 2
|
||||
>>> from mapytex import Polynom
|
||||
>>> un_polynom = Polynom([1,2,3])
|
||||
>>> print(un_polynom)
|
||||
3 x^{ 2 } + 2 x + 1
|
||||
```
|
||||
### Simplify expressions and explain steps
|
||||
|
||||
- *Afficher avec deux types de rendus*: Un en mode texte pour
|
||||
l'affichage dans une console. Un deuxième spécialement pour écrire
|
||||
des documents latex.
|
||||
``` python
|
||||
>>> from mapytex import Expression
|
||||
>>> ajout_fractions = Expression("2 / 5 + 2 / 3")
|
||||
>>> resultat = ajout_fractions.simplify()
|
||||
>>> print(resultat)
|
||||
16 / 15
|
||||
>>> for s in resultat.explain():
|
||||
... print(s)
|
||||
...
|
||||
2 / 5 + 2 / 3
|
||||
2 \times 3 / 5 \times 3 + 2 \times 5 / 3 \times 5
|
||||
6 / 15 + 10 / 15
|
||||
6 + 10 / 15
|
||||
16 / 15
|
||||
```
|
||||
|
||||
``` python
|
||||
>>> from mapytex import Expression
|
||||
>>> ajout_fractions = Expression("2 / 5 + 2 / 3")
|
||||
>>> for i in ajout_fractions.simpliy().explain():
|
||||
... print(i)
|
||||
...
|
||||
\frac{ 2 }{ 5 } + \frac{ 2 }{ 3 }
|
||||
\frac{ 2 \times 3 }{ 5 \times 3 } + \frac{ 2 \times 5 }{ 3 \times 5 }
|
||||
\frac{ 6 }{ 15 } + \frac{ 10 }{ 15 }
|
||||
\frac{ 6 + 10 }{ 15 }
|
||||
\frac{ 16 }{ 15 }
|
||||
>>> from mapytex import txt
|
||||
>>> with Expression.tmp_render(txt):
|
||||
... for i in ajout_fractions.simpliy().explain():
|
||||
... print(i)
|
||||
...
|
||||
2 / 5 + 2 / 3
|
||||
( 2 * 3 ) / ( 5 * 3 ) + ( 2 * 5 ) / ( 3 * 5 )
|
||||
6 / 15 + 10 / 15
|
||||
( 6 + 10 ) / 15
|
||||
16 / 15
|
||||
```
|
||||
|
||||
Le rendu latex permet ensuite d'être directement compilé.
|
||||
|
||||
Ce module a pour but d'être un outil pour faciliter la construction
|
||||
d'exercices et leurs correction. Il a pour but d'être le plus simple
|
||||
possible d'utilisation afin que tout le monde avec un minimum de
|
||||
connaissance en programmation puisse créer librement des exercices.
|
||||
### Random expression generator
|
||||
|
||||
``` python
|
||||
>>> from mapytex import Expression
|
||||
>>> ajout_fraction = Expression.random("{a} + {b} / {c}")
|
||||
>>> print(ajout_fraction)
|
||||
2 + 3 / 5
|
||||
```
|
||||
|
||||
### Render in latex
|
||||
|
||||
``` python
|
||||
>>> from mapytex import Expression
|
||||
>>> Expression.set_render("tex")
|
||||
>>> ajout_fractions = Expression("2 / 5 + 2 / 3")
|
||||
>>> for i in ajout_fractions.simpliy().explain():
|
||||
... print(i)
|
||||
...
|
||||
\frac{ 2 }{ 5 } + \frac{ 2 }{ 3 }
|
||||
\frac{ 2 \times 3 }{ 5 \times 3 } + \frac{ 2 \times 5 }{ 3 \times 5 }
|
||||
\frac{ 6 }{ 15 } + \frac{ 10 }{ 15 }
|
||||
\frac{ 6 + 10 }{ 15 }
|
||||
\frac{ 16 }{ 15 }
|
||||
```
|
||||
|
|
|
|||
Loading…
Reference in New Issue