1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53
|
Welcome to ContourPy's documentation!
=====================================
**ContourPy** is a Python library for calculating contours of 2D quadrilateral grids.
It is written in C++11 and wrapped using `pybind11`_.
It contains the 2005 and 2014 algorithms used in `Matplotlib`_ as well as a newer algorithm that
includes more features and is available in both serial and multithreaded versions.
It provides an easy way for Python libraries to use contouring algorithms without having to include
Matplotlib as a dependency.
Advantages of the new algorithm compared to Matplotlib's default algorithm of 2014 - 2022:
#. Improved performance in many situations (see :ref:`benchmarks`).
#. Multiple return types for both contour lines and filled contours, with different complexity and
performance tradeoffs (see :ref:`line_type` and :ref:`fill_type`).
#. Multiple ways to specify chunk sizes and/or counts (see :ref:`chunks`).
#. Supports treating quads a four triangles for more detailed contours (see :ref:`quad_as_tri`).
#. Supports alternative forms of interpolation of z-values (currently only logarithmic) (see
:ref:`z_interp`).
#. Multithreaded option (see :ref:`threads`).
.. toctree::
:maxdepth: 1
:caption: Basics
installation
usage
quickstart
.. toctree::
:maxdepth: 1
:caption: User Guide
user_guide/calculate/index
user_guide/manipulate/index
user_guide/external/index
.. toctree::
:maxdepth: 1
:caption: Reference
api/index
changelog
.. toctree::
:maxdepth: 1
:caption: Extra Information
developer_guide
benchmarks/index
description
config
|