Update README.md
Browse files
README.md
CHANGED
|
@@ -310,26 +310,29 @@ If you run into any issues regarding feel free to post your questions or comment
|
|
| 310 |
- [**Github Issues**](https://github.com/LeMaterial/lematerial/issues)
|
| 311 |
|
| 312 |
## Citation
|
| 313 |
-
We are currently
|
|
|
|
| 314 |
```
|
| 315 |
@misc {lematerial_2024,
|
| 316 |
-
author
|
| 317 |
-
title
|
| 318 |
-
year
|
| 319 |
-
url
|
| 320 |
-
publisher
|
| 321 |
}
|
|
|
|
| 322 |
|
|
|
|
| 323 |
|
| 324 |
-
|
| 325 |
|
| 326 |
-
If you use materials data which include (”agm-”) in the
|
| 327 |
|
| 328 |
-
If you use materials data which include (”oqmd-”) in the
|
| 329 |
|
| 330 |
Finally, if you make use of the Phase Diagram for visualization purposes, or the crystal viewer in the Materials Explorer, please acknowledge [Crystal Toolkit](https://github.com/materialsproject/crystaltoolkit).
|
| 331 |
|
| 332 |
-
|
| 333 |
|
| 334 |
## License
|
| 335 |
|
|
|
|
| 310 |
- [**Github Issues**](https://github.com/LeMaterial/lematerial/issues)
|
| 311 |
|
| 312 |
## Citation
|
| 313 |
+
We are currently in the process of creating a pre-print to describe our methods, the materials fingerprint method and the dataset. For now however the following can be cited:
|
| 314 |
+
|
| 315 |
```
|
| 316 |
@misc {lematerial_2024,
|
| 317 |
+
author={ {Martin Siron}, {Inel Djafar}, {Lucile Ritchie}, {Etienne Du-Fayet}, {Amandine Rosselo}, {Ali Ramlaoui}, {Leandro von Werra}, {Thomas Wolf}, {Alexandre Duval} },
|
| 318 |
+
title={ LeMat-BulkUnique Dataset },
|
| 319 |
+
year=2024,
|
| 320 |
+
url={ https://huggingface.co/datasets/LeMaterial/LeMat-BulkUnique },
|
| 321 |
+
publisher={ Hugging Face }
|
| 322 |
}
|
| 323 |
+
```
|
| 324 |
|
| 325 |
+
CC-BY-4.0 (license used for Materials Project, Alexandria, OQMD) requires proper acknowledgement.
|
| 326 |
|
| 327 |
+
Thus, if you use materials data which include (”mp-”) in the immutable_id, please cite the [Materials Project](https://pubs.aip.org/aip/apm/article/1/1/011002/119685/Commentary-The-Materials-Project-A-materials).
|
| 328 |
|
| 329 |
+
If you use materials data which include (”agm-”) in the immutable_id, please cite [Alexandria, PBE](https://www.science.org/doi/10.1126/sciadv.abi7948) or [Alexandria PBESol, SCAN](https://www.nature.com/articles/s41597-022-01177-w).
|
| 330 |
|
| 331 |
+
If you use materials data which include (”oqmd-”) in the immutable_id, please cite [OQMD](https://link.springer.com/article/10.1007/s11837-013-0755-4).
|
| 332 |
|
| 333 |
Finally, if you make use of the Phase Diagram for visualization purposes, or the crystal viewer in the Materials Explorer, please acknowledge [Crystal Toolkit](https://github.com/materialsproject/crystaltoolkit).
|
| 334 |
|
| 335 |
+
|
| 336 |
|
| 337 |
## License
|
| 338 |
|