add cite

Author: refraction-ray

.pylintrc

@@ -13,7 +13,7 @@ disable=all
 enable=c-extension-no-member,
        bad-indentation,
        bare-except,
-       broad-except,
+       ; broad-except,
        dangerous-default-value,
        function-redefined,
        len-as-condition,

CHANGELOG.md

@@ -8,6 +8,12 @@
 
 - Add `circuit.to_openqasm_file` function for compatibility of qiskit>1
 
+- Add `tc.cite()` to get citation information
+
+### Fixed
+
+- Fix customized jax eigh operator by noting the return is a namedtuple
+
 ## 1.0.2
 
 ### Added

docs/source/index.rst

@@ -11,7 +11,7 @@ TensorCircuit Next Generation
 Introduction
 ---------------
 
-TensorCircuit-NG is an open-source high-performance quantum computing software framework in Python.
+TensorCircuit-NG is an open-source high-performance quantum software framework in Python.
 
 * It is built for humans. 👽
 
@@ -29,12 +29,15 @@ TensorCircuit-NG is an open-source high-performance quantum computing software f
 
 With the help of TensorCircuit-NG, now get ready to efficiently and elegantly solve interesting and challenging quantum computing and quantum many-body problems: from academic research prototype to industry application deployment.
 
+.. important::
+   Please cite the `whitepaper <https://quantum-journal.org/papers/q-2023-02-02-912/>`_ when using TensorCircuit or TensorCircuit-NG in your research. The bibtex information is provided by ``tc.cite()``.
 
 
 
-Relevant Links
+Useful Links
 --------------------
 
+
 TensorCircuit is created and now maintained as TensorCircuit-NG by `Shi-Xin Zhang <https://github.com/refraction-ray>`_.
 
 The current core authors of TensorCircuit-NG are `Shi-Xin Zhang <https://github.com/refraction-ray>`_ and `Yu-Qin Chen <https://github.com/yutuer21>`_.
@@ -168,7 +171,7 @@ TensorCircuit-NG is unifying infrastructures and interfaces for quantum computin
       :columns: 12 6 3 3
       :shadow: md
 
-      neural network/tensor network/quantum circuit
+      neural-net/tensor-net/quantum-circuit
 
 
 

tensorcircuit/__init__.py

@@ -6,7 +6,7 @@
 
 gpu_memory_share()
 
-from .about import about
+from .about import about, cite
 from .cons import (
     backend,
     set_backend,

tensorcircuit/about.py

@@ -23,20 +23,26 @@ def about() -> None:
         print(f"Scipy version: {scipy.__version__}")
     except ModuleNotFoundError:
         print(f"Scipy is not installed")
+    except Exception as e:
+        print(f"Misconfiguration for Scipy: {e}")
 
     try:
         import pandas
 
         print(f"Pandas version: {pandas.__version__}")
     except ModuleNotFoundError:
         print(f"Pandas is not installed")
+    except Exception as e:
+        print(f"Misconfiguration for Pandas: {e}")
 
     try:
         import tensornetwork as tn
 
         print(f"TensorNetwork version: {tn.__version__}")
     except ModuleNotFoundError:
         print(f"TensorNetwork is not installed")
+    except Exception as e:
+        print(f"Misconfiguration for TensorNetwork: {e}")
 
     try:
         import cotengra
@@ -47,6 +53,8 @@ def about() -> None:
             print(f"Cotengra: installed")
     except ModuleNotFoundError:
         print(f"Cotengra is not installed")
+    except Exception as e:
+        print(f"Misconfiguration for Cotengra: {e}")
 
     try:
         import tensorflow as tf
@@ -56,6 +64,8 @@ def about() -> None:
         print(f"TensorFlow CUDA infos: {dict(tf.sysconfig.get_build_info())}")
     except ModuleNotFoundError:
         print(f"TensorFlow is not installed")
+    except Exception as e:
+        print(f"Misconfiguration for TensorFlow: {e}")
 
     try:
         import jax
@@ -68,13 +78,17 @@ def about() -> None:
             print(f"Jax installation doesn't support GPU")
     except ModuleNotFoundError:
         print(f"Jax is not installed")
+    except Exception as e:
+        print(f"Misconfiguration for Jax: {e}")
 
     try:
         import jaxlib
 
         print(f"JaxLib version: {jaxlib.__version__}")
     except ModuleNotFoundError:
         print(f"JaxLib is not installed")
+    except Exception as e:
+        print(f"Misconfiguration for Jaxlib: {e}")
 
     try:
         import torch
@@ -88,32 +102,64 @@ def about() -> None:
             print(f"Pytorch cuda version: {torch.version.cuda}")
     except ModuleNotFoundError:
         print(f"PyTorch is not installed")
+    except Exception as e:
+        print(f"Misconfiguration for Torch: {e}")
 
     try:
         import cupy
 
         print(f"Cupy version: {cupy.__version__}")
     except ModuleNotFoundError:
         print(f"Cupy is not installed")
+    except Exception as e:
+        print(f"Misconfiguration for Cupy: {e}")
 
     try:
         import qiskit
 
         print(f"Qiskit version: {qiskit.__version__}")
     except ModuleNotFoundError:
         print(f"Qiskit is not installed")
+    except Exception as e:
+        print(f"Misconfiguration for Qiskit: {e}")
 
     try:
         import cirq
 
         print(f"Cirq version: {cirq.__version__}")
     except ModuleNotFoundError:
         print(f"Cirq is not installed")
+    except Exception as e:
+        print(f"Misconfiguration for Cirq: {e}")
 
     from tensorcircuit import __version__
 
     print(f"TensorCircuit version {__version__}")
 
 
+def cite(format: str = "bib") -> str:
+    """
+    Returns the citation information for tensorcircuit.
+    Please cite our work if you use the package in your research.
+
+    :param format: format for bib, defaults to "bib"
+    :type format: str, optional
+    :return: the citation information
+    :rtype: str
+    """
+    if format == "bib":
+        return """@article{Zhang_TensorCircuit_2023,
+        author = {Zhang, Shi-Xin and Allcock, Jonathan and Wan, Zhou-Quan and Liu, Shuo and Sun, Jiace and Yu, Hao and Yang, Xing-Han and Qiu, Jiezhong and Ye, Zhaofeng and Chen, Yu-Qin and Lee, Chee-Kong and Zheng, Yi-Cong and Jian, Shao-Kai and Yao, Hong and Hsieh, Chang-Yu and Zhang, Shengyu},
+        doi = {10.22331/q-2023-02-02-912},
+        journal = {Quantum},
+        month = feb,
+        title = {{TensorCircuit: a Quantum Software Framework for the NISQ Era}},
+        volume = {7},
+        year = {2023}}"""
+    elif format == "aps":
+        return """S.-X. Zhang, J. Allcock, Z.-Q. Wan, S. Liu, J. Sun, H. Yu, X.-H. Yang, J. Qiu, Z. Ye, Y.-Q. Chen, C.-K. Lee, Y.-C. Zheng, S.-K. Jian, H. Yao, C.-Y. Hsieh, and S. Zhang, TensorCircuit: a Quantum Software Framework for the NISQ Era, Quantum 7, 912 (2023)."""  # pylint: disable=line-too-long
+    raise ValueError(f"Unsupported format: {format}")
+
+
 if __name__ == "__main__":
     about()

tensorcircuit/experimental.py

@@ -534,7 +534,7 @@ def jax_jitted_function_save(filename: str, f: Callable[..., Any], *args: Any) -
     :param args: example function arguments for ``f``
     """
 
-    from jax import export
+    from jax import export  # type: ignore
 
     f_export = export.export(f)(*args)  # type: ignore
     barray = f_export.serialize()
@@ -555,14 +555,14 @@ def jax_jitted_function_load(filename: str) -> Callable[..., Any]:
     :return: the loaded function
     :rtype: _type_
     """
-    from jax import export
+    from jax import export  # type: ignore
 
     with open(filename, "rb") as f:
         barray = f.read()
 
     f_load = export.deserialize(barray)  # type: ignore
 
-    return f_load.call
+    return f_load.call  # type: ignore
 
 
 jax_func_load = jax_jitted_function_load

tests/test_miscs.py

@@ -36,6 +36,11 @@ def test_about():
     print(tc.about())
 
 
+def test_cite():
+    print(tc.cite())
+    print(tc.cite("aps"))
+
+
 def test_ps2coo(tfb):
     for l, a in check_pairs:
         r1 = PauliString2COO(tf.constant(l, dtype=tf.int64))