Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion source/coding-the-legislation/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,8 @@ bootstrapping_a_new_country_package
```

Now let's think practical. The following tutorial and documentation offer you an overview of OpenFisca principles.
> If you want to try OpenFisca quickly by yourselves in a [Jupyter Notebook](https://jupyter.org/), please read the tutorials [here](http://mybinder.org/repo/openfisca/tutorial).

> If you want to try OpenFisca quickly by yourself in a [Jupyter Notebook](https://jupyter.org/), please read the [tutorials](http://mybinder.org/repo/openfisca/tutorial).

## Tutorial

Expand Down
2 changes: 1 addition & 1 deletion source/coding-the-legislation/writing_yaml_tests.md
Original file line number Diff line number Diff line change
Expand Up @@ -183,7 +183,7 @@ You can find examples of YAML tests of tax and benefit systems with reforms appl

## Running a test

To run YAML tests, use the command line tool `openfisca test`, documented [here](../../openfisca-python-api/openfisca_test):
To run YAML tests, use the command line tool [`openfisca test`](../../openfisca-python-api/openfisca_test):

```sh
openfisca test path/to/file.yaml
Expand Down
2 changes: 1 addition & 1 deletion source/contribute/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ From the point of view of someone (developer, economist, etc.) who wants to impl
- understand the part of the legislation you want to implement
- identify the variable dependencies using the [legislation explorer](https://fr.openfisca.org/legislation/)
- identify the new variables you need to implement
- write the new variables with their formulas, and make sure their names respect the guidelines you can find [here](./variables-naming.md).
- write the new variables with their formulas, and make sure their names abide by the [guidelines](./variables-naming.md)
- store the new parameters
- if you implement a part of the official legislation, your code should go in OpenFisca-France, but if you implement a new idea or a future reform, your code should go in a reform.

Expand Down
7 changes: 3 additions & 4 deletions source/installation/install-country-web-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,9 @@ These instructions are for installing an OpenFisca country package in a local en

## Run and call a local web API

OpenFisca runs with [Python](https://www.python.org/). If it's not installed in the environment, check the [Installation requirements](installation-requirements.md#install-python) section.
OpenFisca runs with [Python](https://www.python.org/). If that language is not available in your environment, check the [Installation requirements](installation-requirements.md#install-python) section.

To run a local `OpenFisca-Country-Template` web API:

1. Install the `OpenFisca-Country-Template` in the local environment as described by it's `README` [Install Instructions for Users and Contributors](https://github.com/openfisca/country-template#install-instructions-for-users-and-contributors) section,

2. Serve the web API on your environment by running the one command described [here](https://github.com/openfisca/country-template#serve-this-country-package-with-the-openfisca-web-api).
1. [Install](https://github.com/openfisca/country-template#install-instructions-for-users-and-contributors) the `OpenFisca-Country-Template` package in your local environment.
2. [Serve the web API](https://github.com/openfisca/country-template#serve-this-country-package-with-the-openfisca-web-api) in your environment.
Binary file not shown.
Binary file not shown.
130 changes: 52 additions & 78 deletions source/training/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,126 +6,100 @@
kickoff
session1
session2
session3
session4
session5
session6
session7
session8
```

## Slide decks
## Training program

### [Pre Training: Kick-off](./kickoff.md)
The videos of the training sessions were recorded as part of the 2024 Cohort of the EU [GovTech4All](https://interoperable-europe.ec.europa.eu/collection/govtechconnect/govtech4all) program.

An initial get together to ensure everyone has the appropriate tools and understanding to start the training.

### [Session 1: RaC Background](./session1.md)

A background to rules-as-code and how it fits with existing practices.

### [Session 2: Getting started](./session2.md)

Clone the country template, setup a public git repository.

### [Session 3: Modelling legislation​](./session3.md)

_#TODO (Contributions welcomed)_

Variables, formulas, parameters and test suites

### [Session 4: Using the web API​](./session4.md)

_#TODO (Contributions welcomed)_

Examples and guidance

### [Session 5: Using the Python API​](./session5.md)

_#TODO (Contributions welcomed)_
### Pre Training: Kick-off

Examples and guidance
An initial get together to ensure everyone has the appropriate tools and understanding to start the training.

### [Session 6: Data interconnection​​](./session6.md)
- [Slide deck](./kickoff.md).
- [Augmented video](https://webinaire.bbb-dinum-scalelite.visio.education.fr/playback/presentation/2.3/8a90c519e4ee59747cef18db09714b2ddac0e8b9-1715760590666) with chapters and chat interactions.
- [Downloadable video](https://cloud.openfisca.org/s/582X5QjoZ6CjTmF?dir=undefined&openfile=8096).

_#TODO (Contributions welcomed)_
### Session 1: Rules as Code Background

How to run simulations with large and small datasets
A background to rules-as-code and how it fits with existing practices.

### [Session 7: Updating the model​​](./session7.md)
- [Slide deck](./session1.md).
- [Augmented video](https://webinaire.bbb-dinum-scalelite.visio.education.fr/playback/presentation/2.3/8a90c519e4ee59747cef18db09714b2ddac0e8b9-1716360868420) with chapters and chat interactions.
- [Downloadable video](https://cloud.openfisca.org/s/582X5QjoZ6CjTmF?dir=undefined&openfile=8178).

_#TODO (Contributions welcomed)_
### Session 2: Getting started

Building a historically accurate model
Clone the country template, setup a public git repository.

### [Session 8: Designing policy​​​](./session8.md)
- [Slide deck](./session2.md).
- [Augmented video](https://webinaire.bbb-dinum-scalelite.visio.education.fr/playback/presentation/2.3/8a90c519e4ee59747cef18db09714b2ddac0e8b9-1716532557643) with chapters and chat interactions.
- [Downloadable video](https://cloud.openfisca.org/s/582X5QjoZ6CjTmF?dir=undefined&openfile=8178).

_#TODO (Contributions welcomed)_
### Session 3: Modelling legislation

OpenFisca reforms
Variables, formulas, parameters and test suites.

## Videos
- [Augmented video](https://webinaire.bbb-dinum-scalelite.visio.education.fr/playback/presentation/2.3/8a90c519e4ee59747cef18db09714b2ddac0e8b9-1716965399220) with chapters and chat interactions.
- [Downloadable video](https://cloud.openfisca.org/s/582X5QjoZ6CjTmF?dir=undefined&openfile=8176).

These training sessions were recorded as part of the 2024 Cohort of the EU [GovTech4All](https://interoperable-europe.ec.europa.eu/collection/govtechconnect/govtech4all) program.
### Session 4: Using the web API

### Pre Training: Kick-off
Examples and guidance.

- [Augmented version](https://webinaire.bbb-dinum-scalelite.visio.education.fr/playback/presentation/2.3/8a90c519e4ee59747cef18db09714b2ddac0e8b9-1715760590666).
- [Downloadable video](https://cloud.openfisca.org/s/582X5QjoZ6CjTmF?dir=undefined&openfile=8096).
- [Augmented video](https://webinaire.bbb-dinum-scalelite.visio.education.fr/playback/presentation/2.3/8a90c519e4ee59747cef18db09714b2ddac0e8b9-1718172092967) with chapters and chat interactions.
- [Downloadable video](https://cloud.openfisca.org/s/582X5QjoZ6CjTmF?dir=undefined&openfile=8218).

### Session 1: RaC Background
### Session 5: Using the Python API

- [Augmented version](https://webinaire.bbb-dinum-scalelite.visio.education.fr/playback/presentation/2.3/8a90c519e4ee59747cef18db09714b2ddac0e8b9-1716360868420).
- [Downloadable video](https://cloud.openfisca.org/s/582X5QjoZ6CjTmF?dir=undefined&openfile=8178).
Examples and guidance.

### Session 2: Getting started
- [Augmented video](https://webinaire.bbb-dinum-scalelite.visio.education.fr/playback/presentation/2.3/8a90c519e4ee59747cef18db09714b2ddac0e8b9-1718779000584) with chapters and chat interactions.

- [Augmented version](https://webinaire.bbb-dinum-scalelite.visio.education.fr/playback/presentation/2.3/8a90c519e4ee59747cef18db09714b2ddac0e8b9-1716532557643).
- [Downloadable video](https://cloud.openfisca.org/s/582X5QjoZ6CjTmF?dir=undefined&openfile=8178).

### Session 3: Algorithmic transparency
## Modelling collaboratively across silos and disciplines

- [Augmented version](https://webinaire.bbb-dinum-scalelite.visio.education.fr/playback/presentation/2.3/8a90c519e4ee59747cef18db09714b2ddac0e8b9-1716965399220).
- [Downloadable video](https://cloud.openfisca.org/s/582X5QjoZ6CjTmF?dir=undefined&openfile=8176).
A presentation highlighting the need for collaborative modelling in order to deliver a complete model, the difficulties in achieving it and the ways in which OpenFisca supports that goal.

### Session 4: Using the web API
- [Online version](./OpenFisca-Modelling-collaboratively-across-silos-and-disciplines-March-2025-online.pdf) for reading on your own.
- [Full presentation](./OpenFisca-Modelling-collaboratively-across-silos-and-disciplines-March-2025.pdf) with more intermediary steps for in-person delivery by trainers.

- [Augmented version](https://webinaire.bbb-dinum-scalelite.visio.education.fr/playback/presentation/2.3/8a90c519e4ee59747cef18db09714b2ddac0e8b9-1718172092967).
- [Downloadable video](https://cloud.openfisca.org/s/582X5QjoZ6CjTmF?dir=undefined&openfile=8218).
## Building an OpenFisca-powered web application

### Session 5: Using the Python API
A workshop guiding through building a web application from scratch to provide a graphical user interface over the [web API](../openfisca-web-api/index.md) of the [Country Template](https://github.com/openfisca/country-template/) demonstration model.

- [Augmented version](https://webinaire.bbb-dinum-scalelite.visio.education.fr/playback/presentation/2.3/8a90c519e4ee59747cef18db09714b2ddac0e8b9-1718779000584).
### Session 1: Introduction to the Web API

## Workshops
- [Step-by-step guide](https://github.com/redte-ch/ReDistributeMe/blob/main/workshop/01-introduction.md).

### Building an OpenFisca-powered web application
### Session 2: Web App Bootstrap

A workshop created by Mauko Quiroga, building a web application from scratch to provide a graphical user interface over the [web API](../openfisca-web-api/index.md) of the [Country Template](https://github.com/openfisca/country-template/) demonstration model.
- [Step-by-step guide](https://github.com/redte-ch/ReDistributeMe/blob/main/workshop/02-app-bootstrap.md).

#### Session 1: Introduction to the Web API
### Session 3: Calculate Income Tax With Svelte

- [Step-by-step guide](https://github.com/redte-ch/ReDistributeMe/blob/main/workshop/01-introduction.md)
- [Calculate a variable for an individual](https://github.com/redte-ch/ReDistributeMe/blob/main/workshop/03-calculate-income-tax-1.md).
- [Recalculate a variable for an individual](https://github.com/redte-ch/ReDistributeMe/blob/main/workshop/03-calculate-income-tax-2.md).

#### Session 2: Web App Bootstrap
### Session 4: Calculate Disposable Income With React

- [Step-by-step guide](https://github.com/redte-ch/ReDistributeMe/blob/main/workshop/02-app-bootstrap.md)
- [Calculate a variable for a group of individuals](https://github.com/redte-ch/ReDistributeMe/blob/main/workshop/04-calculate-disposable-income-1.md).
- [Recalculate a variable for a group of individuals](https://github.com/redte-ch/ReDistributeMe/blob/main/workshop/04-calculate-disposable-income-2.md).

#### Session 3: Calculate Income Tax With Svelte
### Session 5: Expand Disposable Income Over Axes With VueJS and D3

- [Calculate a variable for an individual](https://github.com/redte-ch/ReDistributeMe/blob/main/workshop/03-calculate-income-tax-1.md)
- [Recalculate a variable for an individual](https://github.com/redte-ch/ReDistributeMe/blob/main/workshop/03-calculate-income-tax-2.md)
- [Expand a variable over axes](https://github.com/redte-ch/ReDistributeMe/blob/main/workshop/05-expand-disposable-income-over-axes.md).

#### Session 4: Calculate Disposable Income With React

- [Calculate a variable for a group of individuals](https://github.com/redte-ch/ReDistributeMe/blob/main/workshop/04-calculate-disposable-income-1.md)
- [Recalculate a variable for a group of individuals](https://github.com/redte-ch/ReDistributeMe/blob/main/workshop/04-calculate-disposable-income-2.md)
## Credit

#### Session 5: Expand Disposable Income Over Axes With VueJS and D3
### Authors

- [Expand a variable over axes](https://github.com/redte-ch/ReDistributeMe/blob/main/workshop/05-expand-disposable-income-over-axes.md)
- The training program was co-created by Hamish Fraser and Matti Schneider.
- The “Building an OpenFisca-powered web application” workshop was created by Mauko Quiroga.
- The “Modelling collaboratively across silos and disciplines” presentation was created by Thomas Guillet.

## Credit
### Funders

These training materials were co-funded by the French Interministerial Direction for Digital Affairs ([DINUM](https://www.numerique.gouv.fr)) and the European Commission under the [GovTech4All](https://interoperable-europe.ec.europa.eu/collection/govtechconnect/govtech4all) program.

Expand Down
28 changes: 0 additions & 28 deletions source/training/session3.md

This file was deleted.

28 changes: 0 additions & 28 deletions source/training/session4.md

This file was deleted.

28 changes: 0 additions & 28 deletions source/training/session5.md

This file was deleted.

28 changes: 0 additions & 28 deletions source/training/session6.md

This file was deleted.

28 changes: 0 additions & 28 deletions source/training/session7.md

This file was deleted.

28 changes: 0 additions & 28 deletions source/training/session8.md

This file was deleted.