fair4jupyternotebook

FAIR for Jupyter Notebooks - A Practical Guide

https://github.com/aleem2/fair4jupyternotebook

Science Score: 67.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 3 DOI reference(s) in README
  • Academic publication links
    Links to: zenodo.org
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (8.5%) to scientific vocabulary

Keywords

accessible fair findable interoperable jupyter jupyter-notebook python reproducible-research
Last synced: 6 months ago · JSON representation ·

Repository

FAIR for Jupyter Notebooks - A Practical Guide

Basic Info
  • Host: GitHub
  • Owner: Aleem2
  • License: bsd-2-clause
  • Language: Jupyter Notebook
  • Default Branch: main
  • Homepage:
  • Size: 85.9 KB
Statistics
  • Stars: 5
  • Watchers: 1
  • Forks: 0
  • Open Issues: 0
  • Releases: 3
Topics
accessible fair findable interoperable jupyter jupyter-notebook python reproducible-research
Created almost 3 years ago · Last pushed almost 2 years ago
Metadata Files
Readme License Citation

README.md

FAIR for Jupyter Notebooks - A Practical Guide

Keywords

ARDC template, Jupyter Notebook, FAIR, Findable, Accessible, Interoperable, Reproducible

Summary

Jupyter Notebooks (JN) have been widely used in research and data science (Mendez et al., 2019). Despite its widespread use, various challenges exist in making JN reproducible, accessible and robust. A plausible approach is to use FAIR principles to make JN findable, accessible, interoperable and reproducible. However FAIR principles are high level aspirations in making research robust and can be difficult to apply in practice. This work aims to provide practical recommendations in making JN FAIR and it closely follows the FAIR for Research Software (FAIR4RS) approach.

This repo serves as an example with instructions to create a FAIR Jupyter Notebook. The example Jupyter notebook file is sourced from matplotlib documentation.

WorkFlow

Create your own FAIR notebook

Executable badges

Badges allow for the instant launch of the notebook files in a reproducible manner.

Binder

Open In Colab

Binderhub service hosted on ARDC's Nectar research cloud

Binder

DOI badge

A persistent identifier, created once the research is completed. Freezing the released Jupyter Notebook, which makes referring to the research software possible.

DOI

Owner

  • Login: Aleem2
  • Kind: user

Citation (CITATION.cff)

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
- family-names: "Uddin"
  given-names: "Aleem"
  orcid: "https://orcid.org/0000-0002-8519-5534"
title: "FAIR4JupyterNotebook"
version: 1.0.0
doi: 10.5281/zenodo.7822009
date-released: 2023-04-12
url: "https://github.com/Aleem2/FAIR4JupyterNotebook"

GitHub Events

Total
Last Year