Update and harmonize python installation instructions

OpenSimulationInterface · Apr 3, 2024 · 5ef4910 · 5ef4910
1 parent 138c6f1
commit 5ef4910
Show file tree

Hide file tree

Showing 2 changed files with 56 additions and 14 deletions.
diff --git a/doc/setup/installing_linux_python.adoc b/doc/setup/installing_linux_python.adoc
@@ -4,12 +4,31 @@ include::{root-path}_config.adoc[]
 endif::[]
 = Installing OSI for Python on Linux
 
+== Installing from PyPI
+
+Steps::
+
+. Open a terminal.
++
+. Optionally create and activate a new virtual environment.
++
+----
+python3 -m venv venv
+source venv/bin/activate
+----
++
+. Install Open Simulation Interface.
++
+----
+pip install open-simulation-interface
+----
+
+== Installing from source
+
 *Prerequisites::
 
 * You have installed everything described in <<top-installing-osi-prerequisits>>.
-* You have installed _pip3_.
-* You have installed _python-setuptools_.
-* For a local installation, you have installed _virtualenv_.
+* You have installed _pip_.
 
 Steps::
 
@@ -26,27 +45,22 @@ git clone https://github.com/OpenSimulationInterface/open-simulation-interface.g
 cd open-simulation-interface
 ----
 +
-. Create a new virtual environment.
-+
-----
-virtualenv -p python3 venv
-----
-+
-. Activate the virtual environment.
+. Optionally create and activate a new virtual environment.
 +
 ----
+python3 -m venv venv
 source venv/bin/activate
 ----
 +
 . Install Open Simulation Interface.
 .. Local installation
 +
 ----
-python3 -m pip install .
+pip install .
 ----
 +
 .. Global installation
 +
 ----
-sudo pip3 install .
+sudo pip install .
 ----
diff --git a/doc/setup/installing_windows_python.adoc b/doc/setup/installing_windows_python.adoc
@@ -4,6 +4,27 @@ include::{root-path}_config.adoc[]
 endif::[]
 = Installing OSI for Python on Windows
 
+== Installing from PyPI
+
+Steps::
+
+. Open a terminal.
++
+. Optionally create and activate a new virtual environment.
++
+----
+python -m venv venv
+venv\Scripts\activate
+----
++
+. Install Open Simulation Interface.
++
+----
+pip install open-simulation-interface
+----
+
+== Installing from source
+
 Prerequisites::
 
 * You have installed everything described in <<top-installing-osi-prerequisits>>.
@@ -25,8 +46,15 @@ git clone https://github.com/OpenSimulationInterface/open-simulation-interface.g
 cd open-simulation-interface
 ----
 +
-. Run the setup script.
+. Optionally create and activate a new virtual environment.
++
+----
+python -m venv venv
+venv\Scripts\activate
+----
++
+. Install Open Simulation Interface.
 +
 ----
-python setup.py install
+pip install .
 ----