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.0.1.tar.gz (12.1 kB view details)

Uploaded Source

Built Distribution

adjustText-1.0.1-py3-none-any.whl (11.0 kB view details)

Uploaded Python 3

File details

Details for the file adjustText-1.0.1.tar.gz.

File metadata

  • Download URL: adjustText-1.0.1.tar.gz
  • Upload date:
  • Size: 12.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.18

File hashes

Hashes for adjustText-1.0.1.tar.gz
Algorithm Hash digest
SHA256 0f1acaf68af93f860e0c1c06631c6fb2507b75de7ce42866b97185c63fbc2d94
MD5 dcee36a2ed88b3436eeaf34aa04585d5
BLAKE2b-256 a9ef3cc618b62dcffd970e6aaadd75e7fca88906ce687ac5e1d9e0406594a81c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: adjustText-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 11.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.18

File hashes

Hashes for adjustText-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 7691ac6d1ed6931d5f63b8fba3d0f18ef9692d78cfe5b18daab6218587c9cf05
MD5 3351dce97ced32c202e6895a566699d7
BLAKE2b-256 95ab30deaddee25ce415c07b13b73abb800e5940100fad88dcc79a8e235c8654

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