[cig-commits] [commit] doc_updates: Tweaked introductory passages in __init__.py (9b7ce0f)

[cig_noreply at geodynamics.org]

Repository : https://github.com/geodynamics/burnman

On branch  : doc_updates
Link       : https://github.com/geodynamics/burnman/compare/da2c9928f27263004daabdc2f9a719f2649fec85...9b7ce0f17f79987ee83b012ce865fdea0c670a30

>---------------------------------------------------------------

commit 9b7ce0f17f79987ee83b012ce865fdea0c670a30
Author: Bob Myhill <myhill.bob at gmail.com>
Date:   Mon Dec 29 20:00:49 2014 +0000

    Tweaked introductory passages in __init__.py


>---------------------------------------------------------------

9b7ce0f17f79987ee83b012ce865fdea0c670a30
 burnman/__init__.py | 18 ++++++++++--------
 1 file changed, 10 insertions(+), 8 deletions(-)

diff --git a/burnman/__init__.py b/burnman/__init__.py
index b8b10bc..74862b4 100644
--- a/burnman/__init__.py
+++ b/burnman/__init__.py
@@ -6,11 +6,14 @@
 =======
 
 BurnMan is an open source mineral physics toolbox written in Python which
-determines seismic velocities of mineral assemblages. BurnMan calculates the
-isotropic thermoelastic moduli by solving the equations-of-state for a
-mixture of minerals defined by the user. The user may select from an extensive 
-list of minerals obtained from published databases. Alternatively, they can 
-easily define their own minerals.
+determines the velocities of seismic waves in mineral assemblages at 
+high pressure and temperature. It was designed to calculate seismic 
+velocities in the lower mantle, but is equally suited to any part 
+of the solid Earth (or indeed any of the terrestrial planets). 
+BurnMan calculates the isotropic thermoelastic moduli by solving the 
+equations-of-state for a mixture of minerals defined by the user. The user 
+may select from an extensive list of minerals obtained from published 
+databases. Alternatively, they can easily define their own minerals.
 
 Features:
 
@@ -21,9 +24,8 @@ Features:
   - extensive :doc:`mineral_database`
   - easy plotting and comparison of seismic profiles using matplotlib
   - many examples highlighting different features of BurnMan
-  - 
-  - different averaging schemes
-  - different geotherms
+  - different averaging schemes for seismic velocities in composite materials
+  - a catalogue of published geotherms
   - extensible: all parts can be replaced by user-written modules if desired
 
 Please cite: