Revision: 5331 http://matplotlib.svn.sourceforge.net/matplotlib/?rev=5331&view=rev Author: mdboom Date: 2008年05月30日 12:28:56 -0700 (2008年5月30日) Log Message: ----------- Adding some FAQs Modified Paths: -------------- trunk/matplotlib/doc/faq/index.rst trunk/matplotlib/doc/faq/installing_faq.rst Added Paths: ----------- trunk/matplotlib/doc/faq/troubleshooting_faq.rst Modified: trunk/matplotlib/doc/faq/index.rst =================================================================== --- trunk/matplotlib/doc/faq/index.rst 2008年05月30日 19:24:37 UTC (rev 5330) +++ trunk/matplotlib/doc/faq/index.rst 2008年05月30日 19:28:56 UTC (rev 5331) @@ -12,5 +12,6 @@ .. toctree:: installing_faq.rst + troubleshooting_faq.rst plotting_faq.rst Modified: trunk/matplotlib/doc/faq/installing_faq.rst =================================================================== --- trunk/matplotlib/doc/faq/installing_faq.rst 2008年05月30日 19:24:37 UTC (rev 5330) +++ trunk/matplotlib/doc/faq/installing_faq.rst 2008年05月30日 19:28:56 UTC (rev 5331) @@ -1,7 +1,23 @@ -**************** -Installation FAQ -**************** +================== + Installation FAQ +================== +How do I report a compilation problem? +====================================== +See :ref:`reporting_problems`. +How do I cleanly rebuild and reinstall everything? +================================================== +Unfortunately:: + + python setup.py clean + +does not properly clean the build directory, and does nothing to the +install directory. To cleanly rebuild: + + * delete the ``build`` directory in the source tree + * delete ``site-packages/matplotlib`` directory in the Python + installation. The location of ``site-packages`` is + platform-specific. Added: trunk/matplotlib/doc/faq/troubleshooting_faq.rst =================================================================== --- trunk/matplotlib/doc/faq/troubleshooting_faq.rst (rev 0) +++ trunk/matplotlib/doc/faq/troubleshooting_faq.rst 2008年05月30日 19:28:56 UTC (rev 5331) @@ -0,0 +1,45 @@ +=================== +Troubleshooting FAQ +=================== + +.. _reporting_problems: + +How do I report a problem? +========================== + +If you are having a problem with matplotlib, search the mailing +lists first: There's a good chance someone else has already run into +your problem. + +If not, please provide the following information in your e-mail to the +mailing list: + + * your operating system + * matplotlib version + * where you obtained matplotlib (e.g. your Linux distribution's + packages or the matplotlib Sourceforge site) + * any customizations to your ``matplotlibrc`` file + * if the problem is reproducible, please try to provide a minimal, + standalone Python script that demonstrates the problem + +If you compiled matplotlib yourself, please also provide + + * any changes you have made to ``setup.py`` or ``setupext.py`` + * the output of:: + + rm -rf build + python setup.py build + + The beginning of the build output contains lots of details about your + platform that are useful for the matplotlib developers to diagnose + your problem. + +Including this information in your first e-mail to the mailing list +will save a lot of time. + +You will likely get a faster response writing to the mailing list than +filing a bug in the bug tracker. Most developers check the bug +tracker only periodically. If your problem has been determined to be +a bug and can not be quickly solved, you may be asked to file a bug in +the tracker so the issue doesn't get lost. + This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
Revision: 5336 http://matplotlib.svn.sourceforge.net/matplotlib/?rev=5336&view=rev Author: jdh2358 Date: 2008年05月30日 13:05:57 -0700 (2008年5月30日) Log Message: ----------- faq updates Modified Paths: -------------- trunk/matplotlib/doc/faq/index.rst trunk/matplotlib/doc/faq/installing_faq.rst trunk/matplotlib/doc/faq/troubleshooting_faq.rst Added Paths: ----------- trunk/matplotlib/doc/faq/howto_faq.rst Removed Paths: ------------- trunk/matplotlib/doc/faq/plotting_faq.rst Copied: trunk/matplotlib/doc/faq/howto_faq.rst (from rev 5335, trunk/matplotlib/doc/faq/plotting_faq.rst) =================================================================== --- trunk/matplotlib/doc/faq/howto_faq.rst (rev 0) +++ trunk/matplotlib/doc/faq/howto_faq.rst 2008年05月30日 20:05:57 UTC (rev 5336) @@ -0,0 +1,61 @@ +***** +HOWTO +***** + +How do I use matplotlib in a web application server? +==================================================== + +Many users report initial problems trying to use maptlotlib in web +application servers, because by default matplotlib ships configured to +work with a graphical user interface which may require an X11 +connection. Since many barebones application servers do not have X11 +enabled, you may get errors if you don't configure matplotlib for use +in these environments. Most importantly, you need to decide what +kinds of images you want to generate (PNG, PDF, SVG) and configure the +appropriate default backend. For 99% of users, this will be the Agg +backend, which uses the C++ `antigrain <http://antigrain.com`_ +rendering engine to make nice PNGs. The Agg backend is also +configured to recognize requests to generate other output formats +(PDF, PS, EPS, SVG). The easiest way to configure matplotlib to use +Agg is to call:: + + # do this before importing pylab or pyplot + import matplotlib + matplotlib.use('Agg') + import matplotlib.pyplot as plt + +Alternatively, you can avoid pylab/pyplot altogeher, which will give +you a little more control, by calling the API directly as shown in +`agg_oo.py <http://matplotlib.sf.net/examples/api/agg_oo.py`_ . + +You can either generate hardcopy on the filesystem by calling savefig:: + + # do this before importing pylab or pyplot + import matplotlib + matplotlib.use('Agg') + import matplotlib.pyplot as plt + fig = plt.figure() + ax = fig.add_subplot(111) + ax.plot([1,2,3]) + fig.savefig('test.png') + +or by saving to a file handle:: + + import sys + fig.savefig(sys.stdout) + + +How do I use matplotlib with apache? +------------------------------------ + +TODO + +How do I use matplotlib with dhango? +------------------------------------ + +TODO + +How do I use matplotlib with zope? +---------------------------------- + +TODO \ No newline at end of file Modified: trunk/matplotlib/doc/faq/index.rst =================================================================== --- trunk/matplotlib/doc/faq/index.rst 2008年05月30日 19:39:37 UTC (rev 5335) +++ trunk/matplotlib/doc/faq/index.rst 2008年05月30日 20:05:57 UTC (rev 5336) @@ -13,5 +13,5 @@ installing_faq.rst troubleshooting_faq.rst - plotting_faq.rst + howto_faq.rst Modified: trunk/matplotlib/doc/faq/installing_faq.rst =================================================================== --- trunk/matplotlib/doc/faq/installing_faq.rst 2008年05月30日 19:39:37 UTC (rev 5335) +++ trunk/matplotlib/doc/faq/installing_faq.rst 2008年05月30日 20:05:57 UTC (rev 5336) @@ -21,3 +21,9 @@ * delete ``site-packages/matplotlib`` directory in the Python installation. The location of ``site-packages`` is platform-specific. + * you may also want to clear some of the cache data that + matplotlib stores in your ``.matplotlib`` directory. You can + find the location of this directory by doing:: + + import matplotlib + print matplotlib.get_configdir() \ No newline at end of file Deleted: trunk/matplotlib/doc/faq/plotting_faq.rst =================================================================== --- trunk/matplotlib/doc/faq/plotting_faq.rst 2008年05月30日 19:39:37 UTC (rev 5335) +++ trunk/matplotlib/doc/faq/plotting_faq.rst 2008年05月30日 20:05:57 UTC (rev 5336) @@ -1,5 +0,0 @@ -************ -Plotting FAQ -************ - - Modified: trunk/matplotlib/doc/faq/troubleshooting_faq.rst =================================================================== --- trunk/matplotlib/doc/faq/troubleshooting_faq.rst 2008年05月30日 19:39:37 UTC (rev 5335) +++ trunk/matplotlib/doc/faq/troubleshooting_faq.rst 2008年05月30日 20:05:57 UTC (rev 5336) @@ -12,15 +12,20 @@ your problem. If not, please provide the following information in your e-mail to the -mailing list: +`mailing list +<http://lists.sourceforge.net/mailman/listinfo/matplotlib-users>`_: - * your operating system - * matplotlib version + * your operating system; on Linux/UNIX post the output of ``uname -a`` + * matplotlib version : ``import matplotlib; print matplotlib.__version__`` * where you obtained matplotlib (e.g. your Linux distribution's packages or the matplotlib Sourceforge site) * any customizations to your ``matplotlibrc`` file - * if the problem is reproducible, please try to provide a minimal, + * if the problem is reproducible, please try to provide a *minimal*, standalone Python script that demonstrates the problem + * you can get very helpful debugging output from matlotlib by + running your script with a ``verbose-helpful`` or + ``--verbose-debug`` flags and posting the verbose output the + lists. If you compiled matplotlib yourself, please also provide @@ -34,6 +39,8 @@ platform that are useful for the matplotlib developers to diagnose your problem. + * your compiler version -- eg, ``gcc --version`` + Including this information in your first e-mail to the mailing list will save a lot of time. This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
Revision: 5499 http://matplotlib.svn.sourceforge.net/matplotlib/?rev=5499&view=rev Author: jdh2358 Date: 2008年06月12日 15:06:09 -0700 (2008年6月12日) Log Message: ----------- added a couple of faqs Modified Paths: -------------- trunk/matplotlib/doc/faq/installing_faq.rst trunk/matplotlib/doc/faq/troubleshooting_faq.rst Modified: trunk/matplotlib/doc/faq/installing_faq.rst =================================================================== --- trunk/matplotlib/doc/faq/installing_faq.rst 2008年06月12日 21:39:18 UTC (rev 5498) +++ trunk/matplotlib/doc/faq/installing_faq.rst 2008年06月12日 22:06:09 UTC (rev 5499) @@ -11,6 +11,8 @@ See :ref:`reporting-problems`. +.. _clean-install: + How do I cleanly rebuild and reinstall everything? ================================================== @@ -102,7 +104,7 @@ backends generate a pixel represenation of the line whose accuracy depends on a DPI setting. -Here is a summary of the matplotlib renders (there is an eponymous +Here is a summary of the matplotlib renderers (there is an eponymous backed for each): =============================== ===================================================================================== @@ -159,3 +161,30 @@ the disk. Many Mac OS X eggs with cruft at the end of the filename, which prevents their installation through easy_install. Renaming is all it takes to install them; still, it's annoying. + +Windows questions +================= + +.. _windows-installers: + +Where can I get binary installers for windows? +---------------------------------------------- + +If you have already installed python, you can use one of the +matplotlib binary installers for windows -- you can get these from the +`sourceforge download +<http://sourceforge.net/project/platformdownload.php?group_id=80706>`_ +site. Choose the files that match your version of python (eg +``py2.5`` if you instaslled Python 2.5) and have the ``exe`` +extension. If you haven't already installed python, you can get the +official version from the `python web site +<http://python.org/download/>`_. There are also two packaged +distributions of python that come preloaded with matplotlib and many +other tools like ipython, numpy, scipy, vtk and user interface +toolkits. These packages are quite large because they come with so +much, but you get everything with a single click installer. + +* the enthought python distribution `EPD + <http://www.enthought.com/products/epd.php>`_ + +* `python (x, y) <http://www.pythonxy.com/foreword.php>`_ Modified: trunk/matplotlib/doc/faq/troubleshooting_faq.rst =================================================================== --- trunk/matplotlib/doc/faq/troubleshooting_faq.rst 2008年06月12日 21:39:18 UTC (rev 5498) +++ trunk/matplotlib/doc/faq/troubleshooting_faq.rst 2008年06月12日 22:06:09 UTC (rev 5499) @@ -77,13 +77,21 @@ python -c `import matplotlib; print matplotlib.__version__` * where you obtained matplotlib (e.g. your Linux distribution's - packages or the matplotlib Sourceforge site) + packages or the matplotlib Sourceforge site, or the enthought + python distribution `EPD + <http://www.enthought.com/products/epd.php>`_. * any customizations to your ``matplotlibrc`` file (see :ref:`customizing-matplotlib`). * if the problem is reproducible, please try to provide a *minimal*, - standalone Python script that demonstrates the problem + standalone Python script that demonstrates the problem. This is + *the* critical step. If you can't post a piece of code that we + can run and reproduce your error, the chances of getting help are + significantly diminished. Very often, the mere act of trying to + minimize your code to the smallest bit that produces the error + will help you find a bug in *your* code that is causing the + problem. * you can get very helpful debugging output from matlotlib by running your script with a ``verbose-helpful`` or @@ -116,3 +124,27 @@ the tracker so the issue doesn't get lost. +.. _svn-trouble: + +I am having trouble with a recent svn update, what should I do? +=============================================================== + +First make sure you have a clean build and install (see +:ref:`clean-install`), get the latest svn update, install it and run a +simple test script in debug mode:: + + rm -rf build + rm -rf /path/to/site-packages/matplotlib* + svn up + python setup.py install > build.out + python examples/pylab_examples/simple_plot.py --verbose-debug > run.out + +and post :file:`build.out` and :file:`run.out` to the +`matplotlib-devel +<http://lists.sourceforge.net/mailman/listinfo/matplotlib-devel>`_ +mailing list (please do not post svn problems to the `users list +<http://lists.sourceforge.net/mailman/listinfo/matplotlib-users>`_). + +Of course, you will want to clearly describe your problem, what you +are expecting and what you are getting, but often a clean build and +install will help. See also :ref:`reporting-problems`. This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
Revision: 5544 http://matplotlib.svn.sourceforge.net/matplotlib/?rev=5544&view=rev Author: dsdale Date: 2008年06月14日 09:35:55 -0700 (2008年6月14日) Log Message: ----------- don't use the contents directive, it doesnt format well in pdf Modified Paths: -------------- trunk/matplotlib/doc/faq/howto_faq.rst trunk/matplotlib/doc/faq/installing_faq.rst trunk/matplotlib/doc/faq/troubleshooting_faq.rst Modified: trunk/matplotlib/doc/faq/howto_faq.rst =================================================================== --- trunk/matplotlib/doc/faq/howto_faq.rst 2008年06月14日 16:24:07 UTC (rev 5543) +++ trunk/matplotlib/doc/faq/howto_faq.rst 2008年06月14日 16:35:55 UTC (rev 5544) @@ -1,10 +1,9 @@ .. _howto-faq: -***** -HOWTO -***** +********* +HOWTO FAQ +********* - .. _howto-ticks: How do I configure the tick linewidths? Modified: trunk/matplotlib/doc/faq/installing_faq.rst =================================================================== --- trunk/matplotlib/doc/faq/installing_faq.rst 2008年06月14日 16:24:07 UTC (rev 5543) +++ trunk/matplotlib/doc/faq/installing_faq.rst 2008年06月14日 16:35:55 UTC (rev 5544) @@ -4,9 +4,7 @@ Installation FAQ ****************** -.. contents:: - How do I report a compilation problem? ====================================== Modified: trunk/matplotlib/doc/faq/troubleshooting_faq.rst =================================================================== --- trunk/matplotlib/doc/faq/troubleshooting_faq.rst 2008年06月14日 16:24:07 UTC (rev 5543) +++ trunk/matplotlib/doc/faq/troubleshooting_faq.rst 2008年06月14日 16:35:55 UTC (rev 5544) @@ -1,8 +1,8 @@ .. _troubleshooting-faq: -=================== +******************* Troubleshooting FAQ -=================== +******************* .. _matplotlib-version: This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.