figure-scale 0.1.0b1

Make matplotlib figures with the coorect scale.

Scale your matplotlib figures

Publication quality figures start here

---

Usage

import matplotlib.pyplot as plt
import figure_scale as fs
figsize = fs.FigureScale(4.0, 2.0, units="in")

plt.rcParams.update({'figure.figsize' : figsize})

fig, ax = plt.subplots(figsize=figsize)

with figsize():
    fig, ax = plt.subplots()

@figsize()
def my_plot():
    ...

Installation

pip install figure-scale

How to Contribute

1. Fork this project, clone your repository and make it your working directory.

2. To install the project, its development dependencies, and the pre-commit hooks, just run:

   poetry install
   poetry shell
   

3. The regular maintenance tasks are handled by taskipy. You can see the available tasks by running:

   $ task --list
   pre_commit_install pre-commit install
   test               pytest
   pre_lint           task pre_commit_install
   lint               pre-commit run --all-files
   qa                 task lint && task test
   pre_docs           poetry install --with docs
   docs               jupyter-book build docs --path-output build
   pre_docs_serve     task pre_docs
   docs_serve         sphinx-autobuild docs build/_build/html
   

   Type task <task_name> to run a task. For example, to run the tests, try task qa.

Copyright and License

© 2023 Felipe N. Schuch. All content is under MIT License.