You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,9 +17,9 @@ This package contains the core features of OpenFisca, which are meant to be used
17
17
18
18
## Environment
19
19
20
-
OpenFisca runs on Python 3.7. More recent versions should work, but are not tested.
20
+
OpenFisca runs on Python 3.7. More recent versions should work but are not tested.
21
21
22
-
OpenFisca also relies strongly on NumPy. Last four minor versions should work, but only latest/stable is tested.
22
+
OpenFisca also relies strongly on NumPy. The last four minor versions should work, but only the latest/stable is tested.
23
23
24
24
## Installation
25
25
@@ -54,7 +54,7 @@ Conda is the easiest way to use OpenFisca under Windows as by installing Anacond
54
54
- A virtual environment manager : [conda](https://docs.conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html)
55
55
- A GUI [Anaconda Navigator](https://docs.anaconda.com/anaconda/navigator/index.html) if you choose to install the full [Anaconda](https://www.anaconda.com/products/individual)
56
56
57
-
If you are familiar with command line you could use [Miniconda](https://docs.conda.io/projects/conda/en/latest/user-guide/install/windows.html), wich need very much less disk space than Anaconda.
57
+
If you are familiar with the command line you could use [Miniconda](https://docs.conda.io/projects/conda/en/latest/user-guide/install/windows.html), which needs very much less disk space than Anaconda.
58
58
59
59
After installing conda, run these commands in an `Anaconda Powershell Prompt`:
60
60
-`conda create --name openfisca python=3.7` to create an `openfisca` environment.
@@ -65,7 +65,7 @@ Then, choose one of the following options according to your use case:
65
65
- or `conda install -c conda-forge openfisca-core-api` if you want the Web API part,
66
66
- or `conda install -c conda-forge -c openfisca openfisca-core-dev` if you want all the dependencies needed to contribute to the project.
67
67
68
-
For informations on how we publish to conda-forge, see [openfisca-core-feedstock](https://github.com/openfisca/openfisca-core-feedstock/blob/master/recipe/README.md).
68
+
For information on how we publish to conda-forge, see [openfisca-core-feedstock](https://github.com/openfisca/openfisca-core-feedstock/blob/master/recipe/README.md).
69
69
70
70
## Testing
71
71
@@ -131,7 +131,7 @@ END
131
131
132
132
## Documentation
133
133
134
-
Yet however OpenFisca does not follow a common convention for docstrings, our current toolchain allows to check whether documentation builds correctly and to update it automatically with each contribution to this repository.
134
+
OpenFisca’s toolchain checks whether documentation builds correctly and updates it automatically with each contribution to this repository.
135
135
136
136
In the meantime, please take a look at our [contributing guidelines](CONTRIBUTING.md) for some general tips on how to document your contributions, and at our official documentation's [repository](https://github.com/openfisca/openfisca-doc/blob/master/README.md) to in case you want to know how to build it by yourself —and improve it!
4. Fix the offending problems —they could be in core, in the doc, or in both.
169
+
4. Fix the offending problems —they could be in core, in the doc, or both.
170
170
171
171
You can test-drive your fixes by checking that each change works as expected:
172
172
@@ -239,7 +239,7 @@ The tracker is activated when these two options are set:
239
239
240
240
*`--tracker-url`: An URL ending with `piwik.php`. It defines the Piwik instance that will receive the tracking information. To use the main OpenFisca Piwik instance, use `https://stats.data.gouv.fr/piwik.php`.
241
241
*`--tracker-idsite`: An integer. It defines the identifier of the tracked site on your Piwik instance. To use the main OpenFisca piwik instance, use `4`.
242
-
*`--tracker-token`: A string. It defines the Piwik API Authentification token to differentiate API calls based on the user IP. Otherwise, all API calls will seem to come from your server. The Piwik API Authentification token can be found in your Piwik interface, when you are logged.
242
+
*`--tracker-token`: A string. It defines the Piwik API Authentification token to differentiate API calls based on the user IP. Otherwise, all API calls will seem to come from your server. The Piwik API Authentification token can be found in your Piwik interface when you are logged in.
243
243
244
244
For instance, to run the Web API with the mock country package `openfisca_country_template` and the tracker activated, run:
0 commit comments