Skip to content

Latest commit

 

History

History
78 lines (51 loc) · 4.9 KB

File metadata and controls

78 lines (51 loc) · 4.9 KB

Module 5 content development

These are the main content development files for this MOOC module.

STATUS:

LIVE! This module is now online and ready to go via Eliademy.

The second release for this module is now also ready, and has been published on Zenodo:

Version 2: DOI

Version 1: DOI

To cite this work, please use the following reference:

Tennant, J. et al. (23/09/2018) Open Science MOOC: Module 5, Open Research Software and Open Source (Version 2.0) Zenodo. http://doi.org/10.5281/zenodo.1434288

Please refer to the contributing guidelines before making changes here.

Anyone can join our open Slack channel and team on GitHub for the whole MOOC project.

Core content

These are the draft content files. The content is fully accessible, and can be used for learning purposes, either individually or as a group, and can be shared and re-used as you wish. However, they have not been integrated into a formal MOOC platform yet. At the moment, they are being written in markdown format, and then using the notedown tool to convert into iPython notebook format. PDF and HTML versions are created using pandoc and the markdown to PDF package for Atom.

For notedown:

  1. Make sure you're working in Linux or Debian
  2. Change working directory: eg cd /mnt/c/users/pc/desktop/
  3. Install notedown: pip install notedown
  4. Convert files: notedown input.md > output.ipynb

IMPORTANT Please edit the markdown files, not the iPython/HTML files. These will be periodically converted and synchronised as needed.

In markdown format

In iPython notebook format

Note: These are best viewed in Juypter for full functionality, as opposed to the GitHub viewer.

In PDF format

In HTML format

Production files

  1. Plan
  2. Design
  3. Recording and editing
  4. Internal reviewing

Key resources from production toolkit