Manage your research project

This is a workshop in development about how to set up a research project on your computer. There are many ways to do this, and how you do it may depend on your unique project and personal preferences. This workshop will guide you through an example of how you can organize your research project files, use version control, create a Python module to contain useful functions, and prepare a paper and reproduction package at the end.

Nothing that we show here is compulsory. Just follow along and see which tips and tricks you can use for your own research project.

Contents:

• Introduction
  • Motivation
  • What will we do during the workshop?
  • Sections and timing
  • What do you need before you start?
• Project directory
  • Choosing a place for your project directory
• Project directory structure
  • Creating a general projects directory
  • Creating a project directory using cookiecutter
  • The created directory structure
  • README
  • File formats
  • Naming files
• Git version control
  • Initialize Git for the src directory
  • Setting up the Github project
• Data analysis
  • Obtaining the data
  • Fitting the data
  • Python package and git
  • Readme
• Paper preparation
  • Adding your results to the paper
• Reproduction package
  • FAIR principles
  • Creating the package
  • Upload to Zenodo
  • The data availability section
  • Congratulations!

Indices and tables

• Index

• Module Index

• Search Page