Merge pull request #23 from uit-cosmo/multiple_figures

Support for figures with multiple axes

README.md

@@ -29,11 +29,31 @@ import matplotlib as mpl
 
 # If you only want the default style
 mpl.style.use("cosmoplots.default")
-# If you want the two column style, combine it with the default. Setting it after is
-# important, since values from the default is overridden.
-mpl.style.use(["cosmoplots.default", "cosmoplots.two_columns"])
 ```
 
+### Muliple subfigures
+To make a figure with multiple rows or columns, use `cosmoplots.figure_multiple_rows_columns`:
+```python
+import matplotlib as mpl
+import matplotlib.pyplot as plt
+import numpy as np
+
+import cosmoplots
+
+mpl.style.use(["cosmoplots.default"])
+rows = 1
+columns = 2
+
+fig, ax = cosmoplots.figure_multiple_rows_columns(rows, columns)
+a = np.linspace(-3,3,100)
+for i in range(rows*columns):
+    ax[i].set_xlabel("X Axis")
+    ax[i].set_ylabel("Y Axis")
+    ax[i].plot(i*a)
+plt.show()
+```
+![multifig](./assets/multifig.png)
+
 ## `change_log_axis_base`
 
 ```python
@@ -203,3 +223,4 @@ cosmoplots.Combine().help()
 ```
 
 ![concat](./assets/concat.png)
+

cosmoplots/axes.py

@@ -1,6 +1,7 @@
 """Module for modifying the axis properties of plots."""
 
 from typing import List, Tuple, Union
+import matplotlib as mpl
 import matplotlib.pyplot as plt
 import numpy as np
 from matplotlib import ticker
@@ -88,3 +89,34 @@ def change_log_axis_base(
             )
         )
     return axes
+
+def figure_multiple_rows_columns(rows: int, columns: int):
+    """Returns a figure with axes which is appropriate for (rows, columns) subfigures.
+
+    Parameters
+    ----------
+    rows : int
+        The number of rows in the figure
+    columns : int
+        The number of columns in the figure
+
+    Returns
+    -------
+    plt.Figure
+        The figure object
+    plt.Axes
+        A list of all the axes objects owned by the figure
+    """
+    fig = plt.figure(figsize = (columns*3.37, rows*2.08277))
+    axes = [None]*rows*columns
+    for c in range(columns):
+        for r in range(rows):
+            index = r*columns + c
+            left = (0.2)/columns + c/columns
+            bottom = (0.2)/rows + (rows-1-r)/rows # Start at the top
+            width = 0.75/columns
+            height = 0.75/rows
+            axes[index]  = fig.add_axes([left, bottom, width, height])
+
+    return fig, axes
+