(Based on https://drivendata.github.io/cookiecutter-data-science/)
Project Description
├── LICENSE
├── README.md <- The top-level README for developers using this project.
├── data
│ ├── external <- Data from third party sources.
│ ├── interim <- Intermediate data that has been transformed.
│ ├── processed <- The final, canonical data sets for modeling.
│ └── raw <- The original, immutable data dump.
│
├── docs <- Documentation for running code, description of results
│ ├── analysis.md <- File with descriptions for how to run analyses
| ├── data.md <- Description of the datasets in ./data
│ ├── figures <- Folder for figures (.png, .jpg, etc.)
│ ├── manuscript <- Folder for files for writing the paper, or link to Overleaf project
│ ├── meetings.md <- Notes from meetings and discussions
│ ├── pdfs <- PDF files (e.g., PDFs of relevant papers linked in referenced.md)
│ ├── references.md <- List of relevant papers and other references
│ ├── reports-completed <- Finished reports and presentations about the project (grants, talks, papers)
| ├── project-ideas.md <- The overall project ideas
│
├── models <- Trained and serialized models, model predictions, or model summaries
│
├── notebooks <- Jupyter notebooks. Naming convention is a number (for ordering),
│ the creator's initials, and a short `-` delimited description, e.g.
│ `1.0-jqp-initial-data-exploration`.
│
├── requirements.txt <- The requirements file for reproducing the analysis environment, e.g.
│ generated with `pip freeze > requirements.txt`
| or `conda list -e > requirements.txt`
│
├── setup.py <- makes project pip installable (pip install -e .) so src can be imported
├── src <- Source code for use in this project.
│ ├── __init__.py <- Makes src a Python module
│ │
│ ├── data <- Scripts to download, preprocess, or generate data
│ │ └── make_dataset.py
│ │
│ ├── models <- Scripts to train models and then use trained models to make
│ │ │ predictions
│ │ ├── predict_model.py
│ │ └── train_model.py
│ │
│ └── visualization <- Scripts to create exploratory and results oriented visualizations
│ └── visualize.py
-
Create new private GitHub repository and add student
-
Make regular meeting time
-
Add student to Slack channel
-
Add student to computing wiki
-
Give student access to GPU01/03
-
Set up Overleaf project