Mathics3’s Developer Reference

Contents:

• The Components of Mathics3
  • Mathics3 Core
  • Mathics3 Character Tables and Tokenizer
  • Mathics3 Syntax Highlighting
  • mathicsscript
  • Django-based GUI
  • Mathics3 Python Modules
    • Determining when Something should be a Mathics3 Module
    • “Hello, World” as a Mathics3 Python Module
    • Mathics3 Module ICU
    • Natural Language Mathics3 Module
    • Network Graph Mathics3 Python Module
    • Matplotlib Python Module Backend Renderer
    • Asymptote Python Module Backend Renderer
    • Mathics3 Debugger https://github.com/Mathics3/Mathics3-Module-trepan
• Installing Mathics3
  • Mathics3 (mathics-core) Requirements
    • OS package dependencies
      • Debian/Ubuntu
      • MacOSX
      • FreeBSD
      • MS Windows (msys2)
      • 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
• Mathics3 Kernel Interpreter
  • Session
    • Definitions
    • session.evaluate() at a High Level
    • Expression.format()
  • Scanning
    • Deciding what goes into Scanning and what goes into Parsing
    • What makes WMA Scanning and parsing hard?
    • How the Scanner Works
    • Scanner Testing
  • Parsing
    • Parsing Overview
    • Precedence-Climbing Parser
      • Introduction
      • Precedence Climbing
      • Mathics3 implementation
      • Recursive descent parsers in Python
      • References
    • 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
      • Gather information from Head and gather its elements
      • Build a new Expression
      • Compute evaluation timestamp
      • Setup Thread rewrite Listable Functions
      • Search for a Rule in Head to apply
      • Apply Rule or restore Expression
    • Mathics3 Function Application
    • Built-in Function Name Descriptions
    • Python Code for Evaluating an Expression
  • Pattern Matching in Evaluation
    • Pattern Classes
    • PatternObject
  • Rules
  • Forms, Boxes, and Formats
    • Forms
    • The Box Model
    • Output Formats
  • Python Modules in Mathics-Core
    • mathics.builtin
    • mathics.core
      • mathics.core.builtin
      • mathics.core.convert
    • mathics.core.compile
    • mathics.core.eval
      • mathics.core.parser
    • mathics.doc
    • mathics.format
  • Object Classes
    • Class Diagram for Some of the Classes
    • Mathics3 Core Classes
      • Atom Class
      • BaseElement Class
      • Definition Class
      • Definitions Class
      • Expression Class
      • Symbol Class
    • Classes for Defining Builtin Functions
      • Builtin class
      • Predefined Class
      • Test Class
      • Operator
      • PrefixOperator and PostFixOperator
      • BinaryOperator and UnaryOperator
      • SympyConstant, MPMathConstant, and NumpyConstant
      • SympyFunction and MPMathFunction
      • Which class should be used for a Mathics3 Object?
  • Glossary
• 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 and Pattern-based Parameter Specification
      • Checking Parameter Counts
      • Adding Help (Information[]) Text
      • Writing Document Tests
      • Working with Multiple Patterns
      • Function Application via Rules
      • Class variables and Function Attributes
      • Emitting Warnings and Errors
    • Case Studies for Adding Builtins
      • Defining Variable $MachineName
      • Selecting a Builtin to Add
      • Adding Builtin Undefined
      • Adding Builtin Function KroneckerProduct
      • Adding Builtin Function Curl
    • Guide Sections and Subsections
    • Documentation Markup
      • Markup in Documentation
      • Markup for Code Examples
    • Guidelines for Writing Documentation
      • Title
      • Definition Block
      • Extended Description Section
    • Thoughts and Experience from Adding Builtins
      • Don’t Reinvent the Wheel
      • Don’t Micromanage Python
      • Misuse of Rewrite Rules
      • Overusing Expensive Evaluate
    • Contributing & Developing
      • Contributing
      • Developing
    • Running Tests
      • Unit tests
      • Doctests
      • Plot Output tests
• Making a Mathics3 Release
  • Beforehand
  • Release Order
    • Making a Mathics-Scanner Release
      • Create a new Mathics3-Scanner branch
      • Update Mathics3 Scanner Changes
      • Check Mathics3 Scanner Python versions
      • Merge Mathics3 Scanner Release
      • Check Mathics3 Scanner package from github
      • Make Mathics3 Scanner packages and check
      • Release Mathics3 Scanner on Github
      • Upload the Mathics3 Scanner release to PyPI
      • Move Mathics3 Scanner dist files to uploaded
      • Post Mathics3 Scanner Release
    • Making a mathics-pygments Release
      • Create a new branch
      • Update Changes
      • Check Python versions
      • Merge release
      • Check package from github
      • Make packages and check
      • Release on Github
      • Upload the release to PyPI
      • Move dist files to save
      • Post-Release
    • Making a Mathics3 Kernel Release
    • Making a MathicsScript Release
      • Create a new Mathicsscript release branch
      • Mathicsscript Workflows update?
      • Update Mathicsscript Changes
      • Check Python versions for Mathicsscript
      • Merge Mathicsscript release
      • Check Mathicsscript package from github
      • Make Maticsscript packages and check
      • Release on Mathicsscript on Github
      • Upload the Mathicsscript release to PyPI
      • Move Mathicsscript dist files to uploaded
      • Post Mathicsscript Release
    • Making a Mathics3 Django Release
      • Mathics3 Django Workflows update?
      • Create a new Mathics3 Django release branch
      • Update Changes to Mathics3 Django
      • Check Mathics3 Django on other Python versions
      • Merge Mathics3 Django release
      • Check Mathics3 Django package from github
      • Make Mathics3 Django packages and check
      • Release Mathics3 Django on Github
      • Upload the Mathics-Django release to PyPI
      • Move Mathics-Django distributed files to uploaded
      • Post Mathics-Django Release
    • Making a Mathics3 Module networkx Release
    • Making a Mathics3 Module nltk Release
    • Making a Mathics3 “Hello World” Module Release
      • Create a new branch
      • Workflows update?
      • Update Changes
      • Check Python versions
      • Merge release
      • Check package from github
      • Make packages and check
      • Release on Github
      • Upload the release to PyPI
      • Move dist files to save
      • Post-Release

Indices and tables

• Index

• Module Index

• Search Page