Template repository for matlab analysis project

Content

├── .git
│   ├── COMMIT_EDITMSG
│   ├── FETCH_HEAD
│   ├── HEAD
│   ├── ORIG_HEAD
│   ├── branches
│   ├── config
│   ├── description
│   ├── hooks
│   │   ├── pre-commit.sample
│   │   └── pre-push.sample
│   ├── ...
│   └── ...
├── .github  # where you put anything github related
│   └── workflows # where you define your github actions
│       └── moxunit.yml # a yaml file that defines a github action
├── lib # where you put the code from external libraries (mathworks website or other github repositories)
│   └── README.md
├── src # where you put your code
│   ├── README.md
│   └── miss_hit.cfg
├── tests # where you put your unit tests
|   ├── README.md
|   └── miss_hit.cfg
├── .travis.yml # where you define the continuous integration done by Travis
├── LICENSE
├── README.md
├── requirements.txt # list of python packages used in this repo: to install `pip install -r requirements.txt`
├── miss_hit.cfg # configuration file for the matlab miss hit linter
└── initEnv.m # a .m file to set up your project (adds the right folder to the path)

Keeping your code stylish: miss hit linter

Python environment

More on this here

Conda cheat sheet

Testing your code

Continuous integration

How to install and use this template

By using the template PTB experiment repository: you can create a new repository on your github account with all the basic folders, files and submodules already set up. You only have to then clone the repository and you are good to go.

How to install and run

Install

git clone --recurse-submodules https://github.com/your_github_account/the_name_of_your_new_experiment.git

Set parameters in setParameters.m

Run

mainScript