This section provides instructions to run or modify the source code of the OpenFisca-Country-Template package.
These instructions should be able to be followed for any OpenFisca country package, just substitute the OpenFisca-Country-Template package with the relevant OpenFisca country package.
OpenFisca runs with Python. Its source code is managed with the Git version control software. The following steps call the pip package installer which requires a Python installation and a git command. To check their installation or install them, follow the Installation requirements section.
The OpenFisca-Country-Template installation instructions are in its README Advanced installation section.
💡 Other OpenFisca models have their own documentation. Check the existing repositories list on the Available Packages section of the openfisca.org website.
Generally when making changes to legislation, there is a need to test the changes with a situation that works with the country’s tax and benefit system.
Sometimes, these situations can be quite complicated to model. Instead of rewriting them everytime, they can be packaged in different formats:
As YAML tests when the expected output result should be registered.
As JSON requests when the output isn’t being tested. Refer to these examples in the OpenFisca-Country-Template repository. These can be adapted as requests to be sent to the OpenFisca web API.
As CSV or other data formats when there is a large number of situations to save.