From cc3f179a5333baa6c64301739cc71e771869bcc0 Mon Sep 17 00:00:00 2001 From: Boxi Li Date: Sun, 9 Jan 2022 14:18:53 +0100 Subject: [PATCH] Add the example to api doc --- qutip/visualization.py | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/qutip/visualization.py b/qutip/visualization.py index 9634876b4d..0fdb9e8e64 100644 --- a/qutip/visualization.py +++ b/qutip/visualization.py @@ -226,6 +226,21 @@ def hinton(rho, xlabels=None, ylabels=None, title=None, ax=None, cmap=None, ValueError Input argument is not a quantum object. + Examples + -------- + >>> import qutip + >>> + >>> dm = qutip.rand_dm(4) + >>> fig, ax = qutip.hinton(dm) + >>> fig.show() + >>> + >>> qutip.settings.colorblind_safe = True + >>> fig, ax = qutip.hinton(dm, color_style="threshold") + >>> fig.show() + >>> qutip.settings.colorblind_safe = False + >>> + >>> fig, ax = qutip.hinton(dm, color_style="phase") + >>> fig.show() """ # Apply default colormaps.