Skip to content

Commit 72db833

Browse files
committed
Update README and bibtex.
1 parent 26fb52b commit 72db833

2 files changed

Lines changed: 20 additions & 8 deletions

File tree

CITATION.bib

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
@software{brainplotlib,
2+
author = {Ma Feilong and Guo Jiahui and M. Ida Gobbini and James V. Haxby},
3+
title = {brainplotlib: plotting brain data on cortical surface},
4+
month = feb,
5+
year = 2022,
6+
publisher = {Zenodo},
7+
doi = {10.5281/zenodo.5979819},
8+
url = {https://doi.org/10.5281/zenodo.5979819}
9+
}

README.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,9 @@
1-
This is a Python package that plots data on cortical surface.
1+
![PyPI](https://img.shields.io/pypi/v/brainplotlib)
2+
![PyPI - Downloads](https://img.shields.io/pypi/dm/brainplotlib)
3+
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.5979819.svg)](https://doi.org/10.5281/zenodo.5979819)
4+
5+
`brainplotlib` is a Python package that plots data on cortical surface.
6+
It's designed to have minimal requirements --- only `NumPy` and `matplotlib`.
27

38
![brain image](https://github.com/feilong/brainplotlib/raw/main/images/random_data_with_colorbar.png)
49

@@ -10,6 +15,8 @@ pip install brainplotlib
1015

1116
## Example usage
1217

18+
**See the [examples gallery](https://feilong.github.io/brainplotlib/examples/index.html) for all code examples with detailed explanations.**
19+
1320
```Python
1421
import numpy as np
1522
from brainplotlib import brain_plot
@@ -36,7 +43,7 @@ plt.savefig('random_data_with_colorbar.png', bbox_inches='tight')
3643
plt.show()
3744
```
3845

39-
Alternatively, the high-resolution image can be saved directly using `cv2`.
46+
Alternatively, the high-resolution image can be saved directly using `OpenCV`.
4047
```Python
4148
import cv2
4249
cv2.imwrite(
@@ -48,12 +55,8 @@ cv2.imwrite(
4855
If you use this software in your publications, please cite it [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.5979819.svg)](https://doi.org/10.5281/zenodo.5979819)
4956
```bibtex
5057
@software{brainplotlib,
51-
author = {Ma Feilong and
52-
Guo Jiahui and
53-
M. Ida Gobbini and
54-
James V. Haxby},
55-
title = {{brainplotlib: plotting brain data on cortical
56-
surface}},
58+
author = {Ma Feilong and Guo Jiahui and M. Ida Gobbini and James V. Haxby},
59+
title = {brainplotlib: plotting brain data on cortical surface},
5760
month = feb,
5861
year = 2022,
5962
publisher = {Zenodo},

0 commit comments

Comments
 (0)