Skip to content

Commit c57d14e

Browse files
authored
introduce cite and update versioninfo`
1 parent c986d84 commit c57d14e

File tree

1 file changed

+48
-11
lines changed

1 file changed

+48
-11
lines changed

src/versioninfo.jl

Lines changed: 48 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -36,17 +36,29 @@ function versioninfo(io::IO = stdout)
3636
)
3737

3838
# print System information
39-
println(io, "System information:")
40-
println(io, "====================================")
41-
println(io, """OS : $(OS_name) ($(Sys.MACHINE))""")
42-
println(io, """CPU : $(length(cpu)) × $(cpu[1].model)""")
43-
println(io, """Memory : $(round(Sys.total_memory() / 2 ^ 30, digits=3)) GB""")
44-
println(io, """WORD_SIZE: $(Sys.WORD_SIZE)""")
45-
println(io, """LIBM : $(Base.libm_name)""")
46-
println(io, """LLVM : libLLVM-$(Base.libllvm_version) ($(Sys.JIT), $(Sys.CPU_NAME))""")
47-
println(io, """BLAS : $(basename(BLAS_info.libname)) ($(BLAS_info.interface))""")
48-
println(io, """Threads : $(Threads.nthreads()) (on $(Sys.CPU_THREADS) virtual cores)""")
49-
return print(io, "\n")
39+
println(
40+
io,
41+
"System information:\n",
42+
"====================================\n",
43+
"""OS : $(OS_name) ($(Sys.MACHINE))\n""",
44+
"""CPU : $(length(cpu)) × $(cpu[1].model)\n""",
45+
"""Memory : $(round(Sys.total_memory() / 2 ^ 30, digits=3)) GB\n""",
46+
"""WORD_SIZE: $(Sys.WORD_SIZE)\n""",
47+
"""LIBM : $(Base.libm_name)\n""",
48+
"""LLVM : libLLVM-$(Base.libllvm_version) ($(Sys.JIT), $(Sys.CPU_NAME))\n""",
49+
"""BLAS : $(basename(BLAS_info.libname)) ($(BLAS_info.interface))\n""",
50+
"""Threads : $(Threads.nthreads()) (on $(Sys.CPU_THREADS) virtual cores)\n""",
51+
)
52+
53+
# print citation information
54+
println(
55+
io,
56+
"+---------------------------------------------------+\n",
57+
"| Please cite QuantumToolbox.jl in your publication |\n",
58+
"+---------------------------------------------------+\n",
59+
"For your convenience, a bibtex reference can be easily generated using `QuantumToolbox.cite()`.\n"
60+
)
61+
return nothing
5062
end
5163

5264
"""
@@ -64,3 +76,28 @@ function _get_pkg_version(pkg_name::String)
6476
end
6577
end
6678
end
79+
80+
@doc raw"""
81+
QuantumToolbox.cite(io::IO = stdout)
82+
83+
Command line output of citation information and bibtex generator for `QuantumToolbox.jl`.
84+
"""
85+
function cite(io::IO = stdout)
86+
citation = raw"""
87+
@article{QuantumToolbox-jl2025,
88+
doi = {},
89+
url = {},
90+
title = {{QuantumToolbox.jl}: {A}n efficient {J}ulia framework for simulating open quantum systems},
91+
author = {Mercurio, Alberto and Huang, Yi-Te and Cai, Li-Xun and Chen, Yueh-Nan and Savona, Vincenzo and Nori, Franco},
92+
journal = {{Quantum}},
93+
issn = {2521-327X},
94+
publisher = {{Verein zur F{\"{o}}rderung des Open Access Publizierens in den Quantenwissenschaften}},
95+
volume = {},
96+
pages = {},
97+
month = sep,
98+
year = {2025}
99+
}
100+
"""
101+
102+
return println(io, citation)
103+
end

0 commit comments

Comments
 (0)