Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/deividrvale/nijn-coq-script-generation
OCaml module of Nijn to generate coq scripts for checking termination proofs of higher-order rewriting systems.
https://github.com/deividrvale/nijn-coq-script-generation
coq termination-checking
Last synced: 9 days ago
JSON representation
OCaml module of Nijn to generate coq scripts for checking termination proofs of higher-order rewriting systems.
- Host: GitHub
- URL: https://github.com/deividrvale/nijn-coq-script-generation
- Owner: deividrvale
- License: mit
- Created: 2022-11-15T14:23:41.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2023-05-10T11:47:37.000Z (over 1 year ago)
- Last Synced: 2024-10-10T21:41:01.593Z (about 1 month ago)
- Topics: coq, termination-checking
- Language: OCaml
- Homepage:
- Size: 493 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ONijn - Coq Proof Script Generation
A persistent version of this artifact is
available at Zenodo with the link below.
[](https://zenodo.org/badge/latestdoi/566366739)
ONijn is an OCaml module of
[Nijn](https://github.com/nmvdw/Nijn).
It is intended to be used as a tool to generate Coq termination certification
scripts from the output of termination tools.
The current version of (O)Nijn supports higher-order polynomials in applicative format.
Essentially,
this is the higher-order interpretation method described in
[Fuhs-Kop](https://drops.dagstuhl.de/opus/volltexte/2012/3492/)'s paper.
Check the [ONijn API](https://deividrvale.github.io/nijn-coq-script-generation/onijn/index.html) for more details.
## Build Instructions (Linux/macOS)
We use [opam](https://opam.ocaml.org/doc/Install.html) to build ONijn.
Make sure it is installed on your system before proceeding.
Here's the **dependency** list,
which can be installed using opam.
- **opam** v2.1.3 or higher.
- See [opam](https://opam.ocaml.org/doc/Install.html) for installation instructions.
- **ocaml** v4.14.0 or higher.
- **dune** v3.5.0 or higher.
- **menhir** v2.1 or higher.
- **coq.8.16.1** is needed for formal verification.
### Managing opam switches
If your current ``opam switch``
doesn't have OCaml v4.14.0 or higher,
we recommend creating a fresh ``opam switch``:
```bash
opam switch create nijn-onijn 4.14.1
eval $(opam env)
opam install dune menhir coq.8.16.1
```
To see the list of switches, use
```bash
opam switch
```
and switching to a new switch is simple.
For instance
```bash
opam switch nijn-onijn
```
Run
```bash
dune build
```
to build the package from source.
```bash
opam install dune menhir
```
To build documentation, we use ``odoc``.
```bash
opam install odoc
```
### Installing binaries locally
Run
```ocaml
dune install
```
to install ONijn binaries locally.
This allows one to invoke the ``onijn``
binary from anywhere.
## How to use it
ONijn receives as input a file describing the term rewriting system and an interpretation of each function symbol in its
signature.
This file is called *proof trace*.
Usually, this is a file in the format ``.onijn``.
The file format is explained in the [API](https://deividrvale.github.io/nijn-coq-script-generation/onijn/index.html#input-file-format).
With ONijn installed,
you run it by providing an input file and an output file with the ``-o`` option.
```bash
onijn -o
```
The output is a Coq proof script asserting the termination
of the term rewriting system described in the input file.
This coq proof script can then be verified by coq,
and for that one needs to install the [Nijn](https://github.com/nmvdw/Nijn) coq library.
## Running Experiments
We provide some experiment files in the folder ``./experiments/ho_poly``.
**Important:** to run the experiments make sure the
``timeout`` utility is installed on your system.
On macOS, it is available with ``coreutils`` formulae in brew.
```bash
brew install coreutils
```
Most Linux systems come with timeout by default.
In order to locally run the experiments, run:
```bash
make
```
this will build and install [Nijn](https://github.com/nmvdw/Nijn) on your system.
The batch of experiments can be run from the script
``run_experiments.sh`` provided at the root of the project.
Next, we set executable permission to the ``run_experiments.sh`` file.
```bash
chmod oug+x run_experiments.sh
```
Finally, execute the ``run_experiments.sh`` file to run the experiments.
```bash
./run_experiments.sh
```