Skip to content

Commit 0c4dd5a

Browse files
committed
consolidated dr. watson README.md with "legacy" lab version
1 parent cbdedaf commit 0c4dd5a

File tree

1 file changed

+61
-1
lines changed

1 file changed

+61
-1
lines changed

README.md

Lines changed: 61 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,64 @@
1-
# template_project
1+
# **Project Template:** Put name of project here
2+
**Author:** *Your name*
3+
4+
**Supervisor(s):** *Supervisor 1*, *Supervisor 2*
5+
6+
**Year:** *2025*
7+
8+
## Project Description
9+
>provide a short description of the main goals
10+
11+
## Zotero Library Path
12+
>Please provide the link to the Zotero group here or include a `Bib`-File in the `report` folder
13+
14+
## Instructions
15+
>If someone wants to re-run your study, how do they do that? Give instructions here.
16+
17+
## Overview of Folder Structure
18+
19+
```
20+
│projectdir <- Project's main folder. It is initialized as a Git
21+
│ repository with a .gitignore file.
22+
23+
├── experiment <- Files for running the experiment
24+
|
25+
├── notebooks <- Pluto, Jupyter, Weave or any other mixed media notebooks.*
26+
|
27+
├── papers <- Materials related to paper, publishing
28+
|
29+
├── _research <- WIP scripts, code, notes, comments,
30+
│ | to-dos and anything in an alpha state.
31+
32+
├── plots <- All exported plots go here, best in date folders.
33+
| | Note that to ensure reproducibility it is required that all plots can be
34+
| | recreated using the plotting scripts in the scripts folder.
35+
|
36+
37+
├── scripts <- Various scripts, e.g. simulations, plotting, analysis,
38+
│ │ The scripts use the `src` folder for their base code.
39+
40+
├── src <- Source code for use in this project. Contains functions,
41+
│ structures and modules that are used throughout
42+
│ the project and in multiple scripts.
43+
44+
├── test <- Folder containing tests for `src`.
45+
│ └── runtests.jl <- Main test file
46+
47+
├── README.md <- Top-level README.
48+
|
49+
├── .gitignore <- produced by Dr. Watson
50+
51+
├── (Manifest.toml) <- Contains full list of exact package versions used currently.
52+
|── (Project.toml) <- Main project file, allows activation and installation. Produced by Dr. Watson
53+
|── (project_project_template.toml) <- This is for a content-wise description of your exepriment.
54+
Change "project_template" in the filename to your project name.
55+
56+
```
57+
58+
\*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.
59+
60+
61+
# template_project - produced by Dr. Watson
262

363
This code base is using the [Julia Language](https://julialang.org/) and
464
[DrWatson](https://juliadynamics.github.io/DrWatson.jl/stable/)

0 commit comments

Comments
 (0)