Skip to content

Latest commit

 

History

History
70 lines (52 loc) · 2.61 KB

README.md

File metadata and controls

70 lines (52 loc) · 2.61 KB
Raw

If you find the framework useful, you can cite this work:

@article{Marcireau_2020,
    title={Sepia, Tarsier, and Chameleon: A Modular C++ Framework for Event-Based Computer Vision},
    volume={13},
    ISSN={1662-453X},
    url={http://dx.doi.org/10.3389/fnins.2019.01338},
    DOI={10.3389/fnins.2019.01338},
    journal={Frontiers in Neuroscience},
    publisher={Frontiers Media SA},
    author={Marcireau, Alexandre and Ieng, Sio-Hoi and Benosman, Ryad},
    year={2020},
    month={Jan},
}

banner

Tutorials provides step-by-step guides to learn how to use the Sepia, Tarsier and Chameleon libraries.

The tutorials are held in the wiki. This repository contains the result files produced during the tutorials.

install

You do not need to clone this repository to follow the tutorials. Nonetheless, if you want to download the tutorials' result files, run the command:

git clone --recursive https://github.com/neuromorphic-paris/tutorials.git

Each tutorial has its own copy of the upstream libraries (Sepia, Tarsier and Chameleon), so that each directory may be used as a boilerplate for your projects. Thus, cloning the whole directory takes time and space. If you are only interested in cloning one of the tutorials, clone the repository without the submodules, then manually pull the tutorial of interest's submodules. As an example, to setup only the blob tracker example:

git clone https://github.com/neuromorphic-paris/tutorials.git
cd tutorials/examples/blob_tracker/third_party
git submodule update --init --recursive sepia tarsier chameleon

contribute

development dependencies

Debian / Ubuntu

Open a terminal and run:

sudo apt install clang-format # formatting tool

macOS

Open a terminal and run:

brew install clang-format # formatting tool

Windows

The clang-format tool is provided by Visual Studio.

format

After changing the code, format the source files by running from the tutorials directory:

for directory in basics/*; do cd $directory; for file in source/*.[hc]pp; do clang-format -i $file; done; cd ../..; done
for directory in examples/*; do cd $directory; for file in source/*.[hc]pp; do clang-format -i $file; done; cd ../..; done

Windows users must run Edit > Advanced > Format Document from the Visual Studio menu instead.

License

See the LICENSE file for license rights and limitations (GNU GPLv3).