Skip to content

Commit 9c09223

Browse files
author
protohedgehog
committed
Updated all files to latest versions. Added PDF for task 3.
1 parent 7762b82 commit 9c09223

18 files changed

Lines changed: 1400 additions & 139 deletions

content_development/MAIN.ipynb

Lines changed: 204 additions & 66 deletions
Large diffs are not rendered by default.

content_development/MAIN.md

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -22,22 +22,16 @@ output:
2222
- [Collaborating through Open Source](#Collaborating)
2323
- [Where to go from here](#Future_OSS)
2424

25-
26-
[IDEA: ONCE TEXT IS COMPLETE; CREATE AUDIO RECORDING FOR ALL OF THIS FOR EACH MODULE, and release as a podcast]
27-
25+
**PLEASE NOTE** that an audio version of this is available to download via [Soundcloud](https://soundcloud.com/open-science-mooc/module-5-open-source-and-open-research-software) and [YouTube](https://www.youtube.com/watch?v=BHrOEmKk5zM).
2826

2927
## Introduction <a name="Introduction"></a>
3028

3129
Welcome to **Module 5** of the Open Science MOOC: **Open Research Software and Open Source**.
3230

33-
This module has been developed [in the open](https://github.com/OpenScienceMOOC/Module-5-Open-Research-Software-and-Open-Source) through collaboration by an international team of [Open Source afficianados](https://github.com/OpenScienceMOOC/Module-5-Open-Research-Software-and-Open-Source/blob/master/README.md#development-team-). Everything you see here has been developed in the open through interactive feedback and collaboration from the wider community. It comprises a series of videos, infographics, text-based reading (sorry), and practical tasks for you to sink you teeth into.
31+
This module has been developed [in the open](https://github.com/OpenScienceMOOC/Module-5-Open-Research-Software-and-Open-Source) through collaboration by an international team of [Open Source afficianados](https://github.com/OpenScienceMOOC/Module-5-Open-Research-Software-and-Open-Source/blob/master/README.md#development-team-). Everything you see here has been developed in the open through interactive feedback and collaboration from the wider community. It comprises a series of videos, infographics, text-based reading, and practical tasks for you to sink you teeth into.
3432

3533
Don't forget you can join in the discussions over at our open [**Slack channel**](https://openmooc-ers-slackin.herokuapp.com/). Please do introduce yourself at #module5opensource, and tell us a bit about who you are, your background, and how you ended up here!
3634

37-
### Why should you take this module?
38-
39-
[TO ADD: Introductory video]
40-
4135
### Who is this module for?
4236

4337
This module is designed primarily for computational researchers at the graduate and undergraduate level, as well as budding data scientists and any other researcher who uses analytical code or software. In a modern day research environment, this covers pretty much anyone who uses a computer for ther work.

content_development/MAIN.pdf

345 Bytes
Binary file not shown.

content_development/README.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,14 +16,20 @@ Please refer to the [contributing guidelines](https://github.com/OpenScienceMOOC
1616

1717
## Core content
1818

19-
These are the draft content files. The content in them is fully accessible, and can be used for learning purposes. 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](https://github.com/aaren/notedown) tool to convert into iPython notebook format.
19+
These are the draft content files. The content in them is fully accessible, and can be used for learning purposes. 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](https://github.com/aaren/notedown) tool to convert into iPython notebook format. PDF and HTML versions are created using [pandoc](https://pandoc.org/demos.html) and the [markdown to PDF](https://atom.io/packages/markdown-pdf) package for Atom.
2020

21-
**IMPORTANT** Please edit the **markdown** files, not the iPython/html files. These will be periodically converted and synchronised as needed.
21+
For notedown:
22+
1. Make sure you're working in Linux or Debian
23+
2. Change working directory: eg `cd /mnt/c/users/pc/desktop/`
24+
3. Install notedown: `pip install notedown`
25+
4. Convert files: `notedown input.md > output.ipynb`
26+
27+
**IMPORTANT** Please edit the **markdown** files, not the iPython/HTML files. These will be periodically converted and synchronised as needed.
2228

2329
### In markdown format
2430

2531
- [**MAIN CONTENT**](MAIN.md) - The main content for this Module.
26-
- [**TASK 1**](Task_1.md) - How to set up a repository on GitHub.
32+
- [**TASK 1**](Task_1.md) - How to set up your first repository on GitHub.
2733
- [**TASK 2**](Task_2.md) - How to make your code citable using GitHub and Zenodo.
2834
- [**TASK 3**](Task_3.md) - How to integrate Git with RStudio.
2935

@@ -34,6 +40,7 @@ Note: These are best viewed in Juypter for full functionality, as opposed to the
3440
- [**MAIN CONTENT**](MAIN.ipynb) (click [here](https://nbviewer.jupyter.org/github/OpenScienceMOOC/Module-5-Open-Research-Software-and-Open-Source/blob/master/content_development/MAIN.ipynb) to view)
3541
- [**TASK 1**](Task_1.ipynb) (click [here](https://nbviewer.jupyter.org/github/OpenScienceMOOC/Module-5-Open-Research-Software-and-Open-Source/blob/master/content_development/Task_1.ipynb) to view)
3642
- [**TASK 2**](Task_2.ipynb) (click [here](https://nbviewer.jupyter.org/github/OpenScienceMOOC/Module-5-Open-Research-Software-and-Open-Source/blob/master/content_development/Task_2.ipynb) to view)
43+
- [**TASK 3**](Task_3.ipynb) (click [here](https://nbviewer.jupyter.org/github/OpenScienceMOOC/Module-5-Open-Research-Software-and-Open-Source/blob/master/content_development/Task_3.ipynb) to view)
3744

3845
## In PDF format
3946

@@ -42,7 +49,7 @@ Note: These are best viewed in Juypter for full functionality, as opposed to the
4249
- [**TASK 2**](Task_2.pdf)
4350
- [**TASK 3**](Task_3.pdf)
4451

45-
## In html format
52+
## In HTML format
4653

4754
- [**MAIN CONTENT**](MAIN.html)
4855
- [**TASK 1**](Task_1.html)

content_development/Task_1.html

Lines changed: 11 additions & 10 deletions
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)