Skip to content

Installation

Requirements

  • Python >= 3.11
  • Linux or FreeBSD (macOS and Windows support is planned)

Install

pip install automathics

Python dependencies are installed automatically.

Post install script

automathics_postinstall
compiles the translation catalogs and offers to install both the fonts used by automathics and the bash script for autocompletion of the automath command. Generated worksheets already embed their fonts, so installing the fonts system-wide is only useful to render standalone SVG exports (e.g. automath render svg) correctly outside automathics.

If run as root on FreeBSD, will also add the rc.d script for automathd.

For unattended installs (e.g. provisioning a jail or container), the prompts can be pre-answered:

  • --yes — answer yes to every prompt;
  • --no-fonts — never install the fonts system-wide (overrides --yes);
  • --no-completion — never install the bash completion (overrides --yes).

For a server that only runs automathd/automathon, the fonts are not needed (they matter only for the local font mode and standalone automath render svg):

automathics_postinstall --yes --no-fonts

Installed executables

automath and automathd.

automathon is deployed as a static web application: automathics_postinstall installs it to the path defined in automathon.yaml, from where it can be served.