Overview of the project

Example project for Tools for Scientific Software Development and Data Science course 2022, AAU.

structure:

Project_name

• README.md # overview of the project
• data/ # data files used in the project
  • README.md # describes where data came from
  • sub-folder/ # may contain subdirectories
• processed_data/ # intermediate files from the analysis
• manuscript/ # manuscript describing the results
• results/ # results of the analysis (data, tables, figures)
• src/ # contains all code in the project
  • LICENSE # license for your code
  • requirements.txt # software requirements and dependencies
  • ...
• doc/ # documentation for your project
  • index.rst
  • ...