Skip to content
This repository has been archived by the owner on Sep 22, 2023. It is now read-only.

Make the user to install Shapely first #111

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 15 additions & 16 deletions documentation/INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,21 @@ Please copy the `tech.key` file that you received after registering inside the `

This code requires **Python 3.7**.

### Shapely ###

You can obtain Shapely from [here](https://www.lfd.uci.edu/~gohlke/pythonlibs/#shapely).

You should download the wheel file matching you Python version, i.e., download the file with cp37 in
the name if you use Python 3.7. The wheel file should also match the architecture of your machine,
i.e., you should install the file with either `win32` or `win_amd64` in the name.

After downloading the wheel file, you can install Shapely by running (in an active virtual environment)
the following command:

```
pip install /path/to/shapely/file
```

### Other Libraries ###

To easily install the other dependencies with rely on `pip`, we suggest to create a
Expand Down Expand Up @@ -74,22 +89,6 @@ in the `additional-requirements.txt` file.

> **Note**: the format of this file must follow the usual `pip` convention where the library name is followed by the target version number separated by `==`, e.g., beamngpy==1.21.1


### Shapely ###

You can obtain Shapely from [here](https://www.lfd.uci.edu/~gohlke/pythonlibs/#shapely).

You should download the wheel file matching you Python version, i.e., download the file with cp37 in
the name if you use Python 3.7. The wheel file should also match the architecture of your machine,
i.e., you should install the file with either `win32` or `win_amd64` in the name.

After downloading the wheel file, you can install Shapely by running (in an active virtual environment)
the following command:

```
pip install /path/to/shapely/file
```

## Recommended Requirements ##

[BeamNG](https://wiki.beamng.com/Requirements) recommends the following hardware requirements:
Expand Down