Clingo with Jupyter Notebooks

This repository is a collection of interactive Jupyter Notebooks for running answer set programs using clingo.

Usage

You can either use the notebooks locally by installing clingo and jupyter notebooks or use mybinder, which builds the interactive environment for you.

1. Use the notebooks locally by installing clingo and jupyter notebook

• Install clingo and classic Jupyter Notebook in your local machine.
• Run the following in the terminal to make %%clingo an alias for %%script --no-raise-error clingo, where %%script is a built-in magic-command in ipython.

IPYLOC=`ipython locate profile` 
echo 'alias_magic clingo script -p "clingo --no-raise-error"' >> $IPYLOC/startup/config.ipy 

• You can also install, enable or disable notebook extensions from here. Some examples are Collapsible headings and Table of contents.

2. Use the notebooks through mybinder without installation

We use mybinder for building and sharing the interactive environment for this repository. More information on how a Binder repository is built can be found here.

• Click on this binder badge to open a notebook server.
• You can create a new notebook or upload an existing one in the Home Page or the specific folder of your instance of Jupyter notebook server. After finishing the work, you can save the notebook on your device by downloading it. For saving your current work across multiple notebooks or directories, save the respective notebooks, compress them to a tar.gz file using the terminal and download it. To resume working on the notebooks in a new binder instance, upload and extract that compressed file.

Commands in use:

• Use %%clingo : the magic cell command for running answer set program specificied in a cell.
• Use !clingo as a shell command for running an answer set program saved in a file.
• Check out sample.ipynb for a small introduction on how to use clingo in Jupyter Notebooks.
• The branch examples contains notebooks with answer set programs, along with clingo and other potasso systems.
• To try other notebook user interfaces, check this.

Adding new notebooks to the repository

To add new notebooks, push them to the respective branch and launch with mybinder. The launch process after every commit takes a while, as it rebuilds the Docker image. If the Binder repository has already been built once, then subsequent clicks on the Binder link will not re-trigger the build process and the launches will be quicker.

Update the environment

To change the underlying environment, modify the configuration files in the binder folder. After every commit, a docker image is built as per the configuration specified in the binder folder. For a list of all configuration files available, check this. The configuration files used in this repository are:

1. environment.yml to install conda packages.
2. postBuild is a script that contains commands to be run after the whole repository has been built. The one in this repository contains an example of creating an alias for a magic command that will be available to any notebook created after launch. Similarly you can add more magic commands or other ipython codes that will be executed before starting the notebook server, and can be used by all the notebooks in the repository.