search

Remi-Gau / template_matlab_analysis

A "clean code" template for MATLAB and Octave projects
https://template-matlab-analysis.readthedocs.io/en/latest/general_information.html
GNU General Public License v3.0
4 stars 1 forks source link
clean-code matlab octave template

readme

pre-commit MATLAB: test and coverage Octave: test and coverage codecov pre-commit Documentation Status: latest Binder

Template repository for MATLAB / Octave projects

How to install and use this template

Install with Github

  1. Click the green button Use this template.

  1. Give a name to the repository you want to create. Something short that contains the name of your project: analysis_my_study.

  1. Decide if you want this new repo to be public or private.

  2. Click on Create repository from template

    You now have a copy of the template on your Github account. You can then download the code and the pre-set dependencies like this.

  3. Click on green Download button and copy the URL_to_your_repo that is shown there.

  4. Open a terminal and type this:

git clone URL_to_your_repo

Install with cookiecutter

Install Cookiecutter:

pip install -U cookiecutter

Generate project:

cookiecutter https://github.com/Remi-Gau/cookiecutter_matlab_analysis.git

Configuration

Check the CONTRIBUTING.md for more information on setting up this repo.