Merged and improved the streamplot demonstration #8082

tmcclintock · 2017-02-15T17:52:07Z

This PR is to address issue #7956 .

Merged the three examples/images_contours_and_fields/streamplot_demo_X.py files into a single streamplot_demo.py file.

Additionally, in the previous streamplot_demo_start_points.py example, the comments in the header were inconsistent with the purpose of the example. This has been corrected in the new streamplot_demo.py example.

…demo.py file. Corrected the incorrect description that accompanied the start_points demo in the streamplot example.

NelleV · 2017-02-15T18:13:39Z

examples/images_contours_and_fields/streamplot_demo.py

+
+# Varying color along a streamline
+fig0, ax = plt.subplots()
+strm = ax.streamplot(X, Y, U, V, color=U, linewidth=2, cmap=plt.cm.autumn)


I have a slight preferences on using the colormap's name directly (ie "autumn").

Sure. I was following the previous streamplot example, which used plt.cm.autumn. Otherwise I agree since it is less clutter.

…aps.

NelleV · 2017-02-15T18:19:16Z

If we want to limit the number of example renaming and moving around, I suggest we do not backport this to 2.0.0: we may have to rename the examples for the gallery for sphinx-gallery.

attn @tacaswell

(Note: I do not believe we should be worried about breaking people's bookmark so I don't think this should be a reason not to backport, but I also don't think we should be backporting documentation changes either.)

NelleV · 2017-02-15T18:20:28Z

examples/images_contours_and_fields/streamplot_demo.py

+                     cmap=plt.cm.autumn, start_points=seed_points.T)
+fig4.colorbar(strm.lines)
+
+ax.plot(seed_points[0], seed_points[1],'bo')


PEP8 violation: there is a space missing between seed_points[1], and 'bo'.

tmcclintock · 2017-02-16T00:52:13Z

@NelleV would you rather that I fixed all the example issues in #7956 so that all the gallery changes would be pushed through at once?

NelleV · 2017-02-16T01:01:47Z

@tmcclintock I think I prefer the solution of not backporting: this leaves us time to see what works and what doesn't in terms of naming and url.

Unfortunately, the list of examples to merge and modify in that ticket is a huge under estimation of the work that need to be done in order to move to sphinx-gallery. We have over 400 examples to go over.
And once this is over, we'll probably have to iteratively go over our examples again, to leverage to a large extent the features sphinx-gallery offers.

Any work you do is very much appreciated! I am very happy to review any work done on the gallery and documentation.

tmcclintock · 2017-02-16T01:36:38Z

@NelleV ok, I think I follow. Excuse my ignorance at being a github newb. I can't say I know enough about the project to know what switching to a sphinx-gallery means/entails, so I guess at this point I can't digest your feedback. I'd be happy to do the rest of the items in the list, but if you are saying that they would never make it into the gallery anyway then I can look for other issues to try and tackle.

NelleV · 2017-02-16T01:41:00Z

@tmcclintock No, the question is just backport versus no backport, ie, should it go into matplotlib 2.0.1 or matplotlib 2.1.

dstansby · 2017-02-16T22:56:39Z

It looks like the documentaiton build is failing because there's still a link to streamplot_demo_features somewhere in the documentation that needs to be removed or redirected to your new example.

Otherwise it looks good!

tmcclintock · 2017-02-16T23:43:41Z

@dstansby Hmm. I don't know where/how to fix that. Do you want me to do that now or is this something that is done external to a PR?

afvincent · 2017-02-17T00:06:58Z

examples/images_contours_and_fields/streamplot_demo.py

+
+seed_points = np.array([[-2, 0, 1], [-2, 0, 1]])
+
+fig4, ax = plt.subplots()


Why fig4 and not fig3?

afvincent · 2017-02-17T00:10:58Z

If @dstansby is right, this page in the doc could be (of) the reason(s). Search “streamplot_demo_features.py” in doc/users/screenshots.rst to find the related link. But I have no idea of how to display only fig0 and fig1 (as previously) in the page with the new all-in-one version of the script. @NelleV would you know how to achieve this?

dstansby · 2017-02-17T10:40:53Z

A quick way to find places that link to certain examples is

$ grep -r "streamplot_demo_features" doc/ lib/
doc//users/prev_whats_new/whats_new_1.2.rst:.. plot:: mpl_examples/images_contours_and_fields/streamplot_demo_features.py
doc//users/screenshots.rst:.. plot:: mpl_examples/images_contours_and_fields/streamplot_demo_features.py

It looks like there's two places where the reference needs to be updated or removed.

afvincent

LGTM.

I have a few minor comments but I will be happy to approve this PR for merging once my “biggest” questions will be answered :).

Edit: Well, it seems that my comments did not make it :/. I will readd them ASAP…

afvincent

Ok, here are my (mostly) minor comments this time…

afvincent · 2017-02-27T07:37:18Z

examples/images_contours_and_fields/streamplot_demo.py

+fig1, (ax1, ax2) = plt.subplots(ncols=2)
+ax1.streamplot(X, Y, U, V, density=[0.5, 1])
+
+# Varying the line width along a stream line


I would merge this block with the previous one. I find it a bit perturbing that the previous block creates two subplots but only uses one. IMO, the two description comments may then be merged into something like:

# Varying the density of streamlines (ax1) and the line width along # a streamline (ax2).

afvincent · 2017-02-27T07:37:35Z

examples/images_contours_and_fields/streamplot_demo.py

+
+    * Varying the color along a streamline.
+    * Varying the density of streamlines.
+    * Varying the line width along a stream line.


stream line <- streamline?

afvincent · 2017-02-27T07:37:43Z

examples/images_contours_and_fields/streamplot_demo.py

+Demo of the `streamplot` function.
+
+A streamplot, or streamline plot, is used to display 2D vector fields. This
+example shows a few features of the stream plot function:


stream plot <- streamplot?

afvincent · 2017-02-27T07:39:34Z

examples/images_contours_and_fields/streamplot_demo.py

+          interpolation='nearest', cmap=plt.cm.gray)
+
+# Controlling the start points of streamlines
+X, Y = (np.linspace(-3, 3, 100),


Why not reuse the previous X and Y arrays? Especially if the purpose is to create similar arrays.

afvincent · 2017-02-27T07:41:09Z

examples/images_contours_and_fields/streamplot_demo.py

+
+U, V = np.mgrid[-3:3:100j, 0:0:100j]
+
+seed_points = np.array([[-2, 0, 1], [-2, 0, 1]])


Any reason for changing the U, V and seed_points arrays compared to the former streamplot_demo_start_points.py script?

afvincent · 2017-02-27T07:42:44Z

examples/images_contours_and_fields/streamplot_demo.py

+ax.imshow(-mask, extent=(-w, w, -w, w), alpha=0.5,
+          interpolation='nearest', cmap=plt.cm.gray)
+
+# Controlling the start points of streamlines


# Controlling the start points of streamlines <- # Controlling the start points of the streamlines. Disclaimer: I am not a native English speaker, so please forget this comment if I am obviously wrong ;)…

The former refers to any streamlines, while the latter is about these streamlines. More importantly, I think it should be "starting" instead of "start".

afvincent · 2017-02-27T07:44:04Z

examples/images_contours_and_fields/streamplot_demo.py

+
+fig3, ax = plt.subplots()
+strm = ax.streamplot(X, Y, U, V, color=U, linewidth=2,
+                     cmap="autumn", start_points=seed_points.T)


Being there, I would replace the double quotes with single ones (i.e. "autumn" <- 'autumn'), to be consistent with the rest of the script.

afvincent · 2017-02-27T07:46:28Z

examples/images_contours_and_fields/streamplot_demo.py

+                     cmap="autumn", start_points=seed_points.T)
+fig3.colorbar(strm.lines)
+
+ax.plot(seed_points[0], seed_points[1], 'bo')


It might be useful to add a small comment to precise that this is some kind of an helper plot. Maybe simply:

# Displaying the starting points with red symbols.

Edit: start <- starting (see @QuLogic's comment above)

afvincent · 2017-02-27T07:48:44Z

examples/images_contours_and_fields/streamplot_demo.py

+    * Varying the density of streamlines.
+    * Varying the line width along a stream line.
+    * Streamlines skipping masked regions and NaN values.
+    * Controlling the start points of streamlines.


See the similar comment below (in the relevant code block).

NelleV · 2017-03-06T20:38:23Z

Hi @tmcclintock
Do you think you'll have time to fix @afvincent 's comment this week?
Thanks,
Nelle

afvincent · 2017-03-25T14:19:09Z

Normally superseded by #8336, which merges the ideas from this PR and another similar one :).

Edit: marked as duplicate. I would be in favor of keeping it open until #8336 is finished and the comments done on current @tmcclintock's PR have been fixed in the new 2-in-1 PR. And thanks again @tmcclintock for opening this PR :).

anntzer · 2017-04-16T06:09:20Z

Superseded by #8336.

Merged the three streamplot_demo_X.py files into a single streamplot_…

08b2382

…demo.py file. Corrected the incorrect description that accompanied the start_points demo in the streamplot example.

afvincent added the Documentation label Feb 15, 2017

afvincent added this to the 2.0.1 (next bug fix release) milestone Feb 15, 2017

NelleV reviewed Feb 15, 2017

View reviewed changes

Changed plt.cm.autumn to the string autumn when specifying the colorm…

4618736

…aps.

NelleV reviewed Feb 15, 2017

View reviewed changes

NelleV modified the milestones: 2.1 (next point release), 2.0.1 (next bug fix release) Feb 16, 2017

afvincent reviewed Feb 17, 2017

View reviewed changes

tmcclintock added 2 commits February 16, 2017 16:15

Changed fig4 to fig3... because there was no fig3.

fadc12c

Added a space to conform to PEP8.

2d8f334

Fixed both references to the streamplot demo in the documentation files.

fc0ce67

dstansby self-assigned this Feb 26, 2017

afvincent mentioned this pull request Feb 27, 2017

merge streamplot_demo_features streamplot_demo_masking streamplot_demo_start_points #8155

Closed

afvincent reviewed Feb 27, 2017

View reviewed changes

dstansby added the status: needs revision label Mar 7, 2017

patniharshit mentioned this pull request Mar 19, 2017

Merged streamline examples #8336

Merged

afvincent added the status: duplicate label Mar 25, 2017

afvincent removed the status: needs revision label Mar 25, 2017

anntzer closed this Apr 16, 2017

dstansby removed their assignment May 27, 2017


		seed_points = np.array([[-2, 0, 1], [-2, 0, 1]])

		fig4, ax = plt.subplots()


		U, V = np.mgrid[-3:3:100j, 0:0:100j]

		seed_points = np.array([[-2, 0, 1], [-2, 0, 1]])

Uh oh!

Merged and improved the streamplot demonstration #8082

Merged and improved the streamplot demonstration #8082

Uh oh!

Conversation

tmcclintock commented Feb 15, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

NelleV commented Feb 15, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tmcclintock commented Feb 16, 2017

Uh oh!

NelleV commented Feb 16, 2017

Uh oh!

tmcclintock commented Feb 16, 2017

Uh oh!

NelleV commented Feb 16, 2017

Uh oh!

dstansby commented Feb 16, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

tmcclintock commented Feb 16, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

afvincent commented Feb 17, 2017

Uh oh!

dstansby commented Feb 17, 2017

Uh oh!

afvincent 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!

afvincent left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

afvincent Feb 27, 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!

Choose a reason for hiding this comment

Uh oh!

NelleV commented Mar 6, 2017

Uh oh!

afvincent commented Mar 25, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

anntzer commented Apr 16, 2017

Uh oh!

Uh oh!

dstansby commented Feb 16, 2017 •

edited

Loading

afvincent left a comment •

edited

Loading

afvincent Feb 27, 2017 •

edited

Loading

afvincent commented Mar 25, 2017 •

edited

Loading