diff --git a/README.md b/README.md index 2a970fd..f8970cc 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,27 @@ -# Brain Source Imaging (BSI) Zoo -The goal of this repository is to efficiently implement conventional and state-of-the art brain source imaging techniques and benchmark their performance with respect to different metrics. In the following, we will briefly describe the key information about each method and show preliminary performance results on the [RAMP challenge](https://github.com/ramp-kits/meg). +# Welcome to the Brain Source Imaging (BSI) Zoo + +drawing + +This package allows for a standardized comparison of BSI methods with custom simulations. + +✔️ source estimation at controlled SNR levels + +✔️ support for both random and semi-real data generation + +✔️ support for fixed and free orientation + +✔️ performance evaluation + +✔️ parameter optimisation + + +.. and ships with several BSI methods! + +## Setup +``` +python setup.py install +``` + +## Documentation + +Coming Soon 🚀