Skip to content

Latest commit

 

History

History
80 lines (54 loc) · 2.71 KB

pew.md

File metadata and controls

80 lines (54 loc) · 2.71 KB
Raw

Setup Aotearoa OpenFisca in pew

Follow this installation if you wish to:

  • run calculations on a large population;
  • run your own instance of openfisca-aotearoa, but not modify the rules

Step 1: Install Python 3

This package requires Python 3 and pip .

Supported platforms:

  • GNU/Linux distributions (in particular Debian and Ubuntu);
  • Mac OS X;
  • Microsoft Windows (we recommend using ConEmu instead of the default console).

Other OS should work if they can execute Python and NumPy.

Step 2: Setup Pew

Setting-up a Virtual Environment with Pew

Create a virtual environment (abbreviated as "virtualenv") with a using pew.

  • A virtualenv is a project specific environment >created to suit the needs of the project you are working on.
  • A virtualenv manager, such as pew, lets you easily create, remove and toggle between several virtualenvs.

To install pew, launch a terminal on your computer and follow these instructions:

 python --version # You should have python 3.7 or better installed on your computer.
 # If not, visit http://www.python.org to install it and install pip as well.
pip install --upgrade pip
pip install pew  # if asked, answer "Y" to the question about modifying your shell config file.

To set-up and create a new a virtualenv named openfisca running python3.11:

pew new openfisca --python=python3.11

The virtualenv you just created will be automatically activated. This means you will operate in the virtualenv immediately. You should see a prompt resembling this:

Installing setuptools, pip, wheel...done.
Launching subshell in virtual environment. Type "exit" or 'Ctrl+D' to return.

Additional information:

  • Exit the virtualenv with exit (or Ctrl-D).
  • Re-enter with pew workon openfisca.

🎉 You are now ready to install this OpenFisca Country Package!

Step 3: Install this Country Package with Pip Install

Inside your virtualenv, check the prerequisites:

python --version  # should print at least "Python 3.11".
#if not, make sure you pass the python version as an argument when creating your virtualenv
pip --version  # should print at least 24.0.
#if not, run "pip install --upgrade pip"

Install the Country Package:

Note OpenFisca Aotearoa Pip package is currently out of date.

pip install openfisca_aotearoa

🎉 OpenFisca Aotearoa Package is now installed and ready, refer to the README.md for instructions on how to run tests or serve the web API.