# plotters

**Repository Path**: mirrors_fbcotter/plotters

## Basic Information

- **Project Name**: plotters
- **Description**: Some convenience functions for doing matplotlib plotting.
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-08
- **Last Updated**: 2026-10-21

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

Plotters
========
This library provides some convenience functions for doing some plotting
operations with matplotlib. In particular, for image processing and image
analysis that often involves converting to floats and having arbitrary scales.

For a demo on how to use them and what they do, look at the `Plotters Functions
Demo`__ notebook.

__ https://github.com/fbcotter/plotters/blob/master/Plotters%20Functions%20Demo.ipynb

The Sphinx version of the documentation can be found `here`__.

__ https://plotters.readthedocs.io

.. _installation-label:

Installation
------------

From PyPi::

    $ pip install plotters
    
Direct install from github (useful if you use pip freeze). To get the master
branch, try::

    $ pip install -e git+https://github.com/fbcotter/plotters#egg=plotters

or for a specific tag (e.g. 0.0.1), try::

    $ pip install -e git+https://github.com/fbcotter/plotters.git@0.0.1#egg=plotters

Download and pip install from Git::

    $ git clone https://github.com/fbcotter/plotters
    $ cd plotters
    $ pip install -r requirements.txt
    $ pip install -e .

I would recommend to download and install (with the editable flag), as it is
likely you'll want to tweak things/add functions more quickly than I can handle
pull requests.

Further documentation
---------------------

There is `more documentation <http://plotters.readthedocs.io>`_
available online and you can build your own copy via the Sphinx documentation
system::

    $ python setup.py build_sphinx

Compiled documentation will then be found in ``build/docs/html/`` (index.html will be
the homepage)