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
Stop suggesting direct setting of PYTHONPATH in install instructions #138
Comments
@ketch, thanks for these links! I'm ok with not recommending PYTHONPATH, particularly in view of the various problems pointed out in relation to Python 2 vs. 3. I personally have still found PYTHONPATH to work fine for what I need, and much easier than pip for my use case where I have several versions for different projects / dual debugging, etc. (and mostly use the Fortran codes rather than pyclaw). But us developers who find this convenient can keep using PYTHONPATH without mentioning it in the install instructions. |
Probably not too surprising but I +1 this idea. I think for most people |
@rjleveque The instructions under http://www.clawpack.org/installing.html#install-from-a-tarfile say to python setup.py install in your $CLAW directory, but as far as I understand this is exactly equivalent to running pip install . there. Have you found those to give different results? Later we say
but this should not be necessary if you did |
With regards to @mjberger's issues with installation I think these are mostly addressed by using a combination of |
Setting PYTHONPATH directly is considered quite dangerous. For instance,
http://python-notes.curiousefficiency.org/en/latest/python_concepts/import_traps.html
says
A similar point is made in this tutorial.
We break this rule in our instructions, e.g. at http://www.clawpack.org/setenv.html#pythonpath.
I think that a lot of problems users run into are caused by this. I propose that we stop supporting or suggesting any installation that requires setting PYTHONPATH. This leaves two options:
Are there objections/counterarguments?
The text was updated successfully, but these errors were encountered: