Jupyter Notebook Template for Data Analysis Projects

Link to the template repository: click here

The Jupyter notebook template was generated using the meta template to streamline the adoption of best software development practices in the NES domain.

By leveraging the meta template, essential files that help a project adhere to the FAIR principles, such as license files, CODE_OF_CONDUCT.md, README.md, and others were automatically included, eliminating the need for manual setup.

This also improves maintainability as updates in the meta template, such as changes in license files, can easily be synced using the following command:

copier update --answers-file .meta-answers.yml

Purpose

This template is designed for users creating or managing data analysis projects in Jupyter notebooks. While maintaining NES best practices, the structure was slightly adjusted to better fit the needs of notebook-based workflows.

Structural Adjustments

To align with typical Jupyter-based research workflows, the following modifications were made:

  • data/ folder – Stores datasets used in analysis.

  • notebooks/ folder – Contains a template notebook with placeholders for project name, project owner and project purpose that are dynamically adjusted based on user input during project creation. The template notebook has sections such as data preprocessing and data analysis.

  • tests/ folder – Organizes and runs validation tests on code or data processing steps.

This ensures a structured, reproducible, and well-documented environment for research software development.

How to Use

Your can quickly use this template as follows:

# Create a new project using the fair-code template
copier copy gh:SS-NES/notebook-template.git <my-software-project>

# Navigate to the project directory
cd <my-software-project>

# initialize a git repository
git init
git add .
git commit -m "Initial commit of my software project"

# start coding!

Note

This software template can be applied to preexisting research software projects using the copier copy command.

copier copy gh:SS-NES/notebook-template.git <./your-preexisting-project>