Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update installation instructions #255

Closed
bonjourmauko opened this issue Oct 29, 2021 · 6 comments · Fixed by #306
Closed

Update installation instructions #255

bonjourmauko opened this issue Oct 29, 2021 · 6 comments · Fixed by #306
Assignees

Comments

@bonjourmauko
Copy link
Member

Currently, the documentation for installing OpenFisca "On Windows without admin rights" points to a 4 year-old version of https://github.com/openfisca/openfisca-france:

Capture d’écran 2021-10-29 à 12 12 44

I have the impression the whole section is outdated and misleading, and propose we either:

  • Replace it by « how to bootstrap a country »
  • Redirect to OpenFisca-Core and OpenFisca-Country-Template
  • Or both

Thanks to @JasonMorrisSC who filed the issue.

@MattiSG
Copy link
Member

MattiSG commented Oct 29, 2021

The whole “installing” section of the doc is misleading: there is no instruction at all on the standard, simple way to install, only workarounds for edge cases!

@sandcha
Copy link
Contributor

sandcha commented Feb 17, 2022

I agree that the whole installing section should be changed. 🙌

But why did we create this page? 🙀

Here is some context about the 3rd step that we mention in this issue: it was created for Windows users without admin rights on offline machines.
That's why it contains a package of the old wheels: this package was manually (and painfully) created. It was meant to be downloaded on an USB key to be carried to the offline machines. 😅

And now what? 🤔

Today, I think that offline machines are uncommon and that we can remove this use case to focus on the Windows users without admin rights. Do you agree?

Knowing that even a secure and offline environment like the CASD agrees to use conda packages.

Then, how can we install openfisca on Windows without admin rights? 🤯

The easiest installation instructions might differ from one country model to another:

  • openfisca-core and openfisca-france users can now be guided to a conda installation.
  • other models, as far as I know, don't have conda packages so the default pip installation might be the best option (works on online machines); this will also require a decision on the default terminal to choose (Default Windows cmd? GitBash? PowerShell? Windows WSL needs admin rights to be installed).

Meanwhile, what can we do?

A quick fix to the 3rd step could be to replace it with a title that specifies the country package (France, for now) and the following instructions (extract from an email):

You have installed GIT, Python 3.7 and Miniconda. All you need now is initializing conda configuration and downloading openfisca-france library (and dependencies).
Miniconda will allow you to do so:

First check that miniconda is fully installed and that you can call the "conda" command:

$ conda

It should return some documentation:

usage: conda [-h] [-V] command ...

conda is a tool for managing and deploying applications, environments and packages.
...

Then, if this first step ended without error, you can configure the conda-forge channel that will provide the libraries with:

$ conda config --add channels conda-forge && conda config --set channel_priority strict

From this step you can already install openfisca-france model but we advise you to create an isolated environment for your project in two commands (optional):

  • by creating a virtual environment (named "openfisca" for example):
$ conda create --name openfisca python=3.7
  • and activating this virtual environment with:
$ conda activate openfisca

Finally, you can install openfisca-france:

$ conda install openfisca-france

You are all set! And you can check the installed libraries with:

$ conda list

You can also exit the virtual environment at any moment when you don't need to use openfisca-france code with:

$ conda deactivate

These steps come from openfisca-france README. We could add the country-template to conda if we decide that conda is a good solution and knowing that the first step toward it was done (for openfisca-core conda package): the country-template deployment now posts a .tar.gz of the package on pypi.

@MattiSG MattiSG linked a pull request May 5, 2022 that will close this issue
@MattiSG MattiSG changed the title Update Windows installation instructions Update installation instructions Mar 10, 2024
@MattiSG
Copy link
Member

MattiSG commented Mar 10, 2024

To close this issue:

  1. Rebase Update default installation instructions #260.
  2. Proofread and complete Update default installation instructions #260 contents.
  3. Open a PR.
  4. 🚢

@verbman
Copy link
Contributor

verbman commented May 19, 2024

Noting that the presets page links to packages on Anaconda which are very out of date:
https://anaconda.org/search?q=openfisca-country-template

Is the intention to maintain these packages or remove them from Anaconda and from the documentation?

@MattiSG
Copy link
Member

MattiSG commented May 22, 2024

The Conda outdated packages would be solved by openfisca/country-template#124.

@MattiSG MattiSG linked a pull request May 22, 2024 that will close this issue
@MattiSG
Copy link
Member

MattiSG commented May 22, 2024

Done in #306!

@MattiSG MattiSG closed this as completed May 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Answer given / Dealt with
4 participants