From: Tony Yu <ts...@gm...> - 2012-12-10 22:19:26
|
Hi all, I'm not sure if non-core-developers are allowed to post MEPs, but I just did ;). MEP 12 outlines the reorganization of the example gallery and subsequent clean up of the examples: https://github.com/matplotlib/matplotlib/wiki/MEP12 In my opinion, there are two open questions in the MEP: * Section names (may seem trivial to some, but I think it's really important) * Guidelines for cleaning up examples I've added proposed section names and clean-up guidelines to the MEP, but I'm sure these will evolve over time. Best, -Tony |
From: Chao Y. <cha...@gm...> - 2012-12-10 22:33:05
|
The gallry will not include everything, could we also have somewhere to let "non-core" users freely share the code? like some features that are nice to have but not easily found in the galery? but hope this will not lead to overcrowded. Chao On Mon, Dec 10, 2012 at 11:18 PM, Tony Yu <ts...@gm...> wrote: > Hi all, > > I'm not sure if non-core-developers are allowed to post MEPs, but I just > did ;). MEP 12 outlines the reorganization of the example gallery and > subsequent clean up of the examples: > > https://github.com/matplotlib/matplotlib/wiki/MEP12 > > In my opinion, there are two open questions in the MEP: > > * Section names (may seem trivial to some, but I think it's really > important) > * Guidelines for cleaning up examples > > I've added proposed section names and clean-up guidelines to the MEP, but > I'm sure these will evolve over time. > > Best, > -Tony > > > ------------------------------------------------------------------------------ > LogMeIn Rescue: Anywhere, Anytime Remote support for IT. Free Trial > Remotely access PCs and mobile devices and provide instant support > Improve your efficiency, and focus on delivering more value-add services > Discover what IT Professionals Know. Rescue delivers > http://p.sf.net/sfu/logmein_12329d2d > _______________________________________________ > Matplotlib-devel mailing list > Mat...@li... > https://lists.sourceforge.net/lists/listinfo/matplotlib-devel > > -- *********************************************************************************** Chao YUE Laboratoire des Sciences du Climat et de l'Environnement (LSCE-IPSL) UMR 1572 CEA-CNRS-UVSQ Batiment 712 - Pe 119 91191 GIF Sur YVETTE Cedex Tel: (33) 01 69 08 29 02; Fax:01.69.08.77.16 ************************************************************************************ |
From: Chao Y. <cha...@gm...> - 2012-12-10 22:57:44
|
thanks Tony. I didn't know this before. On Mon, Dec 10, 2012 at 11:32 PM, Chao YUE <cha...@gm...> wrote: > The gallry will not include everything, could we also have somewhere to > let "non-core" users freely share the code? like some features that are > nice to have but not easily found in the galery? but hope this will not > lead to overcrowded. > > Chao > > On Mon, Dec 10, 2012 at 11:18 PM, Tony Yu <ts...@gm...> wrote: > >> Hi all, >> >> I'm not sure if non-core-developers are allowed to post MEPs, but I just >> did ;). MEP 12 outlines the reorganization of the example gallery and >> subsequent clean up of the examples: >> >> https://github.com/matplotlib/matplotlib/wiki/MEP12 >> >> In my opinion, there are two open questions in the MEP: >> >> * Section names (may seem trivial to some, but I think it's really >> important) >> * Guidelines for cleaning up examples >> >> I've added proposed section names and clean-up guidelines to the MEP, but >> I'm sure these will evolve over time. >> >> Best, >> -Tony >> >> >> ------------------------------------------------------------------------------ >> LogMeIn Rescue: Anywhere, Anytime Remote support for IT. Free Trial >> Remotely access PCs and mobile devices and provide instant support >> Improve your efficiency, and focus on delivering more value-add services >> Discover what IT Professionals Know. Rescue delivers >> http://p.sf.net/sfu/logmein_12329d2d >> _______________________________________________ >> Matplotlib-devel mailing list >> Mat...@li... >> https://lists.sourceforge.net/lists/listinfo/matplotlib-devel >> >> > > > -- > > *********************************************************************************** > Chao YUE > Laboratoire des Sciences du Climat et de l'Environnement (LSCE-IPSL) > UMR 1572 CEA-CNRS-UVSQ > Batiment 712 - Pe 119 > 91191 GIF Sur YVETTE Cedex > Tel: (33) 01 69 08 29 02; Fax:01.69.08.77.16 > > ************************************************************************************ > > -- *********************************************************************************** Chao YUE Laboratoire des Sciences du Climat et de l'Environnement (LSCE-IPSL) UMR 1572 CEA-CNRS-UVSQ Batiment 712 - Pe 119 91191 GIF Sur YVETTE Cedex Tel: (33) 01 69 08 29 02; Fax:01.69.08.77.16 ************************************************************************************ |
From: Tony Yu <ts...@gm...> - 2012-12-10 22:44:04
|
On Mon, Dec 10, 2012 at 5:32 PM, Chao YUE <cha...@gm...> wrote: > The gallry will not include everything, could we also have somewhere to > let "non-core" users freely share the code? like some features that are > nice to have but not easily found in the galery? but hope this will not > lead to overcrowded. > > Chao > Hi Chao, This MEP only concerns the main gallery. I think user-contributed examples were (are?) the intended focus of SciPy Central: http://scipy-central.org/ (and before that, the SciPy Cookbook). I'm not sure about the status of SciPy Central. There was talk of a redesign, but I haven't seen any progress since then. Best, -Tony > On Mon, Dec 10, 2012 at 11:18 PM, Tony Yu <ts...@gm...> wrote: > >> Hi all, >> >> I'm not sure if non-core-developers are allowed to post MEPs, but I just >> did ;). MEP 12 outlines the reorganization of the example gallery and >> subsequent clean up of the examples: >> >> https://github.com/matplotlib/matplotlib/wiki/MEP12 >> >> In my opinion, there are two open questions in the MEP: >> >> * Section names (may seem trivial to some, but I think it's really >> important) >> * Guidelines for cleaning up examples >> >> I've added proposed section names and clean-up guidelines to the MEP, but >> I'm sure these will evolve over time. >> >> Best, >> -Tony >> >> >> ------------------------------------------------------------------------------ >> LogMeIn Rescue: Anywhere, Anytime Remote support for IT. Free Trial >> Remotely access PCs and mobile devices and provide instant support >> Improve your efficiency, and focus on delivering more value-add services >> Discover what IT Professionals Know. Rescue delivers >> http://p.sf.net/sfu/logmein_12329d2d >> _______________________________________________ >> Matplotlib-devel mailing list >> Mat...@li... >> https://lists.sourceforge.net/lists/listinfo/matplotlib-devel >> >> > > > -- > > *********************************************************************************** > Chao YUE > Laboratoire des Sciences du Climat et de l'Environnement (LSCE-IPSL) > UMR 1572 CEA-CNRS-UVSQ > Batiment 712 - Pe 119 > 91191 GIF Sur YVETTE Cedex > Tel: (33) 01 69 08 29 02; Fax:01.69.08.77.16 > > ************************************************************************************ > > |
From: Thomas K. <th...@kl...> - 2012-12-11 17:31:55
|
On 10 December 2012 22:43, Tony Yu <ts...@gm...> wrote: > This MEP only concerns the main gallery. I think user-contributed examples > were (are?) the intended focus of SciPy Central: > > http://scipy-central.org/ > > (and before that, the SciPy Cookbook). I'm not sure about the status of > SciPy Central. There was talk of a redesign, but I haven't seen any > progress since then. > We (IPython) contacted the maintainer of Scipy Central. The picture is roughly that he doesn't have time to maintain it, but is happy to transfer the codebase and content (and server? I can't remember) to anyone who's interested. We've also got an idea about making a site for sharing code samples based on http://nbviewer.ipython.org/ , as the notebook is a format that really lends itself to this sort of thing. Best wishes, Thomas |
From: Paul H. <pmh...@gm...> - 2012-12-10 22:51:20
|
On Mon, Dec 10, 2012 at 2:18 PM, Tony Yu <ts...@gm...> wrote: > Hi all, > > I'm not sure if non-core-developers are allowed to post MEPs, but I just > did ;). MEP 12 outlines the reorganization of the example gallery and > subsequent clean up of the examples: > > https://github.com/matplotlib/matplotlib/wiki/MEP12 > > In my opinion, there are two open questions in the MEP: > > * Section names (may seem trivial to some, but I think it's really > important) > * Guidelines for cleaning up examples > > I've added proposed section names and clean-up guidelines to the MEP, but > I'm sure these will evolve over time. > > Best, > -Tony > > Here here! I've been waiting for a really nasty, cold, and rainy weekend here in Portland to make some PRs at least cleaning up the code contained within the examples. Just hasn't happened yet ;) Tony, if you make your own branch for this, I'd be happy to contribute. -paul |
From: Tony Yu <ts...@gm...> - 2012-12-10 23:01:37
|
On Mon, Dec 10, 2012 at 5:51 PM, Paul Hobson <pmh...@gm...> wrote: > On Mon, Dec 10, 2012 at 2:18 PM, Tony Yu <ts...@gm...> wrote: > >> Hi all, >> >> I'm not sure if non-core-developers are allowed to post MEPs, but I just >> did ;). MEP 12 outlines the reorganization of the example gallery and >> subsequent clean up of the examples: >> >> https://github.com/matplotlib/matplotlib/wiki/MEP12 >> >> In my opinion, there are two open questions in the MEP: >> >> * Section names (may seem trivial to some, but I think it's really >> important) >> * Guidelines for cleaning up examples >> >> I've added proposed section names and clean-up guidelines to the MEP, but >> I'm sure these will evolve over time. >> >> Best, >> -Tony >> >> > Here here! I've been waiting for a really nasty, cold, and rainy weekend > here in Portland to make some PRs at least cleaning up the code contained > within the examples. Just hasn't happened yet ;) > > Tony, if you make your own branch for this, I'd be happy to contribute. > -paul > Awesome! I'm hoping we can quickly converge on some clean-up guidelines and section headings. I was envisioning a single PR that adds new gallery sections. After that examples would be updated over a long period of time in multiple PRs that change a few examples at a time. Do you think that all the work should be done on a parallel branch and merged in one big PR? Best, -Tony |
From: Phil E. <pel...@gm...> - 2012-12-11 09:58:20
|
> I'm not sure if non-core-developers are allowed to post MEPs, but I just did Yes please... The more the merrier! Aren't you a core dev anyway Tony? :-) You've certainly contributed some really valuable features, and even if you don't have access to "the big green button" in my eyes you feedback and input are just as valuable. The gallery was one of the key features that pulled me into mpl, but it definitely needs a bit of TLC. The timing is quite convenient for me as I am about to (in the next month or so) embark on implementing a gallery for a project I'm working on that makes heavy use of matplotlib (cartopy: http://scitools.org.uk/cartopy/docs/latest/). One thing I was considering doing in my implementation was allowing multiple tags for each example by adding some extra module level information (in a list called "__tags__" perhaps) rather than focussing on a directory structure to provide the tag as the current implementation of the gallery does (and as far as I can see, the MEP recommends this too). In the past I have also worked on a gallery extension which uses the docstring of the example to provide a richer explanation of what is going on (example: http://scitools.org.uk/iris/docs/latest/examples/graphics/COP_1d_plot.html). An alternative approach which has worked well for me is the walked through examples found in scikits-learn (their website is down, but most of the examples are good in that regard) which could be done via an iPython notebook for the annotations. > Do you think that all the work should be done on a parallel branch and merged in one big PR? Personally, I'm not in favour of that. We would have to make sure that the pull requests related to this change don't start to stack up, but I think we can definitely do this sequentially once the appropriate machinery is in place. Thanks for bringing this subject up, All the best, Phil On 10 December 2012 23:00, Tony Yu <ts...@gm...> wrote: > > > On Mon, Dec 10, 2012 at 5:51 PM, Paul Hobson <pmh...@gm...> wrote: > >> On Mon, Dec 10, 2012 at 2:18 PM, Tony Yu <ts...@gm...> wrote: >> >>> Hi all, >>> >>> I'm not sure if non-core-developers are allowed to post MEPs, but I just >>> did ;). MEP 12 outlines the reorganization of the example gallery and >>> subsequent clean up of the examples: >>> >>> https://github.com/matplotlib/matplotlib/wiki/MEP12 >>> >>> In my opinion, there are two open questions in the MEP: >>> >>> * Section names (may seem trivial to some, but I think it's really >>> important) >>> * Guidelines for cleaning up examples >>> >>> I've added proposed section names and clean-up guidelines to the MEP, >>> but I'm sure these will evolve over time. >>> >>> Best, >>> -Tony >>> >>> >> Here here! I've been waiting for a really nasty, cold, and rainy weekend >> here in Portland to make some PRs at least cleaning up the code contained >> within the examples. Just hasn't happened yet ;) >> >> Tony, if you make your own branch for this, I'd be happy to contribute. >> -paul >> > > Awesome! I'm hoping we can quickly converge on some clean-up guidelines > and section headings. > > I was envisioning a single PR that adds new gallery sections. After that > examples would be updated over a long period of time in multiple PRs that > change a few examples at a time. Do you think that all the work should be > done on a parallel branch and merged in one big PR? > > Best, > -Tony > > > ------------------------------------------------------------------------------ > LogMeIn Rescue: Anywhere, Anytime Remote support for IT. Free Trial > Remotely access PCs and mobile devices and provide instant support > Improve your efficiency, and focus on delivering more value-add services > Discover what IT Professionals Know. Rescue delivers > http://p.sf.net/sfu/logmein_12329d2d > _______________________________________________ > Matplotlib-devel mailing list > Mat...@li... > https://lists.sourceforge.net/lists/listinfo/matplotlib-devel > > |
From: Tony Yu <ts...@gm...> - 2012-12-12 01:40:43
|
On Tue, Dec 11, 2012 at 4:15 AM, Phil Elson <pel...@gm...> wrote: > > I'm not sure if non-core-developers are allowed to post MEPs, but I just > did > > Yes please... The more the merrier! > Aren't you a core dev anyway Tony? :-) You've certainly contributed some > really valuable features, and even if you don't have access to "the big > green button" in my eyes you feedback and input are just as valuable. > Thanks :) <snip> One thing I was considering doing in my implementation was allowing > multiple tags for each example by adding some extra module level > information (in a list called "__tags__" perhaps) rather than focussing on > a directory structure to provide the tag as the current implementation of > the gallery does (and as far as I can see, the MEP recommends this too). > I think tags would be great, but I don't want to be responsible for implementing them :). As argued in the MEP, tags would be complementary: Sections would help users who just want to scan the gallery. Maybe we can "suggest" that clean ups include tags as a way of preparing for the future? > In the past I have also worked on a gallery extension which uses the > docstring of the example to provide a richer explanation of what is going > on (example: > http://scitools.org.uk/iris/docs/latest/examples/graphics/COP_1d_plot.html). > An alternative approach which has worked well for me is the walked through > examples found in scikits-learn (their website is down, but most of the > examples are good in that regard) which could be done via an iPython > notebook for the annotations. Actually, scikit-image borrowed the scikit-learn gallery extension, and I ended up tweaking it to provide more control over the output: http://tonysyu.github.com/mpltools/auto_examples/sphinx/plot_plot2rst.html I haven't looked too closely at the machinery used to generate the matplotlib gallery, so I'm not sure how difficult it will be to integrate something like this. Best, -Tony |
From: Nicolas R. <Nic...@in...> - 2012-12-11 10:16:45
|
Thanks a lot for this MEP and I would gladly contribute to the new gallery. From my own experience with the current gallery, I would recommend to have simple scripts that illustrate one feature only, it make things more clear IMHO. From my attempt at making some alternative gallery (http://www.loria.fr/~rougier/coding/gallery/), I would also recommend a standard size for figures unless a different size is strictly necessary. For section names, maybe we can use several different schemes with same figures ? Also, one important thing is to have a page with all the figures such one can browse visually all the examples. Nicolas On Dec 11, 2012, at 0:00 , Tony Yu wrote: > > > On Mon, Dec 10, 2012 at 5:51 PM, Paul Hobson <pmh...@gm...> wrote: > On Mon, Dec 10, 2012 at 2:18 PM, Tony Yu <ts...@gm...> wrote: > Hi all, > > I'm not sure if non-core-developers are allowed to post MEPs, but I just did ;). MEP 12 outlines the reorganization of the example gallery and subsequent clean up of the examples: > > https://github.com/matplotlib/matplotlib/wiki/MEP12 > > In my opinion, there are two open questions in the MEP: > > * Section names (may seem trivial to some, but I think it's really important) > * Guidelines for cleaning up examples > > I've added proposed section names and clean-up guidelines to the MEP, but I'm sure these will evolve over time. > > Best, > -Tony > > > Here here! I've been waiting for a really nasty, cold, and rainy weekend here in Portland to make some PRs at least cleaning up the code contained within the examples. Just hasn't happened yet ;) > > Tony, if you make your own branch for this, I'd be happy to contribute. > -paul > > Awesome! I'm hoping we can quickly converge on some clean-up guidelines and section headings. > > I was envisioning a single PR that adds new gallery sections. After that examples would be updated over a long period of time in multiple PRs that change a few examples at a time. Do you think that all the work should be done on a parallel branch and merged in one big PR? > > Best, > -Tony > ------------------------------------------------------------------------------ > LogMeIn Rescue: Anywhere, Anytime Remote support for IT. Free Trial > Remotely access PCs and mobile devices and provide instant support > Improve your efficiency, and focus on delivering more value-add services > Discover what IT Professionals Know. Rescue delivers > http://p.sf.net/sfu/logmein_12329d2d_______________________________________________ > Matplotlib-devel mailing list > Mat...@li... > https://lists.sourceforge.net/lists/listinfo/matplotlib-devel |
From: Tony Yu <ts...@gm...> - 2012-12-12 01:27:36
|
On Tue, Dec 11, 2012 at 2:07 AM, Nicolas Rougier <Nic...@in...>wrote: > > > Thanks a lot for this MEP and I would gladly contribute to the new gallery. > Thanks for adding the link to your gallery. I meant to include it (that's where I got the idea for a "showcase" section) but it slipped through. > From my own experience with the current gallery, I would recommend to have > simple scripts that illustrate one feature only, it make things more clear > IMHO. I definitely agree. That's more clearly stated in the MEP, now. > From my attempt at making some alternative gallery ( > http://www.loria.fr/~rougier/coding/gallery/), I would also recommend a > standard size for figures unless a different size is strictly necessary. I agree, but I'm not sure if this should be controlled by the example script, or if the thumbnail generator should force a specific thumbnail size. Regardless, most examples shouldn't be changing the default figure size (since they should be focused on changes pertinent to a single function). > For section names, maybe we can use several different schemes with same > figures ? I think this would be better suited for a tagging system, which I think is complementary to the gallery sections. I believe Ben started working on a tagging system, but then life got in the way :) Also, one important thing is to have a page with all the figures such one > can browse visually all the examples. > Agreed. I don't think the idea of the gallery should change---just the organization of it. Cheers, -Tony |
From: Michael D. <md...@st...> - 2012-12-11 18:16:03
|
On 12/10/2012 05:18 PM, Tony Yu wrote: > Hi all, > > I'm not sure if non-core-developers are allowed to post MEPs, but I > just did ;). It's a big tent. Come on in! BTW -- if you want to have access to the big green merge button, let me know. You've certainly been working on matplotlib long enough, to say the least. :) > MEP 12 outlines the reorganization of the example gallery and > subsequent clean up of the examples: > > https://github.com/matplotlib/matplotlib/wiki/MEP12 > > In my opinion, there are two open questions in the MEP: > > * Section names (may seem trivial to some, but I think it's really > important) > * Guidelines for cleaning up examples > Some thoughts: You suggest keeping the old examples around in some dark corner. Is there some advantage you envision for doing this? I'd just as soon remove them. Note that the documentation on the website is now versioned, so the examples that shipped with 1.2.0 will remain live and unchanged indefinitely. If a user wants the older gallery it should just be there under matplotlib.org/1.2. As for the categories/structure, I think I prefer your "suggested alternative" -- to have narrowly defined categories rather than a big "plotting" directory. For "cleanup guidelines", perhaps it is worth mentioning that some of the examples are really unit tests -- they just exercise some esoteric feature that's only of interest to developers. These should be converted into unit tests from the framework and probably deleted altogether as gallery examples. Maybe we should also add that examples should be renamed when appropriate: there are things like "image_demo.py" and "image_demo2.py". The "2" doesn't really help to describe what's in there. I'm not sure I agree with "one figure per example" as a goal -- it is sometimes nice to have a number of features demonstrated by a single example file, and cramming them all into multiple axes isn't always the best approach. I think we can take that on a case-by-case basis. I agree with Phil that we might as well just iterate this on master. I would envision one or two PRs to get the general infrastructure in place, and then lots of PRs from multiple authors as we work on whipping the examples into shape. Note that I haven't started doing this yet, but I will probably start periodically posting built documentation of master on the website -- that should make it easy for anyone to preview the new gallery and provide feedback as we work. Cheers, Mike |
From: Tony Yu <ts...@gm...> - 2012-12-11 23:08:40
|
Hi Michael, Thanks for reading the MEP! Responses below: On Tue, Dec 11, 2012 at 1:10 PM, Michael Droettboom <md...@st...> wrote: > On 12/10/2012 05:18 PM, Tony Yu wrote: > > <snip> > MEP 12 outlines the reorganization of the example gallery and subsequent > clean up of the examples: > > > https://github.com/matplotlib/matplotlib/wiki/MEP12 > > In my opinion, there are two open questions in the MEP: > > * Section names (may seem trivial to some, but I think it's really > important) > * Guidelines for cleaning up examples > > Some thoughts: > > You suggest keeping the old examples around in some dark corner. Is there > some advantage you envision for doing this? I'd just as soon remove them. > Note that the documentation on the website is now versioned, so the > examples that shipped with 1.2.0 will remain live and unchanged > indefinitely. If a user wants the older gallery it should just be there > under matplotlib.org/1.2. > I noted that old examples could either be kept in a dark corner, or deleted. I'm actually strongly in favor of deleting, especially since the website is versioned (nice---I didn't know this). I was afraid some people would be resistant to deleting, but I'm happy to hear that you prefer it. I'll make this preference clearer in the MEP. As for the categories/structure, I think I prefer your "suggested > alternative" -- to have narrowly defined categories rather than a big > "plotting" directory. > I agree that "plotting" is too general. My only hesitation with the finer classification of plots is that it's really hard to come up with categories that work; my current suggestions in the MEP aren't really ideal. Nevertheless, I'm sure we can all put our heads together to come up with categories that make sense... > For "cleanup guidelines", perhaps it is worth mentioning that some of the > examples are really unit tests -- they just exercise some esoteric feature > that's only of interest to developers. These should be converted into unit > tests from the framework and probably deleted altogether as gallery > examples. > Agreed. Maybe we should also add that examples should be renamed when appropriate: > there are things like "image_demo.py" and "image_demo2.py". The "2" > doesn't really help to describe what's in there. > I definitely agree. I'm not sure I agree with "one figure per example" as a goal -- it is > sometimes nice to have a number of features demonstrated by a single > example file, and cramming them all into multiple axes isn't always the > best approach. I think we can take that on a case-by-case basis. > I was hesitant to add this initially. I agree it's sometimes a good idea to have multiple figures. I'd still like to have this as a suggestion---I'll try to make that a little clearer in the MEP. > I agree with Phil that we might as well just iterate this on master. I > would envision one or two PRs to get the general infrastructure in place, > and then lots of PRs from multiple authors as we work on whipping the > examples into shape. > Sounds good. Best, -Tony |
From: Marcel O. <m.o...@ja...> - 2012-12-12 12:01:43
|
Tony Yu writes: > MEP 12 outlines the reorganization of the example gallery and > subsequent clean up of the examples: > > https://github.com/matplotlib/matplotlib/wiki/MEP12 Dear all, thanks for this initiative. As a user who has done a fair amount of tweaking for publication-quality graphics, but who cannot claim to have a deep understanding of the overall architecture of matplotlib, the gallery has long been on my radar as something in need of improvement. I believe that the MEP goes in the right direction, but I could see some more radical changes as well. Independent of ordering by topic, I see three categories of examples: 1. API documentation/illustration of basic functionality 2. HOWTO: task driven examples (how to create a certain type of graph, how to perform a certain useful tweak) 3. Showcases (complete projects of typically higher complexity than the above, code could also contain substantial sections which are related to data-generation, preparation, or simulation) For the category 1 examples, the examples are really part of the API documentation and the gallery is just a thumbnail view which makes it easier to use eye-ball navigation through the matplotlib documentation. I believe this is already how it works today, but it's not really clear from the structure of the gallery. The category 1 examples should be clearly recognizable as views into a more comprehensive document and also given some structure (by stating function/methods to whose documentation they are attached, for example, and/or by the categories outlined in the MEP). For the category 2 examples, one needs to think in terms of the workflow. This will likely need to grow as new tasks and problems come to peoples attention, so just a very superficial selection of topics which have come across in my own work: - How do I change the text size of the legend (or of labels, etc.) - How do I make matplotlib use only one marker symbol in the legend (because each symbols refers not to a graph of something, but to a unique point in the graph) - How to I plot labels and ticks on both sides (or top and bottom) of the coordinate system? - How do I use (and properly label) a logarithmically scaled color scale? - How can I label the axes in imshow logarithmically? - How do I produce a QQ-plot? - How do I produce figures such that the font size, when included into a TeX document, matches the font size of the text? - How do I mask invalid regions in imshow()? Here, I believe it would be important that the examples are accompanied by explanatory text. Sometimes these tricks are obvious from the code itself, but sometimes a more high-level explanation would really help a lot. For category 3, I would only take examples of exceptional quality, and also, if possible, with explanation of the task, of solution strategies, and possibly references to publications where the output has appeared (on wikipedia, there seem to be a good number of high quality plots which appear to come from matplotlib but which do not have source code attached, so some cross-linking could be worthwhile). The last item of concern to me is the quality of gallery pictures. While there are excellent examples, most have more or less glaring deficiencies. Some issues appear to point to bugs or at least limitations of matplotlib itself. What is absolutely necessary is a very critical review. Let me just pick a more or less randomly chosen gallery item, sankey_demo_basics.py: - Annotations run into each other, into the flow graph, and into the coordinate frame - Distance of annotations to flow graph inconsistent and often too small - About half way between the label "0.6" and "0.15", the boundary of the flow graph appears to be double-printed with a slightly thicker line. - On the third plot, the flow graph seems down-shifted and the legend is cramped I could easily come up with similar lists of very many of the other graphs (in fact, I might even volunteer to do this systematically if there is a process on how to file and document such observations so that the effort could not get lost). Another effort should be to remove redundancy, the question should always be "is this the best way to demonstrate this feature", if there is a better way, the inferior one should be removed. The gallery has already reached a size where finding things is difficult, so the overall growth should be in quality, not in quantity. Just my 2 cents... As I said, I would be willing to help out mainly with reviewing. Regards, Marcel --------------------------------------------------------------------- Marcel Oliver Phone: +49-421-200-3212 School of Engineering and Science Fax: +49-421-200-3103 Jacobs University m.o...@ja... Campus Ring 1 ol...@me... 28759 Bremen, Germany http://math.jacobs-university.de/oliver --------------------------------------------------------------------- |
From: Thomas K. <th...@kl...> - 2012-12-12 00:17:30
|
On 11 December 2012 23:07, Tony Yu <ts...@gm...> wrote: > You suggest keeping the old examples around in some dark corner. Is >> there some advantage you envision for doing this? I'd just as soon remove >> them. Note that the documentation on the website is now versioned, so the >> examples that shipped with 1.2.0 will remain live and unchanged >> indefinitely. If a user wants the older gallery it should just be there >> under matplotlib.org/1.2. >> > > I noted that old examples could either be kept in a dark corner, or > deleted. I'm actually strongly in favor of deleting, especially since the > website is versioned (nice---I didn't know this). I was afraid some people > would be resistant to deleting, but I'm happy to hear that you prefer it. > I'll make this preference clearer in the MEP. > I haven't had time to consider all the details of this proposal, but I'd like to advise against overzealous deletion. For those of us less familiar with matplotlib's API, a pretty standard approach is to scan through the examples gallery for the plot that looks most like the one we want, copy the code and tweak it into what we need. So a big gallery is very useful. Of course, that doesn't mean it should grow ad infinitum, and I'm sure you'll use good judgement on this. I just wanted to check you were aware of this use case. Best wishes, Thomas |
From: Michael D. <md...@st...> - 2012-12-12 14:10:24
|
On 12/11/2012 07:16 PM, Thomas Kluyver wrote: > On 11 December 2012 23:07, Tony Yu <ts...@gm... > <mailto:ts...@gm...>> wrote: > > You suggest keeping the old examples around in some dark > corner. Is there some advantage you envision for doing this? > I'd just as soon remove them. Note that the documentation on > the website is now versioned, so the examples that shipped > with 1.2.0 will remain live and unchanged indefinitely. If a > user wants the older gallery it should just be there under > matplotlib.org/1.2 <http://matplotlib.org/1.2>. > > > I noted that old examples could either be kept in a dark corner, > or deleted. I'm actually strongly in favor of deleting, especially > since the website is versioned (nice---I didn't know this). I was > afraid some people would be resistant to deleting, but I'm happy > to hear that you prefer it. I'll make this preference clearer in > the MEP. > > > I haven't had time to consider all the details of this proposal, but > I'd like to advise against overzealous deletion. For those of us less > familiar with matplotlib's API, a pretty standard approach is to scan > through the examples gallery for the plot that looks most like the one > we want, copy the code and tweak it into what we need. So a big > gallery is very useful. I don't think Tony was suggesting deleting many of the examples -- only deleting any old stuff after reorganization of what we already have. I was suggesting deleting a few examples that really aren't useful to end users, and are really just unit tests (predating our unit test framework). The sort of thing I was suggesting deleting are: http://matplotlib.org/examples/api/donut_demo.html which is really a unit test. It's highly unlikely the user would create those shapes directly, and if they were we have the dolphin demo which makes more sense from an end user perspective. There are also examples that are sort of developer oriented that should probably just be updated to be less so, for example: http://matplotlib.org/examples/api/clippath_demo.html It's perfectly reasonable code, but seems strange that it's clipped off to the corner which I think makes it less useful as an example. > > Of course, that doesn't mean it should grow ad infinitum, and I'm sure > you'll use good judgement on this. I just wanted to check you were > aware of this use case. > Absolutely. I think that's a major use case for the gallery. Cheers, Mike > Best wishes, > Thomas |
From: Paul H. <pmh...@gm...> - 2012-12-12 18:17:27
|
On Wed, Dec 12, 2012 at 5:59 AM, Michael Droettboom <md...@st...> wrote: > > http://matplotlib.org/examples/api/clippath_demo.html > > It's perfectly reasonable code, but seems strange that it's clipped off to > the corner which I think makes it less useful as an example. > > If I understand correctly, you're proposing that that such an example would be deleted after a more practical example was available to replace it? While I'm 100% in favor of "cleaning out the closet", I used this exact example two days ago to clip a depressed groundwater surface to a landfill boundary :) |
From: Michael D. <md...@st...> - 2012-12-12 18:44:59
|
On 12/12/2012 01:17 PM, Paul Hobson wrote: > > On Wed, Dec 12, 2012 at 5:59 AM, Michael Droettboom <md...@st... > <mailto:md...@st...>> wrote: > > > http://matplotlib.org/examples/api/clippath_demo.html > > It's perfectly reasonable code, but seems strange that it's > clipped off to the corner which I think makes it less useful as an > example. > > > If I understand correctly, you're proposing that that such an example > would be deleted after a more practical example was available to > replace it? > > While I'm 100% in favor of "cleaning out the closet", I used this > exact example two days ago to clip a depressed groundwater surface to > a landfill boundary :) I'm suggesting updating it to be even more useful, and to make the thumbnail image more illustrative of the technique that it demonstrates. Mike |
From: Marcel O. <m.o...@ja...> - 2012-12-12 19:57:38
|
Paul Hobson writes: > On Wed, Dec 12, 2012 at 5:59 AM, Michael Droettboom <md...@st...> wrote: > > http://matplotlib.org/examples/api/clippath_demo.html > > It's perfectly reasonable code, but seems strange that it's > clipped off to the corner which I think makes it less useful as > an example. > > If I understand correctly, you're proposing that that such an > example would be deleted after a more practical example was > available to replace it? > > While I'm 100% in favor of "cleaning out the closet", I used this exact > example two days ago to clip a depressed groundwater surface to a landfill > boundary :) There is one small issue with the example: If one is using imshow on random pixel data, there is not reason to use bilinear interpolation (which is what imshow defaults to). "nearest" is the only reasonable choice. I know this sounds pedantic, but it irks me as a numerical analyst... --Marcel |
From: Tony Yu <ts...@gm...> - 2012-12-27 05:27:38
|
On Wed, Dec 12, 2012 at 11:57 AM, Marcel Oliver < m.o...@ja...> wrote: > Paul Hobson writes: > > On Wed, Dec 12, 2012 at 5:59 AM, Michael Droettboom <md...@st...> > wrote: > > > > http://matplotlib.org/examples/api/clippath_demo.html > > > > It's perfectly reasonable code, but seems strange that it's > > clipped off to the corner which I think makes it less useful as > > an example. > > > > If I understand correctly, you're proposing that that such an > > example would be deleted after a more practical example was > > available to replace it? > > > > While I'm 100% in favor of "cleaning out the closet", I used this exact > > example two days ago to clip a depressed groundwater surface to a > landfill > > boundary :) > > There is one small issue with the example: If one is using imshow on > random pixel data, there is not reason to use bilinear interpolation > (which is what imshow defaults to). "nearest" is the only reasonable > choice. > > I know this sounds pedantic, but it irks me as a numerical analyst... > > --Marcel > Marcel: I agree examples like this should be changed. Actually, I think the default interpolation should be changed to "nearest", but that's a whole different can of worms ;) For those who are interested, I just posted a pull request for this gallery clean up <https://github.com/matplotlib/matplotlib/pull/1623>. It's definitely a work in progress. In particular, the section names are less than ideal, but I think github's PR interface is a better place for that discussion than the wiki or mailing list. The new section names can be found below: https://github.com/matplotlib/matplotlib/pull/1623/files#L0R86 Also, I moved a number of examples to the new sections in order to demonstrate some of the clean up guidelines. BTW, one of the examples I cleaned up is the clippath demo discussed earlier in this thread. Best, -Tony Marcel: Sorry for the second email, I forgot to "reply all" the first time. |