Applying FAIR principles to Jupyter Notebooks

FAIR provides a useful framework for thinking about sharing data in a way that will enable maximum use and reuse. Each letter represents a principle to follow, which includes ensuring data is Findable, Accessible, Interoperable and Reusable. 

Why use FAIR data principles? 

Using the FAIR data principles can accelerate the impact of your work as more researchers can find and reuse your data. This can result in increased collaboration with research and industry, as well as acknowledgement of your data in other publications. 

For detailed information about FAIR, view this ARDC page here. 

For your Jupyter Notebook, here are some steps you can follow to help the notebook adhere to these principles. We have mentioned which FAIR principle each item relates to. For this guide, we are focusing on Github as the repository service, but you are welcome to use similar services.

1. Using repositories and Version Control (All components of FAIR)

You can add files (including your Jupyter Notebook file) to a GitHub repository using this guide. Repositories are an ideal tool for supporting compliance towards FAIR. They allow you to describe your data through the application of rich metadata, provide licensing and reuse options and comment links to other resources.

2. Adding a licence (Reuse)

Github provides an easy to follow guide on licensing the repositories where your notebook is stored. 

3. Adding rich and descriptive metadata (Interoperable)

The Jupyter Hub docs has a handy guide on how to add metadata directly inside your notebook. 

4. Referencing (Reuse)

Provide references wherever applicable and include the origins of the code. The JupyterHub docs explain how to insert references & bibliographies inside your notebook.

5. Adding a DOI (Findable)

A DOI is a digital identifier of an object, physical or digital. Github has a guide to add an identifier to your repository where your notebooks are stored.

6. Application of vocabularies and standard formats (Interoperable)

You can find vocabularies via the ARDC Vocabularies website here, to incorporate into your notebook. This will support machine actionability of the data/notebook and any desired links you wish to make with other objects that exist. 

You can also use the ARDC FAIR Self Assessment tool to check your notebook here. Additionally, training and learning resources regarding FAIR are available here.

If you have questions about using FAIR principles, you can contact contact@ardc.edu.au