Skip to content

Commit

Permalink
add citation and update badge
Browse files Browse the repository at this point in the history
  • Loading branch information
sgbaird authored Jun 1, 2024
1 parent d11c2f3 commit 8b07777
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,9 @@
[![PyPI-Server](https://img.shields.io/pypi/v/matbench-genmetrics.svg)](https://pypi.org/project/matbench-genmetrics/)
[![Conda-Forge](https://img.shields.io/conda/vn/conda-forge/matbench-genmetrics.svg)](https://anaconda.org/conda-forge/matbench-genmetrics)
![PyPI - Downloads](https://img.shields.io/pypi/dm/matbench-genmetrics)
![Lines of code](https://img.shields.io/tokei/lines/github/sparks-baird/matbench-genmetrics)
[![DOI](https://joss.theoj.org/papers/10.21105/joss.05618/status.svg)](https://doi.org/10.21105/joss.05618)
<!-- These are examples of badges you might also want to add to your README. Update the URLs accordingly.
![Lines of code](https://img.shields.io/tokei/lines/github/sparks-baird/matbench-genmetrics)
[![Built Status](https://api.cirrus-ci.com/github/<USER>/matbench-genmetrics.svg?branch=main)](https://cirrus-ci.com/github/<USER>/matbench-genmetrics)
[![Monthly Downloads](https://pepy.tech/badge/matbench-genmetrics/month)](https://pepy.tech/project/matbench-genmetrics)
[![Twitter](https://img.shields.io/twitter/url/http/shields.io.svg?style=social&label=Twitter)](https://twitter.com/matbench-genmetrics)
Expand Down Expand Up @@ -246,6 +247,14 @@ Then take a look into the `scripts` and `notebooks` folders.

<!-- pyscaffold-notes -->

## Citing

Baird, S.G.; Sayeed, H.M.; Montoya, J.; Sparks, T.D. (2024). matbench-genmetrics: A Python library for benchmarking crystal structure generative models using time-based splits of Materials Project structures. _Journal of Open Source Software_, 9(97), 5618, https://doi.org/10.21105/joss.05618

```bibtex
@article{Baird2024, doi = {10.21105/joss.05618}, url = {https://doi.org/10.21105/joss.05618}, year = {2024}, publisher = {The Open Journal}, volume = {9}, number = {97}, pages = {5618}, author = {Sterling G. Baird and Hasan M. Sayeed and Joseph Montoya and Taylor D. Sparks}, title = {matbench-genmetrics: A Python library for benchmarking crystal structure generative models using time-based splits of Materials Project structures}, journal = {Journal of Open Source Software} }
```

## Note

This project has been set up using [PyScaffold] 4.2.2.post1.dev2+ge50b5e1 and the [dsproject extension] 0.7.2.post1.dev2+geb5d6b6.
Expand Down

0 comments on commit 8b07777

Please sign in to comment.