Skip to content

Commit f479d99

Browse files
authored
Merge pull request #800 from OpenSimulationInterface/doc/python-setup-update
Update and harmonize python installation instructions
2 parents af8049b + fd93999 commit f479d99

File tree

2 files changed

+56
-14
lines changed

2 files changed

+56
-14
lines changed

Diff for: doc/setup/installing_linux_python.adoc

+26-12
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,31 @@ include::{root-path}_config.adoc[]
44
endif::[]
55
= Installing OSI for Python on Linux
66

7+
== Installing from PyPI
8+
9+
Steps::
10+
11+
. Open a terminal.
12+
+
13+
. Optionally create and activate a new virtual environment.
14+
+
15+
----
16+
python3 -m venv venv
17+
source venv/bin/activate
18+
----
19+
+
20+
. Install Open Simulation Interface.
21+
+
22+
----
23+
pip install open-simulation-interface
24+
----
25+
26+
== Installing from source
27+
728
*Prerequisites::
829

930
* You have installed everything described in <<top-installing-osi-prerequisits>>.
10-
* You have installed _pip3_.
11-
* You have installed _python-setuptools_.
12-
* For a local installation, you have installed _virtualenv_.
31+
* You have installed _pip_.
1332

1433
Steps::
1534

@@ -26,27 +45,22 @@ git clone https://github.com/OpenSimulationInterface/open-simulation-interface.g
2645
cd open-simulation-interface
2746
----
2847
+
29-
. Create a new virtual environment.
30-
+
31-
----
32-
virtualenv -p python3 venv
33-
----
34-
+
35-
. Activate the virtual environment.
48+
. Optionally create and activate a new virtual environment.
3649
+
3750
----
51+
python3 -m venv venv
3852
source venv/bin/activate
3953
----
4054
+
4155
. Install Open Simulation Interface.
4256
.. Local installation
4357
+
4458
----
45-
python3 -m pip install .
59+
pip install .
4660
----
4761
+
4862
.. Global installation
4963
+
5064
----
51-
sudo pip3 install .
65+
sudo pip install .
5266
----

Diff for: doc/setup/installing_windows_python.adoc

+30-2
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,27 @@ include::{root-path}_config.adoc[]
44
endif::[]
55
= Installing OSI for Python on Windows
66

7+
== Installing from PyPI
8+
9+
Steps::
10+
11+
. Open a terminal.
12+
+
13+
. Optionally create and activate a new virtual environment.
14+
+
15+
----
16+
python -m venv venv
17+
venv\Scripts\activate
18+
----
19+
+
20+
. Install Open Simulation Interface.
21+
+
22+
----
23+
pip install open-simulation-interface
24+
----
25+
26+
== Installing from source
27+
728
Prerequisites::
829

930
* You have installed everything described in <<top-installing-osi-prerequisits>>.
@@ -25,8 +46,15 @@ git clone https://github.com/OpenSimulationInterface/open-simulation-interface.g
2546
cd open-simulation-interface
2647
----
2748
+
28-
. Run the setup script.
49+
. Optionally create and activate a new virtual environment.
50+
+
51+
----
52+
python -m venv venv
53+
venv\Scripts\activate
54+
----
55+
+
56+
. Install Open Simulation Interface.
2957
+
3058
----
31-
python setup.py install
59+
pip install .
3260
----

0 commit comments

Comments
 (0)