CONTRIBUTING.adoc

1. Install Ubuntu 18.04 LTS (or latest build, or preferred terminal) If Ubuntu 18.04 LTS and on Windows, enable Windows Subsystem for Linux Control Panel >> Turn Windows Features On or Off >> Windows Subsystem for Linux

   1. Create Unix username Must be lowercase, can contain underscores

   2. Create passphrase

   3. Re-enter passphrase

2. Generate an SSH Key

   1. ssh-keygen -t rsa -C "[email protected]"

   2. Enter to accept default location

   3. Enter passphrase

   4. Re-enter passphrase

3. Copy SSH Key to GitHub >> Profile >> Settings >> SSH and GPG Keys

   1. New SSH Key

   2. Enter name for key

   3. In Ubuntu terminal, execute command: cat < ~/.ssh/id_rsa.pub

   4. Copy output

   5. Paste in SSH key

   6. Add SSH key

4. Git clone XIA Repo

   1. Navigate to desired file location for repository

   2. git clone https://github.com/det-lab/xia.git

5. Create Environment from YML File

   1. Install latest Anaconda build https://www.digitalocean.com/community/tutorials/how-to-install-anaconda-on-ubuntu-18-04-quickstart

   2. conda update --all

   3. Create Environment https://docs.conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html#id2

   4. Use envXIA.yml

6. Test if path is correct

   1. Navigate to XIA Repo

   2. Execute: py.test --nbval-lax

7. Save Credentials for Ease of git push

   1. Execute following commands $ git config credential.helper store $ git push http://example.com/repo.git Username: <type your username> Password: <type your password>

For Devs Install Kaitai-Struct-Compiler https://kaitai.io/#download Install Java https://www.digitalocean.com/community/tutorials/how-to-install-java-with-apt-get-on-ubuntu-16-04