huangfu/scenarionet
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update doc (#20)

Browse Source 
* Add list.py and desc

* add operations

* add structure

* update readme

* format

* update readme
This commit is contained in:
Quanyi Li
2023-08-26 22:29:54 +01:00
committed by GitHub
parent e6831ff972
commit 4affa68a06
29 changed files with 802 additions and 199 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
documentation/install.rst
View File

@@ -5,21 +5,31 @@ Installation
########################
The ScenarioNet repo contains tools for converting scenarios and building database from various data sources.
We recommend to create a new conda environment and install Python>=3.8,<=3.9::
conda create -n scenarionet python==3.9
conda activate scenarionet
The simulation part is maintained in `MetaDrive <https://github.com/metadriverse/metadrive>`_ repo, and let's install MetaDrive first.
**1. Install MetaDrive**
The installation of MetaDrive on different platforms is straightforward and easy!
We recommend to use the following command to install::
We recommend to install from Github in the following two ways::
# Install MetaDrive Simulator
# Method 1 (Recommend, if you don't want to access the source code)
pip install git+https://github.com/metadriverse/metadrive.git
# Method 2
git clone git@github.com:metadriverse/metadrive.git
cd metadrive
pip install -e.
It can also be installed from PyPI by::
pip install "metadrive-simulator>=0.4.1.1"
A more stable version of MetaDrive can be installed from PyPI by::
# More stable version than installing from Github
pip install "metadrive-simulator>=0.4.1.1"
To check whether MetaDrive is successfully installed, please run::
@@ -29,9 +39,12 @@ To check whether MetaDrive is successfully installed, please run::
**2. Install ScenarioNet**
For ScenarioNet, we only provide Github installation::
For ScenarioNet, we only provide Github installation. Likewise, there are two ways to install from Github::
# Install ScenarioNet
# Method 1 (Recommend, if you don't want to access the source code)
pip install git+https://github.com/metadriverse/scenarionet.git
# Method 2
git clone git@github.com:metadriverse/scenarionet.git
cd scenarionet
pip install -e .