@catala-lang/french-law

Programming language for literate programming law specification

https://github.com/catalalang/catala

Science Score: 54.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Committers with academic emails
    14 of 57 committers (24.6%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (11.9%) to scientific vocabulary

Keywords

legislative-texts programming-language

Keywords from Contributors

mesh cryptocurrencies tides parallel evolutionary-algorithms connection distribution hydrology transformers sequences
Last synced: 4 months ago · JSON representation ·

Repository

Programming language for literate programming law specification

Basic Info
  • Host: GitHub
  • Owner: CatalaLang
  • License: apache-2.0
  • Language: OCaml
  • Default Branch: master
  • Homepage: https://catala-lang.org
  • Size: 61.7 MB
Statistics
  • Stars: 2,095
  • Watchers: 21
  • Forks: 80
  • Open Issues: 84
  • Releases: 7
Topics
legislative-texts programming-language
Created over 5 years ago · Last pushed 4 months ago
Metadata Files
Readme Contributing License Citation Publiccode

README.md

Catala logo

Catala

Explore the docs »
Getting startedReport BugContributeJoin Zulip Chat

![CI][ci-link] [![Opam][opam-link]](https://opam.ocaml.org/packages/catala/) [![Licence][licence-link]](https://www.apache.org/licenses/LICENSE-2.0) ![Tag][tag-link] ![Language][language-link] [![Issues][issues-link]](https://github.com/CatalaLang/catala/issues) [![Contributors][contributors-link]](https://github.com/CatalaLang/catala/graphs/contributors) [![Activity][activity-link]](https://github.com/CatalaLang/catala/pulse) Catala is a domain-specific language for deriving faithful-by-construction algorithms from legislative texts. To learn quickly about the language and its features, you can jump right to the official [Catala tutorial](https://book.catala-lang.org/2-0-tutorial.html). You can join the Catala community on [Zulip][chat-link]!


Table of Contents * [Concepts](#concepts) * [The Catala book](#the-catala-book) * [IDE Extensions and Tooling](#ide-extensions-and-tooling) * [Syntax highlighting](#syntax-highlighting) * [Catala VScode extension](#catala-vscode-extension) * [Code formatting](#code-formatting) * [Documentation](#documentation) * [Syntax cheat sheet](#syntax-cheat-sheet) * [Formal semantics](#formal-semantics) * [Compiler documentation](#compiler-documentation) * [Examples](#examples) * [API](#api) * [Contributing](#contributing) * [Test suite](#test-suite) * [License](#license) * [Limitations and disclaimer](#limitations-and-disclaimer) * [Pierre Catala](#pierre-catala)

Concepts

Catala is a programming language adapted for socio-fiscal legislative literate programming. By annotating each line of the legislative text with its meaning 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 faithfulness.

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 article, in your favorite text editor :

Screenshot

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.

Screenshot

The Catala language is special because its logical structure mimics the logical structure of the law. Indeed, the core concept of "definition-under-conditions" that builds on default logic has been formalized by Professor Sarah Lawsky in her article A Logic for Statutes. 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 language perfectly adapted to literate legislative programming.

The Catala Book

The one-stop-shop for tutorials, installation instructions, FAQ and reference guide about Catala is the Catala book available at:

https://book.catala-lang.org

IDE Extensions and Tooling

Syntax highlighting

Syntax highlighting is available for several text-editors. Scripts can be found here.

Catala VSCode Extension

A VSCode extension for Catala is available on the marketplace. It bundles a syntax highlighter and a dedicated LSP server which offers support for code navigation, auto-completion along with a UX for test suites. See the dedicated repository for more details.

Code formatting

A code formatting tool, catala-format is available alongside the LSP server. If installed, code formatting is directly available in VSCode. This tool is based on a tree-sitter grammar for Catala. See the dedicated repository for more details.

Additional documentation items

Syntax cheat sheet

A complete and handy reference of the Catala syntax can be found in the cheat sheet (for French and English versions of the syntax).

Formal semantics

To audit the formal proof of the partial certification of the Catala compiler, see the dedicated readme.

Compiler documentation

The documentation is accessible online, both for the latest release and bleeding-edge version.

It is otherwise generated from the compiler source code using dune and odoc. Run

make doc

to generate the documentation, then open the doc/odoc.html file in any browser.

Examples

To explore the different programs written in Catala, see the dedicated readme.

API

To know how to use the code generated by the Catala compiler in your favorite programming language, head to the readme of the French law library. The corresponding pre-built examples are also available.

Contributing

To know how you can contribute to the project, see the dedicated readme.

Test suite

To know how to run or improve the Catala reference test suite, see the dedicated readme.

License

The compiler and all the code contained in this repository is released under the Apache license (version 2) unless another license is explicited for a sub-directory.

Limitations and disclaimer

Catala is a research project from Inria, the French National Research Institute for Computer Science. The compiler is yet unstable and lacks some of its features.

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, acting as the public service of legislative documentation.

Owner

  • Name: CatalaLang
  • Login: CatalaLang
  • Kind: organization

Citation (CITATION.cff)

# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
title: Catala
message: >-
  If you want to cite the Catala software in your
  scholarly work, please use the information in this
  file.
type: software
authors:
  - given-names: Denis
    family-names: Merigoux
    affiliation: Inria
  - given-names: Nicolas
    family-names: Chataing
    affiliation: "Inria, ENS"
  - given-names: Emile
    family-names: Rolley
  - given-names: Louis
    family-names: Gesbert
    affiliation: Inria
  - given-names: Raphaël
    family-names: Montat
    affiliation: Inria
  - given-names: Aymeric
    family-names: Fromherz
    affiliation: Inria
  - given-names: Alain
    family-names: Delaët-Tixeuil
    affiliation: "INRIA, ENS Lyon"
  - given-names: Lilya
    family-names: Slimani
  - given-name: Justine
    family-names: Banuls
  - given-name: Aminata
    family-names: Boiguillé
  - given-name: Vincent
    family-names: Botbol
    affiliation: Inria
  - given-name: Romain
    family-names: Primet
    affiliation: Inria
  - given-name: Sarah
    family-names: Lawsky
    affiliation: "University of Illinois - Urbana Champaign"
  - given-name: Jonathan
    family-names: Protzenko
    affiliation: Microsoft
  - given-name: Pierre
    family-names: Goutagny
    affiliation: Inria
  - given-name: Liane
    family-names: Huttner
    affiliation: "Université Paris-Saclay"
  - given-name: Samuel
    family-names: Avril
    affiliation: Inria
  - given-name: Marie
    family-names: Alauzen
    affiliation: "CNRS, Université Paris-Dauphine"
repository-code: "https://github.com/CatalaLang/catala"
url: "https://catala-lang.org/"
abstract: >-
  Catala is a domain-specific language for deriving
  faithful-by-construction algorithms from
  legislative texts.
license: Apache-2.0
version: 1.0.0~alpha
date-released: "2022-03-08"

GitHub Events

Total
  • Issues event: 81
  • Watch event: 103
  • Delete event: 63
  • Issue comment event: 115
  • Push event: 353
  • Pull request review comment event: 95
  • Pull request review event: 125
  • Pull request event: 133
  • Fork event: 5
  • Create event: 86
Last Year
  • Issues event: 81
  • Watch event: 103
  • Delete event: 63
  • Issue comment event: 115
  • Push event: 353
  • Pull request review comment event: 95
  • Pull request review event: 125
  • Pull request event: 133
  • Fork event: 5
  • Create event: 86

Committers

Last synced: 6 months ago

All Time
  • Total Commits: 4,003
  • Total Committers: 57
  • Avg Commits per committer: 70.228
  • Development Distribution Score (DDS): 0.589
Past Year
  • Commits: 450
  • Committers: 7
  • Avg Commits per committer: 64.286
  • Development Distribution Score (DDS): 0.3
Top Committers
Name Email Commits
Denis Merigoux d****x@g****m 1,647
Louis Gesbert l****t@o****m 1,069
EmileRolley e****y@t****m 261
adelaett 9****t 212
Aymeric Fromherz a****z@i****r 178
Alain a****n@i****r 116
vbot v****l@i****r 110
Nicolas Chataing n****g@e****r 76
Romain PRIMET r****t@i****r 44
Bartosz Woźniak b****0@g****m 30
Lilya Slimani l****e@g****m 28
lIlIlIlIIIIlIIIllIIlIllIIllIII l****I 26
Catala nix updated n****r@c****a 25
James Barnes 5****b 23
Raphaël Monat r****t@i****r 22
James Barnes 17
JusBanuls j****s@i****r 16
Aminata-Dev b****a@g****m 12
Raphaël Monat r****t@l****r 10
Jonathan Protzenko j****o@g****m 8
Hugo Gimbert h****t@c****r 7
Rohan Padhye r****e@c****u 5
armandsalek 8****k 5
Edwin Török e****n@e****t 4
Aida Ibrahim a****m@l****r 4
Denis Merigoux i****t@d****r 4
Faez Shakil f****l@g****m 3
Pierre Goutagny p****y@i****r 3
armandsalek a****d@s****c 3
Jean-Marc Le Roux j****x@a****n 2
and 27 more...

Issues and Pull Requests

Last synced: 4 months ago

All Time
  • Total issues: 191
  • Total pull requests: 411
  • Average time to close issues: 8 months
  • Average time to close pull requests: 16 days
  • Total issue authors: 21
  • Total pull request authors: 28
  • Average comments per issue: 1.49
  • Average comments per pull request: 0.96
  • Merged pull requests: 346
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 77
  • Pull requests: 145
  • Average time to close issues: 3 months
  • Average time to close pull requests: 8 days
  • Issue authors: 7
  • Pull request authors: 8
  • Average comments per issue: 0.97
  • Average comments per pull request: 0.81
  • Merged pull requests: 117
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • denismerigoux (101)
  • AltGr (37)
  • rprimet (16)
  • EmileRolley (6)
  • adelaett (6)
  • pierregoutagny (5)
  • rmonat (5)
  • JusBanuls (3)
  • vincent-botbol (2)
  • rohanpadhye (2)
  • msprotz (2)
  • BapMel (1)
  • JMLX42 (1)
  • bzg (1)
  • samestep (1)
Pull Request Authors
  • AltGr (230)
  • vincent-botbol (85)
  • denismerigoux (56)
  • adelaett (13)
  • rprimet (7)
  • EmileRolley (6)
  • armandsalek (5)
  • rohanpadhye (5)
  • pierregoutagny (5)
  • rmonat (4)
  • JMLX42 (3)
  • R1kM (3)
  • zapashcanon (2)
  • bzg (2)
  • Aminata-Dev (2)
Top Labels
Issue Labels
🔧 compiler (91) ✨ enhancement (78) ❓ invalid (33) 🏗️ build system (33) 💡 language (23) ❌ bug (22) 🤩 ide (17) 🔚 backends (16) 💬 discussion (15) 📘 documentation (14) 👌 good first issue (11) 👪 help wanted (9) ⚖️ program (6) ✅ proof (6) #️⃣ syntax (5) ℹ️ information (3) ➗ semantics (2) hackathon (2) :link: dependencies (1)
Pull Request Labels
🔧 compiler (47) ✨ enhancement (40) ❌ bug (23) 🏗️ build system (16) ⚖️ program (12) 📘 documentation (9) ❓ invalid (9) 🔚 backends (6) 🤩 ide (4) ✅ proof (3) ℹ️ information (2) 👌 good first issue (1) 💡 language (1) 🚧 wip (1)

Packages

  • Total packages: 2
  • Total downloads:
    • pypi 23 last-month
    • npm 18 last-month
  • Total dependent packages: 1
    (may contain duplicates)
  • Total dependent repositories: 2
    (may contain duplicates)
  • Total versions: 14
  • Total maintainers: 3
npmjs.org: @catala-lang/french-law

Library of computations defined by French legislative texts, extract from Catala programs (https://catala-lang.org)

  • Versions: 13
  • Dependent Packages: 1
  • Dependent Repositories: 2
  • Downloads: 18 Last month
Rankings
Stargazers count: 2.0%
Forks count: 3.4%
Dependent repos count: 7.6%
Average: 9.0%
Downloads: 10.9%
Dependent packages count: 20.9%
Maintainers (2)
Last synced: 4 months ago
pypi.org: catala-runtime

Runtime libraries needed to execute Catala programs compiled to Python

  • Versions: 1
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 23 Last month
Rankings
Dependent packages count: 10.1%
Average: 38.5%
Dependent repos count: 66.8%
Maintainers (2)
Last synced: 4 months ago

Dependencies

french_law/js/package-lock.json npm
  • benchmark 2.1.4
  • lodash 4.17.21
  • platform 1.3.6
french_law/js/package.json npm
  • benchmark ^2.1.4
  • lodash ^4.17.21
  • platform ^1.3.6
.github/workflows/run-builds.yml actions
  • actions/checkout v2.3.4 composite
  • cachix/install-nix-action v15 composite
.github/workflows/run-make-all.yml actions
  • actions/checkout v2 composite
  • actions/upload-artifact v3 composite
.github/workflows/update-flake-lock.yml actions
  • EndBug/add-and-commit v9 composite
  • actions/checkout v3 composite
  • cachix/install-nix-action v15 composite
Dockerfile docker
  • dev-build-context latest build
  • ocamlpro/ocaml 4.14-2022-07-17 build