Collaboration on Open Data Science Projects: Setup

This setup tutorial will walk you through installing the software you will need for this workshop.

Installing and configuring git

Installation

Install git. You can install using conda

$ conda install git

Configuring Git

The first time you use Git on a particular computer, you need to configure some things.

First, you should set your identity. One of the most important things that version control like Git does is to keep track of who changes what. This helps repository maintainers coordinate the efforts of all the people who contribute to the project. Most importantly, it makes it easier to figure out who to blame when something goes wrong. You can provide git your name and contact information with the following commands:

$ git config --global user.name "<Firstname> <Lastname>"
$ git config --global user.email "<email address>"

Next, you might want to change the Git text editor. As we will see later, certain Git commands will open text files. When this happens, Git will use your environment’s default text editor, which might not be the editor you are most comfortable using. Using configuration commands, you can tell Git to use your favorite editor.

A popular chose is Vim. To use Vim, do

$ git config --global core.editor "vim"

A more complete list of possible editors is available here.

To use VSCode as your core editor, do

$ git config --global core.editor "code --wait"

You can check the configuration commands that you have set using:

$ git config --list

Create GitHub Account

Create an account on github.com if you do not have one already. Remember the user name and password. If you are making a GitHub account, please remember that your username should be recognizable and professional.

Download the resources:

Download the molecool folder for the git practical and then unzip the file.

Conclusion

At the end of this set-up, you should have installed and created an account on GitHub, and configured git.