Update readme and added requirements

Samleo8 · May 5, 2022 · 26341b8 · 26341b8
1 parent b2c51b8
commit 26341b8
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -14,6 +14,19 @@ Without Motion Compensation:
 
 ![Without Motion Compensation](results/full_seq_1_nomotion.jpg)
 
+## Running Code
+
+Requires Python. Tested on Python >= 3.9.
+
+```bash
+pip install -r requirements.txt
+python3 RawROAMSystem.py <DATASET_NAME> [START_FRAME_IND [END_FRAME_IND]]
+```
+
+### Radar Sequences
+
+Radar sequences can be obtained from [Oxford Radar RobotCar Dataset](https://oxford-robotics-institute.github.io/radar-robotcar-dataset/datasets) and should be placed in the `./data` folder. The folder organization listed as `full_seq_1` is an example of how the directory looks like, and is taken from the [`10-11-46-21` sequence](https://oxford-robotics-institute.github.io/radar-robotcar-dataset/datasets/2019-01-10-11-46-21-radar-oxford-10k).
+
 ## Relevant Papers
 
  1. [RadarSLAM (2021)](https://arxiv.org/abs/2104.05347)

diff --git a/requirements.txt b/requirements.txt
@@ -0,0 +1,7 @@
+imageio==2.16.1
+matplotlib==3.5.1
+networkx==2.8
+numpy==1.22.3
+scikit_image==0.19.2
+scipy==1.7.3
+skimage==0.0