8000 Merge branch 'docs' · lindanxia/matplotlib-cpp@02443ce · GitHub
[go: up one dir, main page]
Skip to content

Commit 02443ce

Browse files
CryorisCryoris
committed
Merge branch 'docs'
2 parents 7222379 + e21596c commit 02443ce
  • lato-italic.ttf
  • lato-italic.woff
  • lato-italic.woff2
  • lato-regular.eot
  • lato-regular.ttf
  • lato-regular.woff
  • lato-regular.woff2
  • Lato-Bold.ttf
  • Lato-Regular.ttf
  • RobotoSlab
  • RobotoSlab-Bold.ttf
  • RobotoSlab-Regular.ttf
  • fontawesome-webfont.eot
  • fontawesome-webfont.svg
  • fontawesome-webfont.ttf
  • fontawesome-webfont.woff
  • fontawesome-webfont.woff2
  • jquery-3.2.1.js
  • jquery.js
  • js
  • language_data.js
  • minus.png
  • plus.png
  • pygments.css
  • searchtools.js
  • underscore-1.3.1.js
  • underscore.js
  • up-pressed.png
  • up.png
  • websupport.js
  • compiling.html
  • F438 docs.html
  • genindex.html
  • index.html
  • license.html
  • objects.inv
  • search.html
  • searchindex.js
  • todo.html
  • make.bat
  • matplotlib_icon.png
  • source
  • examples
  • matplotlibcpp.h

    • Some content is hidden

    Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

    116 files changed

    +21398
    -589
    lines changed

    ‎Makefile

    Lines changed: 26 additions & 5 deletions
    Original file line numberDiff line numberDiff line change
    @@ -1,20 +1,25 @@
    11
    # Put the path to your Python.h here
    2-
    includes = -I /usr/local/Cellar/python/3.7.3/Frameworks/Python.framework/Versions/3.7/include/python3.7m
    2+
    includes = -I /usr/local/Cellar/python/3.7.4/Frameworks/Python.framework/Versions/3.7/include/python3.7m
    33

    4-
    # Numpy include
    4+
    # Numpy include
    55
    includes += -I /usr/local/lib/python3.7/site-packages/numpy/core/include
    66

    77
    # Add the path to the directory containing libpython*.a here if the linking fails
    8-
    includes += -L /usr/local/Cellar/python/3.7.3/Frameworks/Python.framework/Versions/3.7/lib
    8+
    includes += -L /usr/local/Cellar/python/3.7.4/Frameworks/Python.framework/Versions/3.7/lib
    99

    10-
    # Link your python version
    10+
    # Link your python version
    1111
    linkings = -lpython3.7
    1212

    1313
    # Compiler definitions
    1414
    definitions = -std=c++11
    1515

    16+
    # Eigen include
    17+
    eigen_include = -I /usr/local/include/eigen3
    18+
    1619
    examples: minimal basic modern animation nonblock xkcd quiver bar surface subplot fill_inbetween fill update
    1720

    21+
    eigen: eigen_basic eigen_modern eigen_loglog eigen_semilogx eigen_semilogy
    22+
    1823
    minimal: examples/minimal.cpp matplotlibcpp.h
    1924
    cd examples && g++ -DWITHOUT_NUMPY minimal.cpp ${includes} ${linkings} -o minimal ${definitions}
    2025
    #cd examples && g++ minimal.cpp ${includes} ${linkings} -o minimal ${definitions}
    @@ -51,9 +56,25 @@ fill_inbetween: examples/fill_inbetween.cpp matplotlibcpp.h
    5156

    5257
    fill: examples/fill.cpp matplotlibcpp.h
    5358
    cd examples && g++ fill.cpp ${includes} ${linkings} -o fill ${definitions}
    54-
    59+
    5560
    update: examples/update.cpp matplotlibcpp.h
    5661
    cd examples && g++ update.cpp ${includes} ${linkings} -o update ${definitions}
    5762

    63+
    eigen_basic: examples/eigen/basic.cpp matplotlibcpp.h
    64+
    cd examples/eigen && g++ basic.cpp ${includes} ${eigen_include} ${linkings} -o $@ ${definitions}
    65+
    66+
    eigen_modern: examples/eigen/modern.cpp matplotlibcpp.h
    67+
    cd examples/eigen && g++ modern.cpp ${includes} ${eigen_include} ${linkings} -o $@ ${definitions}
    68+
    69+
    eigen_loglog: examples/eigen/loglog.cpp matplotlibcpp.h
    70+
    cd examples/eigen && g++ loglog.cpp ${includes} ${eigen_include} ${linkings} -o $@ ${definitions}
    71+
    72+
    eigen_semilogx: examples/eigen/semilogx.cpp matplotlibcpp.h
    73+
    cd examples/eigen && g++ semilogx.cpp ${includes} ${eigen_include} ${linkings} -o $@ ${definitions}
    74+
    75+
    eigen_semilogy: examples/eigen/semilogy.cpp matplotlibcpp.h
    76+
    cd examples/eigen && g++ semilogy.cpp ${includes} ${eigen_include} ${linkings} -o $@ ${definitions}
    77+
    5878
    clean:
    5979
    rm -f examples/{minimal,basic,modern,animation,nonblock,xkcd,quiver,bar,surface,subplot,fill_inbetween,fill,update}
    80+
    rm -f examples/eigen/{eigen_basic,eigen_modern,eigen_loglog}

    ‎docs/Makefile

    Lines changed: 20 additions & 0 deletions
    Original file line numberDiff line numberDiff line change
    @@ -0,0 +1,20 @@
    1+
    # Minimal makefile for Sphinx documentation
    2+
    #
    3+
    4+
    # You can set these variables from the command line, and also
    5+
    # from the environment for the first two.
    6+
    SPHINXOPTS ?=
    7+
    SPHINXBUILD ?= sphinx-build
    8+
    SOURCEDIR = source
    9+
    BUILDDIR = build
    10+
    11+
    # Put it first so that "make" without argument is like "make help".
    12+
    help:
    13+
    @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
    14+
    15+
    .PHONY: help Makefile
    16+
    17+
    # Catch-all target: route all unknown targets to Sphinx using the new
    18+
    # "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
    19+
    %: Makefile
    20+
    @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

    ‎docs/build/doctrees/compiling.doctree

    25.5 KB
    Binary file not shown.

    ‎docs/build/doctrees/docs.doctree

    210 KB
    Binary file not shown.

    ‎docs/build/doctrees/environment.pickle

    91.6 KB
    Binary file not shown.

    ‎docs/build/doctrees/index.doctree

    15.2 KB
    Binary file not shown.

    ‎docs/build/doctrees/license.doctree

    7.68 KB
    Binary file not shown.

    ‎docs/build/doctrees/todo.doctree

    2.79 KB
    Binary file not shown.

    ‎docs/build/html/.buildinfo

    Lines changed: 4 additions & 0 deletions
    Original file line numberDiff line numberDiff line change
    @@ -0,0 +1,4 @@
    1+
    # Sphinx build info version 1
    2+
    # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
    3+
    config: dc893f442bc417e3df3035107b7d8bde
    4+
    tags: 645f666f9bcd5a90fca523b33c5a78b7

    ‎docs/build/html/_images/matplotlib_icon.png

    31.4 KB
    Loading

    ‎docs/build/html/_sources/compiling.rst.txt

    Lines changed: 126 additions & 0 deletions
    Original file line numberDiff line numberDiff line change
    @@ -0,0 +1,126 @@
    1+
    .. _compiling:
    2+
    3+
    Compiling a program
    4+
    *******************
    5+
    6+
    Requirements
    7+
    ============
    8+
    9+
    Matplotlib for C++ requires a working Python installation as well as
    10+
    Matplotlib. Python2.7 and Python3 (>= 3.6) have been tested, but
    11+
    other versions should work as well. In the linking process the exact
    12+
    version of Python to use can be specified by linking the according library.
    13+
    14+
    On Unix it is recommended to install Python via the package manager to
    15+
    assert that all dependencies are installed properly.
    16+
    17+
    .. code-block:: bash
    18+
    19+
    <package-manager> install python3 python3-dev # or -devel depending on the platform
    20+
    21+
    If Python is installed from source problems in the linking may occur.
    22+
    How to resolve these is explained in the next section, or in
    23+
    :ref:`this <pyfromsource>` code-block.
    24+
    25+
    Install matplotlib via pip
    26+
    27+
    .. code-block:: bash
    28+
    29+
    pip3 install matplotlib # or pip for Python 2
    30+
    31+
    Includes and Linking
    32+
    ====================
    33+
    34+
    35+
    The header ``matplotlibcpp.h`` depends on the Python header, ``Python.h``,
    36+
    the corresponding Python library ``libpython``, and on ``numpy/arrayobject.h``.
    37+
    If not in the standard include paths, the paths to the header files,
    38+
    the path to the library, and the library itself have to be specified
    39+
    for the compiler using the options ``-I``, ``-L`` and ``-l`` respectively.
    40+
    Note, that all Python constituents should be of the same Python version.
    41+
    Matplotlib for C++ supports both, Python 2.7 and Python 3 versions.
    42+
    43+
    In detail:
    44+
    45+
    - The Python header ``Python.h``
    46+
    47+
    The Python header comes with the Python installation. It it cannot be
    48+
    found on your system try installing the Python development packages.
    49+
    The location of this header has to be specified using the option ``-I``.
    50+
    51+
    Typical locations:
    52+
    53+
    - Linux: `/usr/local/include/python3.7`
    54+
    - Mac: if installed with Homebrew `/usr/local/Cellar/python/3.7.3/Frameworks/Python.framework/Versions/3.7/include/python3.7m`
    55+
    56+
    - The Python library ``libpython*.so``
    57+
    58+
    The program has to be linked against the compiled Python library.
    59+
    Depending on the Python version the name of the library differs, for
    60+
    Python 3.7 it is ``libpython3.7.so`` (or ``libpython3.7m.so``).
    61+
    Then link the library by specifying ``-lpython3.7`` (or ``-lpython3.7m``).
    62+
    63+
    Additionally to the linking the location of the library must be specified
    64+
    if not installed in the usual directory. For Linux systems this is
    65+
    usually not necessary, for Mac however it mostly is.
    66+
    The location of the library has to be specified using the option ``-L``.
    67+
    68+
    If Python has not been installed using the package manager (but e.g.
    69+
    from source) twofold problems with linking the library can occur.
    70+
    The first are missing dependencies of the Python library, these can be
    71+
    added via ``-lpthread -lutil -ldl``.
    72+
    The second is that dynamic libraries have to be exported which is
    73+
    resolved by adding ``-Xlinker -export-dynamic``.
    74+
    75+
    Typical locations:
    76+
    77+
    - Linux: Path usually already included
    78+
    - Mac: `/usr/local/Cellar/python/3.7.3/Frameworks/Python.framework/Versions/3.7/lib`
    79+
    80+
    - Numpy array ``numpy/arrayobject.h``
    81+
    82+
    By default Matplotlib for C++ uses Numpy arrays. This requires the above
    83+
    header file. However it is possible to avoid this header by defining
    84+
    ``-DWITHOUT_NUMPY``.
    85+
    86+
    - Linux: `/usr/local/lib/python3.7/site-packages/numpy/core/include`
    87+
    - Mac: If installed via Homebrew, same as for Linux.
    88+
    89+
    **Examples**
    90+
    91+
    On Linux with the GNU compiler ``g++`` and
    92+
    C++11.
    93+
    94+
    .. code-block:: bash
    95+
    96+
    # using Python 2.7
    97+
    g++ main.cpp -std=c++11 -I/usr/local/include/python2.7 \
    98+
    -I/usr/local/lib/python2.7/site-packages/numpy/core/include -lpython2.7
    99+
    100+
    .. code-block:: bash
    101+
    102+
    # using Python3.7 and no Numpy
    103+
    g++ main.cpp -std=c++11 -DWITHOUT_NUMPY -I/usr/local/include/python2.7 -lpython2.7
    104+
    105+
    On Mac with the GNU compiler ``g++`` and C++14.
    106+
    107+
    .. code-block:: bash
    108+
    109+
    g++ main.cpp -std=c++14 \
    110+
    -I /usr/local/Cellar/python/3.7.3/Frameworks/Python.framework/Versions/3.7/include/python3.7m \
    111+
    -I /usr/local/lib/python3.7/site-packages/numpy/core/include \
    112+
    -L /usr/local/Cellar/python/3.7.3/Frameworks/Python.framework/Versions/3.7/lib \
    113+
    -lpython3.7
    114+
    115+
    With exporting dynamic libraries and linking to all dependencies of
    116+
    the Python library on a Linux system:
    117+
    118+
    .. _pyfromsource:
    119+
    120+
    .. code-block:: bash
    121+
    122+
    g++ main.cpp -std=c++11 -I/usr/local/include/python3.7m \
    123+
    -I/usr/local/lib/python3.7/site-packages/numpy/core/include \
    124+
    -lpython3.7m \
    125+
    -lpthread -lutil -ldl \ # library dependencies
    126+
    -Xlinker -export-dynamic \ # export dynamic libraries

    0 commit comments

    Comments
     (0)
    0