update doc & fig

JASPE.py

@@ -2,7 +2,7 @@
 # ============================================================================ #
 #                                                                              #
 #    JASPE script                                                              #
-#    JASPE stands for Just Another Stereoplot Python Environment               #
+#    JASPE stands for Just Another Stereoplot (in a) Python Environment        #
 #                                                                              #
 #    Copyright (c) 2017-present   Marco A. Lopez-Sanchez                       #
 #                                                                              #

README.md

@@ -1,35 +1,43 @@
 # JASPE
 
-**JASPE** stands for **J**ust **A**nother **S**tereoplot<sup>1</sup> **P**ython **E**nvironment. This is a pet project that I develop at my own pace and according to my needs. The script is therefore not primarily intended for general use but my own. You should not expect updates, new features, or bug fixes in reasonable times, nor can I assure you that the project will be abandoned for a large period of time. My main goal with this is to include stereographic/equal-area projections in my Python workflow and learn. If you are looking for a software specifically dedicated to this task there are other options out there, for example [here](http://www.geo.cornell.edu/geology/faculty/RWA/programs/stereonet.html), [here](http://www.frederickvollmer.com/orient/), or [here](http://www.igc.usp.br/index.php?id=openstereo). In any case, if you decide to use it or want to access the source code out of curiosity, do so at your own risk and responsibility downloading the script [here](https://github.com/marcoalopez/JASPE/releases). You can also fork the project on GitHub since it is free and open-source.
+**JASPE** stands for **J**ust **A**nother **S**tereoplot*§* **P**ython **E**nvironment. This is a pet project that I develop at my own pace and according to my needs. The script is therefore not primarily intended for general use but my own. You should not expect updates, new features, or bug fixes in reasonable times, nor can I assure you that the project will be abandoned for a large period of time. My main goal with this is to include stereographic/equal-area projections in my Python workflow and learn. If you are looking for a software specifically dedicated to this task there are other options out there, for example [here](http://www.geo.cornell.edu/geology/faculty/RWA/programs/stereonet.html), [here](http://www.frederickvollmer.com/orient/), or [here](http://www.igc.usp.br/index.php?id=openstereo). In any case, if you decide to use it or want to access the source code out of curiosity, do so at your own risk and responsibility downloading the script [here](https://github.com/marcoalopez/JASPE/releases). You can also fork the project on GitHub since it is free and open-source.
 
-So far, the script only performs very basic tasks. One function tweaks the default features of matplotlib plots (i.e. the  standard Python plotting library) to generate single or multiple stereoplots, another is for importing tabular-like data, and the rest to transform between different reference frames; from spherical to equal-area or stereographic (equal-angle) coordinates or from spherical to cartesian coordinates and vice versa.
+So far, the script only performs basic tasks. One function tweaks the default features of matplotlib plots (i.e. the  standard Python plotting library) to generate single or multiple stereoplots, another is for importing tabular-like data, and the rest to transform between different reference frames; from spherical to equal-area or stereographic (equal-angle) coordinates or from spherical to cartesian coordinates and vice versa.
 
->  <sup>1</sup>*As stated above, the JASPE script is intended to produce both stereographic (Wulff) and equal-area (a.k.a. Schmidt net or Lambert azimuthal) projections. I chose the word **stereoplot** because is very familiar in geosciences and used by geoscientists to refer, somewhat loosely, to both projections. Strictly speaking, the equal-area projection is not a stereographic projection. So if you feel picky, exchange the word **Stereoplot** for **Schmidt net** and the acronym JASPE will remain the same.*
+>  *§ As stated above, the JASPE script is intended to produce both stereographic (Wulff) and equal-area (a.k.a. Schmidt net or Lambert azimuthal) projections. I chose the word **stereoplot** because is very familiar in geosciences and used by geoscientists to refer, somewhat loosely, to both projections. Strictly speaking, the equal-area projection is not a stereographic projection. So if you feel picky, exchange the word **Stereoplot** for **Schmidt net plot** and the acronym JASPE will remain the same.*
 
-## Quick examples
+## Requirements
 
+The script requires Python 3.5 or higher and the scientific libraries Numpy (1.11 or higher), Matplotlib (2.0 or higher) and Pandas. For this, we recommend installing the [Continuum Anaconda](https://store.continuum.io/cshop/anaconda/) or the [Enthought Canopy](https://www.enthought.com/products/canopy/) and use the Spyder or Canopy IDEs respectively.
+
+## Quick examples (v0.3 or higher)
+
+### Plot data
 ```python
 # 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
-plot_data(180, 45, ax, form='angle')  # plot in equal-angle projection
+plot_eq_area(ax, 180, 45)  # plot in equal-area projection
+plot_eq_angle(ax, 180, 45)  # plot in equal-angle projection
 ```
-![](https://raw.githubusercontent.com/marcoalopez/JASPE/master/figs/one_plot.png)
+![](https://raw.githubusercontent.com/marcoalopez/JASPE/master/figs/JASPE_Fig_1.png)
 
+### Plot a small dataset defining the features of the markers
 ```python
-# 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)
+# Create dataset
 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
+# plot
+fig, ax = stereoplot()  # create plot
+plot_eq_area(ax, azimuths, dips, marker='h', color='C3', markersize=9)
+```
+![](https://raw.githubusercontent.com/marcoalopez/JASPE/master/figs/JASPE_Fig_2.png)
+
+### Import tabular-like data from a text file and plot them
+```python
+# Import data. The function will ask you for the location of the file through a file selection dialog
 dataset = import_data()  
 
 Trend  Plunge Type
@@ -46,14 +54,20 @@ Trend  Plunge Type
 110  352.0    26.0    C
 111  355.0    24.0    C
 
-## This time we will use matplotlib syntax instead of using the plot_data funtion
-## (this is the way to go if you want to control all the figure aesthetics)
+plot_eq_area(ax, dataset['Trend'], dataset['Plunge'], marker='o', markersize=8, label='Kamb (1959) data')
+ax.legend()  # add legend
+```
+![](https://raw.githubusercontent.com/marcoalopez/JASPE/master/figs/JASPE_Fig_3.png)
+
+### Create plots with multiple stereos
+```python
+# Create a figure with two stereos (1 row * 2 columns)
+fig, (ax1, ax2) = stereoplot(nrows=1, ncols=2)
 
-### Transform from spherical coordinates to equal-area coordinates
-azimuths, dips = sph_to_eq_area(dataset['Trend'], dataset['Plunge'])
+# plot linear data in the left (ax1) stereo
+plot_eq_area(ax1, azimuths, dips)
 
-### Second, plot using matplotlib syntax
-ax2.plot(azimuths, dips, 'h', color='C3', markersize=9, label='Kamb (1959) data')
-ax2.legend()  # add legend
+# plot Kamb data in the right (ax2) stereo
+plot_eq_area(ax2, dataset['Trend'], dataset['Plunge'], color='C3')
 ```
-![](https://raw.githubusercontent.com/marcoalopez/JASPE/master/figs/example.png)
+![](https://raw.githubusercontent.com/marcoalopez/JASPE/master/figs/JASPE_Fig_4.png)