Skip to content

Latest commit

 

History

History
134 lines (87 loc) · 3.96 KB

getting_started.rst

File metadata and controls

134 lines (87 loc) · 3.96 KB
Raw

Getting Started

This section is for people joining the MOAD group. It's mostly a collection of links to other places in these and other docs in approximately the order that you need to do things to get up and running in the group.

There's lots to learn as you join the group, but you can also help us improve things right from Day 1. You are reading these docs with eyes and brain that haven't looked at them before, so you are uniquely qualified to see things that other people take for granted. Please help us improve our docs fixing typos, improving wording, etc. by using the :guilabel:`Edit on GitHub` link in the upper right corner of every page (on a desktop browser - sadly that feature is not available at the moment on phones and tablets). If you find something that you don't feel confident fixing, please create an issue about it in the issue tracker on GitHub.

Here's the Getting Started checklist:

  1. :ref:`GetYourEOASEmailAddressAndUserId`
  2. :ref:`GetSetUpOnGitHub`
  3. :ref:`SetUpSecureRemoteAccess`
  4. :ref:`SetUpGit`
  5. :ref:`SetUpBash`
  6. :ref:`InstallMiniforge`
  7. :ref:`SetUpYourAnalysisRepository`

Get Your EOAS Email Address and User Id

Susan will take you through the form to get your EOAS email address and Linux computer user id setup during your first meeting with her when you join the group.

Get Set Up on GitHub

If you don't already have an account on GitHub, please create one. Then, send your GitHub username to Doug at [email protected]. He will add you to the UBC-MOAD GitHub organization and you will receive an invitation email from GitHub that you will have to accept in order to finalize your addition to the organization. Doug will probably also invite you to at least one of the other project-specific :ref:`GitHub organizations<team-repos>` that we have.

Set Up Secure Remote Access

You will need to have:

  1. An account, user id, and password on the EOAS Ocean collection of Linux computers (which should happen at the same time as getting your eoas.ubc.ca email address)

before you can set up your :command:`ssh` keys and configuration for :ref:`SecureRemoteAccess`.

Set Up Git

You will need to:

  1. Learn about :ref:`vc-with-git`
  2. :ref:`Install Git<InstallingGit>` on your laptop
  3. Set up your :ref:`GitConfiguration` on each of the machines you use

Set Up :program:`bash`

You will need to have:

  1. A user id on the EOAS Ocean collection of Linux computers (which should happen at the same time as getting your eoas.ubc.ca email address)
  2. Completed the process of :ref:`copying your public ssh key to a Waterhole workstation <CopyYourPublicSshKeyToRemoteComputers>`

before you can:

  1. :ref:`Create-.bash_profile`
  2. :ref:`Create-.bashrc`

on a Waterhole workstation.

Install Miniforge

You will need to:

  1. Learn about :ref:`MOAD-CondaPkgAndEnvMgr`
  2. :ref:`Install Miniforge<InstallingMiniforge>` on your laptop
  3. :ref:`Install Miniforge<InstallingMiniforge>` in your workspace on the EOAS Ocean collection of Linux computers

Set Up Your Analysis Repository

You will need to have:

  1. :ref:`SetUpGit`
  2. :ref:`Installed Miniconda<InstallMiniforge>`

before you can set up your :ref:`analysis repository<MOAD-AnalysisRepository>`.