Add Wigner Function Functionality and Documentation. #132

markjeveritt · 2017-10-26T06:46:41Z

Removed duplicate files as suggested by @diego-plan9.

Description

Please see the examples/jupyter/ notebook for description of added functionality.

Motivation and Context

How Has This Been Tested?

By old fashion testing code example (not unit testing as we are still not confident with this technique in python)

Screenshots (if appropriate):

Types of changes

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

My code follows the code style of this project.
My change requires a change to the documentation.
[] I have updated the documentation accordingly.
I have read the CONTRIBUTING document.
I have added tests to cover my changes.
All new and existing tests passed.

Add wigner functions

markjeveritt · 2017-10-26T16:28:38Z

@diego-plan9 Just a quick check - have we done everything we were supposed to please?

diego-plan9 · 2017-10-27T14:03:10Z

Thanks for the contribution, @markjeveritt ! The new changes seems indeed on the right track, but hopefully Chris will be able to review it more in depth and provide feedback eventually - thanks for your patience in the meantime!

chriseclectic

Hi Mark,

Thanks for resubmitting, this looks great and the changes I have requested are mostly organisational.

In summary:

The example notebook / figures shouldn't go here, but rather in the qiskit-tutorials repository where they will have greater visibility.
Rather than have these two modules being separate I think its more natural to put them in the existing modules visualization.py and tomography.py respectively.
wigner_function should be renamed to plot_wigner_function and the orignal plot_wigner_function should be renamed to plot_wigner_data
Once moving the plot_wigner_function to the vizualization module you can add an option to the plot_state function to plot the wigner function with

...
elif method="wigner":
    plot_wigner_state(rho)
...

With regards to putting them in the existing modules, your module introduction string (and in particular the references) should be moved into the relevant function doc strings.

In your example notebook you can then update it rather than importing the full modules to just import the functions you will be using. Eg

from qiskit.tools.visualization import plot_wigner function
```

chriseclectic · 2017-11-09T21:20:57Z

qiskit/tools/wigner_function_visualisation.py

+from mpl_toolkits.mplot3d import Axes3D
+
+
+def wigner_function(rho, res=100):


I'd suggest changing rho to state here as it can be a vector or density matrix.
In addition this function breaks if the input is a list. This can be fixed by adding

def wigner_function(state, res=100): ## .... state = np.array(state) if state.ndim == 1: state = np.outer(state, state)

chriseclectic · 2017-11-09T21:23:28Z

qiskit/tools/wigner_function_visualisation.py

@@ -0,0 +1,264 @@
+"""
+
+Wigner Function Visualization Module


These functions should be moved inside the visualization.py module rather than be seperate.

I also think it makes more sense to rename the wigner_function function to plot_wigner_function, and to rename what you've called plot_wigner_function to plot_wigner_data since it plots the output from the wigner_data function in the tomography module.

chriseclectic · 2017-11-09T21:24:12Z

qiskit/tools/wigner_function_visualisation.py

+    - A single point in phase space
+    - An NxN array plotted as a plaquette
+
+References:


You can move these reference into the function description for plot_wigner_function and/or wigner_function when moving into the visualization.py module

chriseclectic · 2017-11-09T21:36:52Z

qiskit/tools/wigner_function_visualisation.py

+    Plots Wigner results in appropriate format
+
+    Args:
+        wigner_results:


I'd change wigner_results to wigner_data and mention in the description that this is the output returned from the wigner_data` function.

chriseclectic · 2017-11-09T21:37:46Z

qiskit/tools/wigner_function_tomography.py

@@ -0,0 +1,114 @@
+"""
+
+Wigner Function Tomography Module


I think these functions should be moved into the tomography.py module rather than being in their own module

… to QISKIT/qiskit-tutorial

markjeveritt · 2017-11-10T16:21:06Z

@chriseclectic we think we have addressed all the changes you requested. There is a new pull request in the tutorial for the Jupiter notebook and we have edited the content in this repo as detailed above. Have we missed anything please?

chriseclectic

Looks good to me! @diego-plan9

markjeveritt · 2017-11-11T01:48:45Z

Great thank you! Please can we also add Todd Tilma to the author list on the readme? Does this need a new pull request?

…

Sent from my iPhone On 10 Nov 2017, at 23:44, Christopher Wood <notifications@github.com<mailto:notifications@github.com>> wrote: @chriseclectic approved this pull request. Looks good to me! @diego-plan9<https://github.com/diego-plan9> — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub<#132 (review)>, or mute the thread<https://github.com/notifications/unsubscribe-auth/ARe0Y9x1IhhSFoNh43NDtgJl7PCkGsrmks5s1N_LgaJpZM4QHFTy>.

diego-plan9 · 2017-11-13T11:21:33Z

It's looking good to me as well - thanks @markjeveritt for the contribution, and @chriseclectic for the review!

* Add note about working with multiple repositories * Update multiple repository instructions * Fix install.rst

* Add wigner functionw * Adding new wigner function files * Delete exampleCircuit.png * Delete wigner_function_tomography.py * Delete wigner_function_visualisation.py * Delete wigner_functions.ipynb * Delete blochSphere.png * Update wigner_functions.ipynb * files deleted and merged as requested. Jupyter Notebook will be moved to QISKIT/qiskit-tutorial * two other image files deleted * updated visualization.py to include Wigner fucntion code * added author names due to Wigner function capability * Update README.md * alphabetically ordered Authors

markjeveritt added 9 commits October 25, 2017 16:57

Add wigner functionw

6ecfbea

Adding new wigner function files

3866e96

Merge pull request #1 from markjeveritt/markjeveritt-patch-1

dda7318

Add wigner functions

Delete exampleCircuit.png

22968c7

Delete wigner_function_tomography.py

b8757dc

Delete wigner_function_visualisation.py

52e325f

Delete wigner_functions.ipynb

ce5b066

Delete blochSphere.png

5d97589

Update wigner_functions.ipynb

0235ff6

diego-plan9 requested a review from chriseclectic October 27, 2017 09:40

diego-plan9 mentioned this pull request Oct 27, 2017

Adds a simple spin Wigner function calculator example #3

Closed

chriseclectic suggested changes Nov 9, 2017

View reviewed changes

Russell Rundle and others added 4 commits November 10, 2017 15:12

files deleted and merged as requested. Jupyter Notebook will be moved…

3932198

… to QISKIT/qiskit-tutorial

two other image files deleted

008259a

updated visualization.py to include Wigner fucntion code

2f874ed

added author names due to Wigner function capability

77f6a71

chriseclectic approved these changes Nov 10, 2017

View reviewed changes

markjeveritt added 2 commits November 11, 2017 03:36

Update README.md

dcd8f56

alphabetically ordered Authors

7c8451e

diego-plan9 merged commit a0205ce into Qiskit:master Nov 13, 2017

diego-plan9 mentioned this pull request Nov 15, 2017

adds a wignerfuntion Jupyter notebook to qcvv Qiskit/qiskit-tutorials#51

Merged

taalexander pushed a commit to taalexander/qiskit-terra that referenced this pull request May 2, 2019

Add note about working with multiple repositories (Qiskit#132)

29964c5

* Add note about working with multiple repositories * Update multiple repository instructions * Fix install.rst

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add Wigner Function Functionality and Documentation. #132

Add Wigner Function Functionality and Documentation. #132

Uh oh!

markjeveritt commented Oct 26, 2017 •

edited

Loading

Uh oh!

markjeveritt commented Oct 26, 2017

Uh oh!

diego-plan9 commented Oct 27, 2017

Uh oh!

chriseclectic left a comment •

edited

Loading

Uh oh!

chriseclectic Nov 9, 2017 •

edited

Loading

Uh oh!

chriseclectic Nov 9, 2017

Uh oh!

chriseclectic Nov 9, 2017

Uh oh!

chriseclectic Nov 9, 2017

Uh oh!

chriseclectic Nov 9, 2017

Uh oh!

markjeveritt commented Nov 10, 2017

Uh oh!

chriseclectic left a comment

Uh oh!

markjeveritt commented Nov 11, 2017 via email

Uh oh!

diego-plan9 commented Nov 13, 2017

Uh oh!

Uh oh!

		from mpl_toolkits.mplot3d import Axes3D


		def wigner_function(rho, res=100):

Add Wigner Function Functionality and Documentation. #132

Add Wigner Function Functionality and Documentation. #132

Uh oh!

Conversation

markjeveritt commented Oct 26, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Motivation and Context

How Has This Been Tested?

Screenshots (if appropriate):

Types of changes

Checklist:

Uh oh!

markjeveritt commented Oct 26, 2017

Uh oh!

diego-plan9 commented Oct 27, 2017

Uh oh!

chriseclectic left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

chriseclectic Nov 9, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

chriseclectic Nov 9, 2017

Choose a reason for hiding this comment

Uh oh!

chriseclectic Nov 9, 2017

Choose a reason for hiding this comment

Uh oh!

chriseclectic Nov 9, 2017

Choose a reason for hiding this comment

Uh oh!

chriseclectic Nov 9, 2017

Choose a reason for hiding this comment

Uh oh!

markjeveritt commented Nov 10, 2017

Uh oh!

chriseclectic left a comment

Choose a reason for hiding this comment

Uh oh!

markjeveritt commented Nov 11, 2017 via email

Uh oh!

diego-plan9 commented Nov 13, 2017

Uh oh!

Uh oh!

markjeveritt commented Oct 26, 2017 •

edited

Loading

chriseclectic left a comment •

edited

Loading

chriseclectic Nov 9, 2017 •

edited

Loading