Skip to content

Latest commit

 

History

History
183 lines (136 loc) · 8.16 KB

README.md

File metadata and controls

183 lines (136 loc) · 8.16 KB
Raw

Isabelle/DOF: Document Preparation Setup

Isabelle/DOF is a novel Document Ontology Framework on top of Isabelle. Isabelle/DOF allows for both conventional typesetting and formal development.

Pre-requisites

Isabelle/DOF has two major prerequisites:

Installation

Isabelle/DOF is available as part of the Archive of Formal Proofs (AFP). This is the most convenient way to install Isabelle/DOF for the latest official release of Isabelle.

Installation from the Archive of Formal Proofs (AFP)

Isabelle/DOF is available in the AFP. Hence, for using Isabelle/DOF with the latest official released version of Isabelle, please download the Isabelle distribution for your operating system from the Isabelle website. Furthermore, please install the AFP following the instructions given at https://www.isa-afp.org/help.html.

Isabelle/DOF is provided as one AFP entry:

  • Isabelle_DOF: This entry contains the Isabelle/DOF system itself, including the Isabelle/DOF manual.

Installation of the Development Version (Git Repository)

The development version of Isabelle/DOF that is available in this Git repository provides, over the AFP version, additional ontologies, document templates, and examples that might not yet “ready for general use”. Furthermore, as it is provided as an Isabelle component, it can also provide additional tools that cannot be distributed via the AFP. As this repository provides a (potentially) updated version of Isabelle/DOF, it conflicts with a complete installation of the AFP. For more details on installing the development version, please consult the README_DEVELOPMENT.md file.

After installing the prerequisites, change into the directory containing Isabelle/DOF (this should be the directory containing this README.md file) and execute the following command for building the standard sessions of Isabelle/DOF:

foo@bar:~$ isabelle build -D . -x Isabelle_DOF-Proofs -x HOL-Proofs

This will compile Isabelle/DOF and run the example suite.

For building the session Isabelle_DOF-Proofs, the timeout might need to increased to avoid timeouts during building the dependencies:

foo@bar:~$ isabelle build -d . -o 'timeout_scale=2' Isabelle_DOF-Proofs

Usage

In the following, we assume that you installed Isabelle/DOF either from the AFP (adding the AFP as a component to your Isabelle system) or from the Git repository of Isabelle/DOF (installing Isabelle/DOF as a component to your Isabelle system).

Assuming that your current directory contains the example academic paper in the subdirectory Isabelle_DOF-Example-I/, you can open it similar to any standard Isabelle theory:

isabelle jedit -l Isabelle_DOF Isabelle_DOF-Example-I/IsaDofApplications.thy

This will open an example of a scientific paper using the pre-compiled session Isabelle_DOF, i.e., you will not be able to edit the default ontologies defined in the Isabelle_DOF session. If you want to edit the ontology definition, just open the theory file with the session Functional-Automata:

isabelle jedit -l Functional-Automata Isabelle_DOF-Example-I/IsaDofApplications.thy

While this gives you more flexibility, it might "clutter" your editing experience, as a lot of internal theories are loaded into Isabelle's editor.

Repository Structure

The main branch of this repository is developed using the latest official release of Isabelle. This is also the main development branch. In addition, he [isabelle_nightly](https://git.logicalhacking.com/Isabelle_DOF/Isabelle_DOF/src/branch/isabelle_nightly) branch is used for testing Isabelle/DOF with the latest development version of Isabelle.

This repository is structured into several Isabelle sessions, each of which is stored in a subdirectory:

  • Isabelle_DOF: This is the main session, providing the Isabelle/DOF system. Furthermore, this session is currently under consideration for a submission to the AFP.
  • Isabelle_DOF-Example-I: This session provides an example document written Isabelle/DOF. It only requires the core ontologies provided by the Isabelle_DOF session. Furthermore, this session is currently under consideration for a submission to the AFP.
  • Isabelle_DOF-Ontologies: This session provided additional ontologies and document templates.
  • Isabelle_DOF-Unit-Tests: This session includes various tests for the Isabelle/DOF system, partly depending on the ontologies provided by the Isabelle_DOF-Ontologies session.
  • Isabelle_DOF-Examples-Extra: This directory contains additional example documents written using the Isabelle/DOF systems, each of which is defined in an own subdirectory.
  • Isabelle_DOF-Proofs: This session provides the Isabelle/DOF systems with proof objects. This is required for the deep ontology embedding.

Releases

For releases, signed archives including a PDF version of the Isabelle/DOF manual are available. The latest release is Isabelle/DOF 1.3.0/Isabelle2021-1:

Older releases are available here.

Team

Main contacts:

Contributors

  • Idir Ait-Sadoune
  • Paolo Crisafulli
  • Chantal Keller
  • Nicolas Méric

License

This project is licensed under a 2-clause BSD license.

SPDX-License-Identifier: BSD-2-Clause

Publications

Upstream Repository

The upstream git repository, i.e., the single source of truth, for this project is hosted at https://git.logicalhacking.com/Isabelle_DOF/Isabelle_DOF.