Skip to content

Commit 3a99103

Browse files
authored
Merge pull request #577 from mapping-commons/cthoyt-patch-1
Add suggested citations to readme
2 parents e2f67de + e9a3de8 commit 3a99103

File tree

1 file changed

+51
-4
lines changed

1 file changed

+51
-4
lines changed

README.md

Lines changed: 51 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616
<a href="https://github.com/psf/black">
1717
<img src="https://img.shields.io/badge/code%20style-black-000000.svg" alt="Code style: black">
1818
</a>
19+
<a href="https://doi.org/10.5281/zenodo.14296666"><img src="https://zenodo.org/badge/DOI/10.5281/zenodo.14296666.svg" alt="DOI"></a>
1920
</p>
2021

2122
<img src="https://github.com/tis-lab/closed-illustrations/raw/master/logos/sssom-logos/sssom_logo_black_banner.png" />
@@ -37,9 +38,10 @@ This is a python library and command line toolkit for working with SSSOM. It als
3738
See [documentation](https://mapping-commons.github.io/sssom-py/index.html#)
3839

3940
### Deploy documentation
40-
```shell
41-
make sphinx
42-
make deploy-docs
41+
42+
```console
43+
$ make sphinx
44+
$ make deploy-docs
4345
```
4446

4547
## Schema
@@ -53,7 +55,7 @@ derivations to JSON-Schema, ShEx, etc.
5355
configuration is stored in [`tox.ini`](tox.ini) in different "environments"
5456
whose headers look like `[testenv:...]`. All tests can be run with:
5557

56-
```shell
58+
```console
5759
$ pip install tox
5860
$ tox
5961
```
@@ -78,4 +80,49 @@ natural language processing and large-scale knowledge assembly. Their work on SS
7880
DARPA Young Faculty Award W911NF2010255 (PI: Benjamin M. Gyori).
7981

8082
https://indralab.github.io
83+
84+
## Citation
85+
86+
SSSOM itself can be cited with:
87+
88+
```bibtex
89+
@article{10.1093/database/baac035,
90+
author = {Matentzoglu, Nicolas and Balhoff, James P and Bello, Susan M and Bizon, Chris and Brush, Matthew and Callahan, Tiffany J and Chute, Christopher G and Duncan, William D and Evelo, Chris T and Gabriel, Davera and Graybeal, John and Gray, Alasdair and Gyori, Benjamin M and Haendel, Melissa and Harmse, Henriette and Harris, Nomi L and Harrow, Ian and Hegde, Harshad B and Hoyt, Amelia L and Hoyt, Charles T and Jiao, Dazhi and Jiménez-Ruiz, Ernesto and Jupp, Simon and Kim, Hyeongsik and Koehler, Sebastian and Liener, Thomas and Long, Qinqin and Malone, James and McLaughlin, James A and McMurry, Julie A and Moxon, Sierra and Munoz-Torres, Monica C and Osumi-Sutherland, David and Overton, James A and Peters, Bjoern and Putman, Tim and Queralt-Rosinach, Núria and Shefchek, Kent and Solbrig, Harold and Thessen, Anne and Tudorache, Tania and Vasilevsky, Nicole and Wagner, Alex H and Mungall, Christopher J},
91+
title = {A Simple Standard for Sharing Ontological Mappings (SSSOM)},
92+
journal = {Database},
93+
volume = {2022},
94+
pages = {baac035},
95+
year = {2022},
96+
month = {05},
97+
issn = {1758-0463},
98+
doi = {10.1093/database/baac035},
99+
url = {https://doi.org/10.1093/database/baac035},
100+
eprint = {https://academic.oup.com/database/article-pdf/doi/10.1093/database/baac035/43832024/baac035.pdf},
101+
}
102+
```
103+
104+
To cite the SSSOM-py software package specifically, use:
105+
106+
```bibtex
107+
@software{sssom-py,
108+
author = {Harshad Hegde and
109+
Nico Matentzoglu and
110+
Charles Tapley Hoyt and
111+
Chris Mungall and
112+
Joe Flack and
113+
Benjamin M. Gyori and
114+
Damien Goutte-Gattat and
115+
Glass and
116+
Syphax Bouazzouni},
117+
title = {mapping-commons/sssom-py: v0.4.15 release (minor
118+
fixes)
119+
},
120+
month = dec,
121+
year = 2024,
122+
publisher = {Zenodo},
123+
version = {v0.4.15},
124+
doi = {10.5281/zenodo.14296666},
125+
url = {https://doi.org/10.5281/zenodo.14296666},
126+
}
127+
```
81128

0 commit comments

Comments
 (0)