Skip to main content

A rudimentary Jupyter kernel for Agda

Project description

Binder Build Status codecov.io Jupyter Notebook Agda agda-stdlib

agda-kernel

An experimental Agda kernel for Jupyter. Used at Nextjournal [nextjournal kernel].

Examples

You can launch the following examples directly via the mybinder interface:

Alternatively, if you have binder, then you can use repo2docker locally:

repo2docker https://github.com/lclem/agda-kernel

Installation

pip install agda_kernel
python -m agda_kernel.install

Syntax highlighting

Syntax highlighting is done separately by Codemirror, but unfortunately there is no Agda mode packaged with it. A rudimentary Agda mode for Codemirror can be found in codemirror-agda/agda.js. In order to install it, type

make codemirror-install

Agda extension

In order to improve the Jupyter interface, it is strongly recommended to also install agda-extension.

Functionality

Each code cell must contain a line of the form module A.B.C where. For instance:

module A.B.C where

id : {A : Set}  A  A
id x = x

Upon execution, the file A/B/C.agda is created containing the cell's contents, and it is fed to the Agda interpreter (via agda --interaction). The results of typechecking the cell are then displayed.

After a cell has been evaluated, one can

  • Run Agsy (auto) by putting the cursor next to a goal ? and hitting TAB. The hole ? is replaced by the result returned by Agsy, if any, or by {! !} if no result was found. If there is more than one result, the first ten of them are presented for the user to choose from.

  • Refine the current goal by putting the cursor next to a goal {! !} and hitting TAB. An optional variable can be provided for case-splitting {! m !}.

  • Show information about the current context, goal, etc.: putting the cursor near a goal/literal and hit SHIFT-TAB.

Editing

Inputting common UNICODE characters is facilitated by the code-completion feature of Jupyter.

  • When the cursor is immediately to the right of one of the base form symbols hitting TAB will replace it by the corresponding alternate form. Hitting TAB again will go back to the base form.
base form alternate form
->
\ λ
<
B 𝔹
>
=
top
/=
bot
alpha α
/\
e ε
/
emptyset
neg ¬
qed
forall
Sigma Σ
exists
Pi Π
[=

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

agda_kernel-0.64.tar.gz (16.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

agda_kernel-0.64-py3-none-any.whl (21.1 kB view details)

Uploaded Python 3

File details

Details for the file agda_kernel-0.64.tar.gz.

File metadata

  • Download URL: agda_kernel-0.64.tar.gz
  • Upload date:
  • Size: 16.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.25.0 setuptools/50.3.2 requests-toolbelt/0.9.1 tqdm/4.54.0 CPython/3.7.1

File hashes

Hashes for agda_kernel-0.64.tar.gz
Algorithm Hash digest
SHA256 a515ff4e188b55d2841d92e3305e0c2a1c6c612d88ef53a56297edc9dde6965c
MD5 1ad7f0107c37e48723b4b1fa9a06c4cb
BLAKE2b-256 4ab1f00ace52cf4a8e13d944db0635ddaaf42ebcf46e050e29485772632856c3

See more details on using hashes here.

File details

Details for the file agda_kernel-0.64-py3-none-any.whl.

File metadata

  • Download URL: agda_kernel-0.64-py3-none-any.whl
  • Upload date:
  • Size: 21.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/47.1.0 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.8.5

File hashes

Hashes for agda_kernel-0.64-py3-none-any.whl
Algorithm Hash digest
SHA256 4087057c311292a3c8ce446acd4db64032c7c1cf0d733e4db0d8b28c497faf8b
MD5 7ef10798358b2a648b9f37618a7cd4b5
BLAKE2b-256 c40e6c193ad49ff9c3797de2dc1cf31b17495e1b91125e2781bfb942858170a7

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page