Update and harmonize python installation instructions #800
Conversation
pmai
force-pushed
the
doc/python-setup-update
branch
from
5ef4910 to
ec1882e
Compare
| source venv/bin/activate | ||
| ---- | ||
| + | ||
| . Install Open Simulation Interface. | ||
| .. Local installation | ||
| + | ||
| ---- | ||
| python3 -m pip install . |
There was a problem hiding this comment.
I thought you only use it with the prefix: python3 -m pip*
There was a problem hiding this comment.
Only in specific circumstances (e.g. upgrading pip in place, or where there was a multitude of python installations 2 vs 3 - also somewhat ubuntu specific); on most systems pip install is the suggested way to do stuff, and generally is e.g. the way PyPI recommends it.
Both ways work, but as there already was a mixture between the two, I picked one to stay consistent.
| ---- | ||
| + | ||
| .. Global installation | ||
| + | ||
| ---- | ||
| sudo pip3 install . | ||
| sudo pip install . |
There was a problem hiding this comment.
I don't ;), but then I never install globally anyway.
More seriously: That was part of the existing instructions, and yes, if you want the package installed globally then you likely need root permissions on most systems. On Ubuntu e.g. if you do not have root permissions, it will just install for the user.
Not that I would recommend anything like that, hence the local installation is the first suggested one.
pmai
added
Bug
|
CCB 2024-05-06: Merge as-is. |
pmai
added
ReadyToMerge
Signed-off-by: Pierre R. Mai <[email protected]>
pmai
force-pushed
the
doc/python-setup-update
branch
from
d45eaf0 to
fd93999
Compare
Adjust python install instructions to be more uniform across platforms and to reflect availability of packages on PyPI.