Installation & Usage#

Installation#

Attention

This module is not provided on PyPI. It must be installed from GitHub using one of the methods below.

This module is not the same as the one provided on PyPI!

Do not attempt to install this module via pip install mplutils.

If you don’t have matplotlib installed, you will need to do this manually. The simplest way is using pip:

pip install matplotlib

Other methods are listed here.

If you have git installed on your system, you can install the package directly from GitHub.

pip install git+https://github.com/frekm/mpl-utils.git

You can install a particular version by appending it, e.g. v0.5.0,

pip install git+https://github.com/frekm/mpl-utils.git@v0.5.0

Check the release page which versions exist.

You can also install a particular commit using its SHA. Go to the commit history, copy the SHA of the commit in question, and install it, e.g.,

pip install git+https://github.com/frekm/mpl-utils.git@52ef552a15a7b096824dd6457f35f40542f30686

If you don’t have git installed on your system, you can install version (not necessarily the latest release) using

pip install https://github.com/frekm/mpl-utils/archive/refs/heads/main.zip

or a paticular tag (corresponding to a particular release) using

pip install https://github.com/frekm/mpl-utils/archive/refs/tags/v0.1.0.zip

Replace “v0.1.0” with the particular version you want.

Once you have installed the package using any of the above methods, simply import it into your project

import mplutils as mplu

Some basic examples can be found at Examples.

The documentation of all provided methods is available at API reference.