Sharing your paradigms at WIN: a practical introduction

Wellcome Centre for Integrative Neuroimaging, University of Oxford

Instructors: Laurence Hunt, Dejan Draschkow, and Cass Gould van Praag

General Information

WIN is committed to developing an open science community with a positive culture for sharing data, tasks, tools and protocols. A key part of this is training up WIN members to be able to share effectively.

This training will focus on task sharing at WIN. It will teach researchers to:

This workshop was developed using a template designed by the UK reproducibility network (UKRN). Other UKRN Open Research topics can be found in the list of UKRN Primers.

Requirements

Accessibility

We are committed to making this workshop accessible to everybody. Please notify the instructors in advance of the workshop if there is anything we can do to make this workshop more accessible to you.

Contact: Please email the instructors for more information. The instructors' emails are:


Code of Conduct

Everyone who participates in UKRN activities is required to conform to the UKRN Code of Conduct. This document also outlines how to report an incident if needed.


Surveys

Please be sure to complete these surveys before and after the workshop.

Pre-workshop Survey

Post-workshop Survey


Schedule

Day 1

Before starting Pre-workshop survey
13:00
Welcome! Introduction and overview of what we will cover today, and meet the other workshop attendees
13:10
Why share your tasks? A brief discussion on why task sharing is a good idea, and how to get started at WIN
13:25
Demonstration: using the WIN GitLab server to share your task A walkthrough, from start to finish, of setting up a repository on the WIN Gitlab server
13:50
Make your own repository (part 1) Start to create a simple repository for your task, put a copy of the current version of your task in the repository, and make a simple readme file
14:30
Break Have a break, have a KitKat.
14:40
Demonstration: Add a license to your repository, and make it citable How to add a license to your repository, and make it citable using Zenodo
14:55
Make your own repository (part 2) Finish making your repositories, adding more detail to readme, add license
15:35
Wrap up Everyone briefly says what they’ve made, and we address any final questions
End Post-workshop survey

Setup

To participate in a Sharing your paradigms at win: a practical introduction workshop, you will need access to the software described below. In addition, you will need an up-to-date web browser.

The Carpentries maintain a list of common issues that occur during installation as a reference for instructors that may be useful on the Configuration Problems and Solutions wiki.

Git

Git is a version control system that lets you track who made changes to what when and has options for easily updating a shared or public version of your code on the WIN GitLab server (or alternatively, on github.com). You will need a supported web browser.

You will need an account on the WIN GitLab Server for parts of the Git lesson. If you have a WIN IT account, you automatically have a WIN GitLab account created with the same username/password. We encourage you to create an account if you don't have one already.

  1. Download the Git for Windows installer.
  2. Run the installer and follow the steps below:
    1. Click on "Next" four times (two times if you've previously installed Git). You don't need to change anything in the Information, location, components, and start menu screens.
    2. From the dropdown menu select "Use the Nano editor by default" (NOTE: you will need to scroll up to find it) and click on "Next".
    3. On the page that says "Adjusting the name of the initial branch in new repositories", ensure that "Let Git decide" is selected. This will ensure the highest level of compatibility for our lessons.
    4. Ensure that "Git from the command line and also from 3rd-party software" is selected and click on "Next". (If you don't do this Git Bash will not work properly, requiring you to remove the Git Bash installation, re-run the installer and to select the "Git from the command line and also from 3rd-party software" option.)
    5. Ensure that "Use the native Windows Secure Channel Library" is selected and click on "Next".
    6. Ensure that "Checkout Windows-style, commit Unix-style line endings" is selected and click on "Next".
    7. Ensure that "Use Windows' default console window" is selected and click on "Next".
    8. Ensure that "Default (fast-forward or merge) is selected and click "Next"
    9. Ensure that "Git Credential Manager Core" is selected and click on "Next".
    10. Ensure that "Enable file system caching" is selected and click on "Next".
    11. Click on "Install".
    12. Click on "Finish" or "Next".
  3. If your "HOME" environment variable is not set (or you don't know what this is):
    1. Open command prompt (Open Start Menu then type cmd and press Enter)
    2. Type the following line into the command prompt window exactly as shown:

      setx HOME "%USERPROFILE%"

    3. Press Enter, you should see SUCCESS: Specified value was saved.
    4. Quit command prompt by typing exit then pressing Enter

This will provide you with both Git and Bash in the Git Bash program.

Video Tutorial

For macOS, install Git for Mac by downloading and running the most recent "mavericks" installer from this list. Because this installer is not signed by the developer, you may have to right click (control click) on the .pkg file, click Open, and click Open on the pop up window. After installing Git, there will not be anything in your /Applications folder, as Git is a command line program. For older versions of OS X (10.5-10.8) use the most recent available installer labelled "snow-leopard" available here.

Video Tutorial

If Git is not already available on your machine you can try to install it via your distro's package manager. For Debian/Ubuntu run sudo apt-get install git and for Fedora run sudo dnf install git.