[cig-commits] [commit] doc_updates: Updated introductory passages in __init__.py (da2c992)

cig_noreply at geodynamics.org cig_noreply at geodynamics.org
Mon Dec 29 11:53:12 PST 2014


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

On branch  : doc_updates
Link       : https://github.com/geodynamics/burnman/compare/657fe724b1cc67999b292c37beaf7ff3a67adc0e...da2c9928f27263004daabdc2f9a719f2649fec85

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

commit da2c9928f27263004daabdc2f9a719f2649fec85
Author: Bob Myhill <myhill.bob at gmail.com>
Date:   Mon Dec 29 19:52:52 2014 +0000

    Updated introductory passages in __init__.py


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

da2c9928f27263004daabdc2f9a719f2649fec85
 burnman/__init__.py | 13 ++++++++-----
 1 file changed, 8 insertions(+), 5 deletions(-)

diff --git a/burnman/__init__.py b/burnman/__init__.py
index b1980d9..b8b10bc 100644
--- a/burnman/__init__.py
+++ b/burnman/__init__.py
@@ -6,19 +6,22 @@
 =======
 
 BurnMan is an open source mineral physics toolbox written in Python which
-determines seismic velocities for the lower mantle. BurnMan calculates the
+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 a list of
-minerals applicable to the lower mantle included or easily define one of
-their own.
+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:
 
+  - a range of thermoelastic models, choice between second or third order accuracy
+  - a range of thermodynamic models for mineral endmembers
+  - consistent, comprehensive treatment of minerals with solid solutions
   - form composites of arbitrary combination of :doc:`minerals`
   - extensive :doc:`mineral_database`
   - easy plotting and comparison of seismic profiles using matplotlib
   - many examples highlighting different features of BurnMan
-  - different thermoelastic models, choice between second or third order accuracy
+  - 
   - different averaging schemes
   - different geotherms
   - extensible: all parts can be replaced by user-written modules if desired



More information about the CIG-COMMITS mailing list