PC Setup (Contributing)

These are setup instructions for contributing members of the team to setup their PC.

Getting Linux

A Linux OS is required to work with the rUNSWift codebase. Ubuntu 18.04 LTS amd64 is the recommended OS. You can either use a virtual machine, or dual boot your computer.

Pick one of the following:

• Gain Push Access in rUNSWift-VM
• VirtualBox Instructions
• Dual-Boot Instructions

Note

The following distributions are known to work:

• Ubuntu 16.04 LTS amd64 (Need to disable black or install python3.6; and install pip >= 9.0)

• Ubuntu 18.04 LTS amd64

• Ubuntu 19.04 amd64

• Debian 9 (amd64 & i386) (Need to disable black or install python3.6)

• Debian 10 (amd64 & i386) (ctc 2.1 uses glibc 2.6 and needs vsyscall=emulate)

Tip

Have at least 50GB storage and 4GB RAM.

Warning

A virtual machine is more likely to experience slowness in compiling and running simulations.

Add SSH key to GitHub

1. Generating SSH key

   1. Open Terminal (Ctrl+Alt+T)

   2. Run ssh-keygen -t rsa -b 4096

   3. Hit enter three times

2. Add SSH key to GitHub by following GitHub Instructions

Cloning Repository

Run the following commands to clone the rUNSWift repository

$ sudo apt-get install git
$ git clone git@github.com:UNSWComputing/rUNSWift.git rUNSWift

Note

Your GitHub account must have access to the private rUNSWift repository to be able to clone it. To gain access, please Contact us.

Build Environment Setup

Run the following command to setup the build environment.

$ rUNSWift/bin/setup-build.sh

Note

For passwords, please Contact us.