catala/README.md

43 lines
1.7 KiB
Markdown
Raw Normal View History

2020-04-16 18:47:35 +03:00
# Catala
2019-09-04 11:32:33 +03:00
2020-04-16 18:47:35 +03:00
Catala is a domain-specific language for deriving faithful-by-construction algorithms
2020-03-08 08:54:35 +03:00
from legislative texts.
2019-09-04 11:32:33 +03:00
2020-03-08 08:54:35 +03:00
## Installation
2019-09-04 11:32:33 +03:00
The project is distributed as a Dune artifact. Use standard dune commands to build
2019-09-04 12:02:49 +03:00
and install the library. In particular, if you want to install the library as an opam
package, use the following command at the root of the repository:
opam install ./
2020-04-16 18:47:35 +03:00
You can then can the compiler using the `catala` command.
2020-03-08 08:54:35 +03:00
## Usage
2020-04-16 18:47:35 +03:00
Use `catala --help` to get more information about the command line options available.
2020-03-08 08:54:35 +03:00
## Test
In the `test` folder, you will find the `allocations_familiales.lsp` file which contains the
algorithm computing French family benefits. The algorithm consists of annotations to the legislative
2020-04-16 18:47:35 +03:00
texts that define the family benetifs, using the literate programming paradigm. The `catala`
2020-03-08 08:54:35 +03:00
compiler can extract from the `.lsp` file a lawyer-readable version of the annotated text.
To get that lawyer-readable version (which is a LaTeX-created) PDF, use `make test` at the root of
the repository, and then use `make` inside ghe `test` directory to compile the LaTeX file.
2019-09-04 11:32:33 +03:00
## License
The library is released under the Apache license (version 2).
2020-04-16 19:58:05 +03:00
## Pierre Catala
The language is named after Pierre Catala, a professor of law who
pionneered the French legaltech by creating a computer database of law cases,
Juris-Data. The research group that he led in the late 1960s, the
Centre détudes et de traitement de linformation juridique (CETIJ),
has also influenced the creation by state conselor Lucien Mehl of the
Centre de recherches et développement en informatique juridique (CENIJ),
which eventually transformed into the entity managing the LegiFrance website,
acting as the public service of legislative documentation.