Skip to content

Latest commit

 

History

History
57 lines (36 loc) · 1.55 KB

README.rst

File metadata and controls

57 lines (36 loc) · 1.55 KB
Raw

mplotter: matplotlib plotter

Plotting helpers and styles for matplotlib & TeX projects.

Installation

Obtain the github repository (e.g. via git clone) and run pip install . in the same folder as this README file.

Extra dependencies

  • pdf: enables figure sizing functionality for pdf files;
  • raster: enables figure sizing functionality for raster files;
  • dev: for development, see below.

The desired extras can be included by listing them in the install command, e.g. pip install .[pdf,raster].

Usage

See the demo script; as well as the reference documentation.

Contributing

The project is hosted at https://github.com/rgbmrc/mplotter.

Use the issue tracker to submit bug reports or feature requests. To contribute the codebase, create a fork of the project repository on github and work on a new brach. When you're done open a pull request. See e.g. matlotlib's contributing guidelines for an overview of some best practices.

To set up for development:

  • clone the github repository;
  • create a virtual environment via python -m venv <location> and activate it;
  • install the library in editable mode with dev dependencies via pip install -e .[dev];
  • run pre-commit install to set up the git hook scripts.