10000 matplotlib/INSTALL at gtk3-pip · OceanWolf/matplotlib · GitHub
[go: up one dir, main page]
Skip to content
{"payload":{"allShortcutsEnabled":false,"fileTree":{"":{"items":[{"name":".github","path":".github","contentType":"directory"},{"name":"LICENSE","path":"LICENSE","contentType":"directory"},{"name":"ci","path":"ci","contentType":"directory"},{"name":"doc","path":"doc","contentType":"directory"},{"name":"examples","path":"examples","contentType":"directory"},{"name":"extern","path":"extern","contentType":"directory"},{"name":"lib","path":"lib","contentType":"directory"},{"name":"release","path":"release","contentType":"directory"},{"name":"src","path":"src","contentType":"directory"},{"name":"tools","path":"tools","contentType":"directory"},{"name":"unit","path":"unit","contentType":"directory"},{"name":".coveragerc","path":".coveragerc","contentType":"file"},{"name":".gitattributes","path":".gitattributes","contentType":"file"},{"name":".gitignore","path":".gitignore","contentType":"file"},{"name":".mailmap","path":".mailmap","contentType":"file"},{"name":".travis.yml","path":".travis.yml","contentType":"file"},{"name":"CHANGELOG","path":"CHANGELOG","contentType":"file"},{"name":"CONTRIBUTING.md","path":"CONTRIBUTING.md","contentType":"file"},{"name":"INSTALL","path":"INSTALL","contentType":"file"},{"name":"MANIFEST.in","path":"MANIFEST.in","contentType":"file"},{"name":"Makefile","path":"Makefile","contentType":"file"},{"name":"README.osx","path":"README.osx","contentType":"file"},{"name":"README.rst","path":"README.rst","contentType":"file"},{"name":"README.win.md","path":"README.win.md","contentType":"file"},{"name":"appveyor.yml","path":"appveyor.yml","contentType":"file"},{"name":"boilerplate.py","path":"boilerplate.py","contentType":"file"},{"name":"build_alllocal.cmd","path":"build_alllocal.cmd","contentType":"file"},{"name":"conftest.py","path":"conftest.py","contentType":"file"},{"name":"distribute_setup.py","path":"distribute_setup.py","contentType":"file"},{"name":"doc-requirements.txt","path":"doc-requirements.txt","contentType":"file"},{"name":"license.py","path":"license.py","contentType":"file"},{"name":"matplotlibrc.template","path":"matplotlibrc.template","contentType":"file"},{"name":"pytest.ini","path":"pytest.ini","contentType":"file"},{"name":"setup.cfg.template","path":"setup.cfg.template","contentType":"file"},{"name":"setup.py","path":"setup.py","contentType":"file"},{"name":"setup_external_compile.py","path":"setup_external_compile.py","contentType":"file"},{"name":"setupext.py","path":"setupext.py","contentType":"file"},{"name":"test_only.py","path":"test_only.py","contentType":"file"},{"name":"tests.py","path":"tests.py","contentType":"file"},{"name":"tox.ini","path":"tox.ini","contentType":"file"},{"name":"versioneer.py","path":"versioneer.py","contentType":"file"},{"name":"visual_tests.py","path":"visual_tests.py","contentType":"file"}],"totalCount":42}},"fileTreeProcessingTime":8.856909,"foldersToFetch":[],"incompleteFileTree":false,"repo":{"id":22261480,"defaultBranch":"master","name":"matplotlib","ownerLogin":"OceanWolf","currentUserCanPush":false,"isFork":true,"isEmpty":false,"createdAt":"2014-07-25T15:25:52.000Z","ownerAvatar":"https://avatars.githubusercontent.com/u/3758703?v=4","public":true,"private":false,"isOrgOwned":false},"codeLineWrapEnabled":false,"symbolsExpanded":false,"treeExpanded":true,"refInfo":{"name":"gtk3-pip","listCacheKey":"v0:1723239139.0","canEdit":false,"refType":"branch","currentOid":"2e8dc4e8f8104cfd1c0aa86b9d737aaa33d5288e"},"path":"INSTALL","currentUser":null,"blob":{"rawLines":[".. The source of this document is INSTALL. During the doc build process,",".. this file is copied over to doc/users/installing.rst.",".. Therefore, you must edit INSTALL, *not* doc/users/installing.rst!",".. _pip: https://pypi.python.org/pypi/pip/","","**********","Installing","**********","","There are many different ways to install matplotlib, and the best way","depends on what operating system you are using, what you already have","installed, and how you want to use it. To avoid wading through all","the details (and potential complications) on this page, there are several","convenient options.","","Installing pre-built packages","=============================","","Most platforms : scientific Python distributions","------------------------------------------------","","The first option is to use one of the pre-packaged python","distributions that already provide matplotlib built-in. The","Continuum.io Python distribution (`Anaconda","\u003chttps://www.continuum.io/downloads/\u003e`_ or `miniconda","\u003chttp://conda.pydata.org/miniconda.html\u003e`_) and the Enthought","distribution `(Canopy) \u003chttps://www.enthought.com/products/canopy/\u003e`_","are both excellent choices that \"just work\" out of the box for","Windows, OSX and common Linux platforms. Both of these distributions","include matplotlib and *lots* of other useful tools.","","","Linux : using your package manager","----------------------------------","","If you are on Linux, you might prefer to use your package manager. matplotlib","is packaged for almost every major Linux distribution.","","* Debian / Ubuntu : ``sudo apt-get install python-matplotlib``","* Fedora / Redhat : ``sudo yum install python-matplotlib``","","Mac OSX : using pip","-------------------","","If you are on Mac OSX you can probably install matplotlib binaries using the","standard Python installation program pip_.","See :ref:`install_osx_binaries`.","",".. _installing_windows:","","Windows","-------","","If you don't already have Python installed, we recommend using","one of the `scipy-stack compatible Python distributions","\u003chttp://www.scipy.org/install.html\u003e`_ such as WinPython, Python(x,y),","Enthought Canopy, or Continuum Anaconda, which have matplotlib and many","of its dependencies, plus other useful packages, preinstalled.","","For `standard Python \u003chttps://www.python.org/download/\u003e`_ installations,","install matplotlib using pip_::",""," python -m pip install -U pip setuptools"," python -m pip install matplotlib","","In case Python 2.7 or 3.4 are not installed for all users,","the Microsoft Visual C++ 2008 (","`64 bit \u003chttp://www.microsoft.com/download/en/details.aspx?id=15336\u003e`__","or","`32 bit \u003chttp://www.microsoft.com/download/en/details.aspx?id=29\u003e`__","for Python 2.7) or Microsoft Visual C++ 2010 (","`64 bit \u003chttp://www.microsoft.com/en-us/download/details.aspx?id=14632\u003e`__","or","`32 bit \u003chttp://www.microsoft.com/en-us/download/details.aspx?id=5555\u003e`__","for Python 3.4) redistributable packages need to be installed.","","Matplotlib depends on `Pillow \u003chttps://pypi.python.org/pypi/Pillow\u003e`_","for reading and saving JPEG, BMP, and TIFF image files.","Matplotlib requires `MiKTeX \u003chttp://miktex.org/\u003e`_ and","`GhostScript \u003chttp://www.ghostscript.com/download/\u003e`_ for rendering text","with LaTeX.","`FFmpeg \u003chttps://www.ffmpeg.org/\u003e`_, `avconv \u003chttps://libav.org/\u003e`_,","`mencoder \u003chttp://www.mplayerhq.hu\u003e`_, or","`ImageMagick \u003chttp://www.imagemagick.org/\u003e`_ are required for the","animation module.","","The following backends should work out of the box: agg, tkagg, ps,","pdf and svg.","For other backends you may need to install","`pycairo \u003chttps://pypi.python.org/pypi/pycairo\u003e`_,","`PyQt4 \u003chttps://pypi.python.org/pypi/PyQt4\u003e`_,","`PyQt5 \u003chttps://pypi.python.org/pypi/PyQt5\u003e`_,","`PySide \u003chttps://pypi.python.org/pypi/PySide\u003e`_,","`wxPython \u003chttps://pypi.python.org/pypi/wxPython\u003e`_,","`PyGTK \u003chttps://pypi.python.org/pypi/PyGTK\u003e`_,","`Tornado \u003chttps://pypi.python.org/pypi/tornado\u003e`_,","or GhostScript.","","TkAgg is probably the best backend for interactive use from the","standard Python shell or IPython. It is enabled as the default backend","for the official binaries. GTK3 is not supported on Windows.","","The Windows wheels (:file:`*.whl`) on the `PyPI download page","\u003chttps://pypi.python.org/pypi/matplotlib/\u003e`_ do not contain test data","or example code.","If you want to try the many demos that come in the matplotlib source","distribution, download the :file:`*.tar.gz` file and look in the",":file:`examples` subdirectory.","To run the test suite, copy the :file:`lib\\\\matplotlib\\\\tests` and",":file:`lib\\\\mpl_toolkits\\\\tests` directories from the source","distribution to :file:`sys.prefix\\\\Lib\\\\site-packages\\\\matplotlib` and",":file:`sys.prefix\\\\Lib\\\\site-packages\\\\mpl_toolkits` respectively, and","install `nose \u003chttps://pypi.python.org/pypi/nose\u003e`_, `mock","\u003chttps://pypi.python.org/pypi/mock\u003e`_, Pillow, MiKTeX, GhostScript,","ffmpeg, avconv, mencoder, ImageMagick, and `Inkscape","\u003chttps://inkscape.org/\u003e`_.","","","",".. _install_from_source:","","Installing from source","======================","","If you are interested in contributing to matplotlib development,","running the latest source code, or just like to build everything","yourself, it is not difficult to build matplotlib from source. Grab","the latest *tar.gz* release file from `the PyPI files page","\u003chttps://pypi.python.org/pypi/matplotlib/\u003e`_, or if you want to","develop matplotlib or just need the latest bugfixed version, grab the","latest git version :ref:`install-from-git`.","","The standard environment variables `CC`, `CXX`, `PKG_CONFIG` are respected.","This means you can set them if your toolchain is prefixed. This may be used for","cross compiling.",""," export CC=x86_64-pc-linux-gnu-gcc"," export CXX=x86_64-pc-linux-gnu-g++"," export PKG_CONFIG=x86_64-pc-linux-gnu-pkg-config","","Once you have satisfied the requirements detailed below (mainly","python, numpy, libpng and freetype), you can build matplotlib::",""," cd matplotlib"," python setup.py build"," python setup.py install","","We provide a `setup.cfg","\u003chttps://github.com/matplotlib/matplotlib/raw/master/setup.cfg.template\u003e`_","file that goes with :file:`setup.py` which you can use to customize","the build process. For example, which default backend to use, whether","some of the optional libraries that matplotlib ships with are","installed, and so on. This file will be particularly useful to those","packaging matplotlib.","","If you have installed prerequisites to nonstandard places and need to","inform matplotlib where they are, edit ``setupext.py`` and add the base","dirs to the ``basedir`` dictionary entry for your ``sys.platform``.","e.g., if the header to some required library is in","``/some/path/include/someheader.h``, put ``/some/path`` in the","``basedir`` list for your platform.","",".. _install_requirements:","","Build requirements","------------------","","These are external packages which you will need to install before","installing matplotlib. If you are building on OSX, see",":ref:`build_osx`. If you are building on Windows, see",":ref:`build_windows`. If you are installing dependencies with a","package manager on Linux, you may need to install the development","packages (look for a \"-dev\" postfix) in addition to the libraries","themselves.","","","Required Dependencies","^^^^^^^^^^^^^^^^^^^^^","",":term:`python` 2.7, 3.4, or 3.5"," `Download python \u003chttp://www.python.org/download/\u003e`_.","",":term:`numpy` |minimum_numpy_version| (or later)"," array support for python (`download numpy \u003chttp://numpy.org\u003e`_)","","`setuptools \u003chttp://pythonhosted.org/setuptools/\u003e`__"," Setuptools provides extensions for python package installation.","",":term:`dateutil` 1.1 or later"," Provides extensions to python datetime handling. If using pip,"," easy_install or installing from source, the installer will attempt"," to download and install `python_dateutil` from PyPI.","","`pyparsing \u003chttps://pyparsing.wikispaces.com/\u003e`__"," Required for matplotlib's mathtext math rendering support. If"," using pip, easy_install or installing from source, the installer"," will attempt to download and install `pyparsing` from PyPI.","","`libpng 1.2 (or later) \u003chttp://www.libpng.org\u003e`__"," library for loading and saving :term:`PNG` files (`download"," \u003chttp://www.libpng.org/pub/png/libpng.html\u003e`__). libpng requires"," zlib.","","`pytz \u003chttp://pytz.sourceforge.net/\u003e`__"," Used to manipulate time-zone aware datetimes. http://pypi.python.org/pypi/pytz","",":term:`FreeType` 2.3 or later"," Library for reading true type font files. If using pip, easy_install or"," installing from source, the installer will attempt to locate FreeType in"," expected locations. If it cannot, try installing `pkg-config"," \u003chttp://matplotlib.org/users/installing.html#optional-dependencies\u003e`__,"," a tool used to find required non-python libraries.","","`cycler \u003chttp://matplotlib.org/cycler/\u003e`__ 0.10.0 or later"," Composable cycle class used for constructing style-cycles","","`functools32`"," Required for compatibility if running on versions of Python before"," Python 3.2.","","Optional GUI framework","^^^^^^^^^^^^^^^^^^^^^^","","These are optional packages which you may want to install to use","matplotlib with a user interface toolkit. See",":ref:`what-is-a-backend` for more details on the optional matplotlib","backends and the capabilities they provide.","",":term:`tk` 8.3 or later, not 8.6.0 or 8.6.1"," The TCL/Tk widgets library used by the TkAgg backend.",""," Versions 8.6.0 and 8.6.1 are known to have issues that may result"," in segfaults when closing multiple windows in the wrong order.","",":term:`pyqt` 4.4 or later"," The Qt4 widgets library python wrappers for the Qt4Agg backend","",":term:`PyGObject` or `pgi`"," For Gtk3, MPL requires the installation of a GObject introspection library"," for python, either `PyGObject` (also known as gi) or `pgi`.","",":term:`pygtk` 2.4 or later"," The python wrappers for the GTK widgets library for use with the"," GTK or GTKAgg backend","",":term:`wxpython` 2.8 or later"," The python wrappers for the wx widgets library for use with the"," WX or WXAgg backend","","Optional external programs","^^^^^^^^^^^^^^^^^^^^^^^^^^","`ffmpeg \u003chttps://www.ffmpeg.org/\u003e`__/`avconv \u003chttps://libav.org/avconv.html\u003e`__ or `mencoder \u003chttp://www.mplayerhq.hu/design7/news.html\u003e`__"," Required for the animation module to be save out put to movie"," formats.","","`ImageMagick \u003chttp://www.imagemagick.org/\u003e`__"," Required for the animation module to be able to save to animated gif.","","Optional dependencies","^^^^^^^^^^^^^^^^^^^^^","","`Pillow \u003chttp://python-pillow.github.io/\u003e`__"," If Pillow is installed, matplotlib can read and write a larger"," selection of image file formats.","","`pkg-config \u003chttp://www.freedesktop.org/wiki/Software/pkg-config/\u003e`__"," A tool used to find required non-python libraries. This is not strictly"," required, but can make installation go more smoothly if the libraries and"," headers are not in the expected locations.","","","Required libraries that ship with matplotlib","^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^",":term:`agg` 2.4"," The antigrain C++ rendering engine. matplotlib links against the"," agg template source statically, so it will not affect anything on"," your system outside of matplotlib.","","`qhull` 2012.1"," A library for computing Delaunay triangulations.","","`ttconv`"," truetype font utility","","six 1.9.0"," Python 2/3 compatibility library. Do not use this in third-party"," code.","","",".. _build_linux:","","Building on Linux","-----------------","","It is easiest to use your system package manager to install the dependencies.","","If you are on Debian/Ubuntu, you can get all the dependencies","required to build matplotlib with::",""," sudo apt-get build-dep python-matplotlib","","If you are on Fedora/RedHat, you can get all the dependencies required","to build matplotlib by first installing ``yum-builddep`` and then","running::",""," su -c \"yum-builddep python-matplotlib\"","","This does not build matplotlib, but it does get and install the","build dependencies, which will make building from source easier.","","",".. _build_osx:","","Building on OSX","---------------","","The build situation on OSX is complicated by the various places one","can get the libpng and freetype requirements (darwinports, fink,","/usr/X11R6) and the different architectures (e.g., x86, ppc, universal) and","the different OSX version (e.g., 10.4 and 10.5). We recommend that you build","the way we do for the OSX release: get the source from the tarball or the","git repository and follow the instruction in :file:`README.osx`.","","",".. _build_windows:","","Building on Windows","-------------------","","The Python shipped from http://www.python.org is compiled with Visual Studio","2008 for versions before 3.3, Visual Studio 2010 for 3.3 and 3.4, and","Visual Studio 2015 for 3.5. Python extensions are recommended to be compiled","with the same compiler.","","Since there is no canonical Windows package manager, the methods for building","freetype, zlib, and libpng from source code are documented as a build script","at `matplotlib-winbuild \u003chttps://github.com/jbmohler/matplotlib-winbuild\u003e`_."],"stylingDirectives":null,"colorizedLines":null,"csv":null,"csvError":null,"dependabotInfo":{"showConfigurationBanner":false,"configFilePath":null,"networkDependabotPath":"/OceanWolf/matplotlib/network/updates","dismissConfigurationNoticePath":"/settings/dismiss-notice/dependabot_configuration_notice","configurationNoticeDismissed":null},"displayName":"INSTALL","displayUrl":"https://github.com/OceanWolf/matplotlib/blob/gtk3-pip/INSTALL?raw=true","headerInfo":{"blobSize":"12.5 KB","deleteTooltip":"You must be signed in to make or propose changes","editTooltip":"You must be signed in to make or propose changes","ghDesktopPath":"https://desktop.github.com","isGitLfs":false,"onBranch":true,"shortPath":"0fabeb3","siteNavLoginPath":"/login?return_to=https%3A%2F%2Fgithub.com%2FOceanWolf%2Fmatplotlib%2Fblob%2Fgtk3-pip%2FINSTALL","isCSV":false,"isRichtext":false,"toc":null,"lineInfo":{"truncatedLoc":"337","truncatedSloc":"254"},"mode":"file"},"image":false,"isCodeownersFile":null,"isPlain":false,"isValidLegacyIssueTemplate":false,"issueTemplate":null,"discussionTemplate":null,"language":"Text","languageID":372,"large":false,"planSupportInfo":{"repoIsFork":null,"repoOwnedByCurrentUser":null,"requestFullPath":"/OceanWolf/matplotlib/blob/gtk3-pip/INSTALL","showFreeOrgGatedFeatureMessage":null,"showPlanSupportBanner":null,"upgradeDataAttributes":null,"upgradePath":null},"publishBannersInfo":{"dismissActionNoticePath":"/settings/dismiss-notice/publish_action_from_dockerfile","releasePath":"/OceanWolf/matplotlib/releases/new?marketplace=true","showPublishActionBanner":false},"rawBlobUrl":"https://github.com/OceanWolf/matplotlib/raw/refs/heads/gtk3-pip/INSTALL","renderImageOrRaw":false,"richText":null,"renderedFileInfo":null,"shortPath":null,"symbolsEnabled":true,"tabSize":8,"topBannersInfo":{"overridingGlobalFundingFile":false,"globalPreferredFundingPath":null,"showInvalidCitationWarning":false,"citationHelpUrl":"https://docs.github.com/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/about-citation-files","actionsOnboardingTip":null},"truncated":false,"viewable":true,"workflowRedirectUrl":null,"symbols":{"timed_out":false,"not_analyzed":true,"symbols":[]}},"copilotInfo":null,"copilotAccessAllowed":false,"modelsAccessAllowed":false,"modelsRepoIntegrationEnabled":false,"csrf_tokens":{"/OceanWolf/matplotlib/branches":{"post":"GuBRh0ka5reRFZ2rQDr95aYzCTlZoQCW1mtCpX9KXPyT37OhY4GLYHIV_v2j8ZFElscIk81M1sKJXP1S1W2eYw"},"/repos/preferences":{"post":"nXi73dw6riAR-MO8mmYQ2pis3bJ4nAZtRJiEkt669sxSSuB4vmU9nhQn7O87bzSyrBDeYdqvicFnsntTw9xhGQ"}}},"title":"matplotlib/INSTALL at gtk3-pip · OceanWolf/matplotlib","appPayload":{"helpUrl":"https://docs.github.com","findFileWorkerPath":"/assets-cdn/worker/find-file-worker-7d7eb7c71814.js","findInFileWorkerPath":"/assets-cdn/worker/find-in-file-worker-1ae9fa256942.js","githubDevUrl":null,"enabled_features":{"code_nav_ui_events":false,"react_blob_overlay":false,"accessible_code_button":true,"github_models_repo_integration":false}}}
0