matplotlib-devel Mailing List for matplotlib

Andrew Straw <str...@as...> writes:
>> 3. To make this work, agree that sample data files are immutable: if a
>> new version is needed, it needs to have a new name (and thus the
>> examples using it need to be updated). The files have not been
>> changed a lot [2], so I don't think this is very much of a burden.
>>
> I don't like #3 -- for the same reasons as we want to separate the rest 
> of the sample data (smaller download, smaller repository, and separation 
> of code and non-essential data), I think the test comparison images 
> should be with the sample data. Having to deal with renames in the tests 
> would be annoying. 
If the test data is moved there, I agree that renaming won't work. 
But it seems to me that test data is different from sample data used by
examples: when running the tests for a given revision of matplotlib, you
don't want the absolute latest comparison images but the images that
correspond to that particular code revision. You also typically want to
get all of the comparison images for that revision at the same time,
since you're likely to be running the whole test suite. Also, if you are
running the test suite, I think we can assume you can get a checkout of
the test-data repository.
(A git submodule would seem to be a good fit: the main repository would
have a pointer to the appropriate revision of the test-images
repository, and people interested in running the test suite would have
to run "git submodule update" to check it out.)
> Two alternative ideas to handle for the versioning 
> issue: A) Add a .py file in the main source repository with is a list of 
> sample data filenames and checksums. If a sample data file doesn't 
> exist, or its checksum is wrong, it can be downloaded.
Sounds complicated, and makes older versions unable to run newer
examples.
> B) The source file could simply have the same data version number
> required and the sample data itself could be versioned.
That might work. If I understand this correctly, the example code would
call get_sample_data("foo.dat") to get the latest revision or
get_sample_data("foo.dat", 1234) to get a specific one. These would
retrieve URLs like
http://example.com/sample-data/raw/master/foo.dat
http://example.com/sample-data/raw/1234/foo.dat
-- 
Jouni K. Seppänen
http://www.iki.fi/jks

Le 12 sept. 2010 18:08, Benjamin Root <ben...@ou...> a écrit :
> That would be a neat feature. Which other backends have you tested? I 
> presume that numbers still work as usual?
> Ben Root
I've tested it on TkAgg and Qt4Agg which are the only backends I use. 
Numbers should be working just as before.
The patch is very short but probably needs someone who knows the code to 
have a look it.

On Sun, Sep 12, 2010 at 6:54 AM, Peter Butterworth <bu...@gm...>wrote:
> I am considering a patch to support named figures.
>
> >>
> http://sourceforge.net/tracker/?func=detail&aid=3057301&group_id=80706&atid=560723
> Tracker: Feature Requests
> pls support named figures - ID: 3057301
>
> instead of only:
> plt.figure(1)
> the following:
> plt.figure('today')
> would open a figure called 'today' instead of 'figure 1'
>
> Example usage: when opening a lot of tabbed figures (in Spyder) it
> would help if the tabs have meaningful names.
> >>
>
> I have been successful at modifying pyplot.figure to handle string
> arguments. For this I store the figure name in the _label attribute of
> the figure in addition to setting the expected plot number value. My
> hack seems to works on qt4agg backend (it does requires adding an
> optional label argument to the FigureManagerQT constructor).
>
> Is there interest in including such a patch in matplotlib ? Is it
> likely to break things elsewhere ?
>
> --
> thanks,
> peter butterworth
>
>
That would be a neat feature. Which other backends have you tested? I
presume that numbers still work as usual?
Ben Root

On Sun, Sep 12, 2010 at 10:30 AM, Andrew Straw <str...@as...> wrote:
> #1 and #2 seem reasonable to me.
>
> I don't like #3 -- for the same reasons as we want to separate the rest
I agree with Andrew here -- we don't want to hamstring our ability to
change the data just because some people would rather take a version
in place of the latest version. If we have an rc option
 sampledata.fetch : False
then the sampledata function would only look in the sample data dir,
get the file if available, raise otherwise. If fetch is True, it
would always go the web first and check for the latest, get it and
cache it. Then the packagers could download the tarball, unpack it,
and not worry about mpl trying to check for a more recent version.
JDH

On 09/12/2010 07:10 AM, Jouni K. Seppänen wrote:
> A while ago there was a discussion [1] about how using the
> get_sample_data function in building the documentation is a problem for
> Debian packagers. Let me see if I understand the goals of
> get_sample_data correctly:
>
> * we want to enable users to run examples they find in the gallery
> without downloading extra files;
>
> * we don't want to package all the sample data with matplotlib, either
> because it is too large, or because it changes more often than we
> release new versions.
> 
* Also, we want to have the sample data not to be in the same version 
control repository as MPL proper so that when we download the MPL source 
code itself, we don't get the sample data. (This is one of the sticking 
points for a move to git.)
> Here's what I suggest:
>
> 1. Package the sample data in a separate zip file that users can
> download and expand in e.g. ~/.matplotlib/sample_data if they like.
> This file could be released more often than matplotlib, if needed.
> Debian can use this as one source file and package it as a separate
> deb file.
>
> 2. Make get_sample_data look first in the place where the zip file could
> have been expanded, and only if the required file is not found, try
> to obtain it from the web. Add an option to disable the network
> access. This is different from what we do now, because now
> get_sample_data always tries to check if there is a newer version
> available, which apparently doesn't work reliably on unconnected
> computers.
>
> 3. To make this work, agree that sample data files are immutable: if a
> new version is needed, it needs to have a new name (and thus the
> examples using it need to be updated). The files have not been
> changed a lot [2], so I don't think this is very much of a burden.
>
> What do you think?
>
> 
#1 and #2 seem reasonable to me.
I don't like #3 -- for the same reasons as we want to separate the rest 
of the sample data (smaller download, smaller repository, and separation 
of code and non-essential data), I think the test comparison images 
should be with the sample data. Having to deal with renames in the tests 
would be annoying. Two alternative ideas to handle for the versioning 
issue: A) Add a .py file in the main source repository with is a list of 
sample data filenames and checksums. If a sample data file doesn't 
exist, or its checksum is wrong, it can be downloaded. B) The source 
file could simply have the same data version number required and the 
sample data itself could be versioned.

A while ago there was a discussion [1] about how using the
get_sample_data function in building the documentation is a problem for
Debian packagers. Let me see if I understand the goals of
get_sample_data correctly:
* we want to enable users to run examples they find in the gallery
 without downloading extra files;
* we don't want to package all the sample data with matplotlib, either
 because it is too large, or because it changes more often than we
 release new versions.
The current sample data takes about 2.5 megabytes uncompressed, so the
size doesn't look like a real problem, but of course it is desirable
that new examples are usable with old versions unless they need new
features.
The problem that the Debian packagers have with the current system is 
(I suppose) that building the documentation requires network access and 
is not guaranteed to be repeatable.
Here's what I suggest:
1. Package the sample data in a separate zip file that users can
 download and expand in e.g. ~/.matplotlib/sample_data if they like.
 This file could be released more often than matplotlib, if needed.
 Debian can use this as one source file and package it as a separate
 deb file.
2. Make get_sample_data look first in the place where the zip file could
 have been expanded, and only if the required file is not found, try
 to obtain it from the web. Add an option to disable the network
 access. This is different from what we do now, because now
 get_sample_data always tries to check if there is a newer version
 available, which apparently doesn't work reliably on unconnected
 computers.
3. To make this work, agree that sample data files are immutable: if a
 new version is needed, it needs to have a new name (and thus the
 examples using it need to be updated). The files have not been
 changed a lot [2], so I don't think this is very much of a burden.
What do you think?
Jouni
[1] http://thread.gmane.org/gmane.comp.python.matplotlib.devel/8865
[2] Here is a summary of the changes to each file in sample_data:
=== ./aapl.csv ===
------------------------------------------------------------------------
r7379 | jdh2358 | 2009年08月05日 18:57:31 +0300 (2009年8月05日)
------------------------------------------------------------------------
r6202 | jdh2358 | 2008年10月15日 15:43:41 +0300 (2008年10月15日)
------------------------------------------------------------------------
r4975 | jdh2358 | 2008年02月16日 22:58:37 +0200 (2008年2月16日)
------------------------------------------------------------------------
=== ./AAPL.dat ===
------------------------------------------------------------------------
r7388 | jdh2358 | 2009年08月05日 20:16:50 +0300 (2009年8月05日)
------------------------------------------------------------------------
=== ./aapl.npy ===
------------------------------------------------------------------------
r7377 | jdh2358 | 2009年08月05日 18:52:29 +0300 (2009年8月05日)
------------------------------------------------------------------------
r6203 | jdh2358 | 2008年10月15日 18:39:44 +0300 (2008年10月15日)
------------------------------------------------------------------------
=== ./axes_grid/bivariate_normal.npy ===
------------------------------------------------------------------------
r7436 | leejjoon | 2009年08月09日 07:34:08 +0300 (2009年8月09日)
------------------------------------------------------------------------
=== ./ct.raw ===
------------------------------------------------------------------------
r7382 | jdh2358 | 2009年08月05日 19:21:23 +0300 (2009年8月05日)
------------------------------------------------------------------------
r177 | jdh2358 | 2004年03月13日 01:00:12 +0200 (2004年3月13日)
------------------------------------------------------------------------
=== ./data_x_x2_x3.csv ===
------------------------------------------------------------------------
r7382 | jdh2358 | 2009年08月05日 19:21:23 +0300 (2009年8月05日)
------------------------------------------------------------------------
r7078 | efiring | 2009年05月03日 03:09:06 +0300 (2009年5月03日)
------------------------------------------------------------------------
=== ./demodata.csv ===
------------------------------------------------------------------------
r7382 | jdh2358 | 2009年08月05日 19:21:23 +0300 (2009年8月05日)
------------------------------------------------------------------------
r5100 | jdh2358 | 2008年04月30日 22:53:10 +0300 (2008年4月30日)
------------------------------------------------------------------------
=== ./eeg.dat ===
------------------------------------------------------------------------
r7382 | jdh2358 | 2009年08月05日 19:21:23 +0300 (2009年8月05日)
------------------------------------------------------------------------
r52 | jdh2358 | 2003年11月02日 23:23:21 +0200 (2003年11月02日)
------------------------------------------------------------------------
=== ./embedding_in_wx3.xrc ===
------------------------------------------------------------------------
r7382 | jdh2358 | 2009年08月05日 19:21:23 +0300 (2009年8月05日)
------------------------------------------------------------------------
r397 | astraw | 2004年07月10日 21:39:48 +0300 (2004年7月10日)
------------------------------------------------------------------------
=== ./goog.npy ===
------------------------------------------------------------------------
r7377 | jdh2358 | 2009年08月05日 18:52:29 +0300 (2009年8月05日)
------------------------------------------------------------------------
r6203 | jdh2358 | 2008年10月15日 18:39:44 +0300 (2008年10月15日)
------------------------------------------------------------------------
=== ./INTC.dat ===
------------------------------------------------------------------------
r7387 | jdh2358 | 2009年08月05日 20:16:00 +0300 (2009年8月05日)
------------------------------------------------------------------------
=== ./lena.jpg ===
------------------------------------------------------------------------
r7382 | jdh2358 | 2009年08月05日 19:21:23 +0300 (2009年8月05日)
------------------------------------------------------------------------
r2557 | astraw | 2006年07月12日 02:32:31 +0300 (2006年7月12日)
------------------------------------------------------------------------
r2556 | astraw | 2006年07月12日 02:28:46 +0300 (2006年7月12日)
------------------------------------------------------------------------
r603 | astraw | 2004年10月19日 20:50:03 +0300 (2004年10月19日)
------------------------------------------------------------------------
=== ./lena.png ===
------------------------------------------------------------------------
r7364 | jdh2358 | 2009年08月05日 17:36:27 +0300 (2009年8月05日)
------------------------------------------------------------------------
r7327 | jdh2358 | 2009年07月31日 21:55:17 +0300 (2009年7月31日)
------------------------------------------------------------------------
=== ./logo2.png ===
------------------------------------------------------------------------
r7382 | jdh2358 | 2009年08月05日 19:21:23 +0300 (2009年8月05日)
------------------------------------------------------------------------
r5669 | jdh2358 | 2008年06月24日 21:58:41 +0300 (2008年6月24日)
------------------------------------------------------------------------
=== ./membrane.dat ===
------------------------------------------------------------------------
r7382 | jdh2358 | 2009年08月05日 19:21:23 +0300 (2009年8月05日)
------------------------------------------------------------------------
r64 | jdh2358 | 2003年11月15日 19:05:37 +0200 (2003年11月15日)
------------------------------------------------------------------------
=== ./Minduka_Present_Blue_Pack.png ===
------------------------------------------------------------------------
r7421 | leejjoon | 2009年08月08日 04:40:31 +0300 (2009年8月08日)
------------------------------------------------------------------------
=== ./msft.csv ===
------------------------------------------------------------------------
r7382 | jdh2358 | 2009年08月05日 19:21:23 +0300 (2009年8月05日)
------------------------------------------------------------------------
r2144 | jdh2358 | 2006年03月14日 03:28:43 +0200 (2006年3月14日)
------------------------------------------------------------------------
r86 | jdh2358 | 2003年11月21日 19:50:00 +0200 (2003年11月21日)
------------------------------------------------------------------------
=== ./msft_nasdaq.npy ===
------------------------------------------------------------------------
r7377 | jdh2358 | 2009年08月05日 18:52:29 +0300 (2009年8月05日)
------------------------------------------------------------------------
r6203 | jdh2358 | 2008年10月15日 18:39:44 +0300 (2008年10月15日)
------------------------------------------------------------------------
=== ./s1045.ima ===
------------------------------------------------------------------------
r7382 | jdh2358 | 2009年08月05日 19:21:23 +0300 (2009年8月05日)
------------------------------------------------------------------------
r48 | jdh2358 | 2003年11月02日 21:43:30 +0200 (2003年11月02日)
------------------------------------------------------------------------
=== ./testdata.csv ===
------------------------------------------------------------------------
r7364 | jdh2358 | 2009年08月05日 17:36:27 +0300 (2009年8月05日)
------------------------------------------------------------------------
r7361 | jdh2358 | 2009年08月05日 14:39:37 +0300 (2009年8月05日)
------------------------------------------------------------------------
r7360 | jdh2358 | 2009年08月05日 14:34:43 +0300 (2009年8月05日)
------------------------------------------------------------------------
=== ./testdir/subdir/testsub.csv ===
------------------------------------------------------------------------
r7368 | jdh2358 | 2009年08月05日 17:54:01 +0300 (2009年8月05日)
------------------------------------------------------------------------
-- 
Jouni K. Seppänen
http://www.iki.fi/jks

I am considering a patch to support named figures.
>> http://sourceforge.net/tracker/?func=detail&aid=3057301&group_id=80706&atid=560723
Tracker: Feature Requests
pls support named figures - ID: 3057301
instead of only:
plt.figure(1)
the following:
plt.figure('today')
would open a figure called 'today' instead of 'figure 1'
Example usage: when opening a lot of tabbed figures (in Spyder) it
would help if the tabs have meaningful names.
>>
I have been successful at modifying pyplot.figure to handle string
arguments. For this I store the figure name in the _label attribute of
the figure in addition to setting the expected plot number value. My
hack seems to works on qt4agg backend (it does requires adding an
optional label argument to the FigureManagerQT constructor).
Is there interest in including such a patch in matplotlib ? Is it
likely to break things elsewhere ?
-- 
thanks,
peter butterworth