matplotlib-scalebar


Namematplotlib-scalebar JSON
Version 0.8.1 PyPI version JSON
download
home_pagehttps://github.com/ppinard/matplotlib-scalebar
SummaryArtist for matplotlib to display a scale bar
upload_time2022-03-10 11:47:45
maintainerPhilippe Pinard
docs_urlNone
authorPhilippe Pinard
requires_python~=3.7
licenseBSD
keywords matplotlib scale micron bar
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage
            # matplotlib-scalebar

![CI](https://github.com/ppinard/matplotlib-scalebar/workflows/CI/badge.svg)
![PyPI](https://img.shields.io/pypi/v/matplotlib-scalebar)

Provides a new artist for [matplotlib](https://matplotlib.org) to display a scale bar, aka micron bar.
It is particularly useful when displaying calibrated images plotted using
`plt.imshow(...)`.

![Example of scale bar](doc/splashscreen.png)

The artist supports customization either directly from the **ScaleBar** object or from the matplotlibrc.

## Installation

Easiest way to install using `pip`:

```bash
pip install matplotlib-scalebar
```

For development installation from the git repository:

```bash
git clone git@github.com:ppinard/matplotlib-scalebar.git
pip install -e matplotlib-scalebar
```

## Getting started

There are many ways to customize the scale bar.
Examples and explanations of the arguments of the **ScaleBar** class are given [below](#scalebar-arguments), but here is a quick start guide.

The constructor arguments *dx* and *units* specify the pixel dimension.
For example `ScaleBar(0.2, 'um')` indicates that each pixel is equal to 0.2 micrometer.
By default, the scale bar uses SI units of length (e.g. m, cm, um, km, etc.).
See examples below for other system of units.

In this example, we load a sample image from the matplotlib library, create a subplot, plot image, create scale bar and add scale bar as an "artist" of the subplot.

```python
import numpy as np
import matplotlib.pyplot as plt
import matplotlib.cbook as cbook
from matplotlib_scalebar.scalebar import ScaleBar

# Load image
with cbook.get_sample_data("s1045.ima.gz") as dfile:
    im = np.frombuffer(dfile.read(), np.uint16).reshape((256, 256))

# Create subplot
fig, ax = plt.subplots()
ax.axis("off")

# Plot image
ax.imshow(im, cmap="gray")

# Create scale bar
scalebar = ScaleBar(0.08, "cm", length_fraction=0.25)
ax.add_artist(scalebar)

# Show
plt.show()
```

![Example of scale bar](doc/getting_started.png)

## ScaleBar arguments

Here are arguments of the **ScaleBar** class constructor and examples how to use them.

```python
scalebar = ScaleBar(
        dx,
        units="m",
        dimension="si-length",
        label=None,
        length_fraction=None,
        height_fraction=None,
        width_fraction=None,
        location=None,
        pad=None,
        border_pad=None,
        sep=None,
        frameon=None,
        color=None,
        box_color=None,
        box_alpha=None,
        scale_loc=None,
        label_loc=None,
        font_properties=None,
        label_formatter=None,
        scale_formatter=None,
        fixed_value=None,
        fixed_units=None,
        animated=False,
        rotation=None,
    )
```

Each argument can also be changed afterwards using their respective property.

```python
scalebar.dx = 2.0
```

The following schematic illustrates the nomenclature used in the definition of the arguments.

![nomenclature](doc/nomenclature.png)

### dx (required)

Size of one pixel in *units* specified by the next argument.

Set *dx* to 1.0 if the axes image has already been calibrated by setting its *extent*.

```python
fig, ax = plt.subplots()
ax.axis("off")

ax.imshow(im, cmap="gray", extent=[0, 20.48, 0, 20.48])

scalebar = ScaleBar(1, "cm", length_fraction=0.25)
ax.add_artist(scalebar)
```

![dx with extent](doc/argument_dx.png)

**Special notes for geospatial plots**:
If you are plotting geospatial coordinates (such as scatterplots of the location of structures, [geopandas](http://geopandas.org) geodataframe plots, etc.), *dx* needs to be set differently depending on the coordinate system:

* For UTM based coordinate system, where the X and Y are in meters, simply set `dx = 1`.
* For WGS or NAD based coordinate system, where X and Y are in latitude (Y) and longitude (X), compute the distance between two points at the latitude (Y) you wish to have the scale represented and are also one full degree of longitude (X) apart, in meters. For example, `dx = great_circle_distance((X, Y), (X + 1, Y))`

### units

Units of *dx*.
The units needs to be valid for the specified *dimension*.
Default: `m`.

### dimension

Dimension of *dx* and *units*. It can either be equal:

* `si-length` (default): scale bar showing km, m, cm, etc.
* `imperial-length`: scale bar showing in, ft, yd, mi, etc.
* `si-length-reciprocal`: scale bar showing 1/m, 1/cm, etc.
* `pixel-length`: scale bar showing px, kpx, Mpx, etc.
* `angle`: scale bar showing °, ʹ (minute of arc) or ʹʹ (second of arc)
* a `matplotlib_scalebar.dimension._Dimension` object

```python
fig, ax = plt.subplots()
ax.axis("off")

ax.imshow(im, cmap="gray")

scalebar = ScaleBar(0.0315, "in", dimension="imperial-length", length_fraction=0.25)
ax.add_artist(scalebar)
```

![imperial dimension](doc/argument_dimension.png)

### label

Optional label associated with the scale bar.
Default: `None`, no label is shown.
The position of the label with respect to the scale bar can be adjusted using *label_loc* argument.

### length_fraction

Desired length of the scale bar as a fraction of the subplot's width.
Default: `None`, value from matplotlibrc or `0.2`.
The actual length of the scale bar is automatically determined based on the specified pixel size (*dx* and *units*) and the contraint that the scale value can only take the following numbers: 1, 2, 5, 10, 15, 20, 25, 50, 75, 100, 125, 150, 200, 500 or 750.
If you want a specific value, see [*fixed_value*](#fixed_value) and [*fixed_units*](#fixed_units).

In the example below, the scale bar for a *length_fraction* of 0.25 and 0.5 is the same because the scale cannot have a value between 2 and 5 mm.

![length fraction](doc/argument_length_fraction.png)

### height_fraction

**Deprecated**, use *width_fraction*.

### width_fraction

Width of the scale bar as a fraction of the subplot's height.
Default: `None`, value from matplotlibrc or `0.01`.

### location

A location code, same as matplotlib's legend, either: `upper right`, `upper left`, `lower left`, `lower right`, `right`, `center left`, `center right`, `lower center`, `upper center` or `center`.
Default: `None`, value from matplotlibrc or `upper right`.

### loc

Alias for *location*.

### pad

Padding inside the box, as a fraction of the font size.
Default: `None`, value from matplotlibrc or `0.2`.

### border_pad

Padding outside the box, fraction of the font size.
Default: `None`, value from matplotlibrc or `0.1`.

### sep

Separation in points between the scale bar and scale, and between the scale bar and label.
Default: `None`, value from matplotlibrc or `5`.

### frameon

Whether to draw a box behind the scale bar, scale and label.
Default: `None`, value from matplotlibrc or `True`.

### color

Color for the scale bar, scale and label.
Default: `None`, value from matplotlibrc or `k` (black).

### box_color

Background color of the box.
Default: `None`, value from matplotlibrc or `w` (white).

### box_alpha

Transparency of box.
Default: `None`, value from matplotlibrc or `1.0` (opaque).

### scale_loc

Location of the scale with respect to the scale bar.
Either `bottom`, `top`, `left`, `right`, `none`.
Default: `None`, value from matplotlibrc or `bottom`.
If `"none"`, no scale is shown.

![scale_loc](doc/argument_scale_loc.png)

### label_loc

Location of the label with respect to the scale bar.
Either `bottom`, `top`, `left`, `right`, `none`.
Default: `None`, value from matplotlibrc or `top`.
If `"none"`, no label is shown.

### font_properties

Font properties of the scale and label text, specified either as `dict` or `str`.
See [`FontProperties`](https://matplotlib.org/api/font_manager_api.html#matplotlib.font_manager.FontProperties) for the arguments.
Default: `None`, default font properties of matplotlib.

### label_formatter

**Deprecated**, use *scale_formatter*.

### scale_formatter

Custom function called to format the scale.
Needs to take 2 arguments - the scale value and the unit.
Default: `None` which results in

```python
scale_formatter = lambda value, unit: f"{value} {unit}"
```

### fixed_value

Value for the scale.
The length of the scale bar is calculated based on the specified pixel size *dx*.
Default: `None`, the value is automatically determined based on *length_fraction*.

### fixed_units

Units of the *fixed_value*.
Default: `None`, if *fixed value* is not `None`, the units of *dx* are used.

### animated

Animation state.
Default: `False`

### rotation

Whether to create a scale bar based on the x-axis (default) or y-axis.
*rotation* can either be `horizontal` or `vertical`.
Note you might have to adjust *scale_loc* and *label_loc* to achieve desired layout.
Default: `None`, value from matplotlibrc or `horizontal`.

```python
fig, ax = plt.subplots()
ax.axis("off")

ax.imshow(im, cmap="gray")

scalebar = ScaleBar(
    0.08,
    "cm",
    length_fraction=0.25,
    rotation="vertical",
    scale_loc="right",
    border_pad=1,
    pad=0.5,
)
ax.add_artist(scalebar)
```

![rotation](doc/argument_rotation.png)

## Release notes

### 0.8.1

* Remove useless shebangs ([#47][i47])
* Correct License trove classifier ([#48][i48])

### 0.8.0

* Fix missing `_all_deprecated` in future matplotlib (> 3.5) ([#44][i44])
* Add ability to hide scale and label ([#41][i41])

### 0.7.2

* Fix deprecation warning in matplotlib >= 3.4 of `minimumdescent` ([#36][i36])

### 0.7.1

* Fix scalebar location validation from rcParams ([#35](i35))

### 0.7.0

* Add rotation to display scale bar for the y-axis ([#30][i30])
* New documentation ([#32][i32])
* Deprecate argument *height_fraction*, replaced by *width_fraction* ([#32][i32])
* Deprecate argument *label_formatter*, replaced by *scale_formatter* ([#32][i32])
* Add alias *loc* for *location* ([#32][i32])
* Fix deprecation warning in matplotlib >= 3.3 of `validate_legend_loc` ([#33][i33])

### 0.6.2

* Fix reciprocal unit ([#29][i29])

### 0.6.1

* Add notes about for geospatial plots ([#20][i20])

### 0.6.0

* Add angular units ([#19][i19])
* Add blit support and fix documentation ([#22][i22])
* Fix issue with getting the wrong preferred values for the scale bar ([#23][i23])
* Package LICENSE file to distribution ([#24][i24])

### 0.5.1

* Remove leftover print statement ([#18][i18])

### 0.5.0

* Add pixel unit ([#12][i12])
* Display micro symbol in text mode ([#15][i15])
* Fix error in length of scale bar; the bar was drawn with an edge around it which made it longer than the actual size ([#14][i14])

### 0.4.1

* Fix deprecated usage of is_string_like ([#11][i11])

### 0.4.0

* Add possibility to specified a fixed value for the scale bar ([#9][i9])

## Contributors

[@maweigert](https://github.com/maweigert),
[@crosbyla](https://github.com/crosbyla),
[@joschkazj](https://github.com/joschkazj),
[@AKuederle](https://github.com/AKuederle),
[@habi](https://github.com/habi),
[@huangziwei](https://github.com/huangziwei),
[@SirJohnFranklin](https://github.com/SirJohnFranklin),
[@alexandrejaguar](https://github.com/alexandrejaguar),
[@parishcm](https://github.com/parishcm),
[@wiai](https://github.com/wiai),
[@cosmicshear](https://github.com/cosmicshear),
[@ericore](https://github.com/ericore),
[@seangrogan](https://github.com/seangrogan),
[@PhilipeRLeal](https://github.com/PhilipeRLeal),
[@din14970](https://github.com/din14970),
[@SarthakJariwala](https://github.com/SarthakJariwala),
[@k1moradi](https://github.com/k1moradi),
[@anntzer](https://github.com/anntzer),
[@bugalo](https://github.com/bugalo),
[@musicinmybrain](https://github.com/musicinmybrain)

## License

License under the BSD License, compatible with matplotlib.

Copyright (c) 2015-2022 Philippe Pinard

[i9]: https://github.com/ppinard/matplotlib-scalebar/issues/9
[i11]: https://github.com/ppinard/matplotlib-scalebar/issues/11
[i12]: https://github.com/ppinard/matplotlib-scalebar/issues/12
[i14]: https://github.com/ppinard/matplotlib-scalebar/issues/14
[i15]: https://github.com/ppinard/matplotlib-scalebar/issues/15
[i18]: https://github.com/ppinard/matplotlib-scalebar/issues/18
[i19]: https://github.com/ppinard/matplotlib-scalebar/issues/19
[i20]: https://github.com/ppinard/matplotlib-scalebar/issues/20
[i22]: https://github.com/ppinard/matplotlib-scalebar/issues/22
[i23]: https://github.com/ppinard/matplotlib-scalebar/issues/23
[i24]: https://github.com/ppinard/matplotlib-scalebar/issues/24
[i29]: https://github.com/ppinard/matplotlib-scalebar/issues/29
[i30]: https://github.com/ppinard/matplotlib-scalebar/issues/30
[i32]: https://github.com/ppinard/matplotlib-scalebar/issues/32
[i33]: https://github.com/ppinard/matplotlib-scalebar/issues/33
[i35]: https://github.com/ppinard/matplotlib-scalebar/issues/35
[i36]: https://github.com/ppinard/matplotlib-scalebar/issues/36
[i41]: https://github.com/ppinard/matplotlib-scalebar/issues/41
[i44]: https://github.com/ppinard/matplotlib-scalebar/pull/44
[i47]: https://github.com/ppinard/matplotlib-scalebar/pull/47
[i48]: https://github.com/ppinard/matplotlib-scalebar/pull/48



            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/ppinard/matplotlib-scalebar",
    "name": "matplotlib-scalebar",
    "maintainer": "Philippe Pinard",
    "docs_url": null,
    "requires_python": "~=3.7",
    "maintainer_email": "philippe.pinard@gmail.com",
    "keywords": "matplotlib scale micron bar",
    "author": "Philippe Pinard",
    "author_email": "philippe.pinard@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/ff/16/a564e2c97652e95b5aca51f21e3b281a0546159a9a6b06e2f6476bc53da6/matplotlib-scalebar-0.8.1.tar.gz",
    "platform": null,
    "description": "# matplotlib-scalebar\n\n![CI](https://github.com/ppinard/matplotlib-scalebar/workflows/CI/badge.svg)\n![PyPI](https://img.shields.io/pypi/v/matplotlib-scalebar)\n\nProvides a new artist for [matplotlib](https://matplotlib.org) to display a scale bar, aka micron bar.\nIt is particularly useful when displaying calibrated images plotted using\n`plt.imshow(...)`.\n\n![Example of scale bar](doc/splashscreen.png)\n\nThe artist supports customization either directly from the **ScaleBar** object or from the matplotlibrc.\n\n## Installation\n\nEasiest way to install using `pip`:\n\n```bash\npip install matplotlib-scalebar\n```\n\nFor development installation from the git repository:\n\n```bash\ngit clone git@github.com:ppinard/matplotlib-scalebar.git\npip install -e matplotlib-scalebar\n```\n\n## Getting started\n\nThere are many ways to customize the scale bar.\nExamples and explanations of the arguments of the **ScaleBar** class are given [below](#scalebar-arguments), but here is a quick start guide.\n\nThe constructor arguments *dx* and *units* specify the pixel dimension.\nFor example `ScaleBar(0.2, 'um')` indicates that each pixel is equal to 0.2 micrometer.\nBy default, the scale bar uses SI units of length (e.g. m, cm, um, km, etc.).\nSee examples below for other system of units.\n\nIn this example, we load a sample image from the matplotlib library, create a subplot, plot image, create scale bar and add scale bar as an \"artist\" of the subplot.\n\n```python\nimport numpy as np\nimport matplotlib.pyplot as plt\nimport matplotlib.cbook as cbook\nfrom matplotlib_scalebar.scalebar import ScaleBar\n\n# Load image\nwith cbook.get_sample_data(\"s1045.ima.gz\") as dfile:\n    im = np.frombuffer(dfile.read(), np.uint16).reshape((256, 256))\n\n# Create subplot\nfig, ax = plt.subplots()\nax.axis(\"off\")\n\n# Plot image\nax.imshow(im, cmap=\"gray\")\n\n# Create scale bar\nscalebar = ScaleBar(0.08, \"cm\", length_fraction=0.25)\nax.add_artist(scalebar)\n\n# Show\nplt.show()\n```\n\n![Example of scale bar](doc/getting_started.png)\n\n## ScaleBar arguments\n\nHere are arguments of the **ScaleBar** class constructor and examples how to use them.\n\n```python\nscalebar = ScaleBar(\n        dx,\n        units=\"m\",\n        dimension=\"si-length\",\n        label=None,\n        length_fraction=None,\n        height_fraction=None,\n        width_fraction=None,\n        location=None,\n        pad=None,\n        border_pad=None,\n        sep=None,\n        frameon=None,\n        color=None,\n        box_color=None,\n        box_alpha=None,\n        scale_loc=None,\n        label_loc=None,\n        font_properties=None,\n        label_formatter=None,\n        scale_formatter=None,\n        fixed_value=None,\n        fixed_units=None,\n        animated=False,\n        rotation=None,\n    )\n```\n\nEach argument can also be changed afterwards using their respective property.\n\n```python\nscalebar.dx = 2.0\n```\n\nThe following schematic illustrates the nomenclature used in the definition of the arguments.\n\n![nomenclature](doc/nomenclature.png)\n\n### dx (required)\n\nSize of one pixel in *units* specified by the next argument.\n\nSet *dx* to 1.0 if the axes image has already been calibrated by setting its *extent*.\n\n```python\nfig, ax = plt.subplots()\nax.axis(\"off\")\n\nax.imshow(im, cmap=\"gray\", extent=[0, 20.48, 0, 20.48])\n\nscalebar = ScaleBar(1, \"cm\", length_fraction=0.25)\nax.add_artist(scalebar)\n```\n\n![dx with extent](doc/argument_dx.png)\n\n**Special notes for geospatial plots**:\nIf you are plotting geospatial coordinates (such as scatterplots of the location of structures, [geopandas](http://geopandas.org) geodataframe plots, etc.), *dx* needs to be set differently depending on the coordinate system:\n\n* For UTM based coordinate system, where the X and Y are in meters, simply set `dx = 1`.\n* For WGS or NAD based coordinate system, where X and Y are in latitude (Y) and longitude (X), compute the distance between two points at the latitude (Y) you wish to have the scale represented and are also one full degree of longitude (X) apart, in meters. For example, `dx = great_circle_distance((X, Y), (X + 1, Y))`\n\n### units\n\nUnits of *dx*.\nThe units needs to be valid for the specified *dimension*.\nDefault: `m`.\n\n### dimension\n\nDimension of *dx* and *units*. It can either be equal:\n\n* `si-length` (default): scale bar showing km, m, cm, etc.\n* `imperial-length`: scale bar showing in, ft, yd, mi, etc.\n* `si-length-reciprocal`: scale bar showing 1/m, 1/cm, etc.\n* `pixel-length`: scale bar showing px, kpx, Mpx, etc.\n* `angle`: scale bar showing \u00b0, \u02b9 (minute of arc) or \u02b9\u02b9 (second of arc)\n* a `matplotlib_scalebar.dimension._Dimension` object\n\n```python\nfig, ax = plt.subplots()\nax.axis(\"off\")\n\nax.imshow(im, cmap=\"gray\")\n\nscalebar = ScaleBar(0.0315, \"in\", dimension=\"imperial-length\", length_fraction=0.25)\nax.add_artist(scalebar)\n```\n\n![imperial dimension](doc/argument_dimension.png)\n\n### label\n\nOptional label associated with the scale bar.\nDefault: `None`, no label is shown.\nThe position of the label with respect to the scale bar can be adjusted using *label_loc* argument.\n\n### length_fraction\n\nDesired length of the scale bar as a fraction of the subplot's width.\nDefault: `None`, value from matplotlibrc or `0.2`.\nThe actual length of the scale bar is automatically determined based on the specified pixel size (*dx* and *units*) and the contraint that the scale value can only take the following numbers: 1, 2, 5, 10, 15, 20, 25, 50, 75, 100, 125, 150, 200, 500 or 750.\nIf you want a specific value, see [*fixed_value*](#fixed_value) and [*fixed_units*](#fixed_units).\n\nIn the example below, the scale bar for a *length_fraction* of 0.25 and 0.5 is the same because the scale cannot have a value between 2 and 5 mm.\n\n![length fraction](doc/argument_length_fraction.png)\n\n### height_fraction\n\n**Deprecated**, use *width_fraction*.\n\n### width_fraction\n\nWidth of the scale bar as a fraction of the subplot's height.\nDefault: `None`, value from matplotlibrc or `0.01`.\n\n### location\n\nA location code, same as matplotlib's legend, either: `upper right`, `upper left`, `lower left`, `lower right`, `right`, `center left`, `center right`, `lower center`, `upper center` or `center`.\nDefault: `None`, value from matplotlibrc or `upper right`.\n\n### loc\n\nAlias for *location*.\n\n### pad\n\nPadding inside the box, as a fraction of the font size.\nDefault: `None`, value from matplotlibrc or `0.2`.\n\n### border_pad\n\nPadding outside the box, fraction of the font size.\nDefault: `None`, value from matplotlibrc or `0.1`.\n\n### sep\n\nSeparation in points between the scale bar and scale, and between the scale bar and label.\nDefault: `None`, value from matplotlibrc or `5`.\n\n### frameon\n\nWhether to draw a box behind the scale bar, scale and label.\nDefault: `None`, value from matplotlibrc or `True`.\n\n### color\n\nColor for the scale bar, scale and label.\nDefault: `None`, value from matplotlibrc or `k` (black).\n\n### box_color\n\nBackground color of the box.\nDefault: `None`, value from matplotlibrc or `w` (white).\n\n### box_alpha\n\nTransparency of box.\nDefault: `None`, value from matplotlibrc or `1.0` (opaque).\n\n### scale_loc\n\nLocation of the scale with respect to the scale bar.\nEither `bottom`, `top`, `left`, `right`, `none`.\nDefault: `None`, value from matplotlibrc or `bottom`.\nIf `\"none\"`, no scale is shown.\n\n![scale_loc](doc/argument_scale_loc.png)\n\n### label_loc\n\nLocation of the label with respect to the scale bar.\nEither `bottom`, `top`, `left`, `right`, `none`.\nDefault: `None`, value from matplotlibrc or `top`.\nIf `\"none\"`, no label is shown.\n\n### font_properties\n\nFont properties of the scale and label text, specified either as `dict` or `str`.\nSee [`FontProperties`](https://matplotlib.org/api/font_manager_api.html#matplotlib.font_manager.FontProperties) for the arguments.\nDefault: `None`, default font properties of matplotlib.\n\n### label_formatter\n\n**Deprecated**, use *scale_formatter*.\n\n### scale_formatter\n\nCustom function called to format the scale.\nNeeds to take 2 arguments - the scale value and the unit.\nDefault: `None` which results in\n\n```python\nscale_formatter = lambda value, unit: f\"{value} {unit}\"\n```\n\n### fixed_value\n\nValue for the scale.\nThe length of the scale bar is calculated based on the specified pixel size *dx*.\nDefault: `None`, the value is automatically determined based on *length_fraction*.\n\n### fixed_units\n\nUnits of the *fixed_value*.\nDefault: `None`, if *fixed value* is not `None`, the units of *dx* are used.\n\n### animated\n\nAnimation state.\nDefault: `False`\n\n### rotation\n\nWhether to create a scale bar based on the x-axis (default) or y-axis.\n*rotation* can either be `horizontal` or `vertical`.\nNote you might have to adjust *scale_loc* and *label_loc* to achieve desired layout.\nDefault: `None`, value from matplotlibrc or `horizontal`.\n\n```python\nfig, ax = plt.subplots()\nax.axis(\"off\")\n\nax.imshow(im, cmap=\"gray\")\n\nscalebar = ScaleBar(\n    0.08,\n    \"cm\",\n    length_fraction=0.25,\n    rotation=\"vertical\",\n    scale_loc=\"right\",\n    border_pad=1,\n    pad=0.5,\n)\nax.add_artist(scalebar)\n```\n\n![rotation](doc/argument_rotation.png)\n\n## Release notes\n\n### 0.8.1\n\n* Remove useless shebangs ([#47][i47])\n* Correct License trove classifier ([#48][i48])\n\n### 0.8.0\n\n* Fix missing `_all_deprecated` in future matplotlib (> 3.5) ([#44][i44])\n* Add ability to hide scale and label ([#41][i41])\n\n### 0.7.2\n\n* Fix deprecation warning in matplotlib >= 3.4 of `minimumdescent` ([#36][i36])\n\n### 0.7.1\n\n* Fix scalebar location validation from rcParams ([#35](i35))\n\n### 0.7.0\n\n* Add rotation to display scale bar for the y-axis ([#30][i30])\n* New documentation ([#32][i32])\n* Deprecate argument *height_fraction*, replaced by *width_fraction* ([#32][i32])\n* Deprecate argument *label_formatter*, replaced by *scale_formatter* ([#32][i32])\n* Add alias *loc* for *location* ([#32][i32])\n* Fix deprecation warning in matplotlib >= 3.3 of `validate_legend_loc` ([#33][i33])\n\n### 0.6.2\n\n* Fix reciprocal unit ([#29][i29])\n\n### 0.6.1\n\n* Add notes about for geospatial plots ([#20][i20])\n\n### 0.6.0\n\n* Add angular units ([#19][i19])\n* Add blit support and fix documentation ([#22][i22])\n* Fix issue with getting the wrong preferred values for the scale bar ([#23][i23])\n* Package LICENSE file to distribution ([#24][i24])\n\n### 0.5.1\n\n* Remove leftover print statement ([#18][i18])\n\n### 0.5.0\n\n* Add pixel unit ([#12][i12])\n* Display micro symbol in text mode ([#15][i15])\n* Fix error in length of scale bar; the bar was drawn with an edge around it which made it longer than the actual size ([#14][i14])\n\n### 0.4.1\n\n* Fix deprecated usage of is_string_like ([#11][i11])\n\n### 0.4.0\n\n* Add possibility to specified a fixed value for the scale bar ([#9][i9])\n\n## Contributors\n\n[@maweigert](https://github.com/maweigert),\n[@crosbyla](https://github.com/crosbyla),\n[@joschkazj](https://github.com/joschkazj),\n[@AKuederle](https://github.com/AKuederle),\n[@habi](https://github.com/habi),\n[@huangziwei](https://github.com/huangziwei),\n[@SirJohnFranklin](https://github.com/SirJohnFranklin),\n[@alexandrejaguar](https://github.com/alexandrejaguar),\n[@parishcm](https://github.com/parishcm),\n[@wiai](https://github.com/wiai),\n[@cosmicshear](https://github.com/cosmicshear),\n[@ericore](https://github.com/ericore),\n[@seangrogan](https://github.com/seangrogan),\n[@PhilipeRLeal](https://github.com/PhilipeRLeal),\n[@din14970](https://github.com/din14970),\n[@SarthakJariwala](https://github.com/SarthakJariwala),\n[@k1moradi](https://github.com/k1moradi),\n[@anntzer](https://github.com/anntzer),\n[@bugalo](https://github.com/bugalo),\n[@musicinmybrain](https://github.com/musicinmybrain)\n\n## License\n\nLicense under the BSD License, compatible with matplotlib.\n\nCopyright (c) 2015-2022 Philippe Pinard\n\n[i9]: https://github.com/ppinard/matplotlib-scalebar/issues/9\n[i11]: https://github.com/ppinard/matplotlib-scalebar/issues/11\n[i12]: https://github.com/ppinard/matplotlib-scalebar/issues/12\n[i14]: https://github.com/ppinard/matplotlib-scalebar/issues/14\n[i15]: https://github.com/ppinard/matplotlib-scalebar/issues/15\n[i18]: https://github.com/ppinard/matplotlib-scalebar/issues/18\n[i19]: https://github.com/ppinard/matplotlib-scalebar/issues/19\n[i20]: https://github.com/ppinard/matplotlib-scalebar/issues/20\n[i22]: https://github.com/ppinard/matplotlib-scalebar/issues/22\n[i23]: https://github.com/ppinard/matplotlib-scalebar/issues/23\n[i24]: https://github.com/ppinard/matplotlib-scalebar/issues/24\n[i29]: https://github.com/ppinard/matplotlib-scalebar/issues/29\n[i30]: https://github.com/ppinard/matplotlib-scalebar/issues/30\n[i32]: https://github.com/ppinard/matplotlib-scalebar/issues/32\n[i33]: https://github.com/ppinard/matplotlib-scalebar/issues/33\n[i35]: https://github.com/ppinard/matplotlib-scalebar/issues/35\n[i36]: https://github.com/ppinard/matplotlib-scalebar/issues/36\n[i41]: https://github.com/ppinard/matplotlib-scalebar/issues/41\n[i44]: https://github.com/ppinard/matplotlib-scalebar/pull/44\n[i47]: https://github.com/ppinard/matplotlib-scalebar/pull/47\n[i48]: https://github.com/ppinard/matplotlib-scalebar/pull/48\n\n\n",
    "bugtrack_url": null,
    "license": "BSD",
    "summary": "Artist for matplotlib to display a scale bar",
    "version": "0.8.1",
    "project_urls": {
        "Homepage": "https://github.com/ppinard/matplotlib-scalebar"
    },
    "split_keywords": [
        "matplotlib",
        "scale",
        "micron",
        "bar"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "a99e22930e3deb2c374f47c6633aff9f6f379f8c421ab868fff3b4f85eac8b8a",
                "md5": "cca9691b0882355f276efad85e189371",
                "sha256": "a8a2f361d4c2d576d087df3092ed95cac2f708f8b40d5d2bb992bd190e740b3a"
            },
            "downloads": -1,
            "filename": "matplotlib_scalebar-0.8.1-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "cca9691b0882355f276efad85e189371",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": "~=3.7",
            "size": 17686,
            "upload_time": "2022-03-10T11:47:40",
            "upload_time_iso_8601": "2022-03-10T11:47:40.946660Z",
            "url": "https://files.pythonhosted.org/packages/a9/9e/22930e3deb2c374f47c6633aff9f6f379f8c421ab868fff3b4f85eac8b8a/matplotlib_scalebar-0.8.1-py2.py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "ff16a564e2c97652e95b5aca51f21e3b281a0546159a9a6b06e2f6476bc53da6",
                "md5": "06b0c648c423d9deeb3efe2f4727002e",
                "sha256": "14887af1093579c5e6afae51a0a1ecc3f715cdbc5c4d7ef59cdeec76ee6bb15d"
            },
            "downloads": -1,
            "filename": "matplotlib-scalebar-0.8.1.tar.gz",
            "has_sig": false,
            "md5_digest": "06b0c648c423d9deeb3efe2f4727002e",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "~=3.7",
            "size": 1108463,
            "upload_time": "2022-03-10T11:47:45",
            "upload_time_iso_8601": "2022-03-10T11:47:45.960841Z",
            "url": "https://files.pythonhosted.org/packages/ff/16/a564e2c97652e95b5aca51f21e3b281a0546159a9a6b06e2f6476bc53da6/matplotlib-scalebar-0.8.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2022-03-10 11:47:45",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "ppinard",
    "github_project": "matplotlib-scalebar",
    "travis_ci": false,
    "coveralls": true,
    "github_actions": true,
    "lcname": "matplotlib-scalebar"
}
        
Elapsed time: 0.30084s