update script and readme

- improved stereoplot function
- update readme with new syntax

Author: marcoalopez

JASPE.py

@@ -40,29 +40,23 @@
 import pandas as pd
 import os
 
-# Example
-# fig, (ax1, ax2) = stereoplot(number=2, nrows=1, ncols=2)
-# fig, (ax1, ax2, ax3) = stereoplot(number=3, nrows=3, ncols=1)
+# Examples
+# fig, ax = stereoplot()
+# fig, (ax1, ax2) = stereoplot(nrows=1, ncols=2)
+# fig, (ax1, ax2, ax3, ax4) = stereoplot(nrows=2, ncols=2)
 
 
-def stereoplot(number=1, nrows=1, ncols=1):
+def stereoplot(nrows=1, ncols=1):
     """Automatically generate a defined number of stereoplots (between 1 and 5)
     using the matplotlib library
 
     Parameters
     ----------
-    form: integer between 1 and 5
-        the number of stereos, up to 5
-
     nrows: integer
         the number of rows of the subplot grid
 
     ncols: integer
-       the number of columns of the subplot grid
-
-    Assumptions
-    -----------
-    - nrows * ncols must be equal to the number of stereos
+        the number of columns of the subplot grid
 
     Call functions
     --------------
@@ -72,12 +66,9 @@ def stereoplot(number=1, nrows=1, ncols=1):
     ------
     TODO
     """
+    num_plots = nrows * ncols
 
-    if nrows * ncols != number:
-        print('nrows times ncols must be equal to the number of stereos!')
-        return None
-
-    if number == 1:
+    if num_plots == 1:
         fig, ax = plt.subplots()
         set_stereo(ax)
         fig.tight_layout()
@@ -89,7 +80,7 @@ def stereoplot(number=1, nrows=1, ncols=1):
             fig, ax = plt.subplots(nrows=nrows, ncols=ncols, sharey=True)
         elif ncols == 1:
             fig, ax = plt.subplots(nrows=nrows, ncols=ncols, sharex=True)
-        else:  # not yet implemented
+        else:
             fig, ax = plt.subplots(nrows=nrows, ncols=ncols)
 
         for item in fig.axes:

README.md

@@ -9,12 +9,8 @@ So far, the script only performs very basic tasks. One function tweaks the defau
 ## Quick examples
 
 ```python
-# Create a simple figure
-fig, ax = plt.subplots()
-
-# set the plot
-set_stereo(ax)  # set the stereo
-fig.tight_layout()  # assure a tight layout
+# Create a simple stereoplot
+fig, ax = stereoplot()
 
 # Plot some data using the function plot_data
 plot_data(180, 45, ax)  # by default this is an equal-area projection
@@ -23,21 +19,15 @@ plot_data(180, 45, ax, form='angle')  # plot in equal-angle projection
 ![](https://raw.githubusercontent.com/marcoalopez/JASPE/master/figs/one_plot.png)
 
 ```python
-# Create a figure with two stereos using matplotlib [oo] syntax
-fig, (ax1, ax2) = plt.subplots(nrows=1, ncols=2, sharey=True)
-
-# set the plots
-set_stereo(ax1)
-set_stereo(ax2)
-fig.tight_layout()
+# Create a figure with two stereos (1 row * 2 columns)
+fig, (ax1, ax2) = stereoplot(nrows=1, ncols=2)
 
 # plot linear data in the first stereo (ax1)
 azimuths = [0, 45, 90, 135, 180, 225, 270, 315, 360]
 dips = [0, 10, 20, 30, 40, 50, 70, 80, 90]
 plot_data(azimuths, dips, ax1)
 
 # plot linear data from a txt file in the second stereo (ax2)
-
 ## import tabular-like data from text files. The function will ask you for
 ## the location of the file through a file selection dialog
 dataset = import_data()