2020-05-15 16:57:32 +03:00
|
|
|
|
<center>
|
2020-12-14 12:59:15 +03:00
|
|
|
|
<img src="https://github.com/CatalaLang/catala/raw/master/doc/images/logo.png" alt="Catala logo" width="100"/>
|
2020-05-15 16:57:32 +03:00
|
|
|
|
</center>
|
|
|
|
|
|
2021-03-19 20:34:38 +03:00
|
|
|
|
# Catala [![Catala chat][chat-image]][chat-link] ![CI][ci-link] ![Opam][opam-link] ![Licence][licence-link] ![Tag][tag-link] ![LoC][loc-link] ![Language][language-link] ![Issues][issues-link] ![Contributors][contributors-link] ![Activity][activity-link]
|
2019-09-04 11:32:33 +03:00
|
|
|
|
|
2020-04-17 17:22:20 +03:00
|
|
|
|
Catala is a domain-specific language for deriving
|
2020-12-14 12:59:15 +03:00
|
|
|
|
faithful-by-construction algorithms from legislative texts. To learn quickly
|
2021-03-05 21:16:56 +03:00
|
|
|
|
about the language and its features, you can jump right to the official
|
2020-12-14 12:59:15 +03:00
|
|
|
|
[Catala tutorial](https://catala-lang.org/en/examples/tutorial).
|
2021-03-19 20:34:38 +03:00
|
|
|
|
You can join the Catala community on [Zulip][chat-link]!
|
2021-01-05 21:05:29 +03:00
|
|
|
|
|
2020-04-17 17:22:20 +03:00
|
|
|
|
## Concepts
|
|
|
|
|
|
2020-12-14 12:59:15 +03:00
|
|
|
|
Catala is a programming language adapted for socio-fiscal legislative literate
|
|
|
|
|
programming. By annotating each line of the legislative text with its meaning
|
2021-03-05 21:16:56 +03:00
|
|
|
|
in terms of code, one can derive an implementation of complex socio-fiscal
|
|
|
|
|
mechanisms that enjoys a high level of assurance regarding the code-law
|
2020-12-14 12:59:15 +03:00
|
|
|
|
faithfulness.
|
2020-04-17 17:22:20 +03:00
|
|
|
|
|
2021-03-05 21:16:56 +03:00
|
|
|
|
Concretely, you have to first gather all the laws, executive orders, previous
|
|
|
|
|
cases, etc. that contain information about the socio-fiscal mechanism that
|
|
|
|
|
you want to implement. Then, you can proceed to annotate the text article by
|
2020-12-14 12:59:15 +03:00
|
|
|
|
article, in your favorite text editor :
|
2020-04-17 17:22:20 +03:00
|
|
|
|
|
2020-05-15 16:57:32 +03:00
|
|
|
|
<center>
|
2021-03-10 20:36:10 +03:00
|
|
|
|
<img src="https://github.com/CatalaLang/catala/raw/master/doc/images/ScreenShotVSCode.png" alt="Screenshot" height="450"/>
|
2020-05-15 16:57:32 +03:00
|
|
|
|
</center>
|
2020-04-17 17:22:20 +03:00
|
|
|
|
|
|
|
|
|
Once your code is complete and tested, you can use the Catala
|
|
|
|
|
compiler to produce a lawyer-readable PDF version of your
|
|
|
|
|
implementation. The Catala language has been specially designed
|
|
|
|
|
in collaboration with law professionals to ensure that the code
|
|
|
|
|
can be reviewed and certified correct by the domain experts, which
|
|
|
|
|
are in this case lawyers and not programmers.
|
|
|
|
|
|
2020-05-15 16:57:32 +03:00
|
|
|
|
<center>
|
2021-03-10 17:15:47 +03:00
|
|
|
|
<img src="https://github.com/CatalaLang/catala/raw/master/doc/images/CatalaScreenShot.png" alt="Screenshot" height="400"/>
|
2020-05-15 16:57:32 +03:00
|
|
|
|
</center>
|
2020-04-17 17:22:20 +03:00
|
|
|
|
|
|
|
|
|
The Catala language is special because its logical structure mimics
|
|
|
|
|
the logical structure of the law. Indeed, the core concept of
|
2021-03-05 21:16:56 +03:00
|
|
|
|
"definition-under-conditions" that builds on default logic has been formalized
|
2021-03-19 20:34:38 +03:00
|
|
|
|
by Professor Sarah Lawsky in her article
|
2021-03-05 21:16:56 +03:00
|
|
|
|
[A Logic for Statutes](https://papers.ssrn.com/sol3/papers.cfm?abstract_id=3088206).
|
|
|
|
|
The Catala language is the only programming language to our knowledge that
|
|
|
|
|
embeds default logic as a first-class feature, which is why it is the only
|
2020-12-14 12:59:15 +03:00
|
|
|
|
language perfectly adapted to literate legislative programming.
|
2020-04-17 17:22:20 +03:00
|
|
|
|
|
2020-12-21 18:02:00 +03:00
|
|
|
|
## Building and installation
|
2020-04-17 17:22:20 +03:00
|
|
|
|
|
2021-03-19 20:38:57 +03:00
|
|
|
|
Catala is available as an [opam package](https://opam.ocaml.org/packages/catala/)!
|
|
|
|
|
If opam is installed on your machine, simply execute:
|
|
|
|
|
|
|
|
|
|
opam install catala
|
|
|
|
|
|
2021-04-13 19:35:04 +03:00
|
|
|
|
To get the cutting-edge, latest version of Catala, you
|
|
|
|
|
can also do
|
|
|
|
|
|
|
|
|
|
opam pin add catala --dev-repo
|
|
|
|
|
|
2021-03-19 20:38:57 +03:00
|
|
|
|
However, if you wish to get the latest developments of the compiler, you probably
|
|
|
|
|
want to compile it from the sources of this repository. For that, see
|
|
|
|
|
[the dedicated readme](INSTALL.md).
|
2020-04-17 17:22:20 +03:00
|
|
|
|
|
2020-12-21 18:02:00 +03:00
|
|
|
|
## Usage
|
|
|
|
|
|
2021-03-05 21:16:56 +03:00
|
|
|
|
Use `catala --help` to get more information about the command line
|
2020-12-21 18:02:00 +03:00
|
|
|
|
options available.
|
|
|
|
|
|
2021-03-05 21:16:56 +03:00
|
|
|
|
The top-level `Makefile` contains a lot of useful targets to run. To display
|
|
|
|
|
them, use
|
|
|
|
|
|
|
|
|
|
make help
|
|
|
|
|
|
2020-12-14 12:59:15 +03:00
|
|
|
|
## Examples
|
2020-04-17 17:22:20 +03:00
|
|
|
|
|
2020-12-14 12:59:15 +03:00
|
|
|
|
See [the dedicated readme](examples/README.md).
|
2020-04-17 17:22:20 +03:00
|
|
|
|
|
2020-12-14 12:59:15 +03:00
|
|
|
|
## Contributing
|
2020-04-17 17:22:20 +03:00
|
|
|
|
|
2020-12-14 12:59:15 +03:00
|
|
|
|
See [the dedicated readme](CONTRIBUTING.md).
|
2020-04-27 11:04:13 +03:00
|
|
|
|
|
2020-12-14 12:59:15 +03:00
|
|
|
|
## Test suite
|
2020-04-27 11:04:13 +03:00
|
|
|
|
|
2020-12-14 12:59:15 +03:00
|
|
|
|
See [the dedicated readme](tests/README.md).
|
2020-04-27 11:04:13 +03:00
|
|
|
|
|
2020-12-14 12:59:15 +03:00
|
|
|
|
## Documentation
|
2020-04-17 17:22:20 +03:00
|
|
|
|
|
2021-03-05 21:16:56 +03:00
|
|
|
|
### Formal semantics
|
2020-04-17 17:22:20 +03:00
|
|
|
|
|
2020-12-14 12:59:15 +03:00
|
|
|
|
See [the dedicated readme](doc/formalization/README.md).
|
2020-04-17 17:22:20 +03:00
|
|
|
|
|
2020-12-14 12:59:15 +03:00
|
|
|
|
### Compiler documentation
|
2020-04-17 17:22:20 +03:00
|
|
|
|
|
2021-03-05 21:16:56 +03:00
|
|
|
|
The compiler documentation is auto-generated from its source code using
|
|
|
|
|
`dune` and `odoc`. Use
|
|
|
|
|
|
2020-12-14 20:09:38 +03:00
|
|
|
|
make doc
|
|
|
|
|
|
|
|
|
|
to generate the documentation, then open the `doc/odoc.html` file in any browser.
|
2021-03-19 20:34:38 +03:00
|
|
|
|
The documentation is also accessible [online](https://catala-lang.org/ocaml_docs/).
|
2020-04-17 17:22:20 +03:00
|
|
|
|
|
2020-12-14 12:59:15 +03:00
|
|
|
|
## License
|
2020-08-07 18:37:28 +03:00
|
|
|
|
|
2020-12-14 12:59:15 +03:00
|
|
|
|
The library is released under the [Apache license (version 2)](LICENSE.txt).
|
2020-08-07 18:37:28 +03:00
|
|
|
|
|
2020-12-14 12:59:15 +03:00
|
|
|
|
## Limitations and disclaimer
|
2020-04-17 14:02:15 +03:00
|
|
|
|
|
2020-12-14 12:59:15 +03:00
|
|
|
|
Catala is a research project from Inria, the French National
|
2021-03-05 21:16:56 +03:00
|
|
|
|
Research Institute for Computer Science. The compiler is yet
|
|
|
|
|
unstable and lacks some of its features.
|
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 l’information 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,
|
2020-04-17 14:02:15 +03:00
|
|
|
|
acting as the public service of legislative documentation.
|
2021-03-19 20:34:38 +03:00
|
|
|
|
|
|
|
|
|
[chat-image]: https://img.shields.io/badge/zulip-join_chat-blue.svg?style=social&logo=zulip&color=5c75a2
|
|
|
|
|
[chat-link]: https://zulip.catala-lang.org/
|
|
|
|
|
[ci-link]: https://github.com/catalalang/catala/actions/workflows/build.yml/badge.svg
|
|
|
|
|
[licence-link]: https://img.shields.io/github/license/catalalang/catala
|
|
|
|
|
[tag-link]: https://img.shields.io/github/v/tag/catalalang/catala
|
|
|
|
|
[loc-link]: https://img.shields.io/tokei/lines/github/catalalang/catala
|
|
|
|
|
[issues-link]: https://img.shields.io/github/issues/catalalang/catala
|
|
|
|
|
[opam-link]: https://img.shields.io/badge/Package-opam-orange?logo=OCaml&link=https://opam.ocaml.org/packages/catala/
|
|
|
|
|
[language-link]: https://img.shields.io/github/languages/top/catalalang/catala
|
|
|
|
|
[contributors-link]: https://img.shields.io/github/contributors/catalalang/catala
|
|
|
|
|
[activity-link]: https://img.shields.io/github/commit-activity/m/catalalang/catala
|