Merge pull request #167 from allen-cell-animated/feature/docs-year-ci…

…tation Add citation to docs
allen-cell-animated · Mar 12, 2024 · 23592c4 · 23592c4
2 parents a72038a + 8af2c26
commit 23592c4
Show file tree

Hide file tree

Showing 3 changed files with 39 additions and 9 deletions.
diff --git a/agave_app/citationDialog.cpp b/agave_app/citationDialog.cpp
@@ -1,6 +1,7 @@
 #include "citationDialog.h"
 
 #include <QApplication>
+#include <QDate>
 #include <QDialogButtonBox>
 #include <QLabel>
 #include <QTextBrowser>
@@ -18,13 +19,15 @@ CitationDialog::CitationDialog()
 
   QString agaveUrl = "https://github.com/allen-cell-animated/agave";
 
+  int year = QDate::currentDate().year();
+  QString syear = QString::number(year);
+
   auto citationtext = new QLabel(this);
-  citationtext->setText(
-    "Daniel Toloudis, AGAVE Contributors (2023). AGAVE: Advanced GPU Accelerated Volume Explorer (Version " +
-    qApp->applicationVersion() +
-    ") [Computer software]. Allen Institute for Cell Science. <a "
-    "href=\"" +
-    agaveUrl + "\"></a>");
+  citationtext->setText("Daniel Toloudis, AGAVE Contributors (" + syear +
+                        "). AGAVE: Advanced GPU Accelerated Volume Explorer (Version " + qApp->applicationVersion() +
+                        ") [Computer software]. Allen Institute for Cell Science. <a "
+                        "href=\"" +
+                        agaveUrl + "\"></a>");
   citationtext->setFrameShape(QFrame::Panel);
   citationtext->setFrameShadow(QFrame::Sunken);
   citationtext->setTextInteractionFlags(Qt::TextBrowserInteraction);
@@ -40,14 +43,16 @@ CitationDialog::CitationDialog()
   citationtext2->setText("<tt>@software{agave,<br/>"
                          "&nbsp;&nbsp;author    = {Toloudis, Daniel and AGAVE Contributors},<br/>"
                          "&nbsp;&nbsp;title     = {AGAVE: Advanced GPU Accelerated Volume Explorer},<br/>"
-                         "&nbsp;&nbsp;year      = {2023},<br/>"
+                         "&nbsp;&nbsp;year      = {" +
+                         syear +
+                         "},<br/>"
                          "&nbsp;&nbsp;version = {" +
                          qApp->applicationVersion() +
                          "},<br/>"
                          "&nbsp;&nbsp;url       = {" +
                          agaveUrl +
-                         "}<br/>"
-                         "&nbsp;&nbsp;organization = {Allen Institute for Cell Science}<br/>"
+                         "},<br/>"
+                         "&nbsp;&nbsp;organization = {Allen Institute for Cell Science},<br/>"
                          "&nbsp;&nbsp;note      = {Computer Software}<br/>"
                          "}</tt><br/>");
   citationtext2->setFrameShape(QFrame::Panel);

diff --git a/docs/agave.rst b/docs/agave.rst
@@ -630,6 +630,29 @@ AGAVE supports the following command line options:
 
   Only valid in server mode on Linux. Allows AGAVE to run as a server on a headless cluster node.  On other platforms AGAVE must be run in a windowed desktop environment, even in server mode.
 
+.. _Citation:
+
+Citation
+--------
+
+.. |year| date:: %Y
+
+Daniel Toloudis, AGAVE Contributors (|year|). AGAVE: Advanced GPU Accelerated Volume Explorer (Version |release|) [Computer software]. Allen Institute for Cell Science. https://github.com/allen-cell-animated/agave
+
+bibtex:
+
+.. parsed-literal::
+
+   @software{agave,
+    author       = {Toloudis, Daniel and AGAVE Contributors},
+    title        = {AGAVE: Advanced GPU Accelerated Volume Explorer},
+    year         = {|year|},
+    version      = {|release|},
+    url          = {https://github.com/allen-cell-animated/agave},
+    organization = {Allen Institute for Cell Science},
+    note         = {Computer Software}
+    }
+
 Troubleshooting
 ---------------
 

diff --git a/docs/index.rst b/docs/index.rst
@@ -13,6 +13,8 @@ AGAVE is a desktop application for viewing multichannel volume data.
 
 AGAVE's core viewing engine uses a "progressive path tracer". During interactive use, your image will appear grainy at first, but will refine over time as the rendering system builds up more and more render passes. The speed of refinement depends on your hardware, the size and complexity of the image, and the AGAVE parameters you set, i.e., the faster your GPU, the quicker a rendering will resolve. GPU memory dictates the maximum size of the files AGAVE can load. As soon as you change any viewing parameter, including your camera angle, the rendering will start over.
 
+If you use AGAVE in your research, please :ref:`cite <Citation>` it.
+
 .. toctree::
    :includehidden:
    :maxdepth: 2