Skip to content

Commit

Permalink
Update README.md: Comment about reproducibility of plots + other mino…
Browse files Browse the repository at this point in the history
…r changes
  • Loading branch information
jschepers authored Jan 9, 2023
1 parent 0cf0200 commit f7f01c9
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,12 +27,15 @@
├── report <- **Immutable and add-only!**
│ ├── proposal <- Proposal PDF
│ ├── thesis <- Final Thesis PDF
│ ├── talks <- PDFs (and optionally pptx etc) of Mid&Final-Talk
│ ├── talks <- PDFs (and optionally pptx etc) of the Intro,
| | Midterm & Final-Talk
|
├── _research <- WIP scripts, code, notes, comments,
│ | to-dos and anything in an alpha state.
├── plots <- All exported plots go here, best in date folders
├── plots <- All exported plots go here, best in date folders.
| | Note that to ensure reproducibility it is required that all plots can be
| | recreated using the plotting scripts in the scripts folder.
|
├── notebooks <- Pluto, Jupyter, Weave or any other mixed media notebooks.*
Expand All @@ -58,4 +61,4 @@
```

*Instead of having a separate *notebooks* folder, you can also delete it and integrate your notebooks in the scripts folder. However, notebooks should always be marked by adding `nb_` in front of the file name.
\*Instead of having a separate *notebooks* folder, you can also delete it and integrate your notebooks in the scripts folder. However, notebooks should always be marked by adding `nb_` in front of the file name.

0 comments on commit f7f01c9

Please sign in to comment.