|
1 | 1 | [](https://github.com/cpp-lln-lab/template_PTB_experiment/actions) |
2 | 2 |  |
3 | 3 | [](https://codecov.io/gh/cpp-lln-lab/template_PTB_experiment) |
4 | | -[](https://travis-ci.com/cpp-lln-lab/template_PTB_experiment) |
5 | 4 |
|
6 | | -# Template repository for matlab analysis project |
| 5 | +# Template repository for psycthoolbox experiment |
7 | 6 |
|
8 | 7 | ## Content |
9 | 8 |
|
10 | 9 | ```bash |
11 | 10 | ├── .git |
12 | | -│ ├── COMMIT_EDITMSG |
13 | | -│ ├── FETCH_HEAD |
14 | | -│ ├── HEAD |
15 | | -│ ├── ORIG_HEAD |
16 | | -│ ├── branches |
17 | | -│ ├── config |
18 | | -│ ├── description |
19 | | -│ ├── hooks |
20 | | -│ │ ├── pre-commit.sample |
21 | | -│ │ └── pre-push.sample |
22 | | -│ ├── ... |
23 | | -│ └── ... |
24 | 11 | ├── .github # where you put anything github related |
25 | 12 | │ └── workflows # where you define your github actions |
26 | 13 | │ └── moxunit.yml # a yaml file that defines a github action |
27 | | -├── lib # where you put the code from external libraries (mathworks website or other github repositories) |
| 14 | +├── lib # external libraries (mathworks website or other github repositories) |
28 | 15 | │ └── README.md |
29 | 16 | ├── src # where you put your code |
30 | 17 | │ ├── README.md |
31 | 18 | │ └── miss_hit.cfg |
32 | 19 | ├── tests # where you put your unit tests |
33 | 20 | | ├── README.md |
34 | 21 | | └── miss_hit.cfg |
35 | | -├── .travis.yml # where you define the continuous integration done by Travis |
36 | 22 | ├── LICENSE |
37 | 23 | ├── README.md |
38 | | -├── requirements.txt # list of python packages used in this repo: to install `pip install -r requirements.txt` |
| 24 | +├── requirements.txt # python packages used: to install `pip install -r requirements.txt` |
39 | 25 | ├── miss_hit.cfg # configuration file for the matlab miss hit linter |
40 | 26 | └── initEnv.m # a .m file to set up your project (adds the right folder to the path) |
41 | 27 | ``` |
42 | 28 |
|
43 | | -## Keeping your code stylish: miss hit linter |
44 | | - |
45 | | -## Python environment |
46 | | - |
47 | | -More on this |
48 | | -[here](https://the-turing-way.netlify.app/reproducible-research/renv/renv-package.html) |
49 | | - |
50 | | -[Conda cheat sheet](https://docs.conda.io/projects/conda/en/4.6.0/_downloads/52a95608c49671267e40c689e0bc00ca/conda-cheatsheet.pdf) |
51 | | - |
52 | | -## Testing your code |
53 | | - |
54 | | -## Continuous integration |
55 | | - |
56 | 29 | ## How to install and use this template |
57 | 30 |
|
58 | 31 | By using the |
59 | 32 | [template PTB experiment repository](https://github.com/cpp-lln-lab/template_PTB_experiment): |
60 | | -you can create a new repository on your github account with all the basic folders, |
61 | | -files and submodules already set up. You only have to then clone the repository |
62 | | -and you are good to go. |
63 | | - |
| 33 | +you can create a new repository on your github account with all the basic |
| 34 | +folders, files and submodules already set up. You only have to then clone the |
| 35 | +repository and you are good to go. |
64 | 36 |
|
65 | 37 | ## How to install and run |
66 | 38 |
|
67 | 39 | Install |
| 40 | + |
68 | 41 | ``` |
69 | 42 | git clone --recurse-submodules https://github.com/your_github_account/the_name_of_your_new_experiment.git |
70 | 43 | ``` |
71 | 44 |
|
72 | 45 | Set parameters in `setParameters.m` |
73 | 46 |
|
74 | 47 | Run |
| 48 | + |
75 | 49 | ``` |
76 | 50 | mainScript |
77 | 51 | ``` |
0 commit comments