Paths

DReyeVR-CARLA Path correspondences

Since DReyeVR is a simulator that builds upon the CARLA simulator, the installation process is to copy and overwrite each file in the Carla directory with the "new" DReyeVR files.

This is somewhat tedious and unorthodox but if you are aware of a better way then we'd be happy to hear it! (And yes, we do use forks of Carla for development which is fast, but keeping all the standalone DReyeVR changes in one clean repository is a big plus)

Therefore, when installing to/from DReyeVR <--> Carla, we need to have some kind of path-to-path correspondences between the two directories. In this case, we use a .csv file to map the DReyeVR path, Carla path variables together in a code-agnostic manner.

This is used in the python utils.py script to read the correspondences and generate a mapping from DReyeVR -> Carla (and equivalently Carla -> DReyeVR, since the mappings are bijective) which makes it simple to have a script copy over all the requisite files from one directory to another.

Our Mapping

The formatting we use is as follows:

# copying one DReyeVR file to a specific directory in Carla
Path/To/DReyeVR/File,Path/In/Carla/

# copying one DReyeVR directory to a specific directory in Carla
Path/To/DReyeVR/Directory,Path/In/Carla/

# copying one DReyeVR file to a specific file in Carla
# NOTE: including the path separator '/' at the end denotes directory, else file
Path/To/DReyeVR/File,Path/To/File/In/Carla

# glob-selecting some subset of a DReyeVR repository to a specific location in Carla
Path/To/DReyeVR/Directory/*.ini,Path/In/Carla/ # example for selecting only the .ini files

Notice that (as with regular .csv's), there is a , (comma) delimiter to separate the left (DReyeVR) from the right (Carla) paths.

Note that all the Path/InCarla/ directories are relative to the carla root variable.

Add New Mappings

Adding new mappings is simple and code-agnostic, simply add a new entry to the bottom of the .csv files.

Notice that we use the DReyeVR.csv file for installing over a CARLA directory, and we use a ScenarioRunner.csv file for installing (different files) over a ScenarioRunner directory.

You will need to edit the appropriate file to match your desired installation type (make install CARLA=... vs make install SR=...)