About EDS book notebooks
About EDS book notebooks¶
With the great diversity in open data, software and computational resources, environmental data science research and applications have accelerated rapidly. This presents a timely opportunity for advancing the cyberinfrastructure for showcasing these emerging developments. Building upon existing open science communities such as the Turing Way and Pangeo, EDS book aims at educating and leveraging good scientific software and data management practises among environmental scientists through peer-reviewed findable, accessible, interoperable and reusable (FAIR) computational notebooks.
Computation notebooks allow users to combine interactive code with text and graphical objects. They have become a successful mechanism for sharing the analysis of data and documenting research workflows. Notebooks has been an excellent tool for prototyping and writing examples to showcase a piece of software.
The EDS book aims to complement the science and methodological development embedded within academic journals using open infrastructure to translate research outputs into FAIR notebooks which benefit from a collaborative and open reviewing process (Figure 2).
Why EDS book notebooks?¶
EDS book notebooks contributes to open, collaborative and transparent Environmental science. A shared goal among our community-driven notebooks is to increase awareness and demonstrate open-source software developments and open data suited to Environmental science. Building upon recent efforts by EarthCube Peer-Reviewed Jupyter Notebooks initiative, EDS book notebooks advance in providing standards and guidelines for evaluating notebooks and their quality.
EDS book notebooks support FAIR principles for research software (FAIR4RS) as describe below:
F: Software, and its associated metadata, is easy for both humans and machines to find:
All notebooks are hosted as separate repositories in EDS Book Gallery GitHub organisation.
Rendered versions of notebooks are indexed and centralized into a Jupyter Book hosted as a repository in the Alan Turing Institute GitHub organisation.
Notebooks metadata (inputs, outputs, bibliography and software) are findable in ROHub, a Research Object management platform that enables researchers to collaboratively manage, share and preserve their research work (read further in the technologies sections of EDS book notebooks).
The same platform allows handling notebooks versions and assign distinct identifiers.
A: Software, and its metadata, is retrievable via standardised protocols:
Notebooks repositories can be retrieved from Git Clone from GitHub.
RoHub packages EDS book notebooks with their metadata using Research Object Crate (RO-Crate).
I: Software interoperates with other software by exchanging data and/or metadata, and/or through interaction via application programming interfaces (APIs), described through standards:
The Jupyter ecosystem facilitates exchanging data and/or metadata of all published notebooks. through standardised protocols, including a RESTful web service architecture implemented in Jupyter notebook.
Notebooks repositories have a dedicated folder to provide lock environments which pin dependencies according to three main operating systems: Windows, Linux and MacOS.
R: Software is both usable (can be executed) and reusable (can be understood, modified, built upon, or incorporated into other software):
Users have multiple pathways to run notebooks. Notebooks repositories contain clear instructions on how to install their computational environment and dependencies in users own system. We also lower the barrier to access notebooks through public or community cloud-based services in Binder and JupyterHubs.
Notebook repositories and their RoHub repositories can be reused under an OSI-approved MIT license.
Additional to following FAIR principles, we expand the pedagogical possibilities of Jupyter Notebook and community-centred open infrastructure services. We aim to build and connect a community of environmental data scientists and enthusiasts in open-source developments at all levels of seniority.
Since the official launch of EDS book in December 2021, the community has successfully published numerous notebooks covering exploration, preprocessing and modelling from environmental datasets.
Some material in this section and derived content has been adapted from The Turing Way, the Journal of Open Source Education and pyOpenSci content, released under CC BY 4.0, CC BY 4.0 and CC BY-SA 4.0, respectively.