Skip to content

Commit a787612

Browse files
committed
Update installation description. Parameterize kaggle script.
1 parent 53cfd44 commit a787612

File tree

3 files changed

+34
-11
lines changed

3 files changed

+34
-11
lines changed

README.md

+22-10
Original file line numberDiff line numberDiff line change
@@ -46,34 +46,46 @@ First, clone the new fork from your own account and create a new environment wit
4646
```bash
4747
mkdir -p ~/repos && cd repos
4848
git clone https://github.com/<YOUR-USERNAME>/lsy_drone_racing.git
49-
cd lsy_drone_racing
50-
conda conda env create -f environment.yaml
49+
conda env create -n drone python=3.8
5150
conda activate drone
5251
```
5352

5453
> **Note:** It is important you stick with **Python 3.8**. Yes, it is outdated. Yes, we'd also like to upgrade. However, there are serious issues beyond our control when deploying the code on the real drones with any other version.
5554
56-
Next, install the lsy_drone_racing package in editable mode from the repository root
57-
58-
```bash
59-
pip install -e .
60-
```
61-
62-
Download the `safe-control-gym` and `pycffirmware` repositories and install them. Make sure you have your conda/mamba environment active!
55+
Next, download the `safe-control-gym` and `pycffirmware` repositories and install them. Make sure you have your conda/mamba environment active!
6356

6457
```bash
6558
cd ~/repos
6659
git clone -b beta-iros-competition https://github.com/utiasDSL/safe-control-gym.git
6760
cd safe-control-gym
68-
pip install . --no-deps
61+
pip install .
6962
```
63+
64+
> **Note:** If you receive an error installing safe-control-gym related to gym==0.21.0, run
65+
> ```bash
66+
> pip install setuptools==65.5.0 pip==21 wheel==0.38.4
67+
> ```
68+
> first
69+
7070
```bash
7171
cd ~/repos
7272
git clone https://github.com/utiasDSL/pycffirmware.git
7373
cd pycffirmware
7474
git submodule update --init --recursive
75+
sudo apt update
76+
sudo apt install build-essential
77+
conda install swig
7578
./wrapper/build_linux.sh
7679
```
80+
81+
Now you can install the lsy_drone_racing package in editable mode from the repository root
82+
83+
```bash
84+
cd ~/repos/lsy_drone_racing
85+
pip install --upgrade pip
86+
pip install -e .
87+
```
88+
7789
Finally, you can test if the installation was successful by running
7890

7991
```bash

pyproject.toml

+10
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,16 @@ classifiers = [
1717
"Intended Audience :: Science/Research",
1818
]
1919

20+
dependencies = [
21+
"fire >= 0.6.0",
22+
"munch >= 2.5.0",
23+
"numpy >= 1.24.1",
24+
"pandas >= 1.5.3",
25+
"pybullet >= 3.2.6",
26+
"PyYAML >= 6.0.1",
27+
"rospkg >= 1.5.1",
28+
"scipy >= 1.10.1",
29+
]
2030

2131
[tool.setuptools]
2232
packages = ["lsy_drone_racing"]

scripts/kaggle.py

+2-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,8 @@
1515
def main():
1616
"""Run the simulation N times and save the results as 'submission.csv'."""
1717
n_runs = 10
18-
ep_times = simulate(config="config/level3.yaml", n_runs=n_runs, gui=False)
18+
controller = "examples/controller.py"
19+
ep_times = simulate(config="config/level3.yaml", controller=controller,n_runs=n_runs, gui=False)
1920
# Log the number of failed runs if any
2021

2122
if failed := [x for x in ep_times if x is None]:

0 commit comments

Comments
 (0)