Metadata-Version: 2.1
Name: mpl_sizes
Version: 0.0.2
Summary: Default figure sizes for matplotlib.
Home-page: https://github.com/BayesWatch/matplotlib_size_sheets
Author: Jack Turner
Author-email: jackwilliamturner@icloud.com
License: UNKNOWN
Project-URL: Bug Tracker, https://github.com/BayesWatch/matplotlib_size_sheets/issues
Description: # mpl_sizes
        ![](https://img.shields.io/pypi/v/mpl_sizes?color=green)
        
        A lightweight tool for setting `figsize` and font sizes in `matplotlib`, with support for:
        
        - ICLR
        - ICML
        - NeurIPS
        - Informatics thesis 
        
        ## Installation
        
        Install via `pip`:
        
        ```bash
        pip install mpl-sizes
        ```
        
        Install from source:
        ```bash
        git clone git@github.com:BayesWatch/mpl_sizes.git
        cd mpl_sizes 
        python setup.py install
        ```
        
        ## Usage
        
        In your plotting script: 
        
        ```python
        import matplotlib.pyplot as plt
        from mpl_sizes import get_format
        
        formatter = get_format("InfThesis") # options: ICLR, ICML, NeurIPS, InfThesis
        
        fig, ax = plt.subplots(figsize=formatter.text_width_plot())
        ```
        
        Formatters have two methods: 
        - `text_width_plot` - for full pagewidth plots (e.g. in double column, this would be a full width plot)
        - `line_width_plot` - for plots the width of the lines of text
        
        and font size will automatically be set correctly. 
        
        A full example is given in `example.py`. 
        
        You can also set aspect ratio to be: "narrow", "normal", "wide", or "equal". 
        
        ## Aspect ratios
        
        You can also set aspect ratio to be: "narrow", "normal", "wide", or "equal".   
        
        
        e.g. 
        
        A single column width plot for ICML:
        ![](figures/ICML_normal.png)
        
        
        A double column width plot in wide aspect ratio:
        ![](figures/ICML_wide.png)
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: OS Independent
Requires-Python: >=3.8
Description-Content-Type: text/markdown
