Update plot_wigner_sphere and delete matrix_histogram_complex #2193

tamakoshi2001 · 2023-07-10T03:40:02Z

Checklist
Thank you for contributing to QuTiP! Please make sure you have finished the following tasks before opening the PR.

Please read Contributing to QuTiP Development
Contributions to qutip should follow the pep8 style.
You can use pycodestyle to check your code automatically
Please add tests to cover your changes if applicable.
If the behavior of the code has changed or new feature has been added, please also update the documentation in the doc folder, and the notebook. Feel free to ask if you are not sure.
Include the changelog in a file named: doc/changes/<PR number>.<type> 'type' can be one of the following: feature, bugfix, doc, removal, misc, or deprecation (see here for more information).

Do the same change for plot_wigner_sphere and matrix_histogram as #2170 did.
#2170

The arguments in plot_wigner_sphere is now similar to those of other functions. Of course, it change its color as users set qutip.settings.colorblind_safe=True.

def plot_wigner_sphere(wigner, reflections=False, *, cmap=None,
                       colorbar=True, fig=None, ax=None):

matrix_histogram and matrix_histogram_complex combined into one function. The new matrix_histogram can change bar_style and color_style. Here is an example.

coveralls · 2023-07-10T04:21:36Z

coverage: 84.621% (+1.4%) from 83.199% when pulling 22f94fa on tamakoshi2001:edit_functions_in_visualization.py into 4f29ae5 on qutip:master.

tamakoshi2001 · 2023-07-10T10:08:52Z

Codeclimte detects the same code in matrix_histogram and matrix_histogram_complex, but matrix_histogram_complex will be deleted after matrix_histogram takes over it and the problem will be solved

tamakoshi2001 · 2023-07-10T10:22:17Z

sample plot of matrix_histogram
matrix-histogram.pdf

tamakoshi2001 · 2023-07-11T04:59:03Z

I moved limits bar_style color_limits color_style. The number of arguments is 13 > 10, but they should not be in options. Also, I raised an error when users pass unexpected arguments to bar_style color_style.

tamakoshi2001 · 2023-07-12T12:42:40Z

@Ericgig Hi. Do you have any advice on plot_wigner_sphere and matrix_histogram? I will fix the documentation error tomorrow.

tamakoshi2001 · 2023-07-13T13:27:31Z

@Ericgig Hi. I tried to fix the documentation error, but I do not know how to fix the following errors. Could you help me?

/home/runner/work/qutip/qutip/qutip/visualization.py:docstring of qutip.visualization.hinton:10: WARNING: Bullet list ends without a blank line; unexpected unindent.
looking for now-outdated files... none found
/home/runner/work/qutip/qutip/qutip/visualization.py:docstring of qutip.visualization.hinton:7: WARNING: Bullet list ends without a blank line; unexpected unindent.
/home/runner/work/qutip/qutip/qutip/visualization.py:docstring of qutip.visualization.hinton:23: WARNING: Bullet list ends without a blank line; unexpected unindent.

Ericgig · 2023-07-13T14:50:15Z

qutip/visualization.py

        -  If set to ``"scaled"`` (default), each color is chosen by
-           passing the absolute value of the corresponding matrix
-           element into `cmap` with the sign of the real part.
+        passing the absolute value of the corresponding matrix
+        element into `cmap` with the sign of the real part.
        -  If set to ``"threshold"``, each square is plotted as
-           the maximum of `cmap` for the positive real part and as
-           the minimum for the negative part of the matrix element;
-           note that this generalizes `"threshold"` to complex numbers.
+        the maximum of `cmap` for the positive real part and as
+        the minimum for the negative part of the matrix element;
+        note that this generalizes `"threshold"` to complex numbers.
        -  If set to ``"phase"``, each color is chosen according to
-           the angle of the corresponding matrix element.
+        the angle of the corresponding matrix element.


I think it's these bullet list that cause the issues with the documentation.
The indentation is needed.

Thanks! This solved the problem. The other two are in matrix_histogram.

tamakoshi2001 · 2023-07-17T10:15:45Z

@Ericgig This PR is. also ready for review. The build doc fails, but it is not related to my change.

Ericgig

A few issues to fix, but overall looks nice.

qutip/visualization.py

Ericgig · 2023-07-17T15:13:38Z

qutip/visualization.py

@@ -679,12 +720,10 @@ def matrix_histogram(M, xlabels=None, ylabels=None, title=None, limits=None,
    """

    # default options
-    default_opts = {'figsize': None, 'cmap': 'jet', 'cmap_min': 0.,
-                    'cmap_max': 1., 'zticks': None, 'bars_spacing': 0.2,
+    default_opts = {'zticks': None, 'bars_spacing': 0.2,


Could you rename this variable, it is used later with values no longer the default.

I changed the code to use options argument instead of default_opts and changed the default value from None to {}.

qutip/visualization.py

tamakoshi2001 · 2023-07-18T12:27:48Z

@Ericgig Hi. I fixed the issues you suggested.

Ericgig · 2023-07-18T14:38:59Z

qutip/visualization.py

-
+        'threshold': float, optional
+            Threshold for when bars of smaller height should be transparent. If
+            not set, all bars are colored according to the color map.


Suggested change

not set, all bars are colored according to the color map.

not set, all bars are colored according to the color map.

Ericgig

One last small change.

tamakoshi2001 · 2023-07-19T10:39:27Z

@Ericgig I added an indent. The doc looks good now.

tamakoshi2001 added 2 commits July 10, 2023 12:38

make plot_wigner_sphere user-friendly

7fef759

minor bagfix

441ccd5

tamakoshi2001 added 7 commits July 10, 2023 13:31

delete arguments which users can set

10ef557

change matrix_histogram

eb9cfcd

change matrix_histogram; change arguments to follow pep8

9bd647b

add threshold

81e6b89

add colorbar label

b5f481f

add azim and elev

ab5f0e5

refactoring

c682823

tamakoshi2001 changed the title ~~make plot_wigner_sphere user-friendly~~ change for plot_wigner_sphere and matrix_histogram_complex Jul 10, 2023

tamakoshi2001 added 2 commits July 10, 2023 18:59

reflection is optional

0351ee5

edit docstring

65731c8

tamakoshi2001 added 2 commits July 11, 2023 13:51

update arguments and error status

36cb021

minor change

394ab6d

tamakoshi2001 added 8 commits July 11, 2023 19:36

add default values

27ab9e9

update on threshold option

062c1fa

pep8

d6cd8da

minor fix

a0feb2d

minor fix

b4c005b

replace matrix_histogram_complex with matrix_histogram

6ada27e

bugfix

1e0d02f

towncrier

477926e

tamakoshi2001 added 3 commits July 13, 2023 20:58

delete matrix_histogram_complex from text

cc953e6

pep8

5991da7

docstring warning

e9e776c

Ericgig reviewed Jul 13, 2023

View reviewed changes

tamakoshi2001 added 3 commits July 14, 2023 20:48

add indentation

eed69ab

indent

03256ef

pep8

b2cdd69

Ericgig mentioned this pull request Jul 14, 2023

Add pytest for visualization.py #2192

Merged

5 tasks

tamakoshi2001 added 6 commits July 16, 2023 17:00

add pytest

f996c0f

add pytest

e652b3f

add pytest

10cd390

add pytest

fef43f4

bugfix

87d9023

add pytest

c24db08

Ericgig reviewed Jul 17, 2023

View reviewed changes

tamakoshi2001 and others added 3 commits July 18, 2023 20:11

changes for review

37add2e

Merge branch 'master' into edit_functions_in_visualization.py

1712eca

resolve conflict

d95a1a7

Ericgig reviewed Jul 18, 2023

View reviewed changes

add indent

22f94fa

Ericgig approved these changes Jul 19, 2023

View reviewed changes

Ericgig merged commit efd39be into qutip:master Jul 19, 2023
11 of 12 checks passed

tamakoshi2001 mentioned this pull request Aug 16, 2023

Delete matrix_histogram_complex qutip/qutip-tutorials#68

Merged

tamakoshi2001 changed the title ~~change for plot_wigner_sphere and matrix_histogram_complex~~ Update plot_wigner_sphere and delete matrix_histogram_complex Aug 28, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update plot_wigner_sphere and delete matrix_histogram_complex #2193

Update plot_wigner_sphere and delete matrix_histogram_complex #2193

tamakoshi2001 commented Jul 10, 2023 •

edited

coveralls commented Jul 10, 2023 •

edited

tamakoshi2001 commented Jul 10, 2023

tamakoshi2001 commented Jul 10, 2023

tamakoshi2001 commented Jul 11, 2023

tamakoshi2001 commented Jul 12, 2023 •

edited

tamakoshi2001 commented Jul 13, 2023

Ericgig Jul 13, 2023

tamakoshi2001 Jul 14, 2023

tamakoshi2001 commented Jul 17, 2023

Ericgig left a comment

Ericgig Jul 17, 2023

tamakoshi2001 Jul 18, 2023 •

edited

tamakoshi2001 commented Jul 18, 2023

Ericgig Jul 18, 2023

Ericgig left a comment

tamakoshi2001 commented Jul 19, 2023

	not set, all bars are colored according to the color map.
	not set, all bars are colored according to the color map.

Update plot_wigner_sphere and delete matrix_histogram_complex #2193

Update plot_wigner_sphere and delete matrix_histogram_complex #2193

Conversation

tamakoshi2001 commented Jul 10, 2023 • edited

coveralls commented Jul 10, 2023 • edited

tamakoshi2001 commented Jul 10, 2023

tamakoshi2001 commented Jul 10, 2023

tamakoshi2001 commented Jul 11, 2023

tamakoshi2001 commented Jul 12, 2023 • edited

tamakoshi2001 commented Jul 13, 2023

Ericgig Jul 13, 2023

Choose a reason for hiding this comment

tamakoshi2001 Jul 14, 2023

Choose a reason for hiding this comment

tamakoshi2001 commented Jul 17, 2023

Ericgig left a comment

Choose a reason for hiding this comment

Ericgig Jul 17, 2023

Choose a reason for hiding this comment

tamakoshi2001 Jul 18, 2023 • edited

Choose a reason for hiding this comment

tamakoshi2001 commented Jul 18, 2023

Ericgig Jul 18, 2023

Choose a reason for hiding this comment

Ericgig left a comment

Choose a reason for hiding this comment

tamakoshi2001 commented Jul 19, 2023

tamakoshi2001 commented Jul 10, 2023 •

edited

coveralls commented Jul 10, 2023 •

edited

tamakoshi2001 commented Jul 12, 2023 •

edited

tamakoshi2001 Jul 18, 2023 •

edited