Mathics’s Developer Reference

Contents:

• The Components of Mathics3
  • Mathics3 Core
  • Mathics3 Character Tables and Tokenizer
  • Mathics3 Syntax Highlighting
  • mathicsscript
  • Django-based GUI
  • PyMathics3 Modules
    • Natural Language Python Module add-on
    • Graph Python Module add-on
    • Matplotlib Python Module Backend Renderer
    • Asymptote Python Module Backend Renderer
• Installing Mathics3
  • Mathics3 (mathics-core) Requirements
    • OS package dependencies
      • Debian/Ubuntu
      • MacOSX
      • FreeBSD
      • MS Windows
  • Install from PyPI
  • From docker (dockerhub)
  • From an OS-Specific Repository
  • Install from the Mathics3 Github Organization
• Running Mathics3
  • Running natively
    • Command-line interface
    • Full Command-line Shell
    • Django-based-line interface
  • Running via docker
  • Running Mathics3 on your server
    • Best practices for a local network
    • Running Mathics3 on a public webserver
• Reporting Bugs and Problems
  • Issues and Issue Fixers, Priorities
  • Narrowing the problem
  • Karma
• Input/Output Unicode Tables
  • WL Unicode and Name to Standard Unicode Table
  • Standard Unicode to WL Conversion Table
  • Full WL Unicode and Name to Standard Unicode Table
• Extending Mathics3
  • Mathics3 Setup Code Read on Loading
  • Mathics3 Packages
  • Setup for Developing Mathics3 Python Code
    • Developer Python Code-Checking Packages
    • Optional but Useful Developer Python Packages
  • Mathics3 from Python
    • Using Mathics3 from your code
      • From a shell
      • Using MathicsSession
      • Mathics3 Results as Python Objects
    • Tutorial: Adding a new Mathics3 Function
      • Hello, World! – using Predefined
      • Introducing the Builtin Class
      • Adding Help (Information[]) Text
      • Writing Document Tests
      • Working with Multiple Patterns
      • Function Application via Rules
      • Class variables and Function Attributes
      • Emitting warnings
    • Case Studies for Adding Builtins
      • Selecting a Builtin to add
      • Adding Builtin Undefined
      • Adding Builtin Function KroneckerProduct
      • Adding Builtin Function Curl
    • Documentation Markup
      • Markup in Documentation
      • Markup for Code Examples
    • Guidelines for Writing Documentation
      • Title
      • Definition Block
      • Extended Description Section
    • Contributing & Developing
      • Contributing
      • Developing
    • Running Tests
      • Unit tests
      • Doctests
  • Mathics3 Core Interpreter Overview
    • Session
      • Definitions
      • session.evaluate() at a High Level
      • Expression.format()
    • Scanning
    • Parsing
      • Parsing Overview
      • Precedence-Climbing Parser
      • Python Code for Scanning and Parsing a String
    • AST, M-Expression, General List: same thing
    • Evaluation of an Expression
      • Evaluation Overview
      • Evaluation can leave an Expression Seemingly Unchanged
      • Broad Description of the Rewrite/Apply/Eval Process
      • Detailed Rewrite/Apply/Eval Process
      • Mathics3 Function Application
      • Built-in Function Name Descriptions
      • Python Code for Evaluating an Expression
    • Pattern Matching in Evaluation
      • Pattern Classes
    • Forms, Boxes, and Formats
      • Forms
      • The Box Model
      • Output Formats
    • Python Modules
      • mathics.core
      • mathics.eval
      • mathics.builtin
      • mathics.compile
      • mathics.doc
    • Object Classes
      • Class Diagram for Some of the Classes
      • Mathics3 Core Classes
      • Classes for Defining Builtin Functions
    • Glossary
• Making a Mathics3 Release
  • Beforehand
  • Get latest sources:
  • Change version in mathics/version.py
  • Create a new branch
  • Update Changes
  • Build Docs
  • Check package from github
  • Make packages and check
  • Release on Github
  • Upload the release to PyPI
  • Post-Release
    • Update magic.github.io PDF

Indices and tables

• Index

• Module Index

• Search Page