Sample Project

This is as an example on how teams can structure their project repositories. Thanks to Lindsey Heagey and Joachim Meyer for the template!

Files

• .gitignore
  Globally ignored files by git for the project.
• environment.yml
conda environment description needed to run this project.
• README.md
  Description of the project (see suggested headings below)

Folders

contributors

Each team member has it's own folder under contributors, where they can work on their contribution. Having a dedicated folder for each person helps to prevent conflicts when merging with the main branch.

notebooks

Notebooks that are considered delivered results for the project should go in here.

scripts

Helper utilities that are shared with the team

Recommended content for your README.md file:

Project Summary

Project Title

Brief title describing the proposed work.

Collaborators on this project

List all participants on the project. Choose one team member to act as project lead, and identify one hackweek organizer as the data science lead.

The problem

What problem are you going to explore? Provide a few sentences. If this is a technical exploration of software or data science methods, explain why this work is important in a broader context.

Application Example

List one specific application of this work.

Sample data

If you already have some data to explore, briefly describe it here (size, format, how to access).

Specific Questions

List the specific tasks you want to accomplish or research questions you want to answer.

Existing methods

How would you or others traditionally try to address this problem?

Proposed methods/tools

Building from what you learn at this hackweek, what new approaches would you like to try to implement?

Background reading

Optional: links to manuscripts or technical documents for more in-depth analysis.