C1ick ⅋ c⊗LLec⊥

The repository contains frontend and backend code for an online interactive sequent prover for linear logic.

Technical information and roadmap

Some information is available in the wiki.

Install

Build using opam

• First initialize opam if necessary

  sudo apt-get install opam
  opam init

• Make sure you are running a recent compiler (to get the list of available versions, use opam switch list-available).

  opam switch create 4.12.0 # latest version at the time of writing

• Install opium

  opam depext opium
  opam install opium

• Clone this repository

  git clone https://github.com/etiennecallies/click-and-collect

• Build and launch

  dune build
  ./_build/default/main.exe

Now you can visit http://localhost:3000 and play with click-and-collect.

Make proof sharing work

To compress/uncompress json we use LZMA algorithm. The code calls unix commands lzma and unlzma. Install them by installing liblzma-dev package:

sudo apt-get install liblzma-dev

Make LaTeX export work

If you don't have LaTeX environment installed on your machine (or your server), you can proceed as following to make LaTeX export work.

• Install TexLive (for LaTeX to PDF/PNG export) following guidelines like these ones.
• Install poppler-utils (for LaTeX to PNG export)

  sudo apt-get install poppler-utils

Deploy on server

Same as local dev, except that we need to proxy port 3000 by nginx (or Apache).

• Add this nginx config (install it with sudo apt install nginx)

  server {
  root /home/{username}/click-and-collect;
  index index.html;
  server_name {hostname};
  
  location / {
      proxy_pass http://127.0.0.1:3000;
  }
  }

• Allow https by adding a certificate sudo certbot --nginx

Use

URL parmaters

• withInteractions: enabled by default, 0 to disable interaction on proof.
• exportButtons: enabled by default, 0 to hide export buttons.
• checkProvability: enabled by default, 0 to disable provability checks.
• autoReverse: option available by default, 1 to toggle on auto-reverse, 0 to hide option.
• cutMode: option available by default, 1 to toggle on cut mode, 0 to hide option.
• proofTransformation: option available by default, 1 to toggle on proof transformation mode, 0 to hide option.
• s: contain sequent to prove as string.
• n: contain notations. n=0 to disable notations, n=n1,v1&n=n2,v2&... to add notations.
• p: contain compressed proof.

Example: A minimal interactive A*A^,A|A^ sequent -> http://localhost:3000/?s=A*A%5E%2CA%7CA%5E+&proofTransformation=0&cutMode=0&autoReverse=0&n=0&exportButtons=0&checkProvability=0

Contribute

Modify Coq nanoyalla package

Whenever a file in nanoyalla/ directory package is modified, nanoyalla version should be incremented that way:

1. Increment version in nanoyalla/README.md.
2. Increment version in export_as_coq.ml, in header printed in generated files.
3. Zip nanoyalla/ directory: rm -f static/download/nanoyalla.zip && zip -r static/download/nanoyalla.zip nanoyalla/

Modify parser

Do not modify ll_parser.mli or ll_parser.ml neither ll_lexer.mll, but just ll_parser.mly and ll_lexer.mll and then run

ocamllex ll_lexer.mll && ocamlyacc ll_parser.mly

Test

Test API

There are some API tests in test/api_test.ml, which uses test data in api_test_data.json. It calls API and checks its response.

First time:

opam install alcotest

First time and whenever you change test script (no need if you change only the json file):

ocamlfind ocamlc -thread -linkpkg -package alcotest -package lwt -package cohttp -package cohttp-lwt-unix -package threads -package yojson -package str -o test/api_test test/api_test.ml

To execute tests (you need to have make test.byte running):

test/api_test

Test Coq

To check that Coq files returned by API actually compile, we have some examples of proof as json object in test/proof_test_data. Some additional Coq files can be checked to compile in test/coq_test_data.

To execute tests (you need to have make test.byte running):

test/coq_test.sh

Test LaTeX

To check that LaTeX files returned by API actually compile, we have some examples of proof as json object in test/proof_test_data.

To execute tests (you need to have make test.byte running):

test/latex_test.sh

Tribute

This tool design was mainly inspired by Logitext (GitHub).