Skip to content
Repository of tutorials for The COBRA Toolbox
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.artenolis change of updating submodules command Mar 5, 2019
.template renaming template directory Sep 24, 2018
analysis fix all logo urls in readme files Apr 2, 2019
base fix all logo urls in readme files Apr 2, 2019
dataIntegration fix all logo urls in readme files Apr 2, 2019
design
reconstruction
visualization fix all logo urls in readme files Apr 2, 2019
.artenolis.yml
.gitignore updating gitignore Sep 24, 2018
README.rst

README.rst

COBRA Tutorials

Tutorials are here to get you started with using The COBRA Toolbox. The tutorials are grouped according to the src/ folder structure:

All tutorials are provided in 4 formats: .mlx, .m, .pdf, and .html.

Contribute a new tutorial or modify an existing tutorial

A template for generating a new tutorial is provided here.

Contribute using the MATLAB.devTools

You can use the MATLAB.devTools to submit your tutorial.

Contribute using git (via command line)

Fork and checkout your branch

  1. Fork the COBRA.tutorials repository on Github.

  2. Clone the forked repository to a directory of your choice:

    $ git clone git@github.com:<userName>/COBRA.tutorials.git fork-COBRA.tutorials.git
  3. Change to the directory:

    $ cd fork-COBRA.tutorials.git/
  4. Set the upstream to the opencobra/COBRA.tutorials repository:

    $ git remote add upstream git@github.com:opencobra/COBRA.tutorials.git
  5. Fetch from the upstream repository

    $ git fetch upstream
  6. Checkout a new branch from develop:

    $ git checkout -b <yourBranch> upstream/develop
  7. Now, make your changes in the tutorial in MATLAB.

Submit your changes and open a pull request

  1. Once you are done making changes, add the files to your branch, where tutorial_<yourFile> is the name of the tutorial. Make sure to add the .m and the .mlx files.

    $ git add tutorial_<yourFile>.m
    $ git add tutorial_<yourFile>.mlx
    $ git commit -m "Changes to tutorial_<yourFile>"
  2. Push your commits on <yourBranch> to your fork:

    $ git push origin <yourBranch>
  3. Browse to your fork on https://www.github.com/<yourUserName>/COBRA.tutorials, where <yourUserName> is your Github username.

  4. Click on Compare & Pull Request.

  5. Change the target branch develop.

  6. Submit your pull request.

  7. Wait until your pull request is accepted.

You can’t perform that action at this time.