Add citation method to ImageJPython class

src/imagej/__init__.py

@@ -48,6 +48,7 @@
 import scyjava as sj
 import xarray as xr
 from jpype import JImplementationFor, setupGuiEnvironment
+from jpype import __version__ as _jpype_version
 from scyjava.config import find_jars
 
 import imagej.convert as convert
@@ -164,6 +165,83 @@ def argstring(self, args, ij1_style=True):
                     formatted_args.append(arg)
             return " ".join(formatted_args)
 
+    def cite_publication(self, show: bool = True) -> str:
+        """Generate a citation string.
+
+        Generate the PyImageJ citation/reference string.
+
+        :param show: Print the PyImageJ citation if True, if False
+            the PyImageJ citation string is returned instead.
+        :return: The PyImageJ citation.
+        """
+        # set PyImageJ reference sub strings
+        header = "=====PyImageJ Citation====="
+        authors = "\nRueden, C.T., Hiner, M.C., Evans, E.L. et al."
+        pub_title = "\nPyImageJ: A library for integrating ImageJ and Python."
+        journal = "\nNat Methods 19, 1326–1327 (2022)."
+        doi_link = "\nhttps://doi.org/10.1038/s41592-022-01655-4"
+
+        # construct output citation string
+        citation = header + authors + pub_title + journal + doi_link
+        if show:
+            print(citation)
+        else:
+            return citation
+
+    def cite_versions(self, show: bool = True) -> str:
+        """Fetch the current environment's package versions.
+
+        Fetch and construct the current environment's package versions.
+        This function returns the versions for:
+            - Python
+            - Java
+            - pyimagej
+            - scyjava
+            - imglyb
+            - jgo
+            - jpype
+
+        :param show: Print the PyImageJ citation if True, if False
+            the PyImageJ citation string is returned instead.
+        :param show: Print the version numbers if True, if False
+            the environment version number string is returned instead.
+        :return: The current PyImageJ instance's package versions.
+        """
+        # collect the current isntance's package versions
+        py_ver = sys.version_info
+        java_ver = sj.jvm_version()
+        pyimagej_ver = __version__
+        scyjava_ver = sj.get_version("scyjava")
+        imglyb_ver = sj.get_version("imglyb")
+        jpype_ver = _jpype_version
+        jgo_ver = sj.get_version("jgo")
+
+        # construct version strings
+        header = "=====Environment package versions====="
+        python_ver_str = f"\nPython:   {py_ver.major}.{py_ver.minor}.{py_ver.micro}"
+        java_ver_str = f"\nJava:     {java_ver[0]}.{java_ver[1]}.{java_ver[2]}"
+        pyimagej_ver_str = f"\npyimagej: {pyimagej_ver}"
+        scyjava_ver_str = f"\nscyjava:  {scyjava_ver}"
+        imglyb_ver_str = f"\nimglyb:   {imglyb_ver}"
+        jgo_ver_str = f"\njgo:      {jgo_ver}"
+        jpype_ver_str = f"\njpype:    {jpype_ver}"
+
+        # construct output version string
+        versions = (
+            header
+            + python_ver_str
+            + java_ver_str
+            + pyimagej_ver_str
+            + scyjava_ver_str
+            + imglyb_ver_str
+            + jgo_ver_str
+            + jpype_ver_str
+        )
+        if show:
+            print(versions)
+        else:
+            return versions
+
     def dtype(self, image_or_type):
         """Get the dtype of the input image as a numpy.dtype object.