Skip to content

Commit

Permalink
Merge from rebase
Browse files Browse the repository at this point in the history
  • Loading branch information
verbman committed May 20, 2024
2 parents 284f882 + 7d239fe commit b6d9b67
Showing 1 changed file with 1 addition and 27 deletions.
28 changes: 1 addition & 27 deletions source/installation/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,33 +14,7 @@ offline-environment
windows-no-admin
```

This section is a guide to the various methods of accessing or installing OpenFisca. Follow the guide below to establish what the use case is and get directed to the appropriate section(s).

## Install the OpenFisca-Country-Template to run or modify the source code

> This step requires the Python installation described above.
You will find the `OpenFisca-Country-Template` installation instruction in its README: see the [Install Instructions for Users and Contributors](https://github.com/openfisca/country-template#install-instructions-for-users-and-contributors).

Other OpenFisca models have their own documentation. You will find the existing repositories list on [this page of openfisca.org](https://openfisca.org/en/countries/) website.

## Test or install the OpenFisca-Country-Template Web API

You can call `OpenFisca-Country-Template` Web API without installing it by relying on the demonstration instance. Or install it on your local environment for further testing.

### Call a demonstration instance

OpenFisca community hosts a demonstration instance for the `OpenFisca-Country-Template` Web API.

Here is a [swagger interface](https://legislation.demo.openfisca.org/swagger) allowing you to interact with this Web API endpoints. For further information, [this section of the documentation](./../openfisca-web-api/endpoints.md) describes OpenFisca Web APIs endpoints.

### Run and call a local instance

> This step requires the Python installation described above.
To run a local instance of `OpenFisca-Country-Template` Web API, you need to:
1. install `OpenFisca-Country-Template` on your local environment as described by the [Install Instructions for Users and Contributors](https://github.com/openfisca/country-template#install-instructions-for-users-and-contributors) section of the README,
2. serve the Web API on your environment by running one command as described [here](https://github.com/openfisca/country-template#serve-this-country-package-with-the-openfisca-web-api).
This section is a guide to the various methods of accessing or installing OpenFisca. Follow the guide below to establish what the use case is and get directed to the appropriate section(s).

## 1) Identify the country package

Expand Down

0 comments on commit b6d9b67

Please sign in to comment.