Skip to content

Commit d610c69

Browse files
committed
Add installation instructions
Signed-off-by: Pierre R. Mai <[email protected]>
1 parent 168f830 commit d610c69

File tree

1 file changed

+40
-2
lines changed

1 file changed

+40
-2
lines changed

README.md

Lines changed: 40 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,47 @@ This python package provides python bindings and utility modules for the [ASAM O
55

66
For more information on OSI see the [official documentation](https://opensimulationinterface.github.io/osi-antora-generator/asamosi/latest/specification/index.html) or the [class list](https://opensimulationinterface.github.io/osi-antora-generator/asamosi/latest/gen/annotated.html) for defined protobuf messages.
77

8-
## Usage
8+
Usage
9+
-----
10+
911
For usage examples, please refer to the official documentation:
12+
1013
- [Trace file generation with python](https://opensimulationinterface.github.io/osi-antora-generator/asamosi/latest/interface/architecture/trace_file_example.html)
1114

12-
## Installation
15+
Installation
16+
------------
17+
18+
### Installing from source
19+
20+
#### Prerequisites
21+
22+
- You have installed Python 3.10 or later.
23+
- You have installed _pip_.
24+
25+
#### Steps
26+
27+
- Open a terminal.
28+
- Clone the osi-python repository, including sub-modules:
29+
30+
```console
31+
git clone --recurse-submodules https://github.com/PMSFIT/osi-python.git
32+
```
33+
34+
- Switch to the repository directory:
35+
36+
```console
37+
cd osi-python
38+
```
39+
40+
- Optionally create and activate a new virtual environment:
41+
42+
```console
43+
python3 -m venv venv
44+
source venv/bin/activate
45+
```
46+
47+
- Install the package:
1348

49+
```console
50+
pip install .
51+
```

0 commit comments

Comments
 (0)