Skip to content

Commit

Permalink
Add example notebook and change README to rst for PyPI
Browse files Browse the repository at this point in the history
  • Loading branch information
camillescott committed Nov 11, 2015
1 parent 853a295 commit fba3c9a
Show file tree
Hide file tree
Showing 3 changed files with 77 additions and 31 deletions.
28 changes: 0 additions & 28 deletions README.md

This file was deleted.

48 changes: 48 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
ficus
=====

About
-----

Ficus provides a context manager for matplotlib figures. It finds particular utility in jupyter
notebooks, where the user might prefer that figures are not automatically displayed but still wants
the option to embed them inline -- such behavior can be accomplished with::

%config InlineBackend.close_figures = False

However, the user is now responsible for making new `Figure` objects and closing them, which is a
pain. The ficus context manager takes care of this boilerplate of opening, showing, saving, and
closing figures for you.

Example
-------

Some very basic usage::

from ficus import FigureManager
import numpy as np
X = np.arange(0, 10, .1)
Y = np.exp(X)
with FigureManager(filename='myplot.png', show=True) as (fig, ax):
ax.plot(X, Y)
ax.set_title('The Exponential Function')

`FigureManager` uses the `pyplot.subplots(..)` to generate its axes. Thus, you can specify rows and
columns and get an array of `Axes` objects::

with FigureManager(show=True, nrows=3, ncols=4) as (fig, ax_mat):
for i, row in enumerate(ax_mat):
for j, ax in enumerate(row):
ax.plot(X, X**(i+j))
ax.set_title(r'$y = x^{0}$'.format(i+j), fontsize=14)

In fact, you can pass any keyword arguments you'd like to `subplots`::

with FigureManager(filename='myplot.png', show=True, figsize=(12,8)) as (fig, ax):
ax.plot(X, Y)

---

[![Build Status](https://drone.io/github.com/camillescott/ficus/status.png)](https://drone.io/github.com/camillescott/ficus/latest)
Loading

0 comments on commit fba3c9a

Please sign in to comment.