Skip to content

Commit b3bd7ba

Browse files
committed
📝 update README
1 parent dbc2c36 commit b3bd7ba

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

README.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# brainextractor
2-
A reimplementation of FSL's Brain Extraction Tool in Python.
2+
A re-implementation of FSL's Brain Extraction Tool in Python.
33

44
Follows the algorithm as described in:
55

@@ -8,11 +8,13 @@ Smith SM. Fast robust automated brain extraction. Hum Brain Mapp.
88
2002 Nov;17(3):143-55. doi: 10.1002/hbm.10062. PMID: 12391568; PMCID: PMC6871816.
99
```
1010

11+
This code was originally made for a [course project](https://www.cse.wustl.edu/~taoju/cse554/).
12+
1113
https://user-images.githubusercontent.com/3641187/190677589-be019bc6-60e4-4e96-8c71-266285ab0755.mp4
1214

1315
## Install
1416

15-
To install, simply use `pip` to install this repo:
17+
To install, use `pip` to install this repo:
1618

1719
```
1820
# install from pypi
@@ -25,7 +27,7 @@ pip install git+https://github.com/vanandrew/brainextractor@main
2527
pip install /path/to/local/repo
2628
```
2729

28-
Note that it is recommended to use `brainextractor` on python 3.7+
30+
> **__NOTE:__** It is recommended to use `brainextractor` on **Python 3.7+**
2931
3032
## Usage
3133

@@ -49,8 +51,8 @@ brainextractor [input_image] [output_image] -f [threshold]
4951
brainextractor /path/to/test_image.nii.gz /path/to/some_output_image.nii.gz -f 0.4
5052
```
5153

52-
To view the deformation process, you can use the `-w` flag to write the
53-
surfaces to a file. Then use `brainextractor_render` to view them:
54+
To view the deformation process (as in the video above), you can use the `-w` flag to
55+
write the surfaces to a file. Then use `brainextractor_render` to view them:
5456

5557
```
5658
# writes surfaces to file
@@ -65,7 +67,7 @@ brainextractor /path/to/test_image.nii.gz /path/to/some_output_image.nii.gz -w /
6567
brainextractor_render /path/to/surface_file.surfaces
6668
```
6769

68-
If you need an explanation of the options at any time, simply run the help:
70+
If you need an explanation of the options at any time, simply run the `--help` flag:
6971

7072
```
7173
brainextractor --help

0 commit comments

Comments
 (0)