mathmaker 0.7.1dev3

Mathmaker creates automatically elementary maths exercises and their (detailed) answers.

Overview

Mathmaker creates elementary maths worksheets with detailed solutions.

The output documents can be compiled into pdf files by lualatex. Examples of available themes are: first degree equations, pythagorean theorem, fractions calculation…

It can run from command line, but can be controlled via http requests too.

Documentation (master release) Documentation (latest development version)).

Quickstart

Complete install

• on Ubuntu 14.04 or later:

  External dependencies:

  $ sudo apt-get install eukleides libxml2-utils gettext texlive-full

  Note: to avoid installing texlive-full, check the documentation.

  Then:

  $ pip3 install mathmaker

• on FreeBSD 10.*:

  External dependencies:

  $ sudo pkg install python34 py34-sqlite3 gettext eukleides libxml2 texlive-full
  $ rehash
  
  **note**
  
  Because of a bug in current FreeBSD's eukleides package you'll
  have to fix eukleides install. See
  `here <http://mathmaker.readthedocs.io/en/master/user_doc.html#eukleides-fix>`__.

  Once you’re done, you can proceed installing mathmaker:

  $ pip3 install mathmaker
  
  **note**
  
  If you stumble upon an error during the install of the
  python-daemon dependency, you'll find the way to solve it
  `there <http://mathmaker.readthedocs.io/en/master/user_doc.html#python-daemon-error-at-install>`__

Basic use

$ mathmaker pythagorean-theorem-short-test > out.tex
$ lualatex out.tex

or directly:

$ mathmaker pythagorean-theorem-short-test --pdf > out.pdf

Get the list of all provided sheets(3):

$ mathmaker list

To get the command-line options, you can use mathmaker --help.

Several settings can be overriden by user defined values in ~/.config/mathmaker/user_config.yaml. Read the complete documentation for more information.

Advanced use

It’s possible to create your own sheets in xml (only for the mental calculation theme yet). Read the complete documentation for more information.

Contribute

You can contribute to mathmaker:

As a wordings contributor

Mathmaker needs contexts for problems wordings. There are already some, but the more there is, the better. Existing wordings can be found here. You can submit any new idea as an enhancement proposal there (should be written in english, french or german).

Any question can be sent to nh dot techn (hosted at gmail dot com).

As a translator

You can help translating mathmaker to your language (or any language you like, if you have enough elementary maths vocabulary for that).

If the translation to your language isn’t started yet, there are several pot files to get here (see explanations about their respective roles there). You can use an editor like poedit or any other you like better, to create po files from them and start to translate.

If you want to add missing translations, or to correct some, you can find the po files in the subdirectories here.

Once you’re done, you can make a pull request here.

Any question can be sent to nh dot techn (hosted at gmail dot com).

As a developer

Before submitting a PR, please ensure you’ve had a look at the writing rules.

More details can be found in the documentation for developers.

Any question can be sent to nh dot techn (hosted at gmail dot com).

Additional informations

Contact: nh dot techn (hosted by gmail dot com)

Contributors

Development

• Lead developer: Nicolas Hainaux

• Developers: Vaibhav Gupta

• Clever advices: Olivier Cecillon

Translation

• French: Nicolas Hainaux

Problems wordings

Nicolas Hainaux

Patience and chocolate cakes

Sophie Reboud

Changelog

New in version 0.7.1dev3 (2016-10-21)

• New sheets:

  • intercept theorem: “butterfly” configuration

  • intercept theorem: converse

New in version 0.7.1dev2 (2016-10-13)

• New sheets:

  • expansion of simple brackets (declined in two versions)

  • clever multiplications (mental calculation)

  • intercept theorem: write the correct quotients’ equalities

  • intercept theorem: solve simple exercises

These sheets and all future sheets will be defined in xml files.

New in version 0.7.1dev1 (2016-09-14)

• A new sheet (declined in two versions): expansion of double brackets. Defined in an xml sheet as for mental calculation sheets.

New in version 0.7.0-6 (2016-08-19)

• Added a setting to let the user change mathmaker’s path (to be used by the daemon)

New in version 0.7.0-5 (2016-08-19)

• Bugfix

New in version 0.7.0-4 (2016-08-19)

• If an IP address is passed as parameter to mathmaker’s daemon, it will return a 429 http status code (too many requests) if the last request from the same address is not older than 10 seconds.

New in version 0.7.0-3 (2016-07-18)

• Fixed the install of locale files and font listing file

New in version 0.7 (2016-07-15)

• Standardized structure (mathmaker becomes pip3-installable, available on PyPI and github; its documentation is hosted on readthedocs; tests are made with py.test)

• A daemon is added (mathmakerd) to provide communication with mathmaker through http connections.

• A bunch of mental calculation sheets

• The use of XML frameworks for the sheets (yet only for mental calculation, so far)