.. toctree::
    :hidden:

    getting_started/index
    gallery/index
    installing
    reference/index
    whatsnew/index

Introduction
============

Cartopy is a Python package designed for geospatial data processing in order to produce maps and other geospatial data analyses.

Cartopy makes use of the powerful PROJ, NumPy and Shapely libraries and includes a programmatic interface
built on top of Matplotlib for the creation of publication quality maps.

Key features of cartopy are its object oriented :ref:`projection definitions <cartopy_projections>`, and its
ability to transform points, lines, vectors, polygons and images between those projections.

You will find cartopy especially useful for large area / small scale data, where Cartesian
assumptions of spherical data traditionally break down. If you've ever experienced a singularity
at the pole or a cut-off at the dateline, it is likely you will appreciate cartopy's unique features!

.. note::
  The v0.20 release uses pyproj for transformations, which could be slower in some situations.
  If you need to increase the speed of plots and don't need to worry about thread safety in
  your application, you can set the environment variable
  `PYPROJ_GLOBAL_CONTEXT=ON` to make the projection calculations faster.


Getting involved
================

Cartopy was originally developed at the UK Met Office to allow scientists to visualise
their data on maps quickly, easily and most importantly, accurately.
Cartopy has been made freely available under the terms of the
`BSD 3-Clause License <https://opensource.org/license/bsd-3-clause/>`_.
It is suitable to be used in a variety
of scientific fields and has an :doc:`active development community <contributors>`.

There are many ways to get involved in the development of cartopy:

 * If you write a paper which makes use of cartopy, please consider :doc:`citing <citation>` it.
 * If you publish the maps and plots, please consider the required :ref:`attribution of copyright <referencing_copyright>` for the data.
 * Report bugs and problems with the code or documentation to https://github.com/SciTools/cartopy/issues (please look to see if there are any outstanding
   bugs which cover the issue before making a new one).
 * Help others with cartopy questions on `StackOverflow <https://stackoverflow.com/questions/tagged/cartopy>`_.
 * Contribute to the documentation fixing typos, adding examples, explaining things more clearly, or even
   re-designing its layout/logos etc. The `documentation source <https://github.com/SciTools/cartopy>`_ is kept in the same repository as the source code.
 * Contribute bug fixes (:issues:`a list of outstanding bugs can be found on GitHub <Type%3A%20bug>`).
 * :ref:`contribute` describes some simple steps to get started when contributing code to Cartopy.
 * Chat with users and developers in the `Gitter chat room <https://gitter.im/SciTools/cartopy>`_.
