Pantograph/README.md

76 lines
2.0 KiB
Markdown
Raw Normal View History

2023-05-09 22:51:19 -07:00
# Pantograph
An interaction system for Lean 4.
## Installation
Install `elan` and `lean4`. Then, execute
``` sh
lake build
```
2023-05-12 01:08:36 -07:00
In order to use `mathlib`, its binary must also be built
``` sh
2023-05-12 16:12:21 -07:00
lake build Qq
lake build aesop
2023-05-12 01:08:36 -07:00
lake build std
lake build mathlib
```
In a future version, the dependencies of mathlib will be removed and the user will be responsible for adding such library paths to `LEAN_PATH`.
2023-05-09 22:51:19 -07:00
## Usage
``` sh
build/bin/pantograph OPTIONS|MODULES
```
The REPL loop accepts commands as single-line JSON inputs and outputs either an
`Error:` (indicating malformed command) or a json return value indicating the
result of a command execution. The command can be passed in one of two formats
```
command { ... }
{ "cmd": command, "payload": ... }
```
The list of available commands can be found in `Pantograph/Commands.lean`. An
empty command aborts the REPL.
2023-05-12 16:12:21 -07:00
2023-05-24 00:55:54 -07:00
The `Pantograph` executable must be run with a list of modules to import. It can
also accept options of the form `--key=value` e.g. `--pp.raw=true`.
2023-05-12 16:12:21 -07:00
Example: (~5k symbols)
```
$ build/bin/Pantograph Init
catalog
inspect {"name": "Nat.le_add_left"}
2023-05-12 16:12:21 -07:00
```
Example with `mathlib` (~90k symbols)
2023-05-12 01:08:36 -07:00
```
$ lake env build/bin/Pantograph Mathlib.Analysis.Seminorm
catalog
2023-05-09 22:51:19 -07:00
```
Example proving a theorem: (alternatively use `proof.start {"copyFrom": "Nat.add_comm"}`) to prime the proof
2023-05-21 17:41:39 -07:00
```
$ env build/bin/Pantograph Init
proof.start {"expr": "∀ (n m : Nat), n + m = m + n"}
2023-05-21 17:41:39 -07:00
proof.tactic {"treeId": 0, "stateId": 0, "goalId": 0, "tactic": "intro n m"}
proof.tactic {"treeId": 0, "stateId": 1, "goalId": 0, "tactic": "assumption"}
proof.printTree {"treeId": 0}
proof.tactic {"treeId": 0, "stateId": 1, "goalId": 0, "tactic": "rw [Nat.add_comm]"}
proof.printTree {"treeId": 0}
```
where the application of `assumption` should lead to a failure.
2023-05-09 22:51:19 -07:00
2023-05-14 15:22:41 -07:00
## Troubleshooting
2023-05-09 22:51:19 -07:00
2023-05-14 15:22:41 -07:00
If lean encounters stack overflow problems when printing catalog, execute this before running lean:
```sh
ulimit -s unlimited
```
## Testing
The tests are based on `LSpec`. To run tests,
``` sh
test/all.sh
```