JamesCrook/MathsQuests

Mathematics tools

★ 0Forks 0HTMLGitHub ↗Compare

README

MathsQuests

MathsQuests is a new collection of mathematics software

Current Status

Right now... early days. Data viewers in the website section are the main thing currently.

Project Structure

/                                   #
├─ c_src/                           # C++ and Metal source code
├─ data/                            # Small data files for development (not full data files)
├─ website/                         # HTML, CSS, JavaScript for the web interface
│  ├─ polynomial-calculator.html    #  Polynomials in x,y,z for Gröbner bases
│  ├─ spice_ui.html                 #  Intro to PDEs
│  └─ pinwheel.html                 #  Flattening a klein bottle
├─ py/                              # Python scripts
│  ├─ ready_to_rock.py              #  Checks readiness; Sets up environment; Compiles code
│  └─ web_server.py                 #  Web browser front end
├─ docs/                            # Docs (work in progress).
│  ├─ explanations/                 #  Background rather than how to
│  ├─ how-to/                       #  Recipes organised by related topics
│  ├─ reference/                    #  Settings for the various scripts 
│  └─ tutorials/                    #  Tutorial content
├─ GETTING_STARTED.md               # How to set up the system
├─ LICENSE.md                       # Copyright licenses
├─ CITATION.cff                     # Citing this work
└─ README.md                        # This README

Links for AI Assistants

AI assistants are guided to instructions they should follow by text like the text below:

See docs/reference/specs/specs.md for IMPORTANT REQUIREMENTS for AI assistant work.

Getting started

For the viewers in /website you don't need a webserver, so you can just use them as is already and drag and drop files into them. The web server will be needed when there is heavy data crunching happenning and databases to access.

Coming Summer 2026: See GETTING_STARTED.md in this directory for instructions on getting started.

Contributors

JamesCrook

Issues