add cite information

yuriok · Aug 29, 2021 · 7473106 · 7473106
1 parent cd8b7be
commit 7473106
Show file tree

Hide file tree

Showing 11 changed files with 31 additions and 2 deletions.
diff --git a/QGrain/__init__.py b/QGrain/__init__.py
@@ -1,4 +1,4 @@
-QGRAIN_VERSION = "0.3.4.1"
+QGRAIN_VERSION = "0.3.4.2"
 
 import os
 

diff --git a/QGrain/charts/SSUTypicalComponentChart.py b/QGrain/charts/SSUTypicalComponentChart.py
@@ -251,6 +251,9 @@ def save_typical(self, filename):
             """
             This Excel file was generated by QGrain ({0}).
 
+            Please cite:
+            Liu, Y., Liu, X., Sun, Y., 2021. QGrain: An open-source and easy-to-use software for the comprehensive analysis of grain size distributions. Sedimentary Geology 423, 105980. https://doi.org/10.1016/j.sedgeo.2021.105980
+
             It contanins 2 + N_clusters sheets:
             1. The first sheet is the sum distributions of all component clusters.
             2. The second sheet is used to put the component distributions that not in any cluster.

diff --git a/QGrain/ui/AboutPanel.py b/QGrain/ui/AboutPanel.py
@@ -11,6 +11,10 @@
 
 QGrain aims to provide an easy-to-use and comprehensive analysis platform for grain-size distributions. QGrain has implemented many functions, however, there still are many useful tools that have not been contained. Hence, we published QGrain as an open-source project, and welcome other researchers to contribute their ideas and codes. Codes are available at this GitHub [repository](https://github.com/yuriok/QGrain/). More information and tutorials are available at the [offical website](https://qgrain.net/).
 
+Please cite:
+
+* Liu, Y., Liu, X., Sun, Y., 2021. QGrain: An open-source and easy-to-use software for the comprehensive analysis of grain size distributions. Sedimentary Geology 423, 105980. https://doi.org/10.1016/j.sedgeo.2021.105980
+
 Feel free to contact the author below.
 
 * Yuming Liu, a PhD student of IEECAS, [liuyuming@ieecas.cn](mailto:liuyuming@ieecas.cn)

diff --git a/QGrain/ui/EMMAResolverPanel.py b/QGrain/ui/EMMAResolverPanel.py
@@ -348,6 +348,9 @@ def save_result_excel(self, filename: str, result: EMMAResult):
             """
             This Excel file was generated by QGrain ({0}).
 
+            Please cite:
+            Liu, Y., Liu, X., Sun, Y., 2021. QGrain: An open-source and easy-to-use software for the comprehensive analysis of grain size distributions. Sedimentary Geology 423, 105980. https://doi.org/10.1016/j.sedgeo.2021.105980
+
             It contanins three sheets:
             1. The first sheet is the dataset which was used to perform the EMMA algorithm.
             2. The second sheet is used to put the distributions of all end-members.

diff --git a/QGrain/ui/FittingResultViewer.py b/QGrain/ui/FittingResultViewer.py
@@ -454,6 +454,9 @@ def save_excel(self, filename, align_components=False):
             """
             This Excel file was generated by QGrain ({0}).
 
+            Please cite:
+            Liu, Y., Liu, X., Sun, Y., 2021. QGrain: An open-source and easy-to-use software for the comprehensive analysis of grain size distributions. Sedimentary Geology 423, 105980. https://doi.org/10.1016/j.sedgeo.2021.105980
+
             It contanins 4 + max(N_components) sheets:
             1. The first sheet is the sample distributions of SSU results.
             2. The second sheet is used to put the infomation of fitting.

diff --git a/QGrain/ui/GrainSizeDatasetViewer.py b/QGrain/ui/GrainSizeDatasetViewer.py
@@ -350,6 +350,9 @@ def save_file(self, filename: str):
             """
             This Excel file was generated by QGrain ({0}).
 
+            Please cite:
+            Liu, Y., Liu, X., Sun, Y., 2021. QGrain: An open-source and easy-to-use software for the comprehensive analysis of grain size distributions. Sedimentary Geology 423, 105980. https://doi.org/10.1016/j.sedgeo.2021.105980
+
             It contanins one sheet:
             1. The sheet puts the statistic parameters and the classification groups of the samples.
 

diff --git a/QGrain/ui/HCResolverPanel.py b/QGrain/ui/HCResolverPanel.py
@@ -254,6 +254,9 @@ def save_as_xlsx(self, filename: str):
             """
             This Excel file was generated by QGrain ({0}).
 
+            Please cite:
+            Liu, Y., Liu, X., Sun, Y., 2021. QGrain: An open-source and easy-to-use software for the comprehensive analysis of grain size distributions. Sedimentary Geology 423, 105980. https://doi.org/10.1016/j.sedgeo.2021.105980
+
             It contanins three (or n_clusters + 3) sheets:
             1. The first sheet is the dataset which was used to perform the hierarchy clustering algorithm.
             2. The second sheet is used to put the clustering flags of all samples.

diff --git a/QGrain/ui/PCAResolverPanel.py b/QGrain/ui/PCAResolverPanel.py
@@ -112,6 +112,9 @@ def save_as_xlsx(self, filename: str):
             """
             This Excel file was generated by QGrain ({0}).
 
+            Please cite:
+            Liu, Y., Liu, X., Sun, Y., 2021. QGrain: An open-source and easy-to-use software for the comprehensive analysis of grain size distributions. Sedimentary Geology 423, 105980. https://doi.org/10.1016/j.sedgeo.2021.105980
+
             It contanins three sheets:
             1. The first sheet is the dataset which was used to perform the PCA algorithm.
             2. The second sheet is used to put the distributions of all PCs.

diff --git a/QGrain/ui/RandomDatasetGenerator.py b/QGrain/ui/RandomDatasetGenerator.py
@@ -340,6 +340,9 @@ def cancel():
             """
             This Excel file was generated by QGrain ({0}).
 
+            Please cite:
+            Liu, Y., Liu, X., Sun, Y., 2021. QGrain: An open-source and easy-to-use software for the comprehensive analysis of grain size distributions. Sedimentary Geology 423, 105980. https://doi.org/10.1016/j.sedgeo.2021.105980
+
             It contanins n_components + 3 sheets:
             1. The first sheet is the random settings which were used to generate random parameters.
             2. The second sheet is the generated dataset.

diff --git a/README.md b/README.md
@@ -2,6 +2,10 @@
 
 QGrain aims to provide an easy-to-use and comprehensive analysis platform for grain-size distributions. QGrain has implemented many functions, however, there still are many useful tools that have not been contained. Hence, we published QGrain as an open-source project, and welcome other researchers to contribute their ideas and codes. Codes are available at this GitHub [repository](https://github.com/yuriok/QGrain/). More information and tutorials are available at the [offical website](https://qgrain.net/).
 
+Please cite:
+
+* Liu, Y., Liu, X., Sun, Y., 2021. QGrain: An open-source and easy-to-use software for the comprehensive analysis of grain size distributions. Sedimentary Geology 423, 105980. https://doi.org/10.1016/j.sedgeo.2021.105980
+
 Feel free to contact the author below.
 
 * Yuming Liu, a PhD student of IEECAS, [liuyuming@ieecas.cn](mailto:liuyuming@ieecas.cn)
diff --git a/setup.py b/setup.py
@@ -4,7 +4,7 @@
 
 setup(
     name="QGrain",
-    version="0.3.4.1",
+    version="0.3.4.2",
     description="An easy-to-use software for the comprehensive analysis of grain-size distributions",
     platforms="all",
     author="Yuming Liu",