citation notes for the data retrieval classes

hackingmaterials · Feb 8, 2019 · 721388a · 721388a
1 parent f029180
commit 721388a
Show file tree

Hide file tree

Showing 4 changed files with 25 additions and 1 deletion.
diff --git a/matminer/data_retrieval/retrieve_AFLOW.py b/matminer/data_retrieval/retrieve_AFLOW.py
@@ -23,7 +23,7 @@ class AFLOWDataRetrieval(BaseDataRetrieval):
     dynamically generate the keywords supported by the AFLUX API from their
     servers, which makes it robust against changes in the AFLOW system.
 
-    If you use data from this method, please additionally cite:
+    If you use this data retrieval class, please additionally cite:
     Rose, F., Toher, C., Gossett, E., Oses, C., Nardelli, M.B., Fornari, M.,
     Curtarolo, S., 2017. AFLUX: The LUX materials search API for the AFLOW
     data repositories. Computational Materials Science 137, 362–370.

diff --git a/matminer/data_retrieval/retrieve_MDF.py b/matminer/data_retrieval/retrieve_MDF.py
@@ -21,6 +21,12 @@ class MDFDataRetrieval(BaseDataRetrieval):
 
         >>>results = mdf_dr.get_dataframe({"source_names": ["oqmd"],
         >>>          "match_ranges": {"oqmd.band_gap.value": [4.0, "*"]}})
+
+    If you use this data retrieval class, please additionally cite:
+    Blaiszik, B., Chard, K., Pruyne, J., Ananthakrishnan, R., Tuecke, S.,
+    Foster, I., 2016. The Materials Data Facility: Data Services to Advance
+    Materials Science Research. JOM 68, 2045–2052.
+    https://doi.org/10.1007/s11837-016-2001-3
     """
 
     def __init__(self, anonymous=False, **kwargs):

diff --git a/matminer/data_retrieval/retrieve_MP.py b/matminer/data_retrieval/retrieve_MP.py
@@ -12,6 +12,16 @@
 class MPDataRetrieval(BaseDataRetrieval):
     """
     Retrieves data from the Materials Project database.
+
+    If you use this data retrieval class, please additionally cite:
+
+    Ong, S.P., Cholia, S., Jain, A., Brafman, M., Gunter, D., Ceder, G.,
+    Persson, K.A., 2015. The Materials Application Programming Interface
+    (API): A simple, flexible and efficient API for materials data based on
+    REpresentational State Transfer (REST) principles. Computational
+    Materials Science 97, 209–215.
+    https://doi.org/10.1016/j.commatsci.2014.10.037
+
     """
 
     def __init__(self, api_key=None):

diff --git a/matminer/data_retrieval/retrieve_MPDS.py b/matminer/data_retrieval/retrieve_MPDS.py
@@ -74,6 +74,14 @@ class MPDSDataRetrieval(BaseDataRetrieval):
 
     *or*
     jsonobj = client.get_data({"formula":"SrTiO3"}, fields=[])
+
+    If you use this data retrieval class, please additionally cite:
+    Blokhin, E., Villars, P., 2018. The PAULING FILE Project and Materials
+    Platform for Data Science: From Big Data Toward Materials Genome,
+    in: Andreoni, W., Yip, S. (Eds.), Handbook of Materials Modeling :
+    Methods: Theory and Modeling. Springer International Publishing, Cham,
+    pp. 1–26. https://doi.org/10.1007/978-3-319-42913-7_62-1
+
     """
     default_properties = ('Phase', 'Formula', 'SG',
                           'Entry', 'Property', 'Units', 'Value')