Skip to main content

Iteratively adjust text position in matplotlib plots to minimize overlaps

Project description

Documentation Status Gitter chat DOI PyPI version

adjustText - automatic label placement for matplotlib

Inspired by ggrepel package for R/ggplot2 (https://github.com/slowkow/ggrepel) Alt text

Alternative: textalloc https://github.com/ckjellson/textalloc

Brief description

The idea is that often when we want to label multiple points on a graph the text will start heavily overlapping with both other labels and data points. This can be a major problem requiring manual solution. However this can be largely automatized by smart placing of the labels (difficult) or iterative adjustment of their positions to minimize overlaps (relatively easy). This library (well... script) implements the latter option to help with matplotlib graphs. Usage is very straightforward with usually pretty good results with no tweaking (most important is to just make text slightly smaller than default and maybe the figure a little larger). However the algorithm itself is highly configurable for complicated plots.

Getting started

Installation

Should be installable from pypi:

pip install adjustText

Or with conda:

conda install -c conda-forge adjusttext 

For the latest version from github:

pip install https://github.com/Phlya/adjustText/archive/master.zip

Documentation

Wiki has some basic introduction, and more advanced usage examples can be found here.

Thanks to Christophe Van Neste @beukueb, adjustText has a simple documentation: http://adjusttext.readthedocs.io/en/latest/

Citing adjustText

To cite the library if you use it in scientific publications (or anywhere else, if you wish), please use the link to the GitHub repository (https://github.com/Phlya/adjustText) and a zenodo doi (see top of this page). Thank you!

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

adjusttext-1.2.0.tar.gz (14.8 kB view details)

Uploaded Source

Built Distribution

adjustText-1.2.0-py3-none-any.whl (12.2 kB view details)

Uploaded Python 3

File details

Details for the file adjusttext-1.2.0.tar.gz.

File metadata

  • Download URL: adjusttext-1.2.0.tar.gz
  • Upload date:
  • Size: 14.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.19

File hashes

Hashes for adjusttext-1.2.0.tar.gz
Algorithm Hash digest
SHA256 d76f509f0dbc1ccd2fb28908364427f0dccfc4bc95a5f466b228209a10585e18
MD5 665aec32e5d8b6f34fd0c66209af68f8
BLAKE2b-256 c25ba08c34664bd363e1b42a125a5f254d83fde2d693db09a4896548759f1b7c

See more details on using hashes here.

File details

Details for the file adjustText-1.2.0-py3-none-any.whl.

File metadata

  • Download URL: adjustText-1.2.0-py3-none-any.whl
  • Upload date:
  • Size: 12.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.19

File hashes

Hashes for adjustText-1.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 53212d5ea02b224ba56a1929d30264c8f6ea35d18a39f0fc351cff0bca66a214
MD5 2134c8086a5f88a4fbd8e24a8c0cb2ce
BLAKE2b-256 710dbaaa8e9f8c14e33f353419f7c7da4c270145626f043e98740e743ece6a8e

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page