{"id":19246733,"url":"https://github.com/trallard/jnb_reproducible","last_synced_at":"2025-06-21T17:04:41.576Z","repository":{"id":22844094,"uuid":"97463519","full_name":"trallard/JNB_reproducible","owner":"trallard","description":"📓Notebook materials for the RSE conference workshop (2017)","archived":false,"fork":false,"pushed_at":"2022-12-08T00:00:19.000Z","size":18895,"stargazers_count":9,"open_issues_count":12,"forks_count":2,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-21T11:39:35.234Z","etag":null,"topics":["jupyter-notebook","nbdime","nbval","open-source","reproducible-research","testing","version-control"],"latest_commit_sha":null,"homepage":"http://bitsandchips.me/JNB_reproducible/","language":"Jupyter Notebook","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/trallard.png","metadata":{"files":{"readme":"Readme.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-07-17T10:18:29.000Z","updated_at":"2021-12-08T14:04:57.000Z","dependencies_parsed_at":"2023-01-14T01:00:11.422Z","dependency_job_id":null,"html_url":"https://github.com/trallard/JNB_reproducible","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/trallard/JNB_reproducible","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/trallard%2FJNB_reproducible","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/trallard%2FJNB_reproducible/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/trallard%2FJNB_reproducible/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/trallard%2FJNB_reproducible/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/trallard","download_url":"https://codeload.github.com/trallard/JNB_reproducible/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/trallard%2FJNB_reproducible/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261162067,"owners_count":23118220,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["jupyter-notebook","nbdime","nbval","open-source","reproducible-research","testing","version-control"],"created_at":"2024-11-09T17:33:57.056Z","updated_at":"2025-06-21T17:04:36.530Z","avatar_url":"https://github.com/trallard.png","language":"Jupyter Notebook","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Jupyter notebooks for reproducible research\n\n[![DOI](https://zenodo.org/badge/97463519.svg)](https://zenodo.org/badge/latestdoi/97463519)\n\nHopefully this will be green....\n[![Build Status](https://travis-ci.org/trallard/JNB_reproducible.svg?branch=master)](https://travis-ci.org/trallard/JNB_reproducible)\n\nThis repository contains the materials for the Jupyter notebooks for reproducible research workshop given at the [Second RSE conference ](http://rse.ac.uk/conf2017/) (7-8th September 2017).\n\nCritically, we will  introduce two technologies recently developed as part of the EU OpenDreamKit project, nbval and nbdime, which bring unit testing and version control to the Jupyter notebook ecosystem.\nBy doing so we aim to encourage others to adopt best development practices leading to more reproducible, replicable, and reliable computational results.\n\n## Leading by example\n\nSince this workshop is centered  around establishing best practices for reproducible research it is completely self contained and should be easily adapted/extended for future\n workshops.\n Feel free to [raise issues](https://github.com/trallard/JNB_reproducible/issues) if you see it fit.\n\nA suitable environment is provided in the form of a Docker container (Dockerfile provided in the repo):\n - Setup and usage notes [for students](./user_setup_notes.md)\n - Setup and usage notes [for facilitators](./facilitator_notes.md)\n\nThe slides are built using reveal.js and can be served locally following the instructions shown [here](https://github.com/hakimel/reveal.js/).\n Since the slides are served using GitHub Pages, these can be found in the `gh-pages` branch of this repository.\n\nAlternatively the web-hosted version of the slides can be found in the following sites: [http://rse.shef.ac.uk/RSE_conference_jupyter_workshop/](http://rse.shef.ac.uk/RSE_conference_jupyter_workshop/)\n\n[http://bitsandchips.me/JNB_reproducible/](http://bitsandchips.me/JNB_reproducible/)\n\n## Licensing\n\nThe creative material of this workshop (including the presentation slides as well as the images from external sources used in the presentation) are licensed under [ CC BY 4.0 ](https://creativecommons.org/licenses/by/4.0/)\n\nnbval and nbdime are open source projects developed as part of the European funded project [OpenDreamKit project](http://opendreamkit.org).\n\nThe code as well as the license terms of both packages can be found at:\n- [nbval GitHub repository](https://github.com/computationalmodelling/nbval)\n- [nbdime GitHub repository](https://github.com/jupyter/nbdime)\n\nThe scripts and jupyter notebook contained in this repository are distributed under [the 3-Clause BSD license](https://opensource.org/licenses/BSD-3-Clause).\n\n\n## Pre-requisites\n\n**Note:** as mentioned above, the required packages for this workshop are provided in the form of a Docker container.  Should you opt not to use this container you need to ensure you have the following installed in your computer in a [virtualenv](https://virtualenv.pypa.io/en/stable/) or [Conda environment](https://conda.io/docs/user-guide/tasks/manage-environments.html):\n- Python 3.5\n- git\n- jupyter notebooks\n- pip\n- pandas\n- seaborn\n\nAlso you will need to have a terminal ([Git Bash](https://git-for-windows.github.io/) or [CygWin](http://www.cygwin.com/) are recommended for Windows users).\n\n## Attendees of the RSE conference 2017\nWe will have some hands-on bits as well as discussion slots in this workshop, for this purpose we have set an Etherpad at [https://etherpad.wikimedia.org/p/RSE-reproNB](https://etherpad.wikimedia.org/p/RSE-reproNB).\n\n\n### Getting started with the workshop materials\nBy now you should have a the RSE conference Virtual Machine already set in your personal laptop, which includes all the materials for this workshop.\n\nYou now need to follow [these notes](./user_setup_notes.md) to prepare for this tutorial.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftrallard%2Fjnb_reproducible","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftrallard%2Fjnb_reproducible","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftrallard%2Fjnb_reproducible/lists"}