Skip to content

Commit 18dc8d1

Browse files
committed
Update README.md with correct instructions and links.
1 parent a8f8b7e commit 18dc8d1

1 file changed

Lines changed: 42 additions & 13 deletions

File tree

README.md

Lines changed: 42 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -6,32 +6,61 @@ Code that creates the analyses the data and figures of the article:
66
*Celestial compass design mimics the fan-like polarisation filter array of insect eyes***.
77
*Nature Communications*.
88

9+
## Clone the repository
10+
Open a terminal, clone the project, and navigate to its working directory:
11+
```commandline
12+
git clone https://github.com/InsectRobotics/CelestialCompassAnalysis.git
13+
cd CelestialCompassAnalysis
14+
```
15+
The processed data can be downloaded from [here](https://doi.org/10.7488/ds/6106) and
16+
they should be placed in the [csv](csv) directory. Alternatively, they can be generated by following the instructions below.
917

1018
## Analyse the data and create the processed datasets
1119

12-
The processed data can be downloaded from [here](). Alternatively, the data can be created
13-
by copying the ROS-bag files in the repositories workspace and following the instructions
14-
below.
20+
If you have access to the ROS-bag files produced by the robot (upon request from the authors),
21+
proceed with step 1a, otherwise proceed with step 1b.
1522

16-
Open a terminal, navigate to the [templates](templates) directory, and run:
23+
### 1a. Generate the raw_dataset.csv
24+
Copy the ```sardinia_data``` and ```south_africa_data``` directories
25+
to the working directory, navigate to the [templates](templates) directory (e.g., ```cd templates```), and run the
26+
script that creates the raw dataset:
1727
```commandline
1828
python create_csv.py -t raw
1929
```
20-
This will create a CSV file in the ```csv``` directory (named ```raw_dataset.csv```) that
21-
contains all the important data from the ```sardinia_data``` and ```south_africa_data```
22-
directories (that contain the raw ROS-bag files). The size of these directories was almost 100 GB,
23-
so they were excluded from the dataset, but we include the code for reference. Providing the
24-
```raw_dataset.csv``` as input, should allow the following commands to work without problems.
30+
The ROS-bag files contain a lot of information, including low resolution videos captured by the fish-eye camera
31+
during the experiments that increased the size of the datasets to almost 100 GB. The above script creates a CSV
32+
file (named ```raw_dataset.csv```) in the [csv](csv) directory, which includes only the data used in the article
33+
without any further processing and reduces the size of the datasets to 677.7 MB. It also creates a directory in
34+
named ```sessions``` in the [csv](csv) directory, which contains the high-resolution fish-eye images captured at
35+
beginning of each session (400.1 MB).
36+
37+
### 1b. Download the raw_dataset.csv
38+
Navigate to the [csv](csv) directory and download the raw dataset from the above link. Alternatively, run
39+
the below lines from the working directory:
40+
```commandline
41+
cd csv
42+
wget https://datashare.ed.ac.uk/bitstream/handle/10283/7116/raw_dataset.csv?sequence=9&isAllowed=n
43+
wget https://datashare.ed.ac.uk/bitstream/handle/10283/7116/sessions.zip?sequence=5&isAllowed=n
44+
cs ..
45+
```
46+
This will download the CSV file (```raw_dataset.csv```) and fish-eye images (```sessions.zip```)
47+
in the ```csv``` directory. These contain all the important data from the ```sardinia_data``` and
48+
```south_africa_data``` directories (which are excluded from the dataset because of their large size).
49+
Finally, extract the ```sessions.zip``` in the [csv](csv) directory.
50+
51+
### 2. Generate the pooled_dataset.csv
52+
Providing the ```raw_dataset.csv``` as input, should allow the following commands to work without problems.
2553
The option ```-o [output_path]``` allows for a different output path.
2654
To create the pooled data from the above CSV file, run:
2755
```commandline
2856
python create_csv.py -t pooled -i DATASET_DIR/raw_dataset.csv
2957
```
3058
which will create another CSV file in the ```csv``` directory (named ```pooled_dataset.csv```).
31-
Again the output path can be changed using the ```-o [output_path]``` option. This process
32-
needs the ```csv/raw_dataset.csv```, so if an alternative output path was chosen before,
33-
this has to be specified through the input option ```-i [input_path]```. Finally, the errors
34-
for all the sessions and models can be calculated by running:
59+
The ```-i DATASET_DIR/raw_dataset.csv``` part is optional, and if you followed step 1a or 1b, it
60+
shouldn't be necessary.
61+
62+
### 3. Generate the error_dataset.csv
63+
The errors for all the sessions and models can be calculated by running:
3564
```commandline
3665
python create_csv.py -t error
3766
```

0 commit comments

Comments
 (0)