Mathics3 is a general-purpose computer algebra system (CAS). It is an open-source alternative to Mathematica. It is free, both in the sense of "freedom" and in the sense of "free beer".

Mathics3 consists of several separable components so that those pieces that are desired can be used without the burden of dependencies of the other parts.

For example, if you are interested in just running a command-line interface, you might not be interested in having Django and what that entails, and vice versa. If you are just interested in the computational library, there is no need for either the Web parts or the command-line library parts.

But what if you want both the command-line interface, the Web interface, all of the Mathics3 Modules, and whatever else there is to offer?

That's what this repository is about. Here we have a PyPI installable package that pulls in the various components and offers commands:

• mathics3-tokens utility to show how an input stream is tokenized by Mathics3
• mathicsscript to run the command-line interface,
• mathicsserver to run the Django-Web server,
• dmathicsscript and dmathicsserver, which runs the docker version of these,
• dmathicssdoc which runs a PDF viewer, evince, which can view the generated reference manual in PDF.
• dmathicsdoccopy which copies the generated reference PDF manual out of the container and into the host filesystem.

This repository also contains the Dockerfiles used to create the mathicsorg/mathics docker images.

That image is a combination of:

• Mathics-Scanner (WL Character Tables and Mathics Scanner)
• mathicsscript (Command-line Mathics Interface)
• mathics-pygments (WL Syntax Highlighting)
• Mathics-Django (Django-based HTTP server)
• mathics-threejs-backend (Graphics3D rendering using threejs)
• Mathics-Module-nltk (Mathics3 Module for Natural Language Processing add-on via NLTK)
• Mathics-Module-PyUI (Mathics3 Module for ICU - Human-Language Alphabets and Locales via PyICU)
• pymathics-graph (Graph add-on based on NetworkX.

It is likely that in the future more components will be added, so stay tuned...

Installing

From pre-built artificats:

The easier ways to install are to use Python pip and docker

To install from Python pip:

pip install Mathics-omnibus

To install the Docker image, run:

docker pull mathicsorg/mathics

See https://hub.docker.com/r/mathicsorg/mathics for more information on how to use it after installing

From GitHub:

Beware that there is always a bit of churn in the code base. So what is in GitHub in the master right branch might not line up with all the changes across all the repositories.

Either before a release or right after a release, things generally match up, though.

I won't repeat how to install Python in developer mode, build a Python package, or how to create an docker image. For that, use whatever generic help mechanism you use for helping with these generic kinds of tasks.

However, Python PIP, pyrpoject.toml is an important file to consult. And for Docker, the file is docker/Dockerfile.

Docker-specific items

By default, we use a SQLite database that has examples that you can load and use. This data comes from mathics-omnibus/django-db/mathics.sqlite.

Since this is tied to the Docker image, any changes made won't survive across restarting the Docker image.

If you would like to save your own, you can set the environment variable MATHICS_DJANGO_DB_PATH. Here is an example:

$ MATHICS_DJANGO_DB_PATH=/usr/src/app/data/mathics-django/mathics.sqlite ../mathics-omnibus/script/dmathicsserver
MATHICS_DJANGO_DB_PATH=/usr/src/app/data/mathics-django/mathics.sqlite ../mathics-omnibus/script/dmathicsserver^J-(../mathics-omnibus/script/dmathicsserver:5):  -[2,0, 0]
DOCKER=docker
-(../mathics-omnibus/script/dmathicsserver:6):  -[2,0, 0]
MATHICS_DJANGO_DB=mathics.sqlite
-(../mathics-omnibus/script/dmathicsserver:7):  -[2,0, 0]
MATHICS_DJANGO_DB_PATH=/usr/src/app/data/mathics-django/mathics.sqlite
-(../mathics-omnibus/script/dmathicsserver:9):  -[2,0, 0]
docker run -it --name mathics-web --rm --env=DISPLAY --env MATHICS_DJANGO_DB_PATH=/usr/src/app/data/mathics-django/mathics.sqlite --workdir=/app --volume=/src/external-vcs/github/Mathics3/mathics-django:/app --volume=/tmp/.X11-unix:/tmp/.X11-unix:rw -p 8000:8000 -v /tmp:/usr/src/app/data mathicsorg/mathics --mode ui

~~~~ app/data has been mounted to /usr/src/app/data ~~~~
~~~~ SQLite data (worksheets, user info) will be stored in /usr/src/app/data/mathics django/mathics.sqlite ~~~~
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

 warning: database file /usr/src/app/data/mathics-django/mathics.sqlite not found

 Migrating database /usr/src/app/data/mathics-django/mathics.sqlite
 Operations to perform:
   Apply all migrations: auth, contenttypes, sessions, sites, web
 Running migrations:

In the above, when it says mathics.sqlite not found an empty one is created. The real location of it outside of the container is in /tmp/mathics-django/mathics.sqlite.