Skip to content

README.md

Latest commit

 

History

History
48 lines (32 loc) · 1.34 KB

README.md

File metadata and controls

48 lines (32 loc) · 1.34 KB

License

Notebook template for data analysis

This is a copier Jupyter Notebook project template for data analysis that implements the best practices on sustainable software for researchers in Natural and Engineering Science. The template provides boilerplate folder structure, a Jupyter notebook, documentation, etc.

How to Use

  1. Use pipx to install copier, and render the template.
# intalling copier
pipx install copier
  1. Start a new Jupyter Notebook project using this template:
copier copy https://github.com/SS-NES/notebook-template <path/to/project-directory>
  1. Inialize a Git repository in your templating project
cd <path/to/project-directory>
git init
git add . 
git commit -m 'initial commit'

Contributing

Read our guidelines to know how to be part of the development of this template.

License

This template is freely available under an Apache License 2.0

Acknowledgements