/module-template

Template repository to create TOPS learning modules

Primary LanguageJupyter NotebookCreative Commons Attribution 4.0 InternationalCC-BY-4.0

CC BY 4.0

Template for TOPS modules

This template repository provides a base folder structure, and sample files containing some guidance to help us achieve consistency across the different modules of the TOPS OpenCore curriculum.

The OpenCore is part of the TOPS mission Area 2: Capacity Sharing. In the first phase, the project is deploying a scalable learning platform, and five learning modules:

  1. Ethos of Open Science
  2. Open Data
  3. Open Software
  4. Open Results
  5. Tools and Resources

Course curriculum leads will get a link to make a new repository under the GitHub organization learnopenscience with the contents of this template reproduced, and admin permissions granted automatically.

Next actions:

  • change the repository name to the module identifier as follows:

    • TOPS-OC1-ethos
    • TOPS-OC2-data
    • TOPS-OC3-code
    • TOPS-OC4-results
    • TOPS-OC5-tools
  • add contributors (subject matter experts) as collaborators

  • begin replacing the sample content in the lesson files with your own material

You can create more files to add more sections to the module. Use one file per section, beginning with a top heading (using #), and add sub-headings (with ## and ###) as needed. These will be used automatically to build the table of contents.


This work is licensed under a Creative Commons Attribution 4.0 International License. Prepared by Lorena A. Barba (2022) for the AGU TOPS project.

CC BY 4.0