Skip to content

Commit eb1e999

Browse files
Merge pull request #1475 from softmatterlab/yc-ReadMe
ReadMe updates
2 parents 45dcaf3 + 9ce0d5a commit eb1e999

1 file changed

Lines changed: 14 additions & 15 deletions

File tree

README.md

Lines changed: 14 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -6,37 +6,36 @@
66
<p align="center">
77
<a href="https://twitter.com/braph2software" alt="tweeter"><img src="https://img.shields.io/twitter/url?label=BRAPH%202&style=social&url=https%3A%2F%2Ftwitter.com%2Fbraph2software"></a>
88
<a href="http://braph.org/" alt="website"><img src="https://img.shields.io/website?up_message=braph.org&url=http%3A%2F%2Fbraph.org%2F"></a>
9-
<a href="https://doi.org/10.1371/journal.pone.01787981" alt="DOI"><img src="https://img.shields.io/badge/DOI-10.1371%2Fjournal.pone.0178798-blue">
9+
<a href="https://doi.org/10.1371/journal.pone.0178798" alt="DOI"><img src="https://img.shields.io/badge/DOI-10.1371%2Fjournal.pone.0178798-blue">
1010
</a>
1111
</p>
1212
<p align="center">
1313
<a href="#installation">Installation</a> •
14-
<a href="#using-braph2">Examples</a> •
15-
<a href="#learning-braph-2">Basics</a> •
14+
<a href="#braph-2-usage-examples">Examples</a> •
1615
<a href="#cite-us">Cite us</a> •
17-
<a href="https://github.com/softmatterlab/BRAPH-2-Matlab/blob/develop/braph2genesis/LICENSE">License</a>
16+
<a href="https://github.com/softmatterlab/BRAPH-2-Matlab/blob/develop/LICENSE">License</a>
1817
</p>
1918

2019

2120
An object-oriented software that provides pipelines for conventional brain connectivity analysis as well as more advanced methods, including multilayer networks and deep learning methods.
2221

2322
# Installation
2423

25-
BRAPH 2 requires at least MATLAB 2020b. BRAPH 2 requires Statistics and Machine Learning Toolbox. For deep learning analysis, Deep Learning Toolbox and Deep Learning Toolbox Converter for ONNX Model Format are also needed. We strongly recommend the Parallel Computing Toolbox to speed up BRAPH 2.
24+
BRAPH 2 requires at least **MATLAB R2021a**. BRAPH 2 requires both **Statistics and Machine Learning Toolbox** and **Parallel Computing Toolbox**. For deep learning analysis, **Deep Learning Toolbox** and **Deep Learning Toolbox Converter for ONNX Model Format** are also needed.
2625

27-
To install BRAPH 2, first clone this repository or download via zip.
28-
Once inside MATLAB go to the folder of BRAPH 2 and run braph2genesis (you may have to add it to the path). This will create a braph2 folder with the executable code, it may take a while.
29-
This will be only needed once, or every time you add a new functionality to BRAPH 2.
26+
To install BRAPH 2, first download BRAPH 2.
27+
From our GitHub repository, you can find the latest stable version in the branch <a href="https://github.com/softmatterlab/BRAPH-2-Matlab/tree/master">master</a> and the latest development version in the branch <a href="https://github.com/softmatterlab/BRAPH-2-Matlab/tree/develop">develop</a>.
28+
You can also download BRAPH 2 from our <a href="http://braph.org/software/braph-2/">website</a>.
3029

31-
# Using-braph2
30+
After unzipping the downloaded file into the desired directory and launching MATLAB, change the current folder to **braph2genesis** and run *braph2genesis* (you may have to add it to the path). This installation takes around 5 minutes.
31+
The installation will be only needed once.
32+
You can also follow the <a href="http://braph.org/software/braph-2/">Installation</a> section from our website.
3233

33-
Each provided pipeline comes with an example folder where you can run the example script that mocks the analysis/comparison of the cohort data using the desired graph measures.
34+
# BRAPH 2 usage examples
3435

35-
# Learning-braph-2
36+
BRAPH 2 is a powerful tool that transforms scripts to pipelines. We provide example data in order to test the different analyses and comparisons from the provided pipelines. Please check the <a href="http://braph.org/tutorials/">Tutorials</a> section from our website for the step-by-step instructions and more details.
3637

37-
BRAPH 2 is a powerful tool that transforms scripts to pipelines. Please check the tutorial section on our website <a href="http://braph.org/tutorials/"></a>
38-
39-
## Cite us!
38+
# Cite us!
4039
If you use BRAPH 2 in your project, please cite us here:
4140

4241
```
@@ -52,5 +51,5 @@ See also:
5251
```
5352
Mite Mijalkov, Ehsan Kakaei, Joana B Pereira, Eric Westman, Giovanni Volpe
5453
BRAPH: A graph theory software for the analysis of brain connectivity.
55-
PLOS ONE 12, e0178798 (2017)..
54+
PLOS ONE 12, e0178798 (2017).
5655
```

0 commit comments

Comments
 (0)