diff --git a/doc/setup/installing_linux_python.adoc b/doc/setup/installing_linux_python.adoc index b1b84a32c..de234498f 100644 --- 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 <>. -* You have installed _pip3_. -* You have installed _python-setuptools_. -* For a local installation, you have installed _virtualenv_. +* You have installed _pip_. Steps:: @@ -26,15 +45,10 @@ 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 ---- + @@ -42,11 +56,11 @@ source venv/bin/activate .. 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 index ecb3d31cf..37a2bba30 100644 --- 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 <>. @@ -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 . ----