Contains the CMR production code.
- Linux or OS X
- While Docker in theory runs on Windows, no one has tried it.
- Python 3
Install the necessary software:
- OS X:
brew install python3 git docker
sudo apt-get install python3 git docker
sudo pacman -S python git docker
sudo emerge -a python git docker
- OS X:
Clone the repository to
CMR_ROOT(a directory of your choosing):
cd "$CMR_ROOT" && git clone email@example.com:CornellMarsRover/Superproject.git
Configure your environment:
echo 'eval "$($CMR_ROOT/Superproject/scripts/cmr eval)"' >> ~/.bashrc source ~/.bashrc
You may have to use
~/.bash_profileon a Mac.
You may have to restart your computer or log out and back after this in order for Docker to work
When connecting to the NUC, you need to have an active Ethernet connection with
the following settings:
- IPv4 address:
The scripts in
scripts rely on various variables in order to function properly. Local changes can be made in
scripts/config/user_conf.py. Any changes to that file will overwrite the default values.
You can modify code directly within Superproject, and any changes will propagate
to the Docker image. This is possible due to
You can run
cmr make from anywhere; it figures out whether Docker is already
running and whether you need to run inside Docker.
You should run code within a Docker container, since this container has the
software configuration that will be used in production. Run the command
cmr shell to get inside the Docker image and start running commands (e.g.
cmr shell automatically spawns a container running
roscore, so you don't need to run
To run the actual rover code, see
For help on how to use
cmr shell, run
cmr shell -h. The
cmr utility also
has lots of other handy subcommands. Run
cmr -h for a complete list.