Skip to main content

Iteratively adjust text position in matplotlib plots to minimize overlaps

Project description

Documentation Status Mutable.ai Auto Wiki 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.3.0.tar.gz (15.7 kB view details)

Uploaded Source

Built Distribution

adjustText-1.3.0-py3-none-any.whl (13.2 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for adjusttext-1.3.0.tar.gz
Algorithm Hash digest
SHA256 4ab75cd4453af4828876ac3e964f2c49be642ea834f0c1f7449558d5f12cbca1
MD5 cc81913691b418130d3dfe0bc0fb944d
BLAKE2b-256 4cd46585f3b6fdb75648bca294664af4becc8aa2fb3fb08f4e4e9fd27e10d773

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for adjustText-1.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 da23d7b24b6db5ffa039bb136bfa556207365e32f48ac74b07ad26dd485bc691
MD5 e853f03a12830635719e2cc5c4fc4951
BLAKE2b-256 531c8feedd607cc14c5df9aef74fe3af9a99bf660743b842a9b5b1865326b4aa

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