Docs

Installing for Development

1. Make sure you have an ssh key set up:
   1. ls ~/.ssh/id_rsa.pub
   2. If there's a file there, go to step 2.
   3. If there's not a file there, generate a key by running ssh-keygen. You can safely press enter for all the prompts.
   4. Add the generated key to GitHub:
      1. cat /home/username/.ssh/id_rsa.pub
      2. Logged into GitHub, go to https://github.com/settings/keys
      3. Click the green "New SSH key" button
      4. Enter the name of the computer you're on in the "Title" section
      5. Copy the entirety of the output of the cat command into the "Key" box
      6. Click "Add SSH key" to save it
      7. You might have to reënter your password
2. Clone the repository
   1. cd into the directory you want to work on UltraTrace in (e.g., Documents or Desktop)
   2. Clone the repo: git clone git@github.com:SwatPhonLab/UltraTrace.git
3. Change into the UltraTrace directory and run UltraTrace!
   • cd ultratrace
   • python3 -m ultratrace