[cig-commits] [commit] doc_updates: Merge branch 'master' into doc_updates (b439f5f)

[cig_noreply at geodynamics.org]

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

On branch  : doc_updates
Link       : https://github.com/geodynamics/burnman/compare/1ab7a08f00ad7f036053013a7b7b187b06456c48...b439f5f5fcf04d4f28d9624d36e073094ce1d3f0

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

commit b439f5f5fcf04d4f28d9624d36e073094ce1d3f0
Merge: 1ab7a08 ed52c21
Author: Ian Rose <ian.r.rose at gmail.com>
Date:   Mon Jan 5 10:35:31 2015 -0800

    Merge branch 'master' into doc_updates
    
    Conflicts:
    	burnman/mineral.py



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

b439f5f5fcf04d4f28d9624d36e073094ce1d3f0
 burnman/chemicalpotentials.py                      |  14 +-
 .../HHPH2013data_to_burnman.py                     |   2 +-
 .../HPdata_to_burnman.py                           |   2 +-
 burnman/eos/__init__.py                            |   1 +
 burnman/eos/helper.py                              |   5 +-
 burnman/eos/{modified_tait.py => hp.py}            |  89 ++---
 burnman/eos/mie_grueneisen_debye.py                |   6 +-
 burnman/eos/modified_tait.py                       | 351 ++++--------------
 burnman/eos/slb.py                                 |   4 +-
 burnman/mineral.py                                 |  14 +-
 burnman/minerals/HHPH_2013.py                      |  86 ++---
 burnman/minerals/HP_2011_ds62.py                   | 408 ++++++++++-----------
 burnman/solidsolution.py                           |  11 +
 burnman/solutionmodel.py                           |  60 ++-
 examples/example_chemical_potentials.py            | 195 ++++++++++
 examples/example_solid_solution.py                 | 219 +++++++++++
 misc/benchmarks/chemical_potential_benchmarks.py   |  16 +-
 misc/benchmarks/endmember_benchmarks.py            |  33 +-
 misc/paper_onefit.py                               |   2 +-
 misc/ref/endmember_benchmarks.py.out               |  39 +-
 misc/ref/example_chemical_potentials.py.out        |   3 +
 misc/ref/example_compare_all_methods.py.out        |   8 +-
 misc/ref/example_fit_data.py.out                   |   4 +-
 ...chmark.py.out => example_solid_solution.py.out} |   0
 misc/ref/paper_fit_data.py.out                     |   4 +-
 misc/table.py                                      |   2 +-
 sphinx/examples.rst                                |  23 +-
 sphinx/figures/example_fO2.png                     | Bin 0 -> 52448 bytes
 sphinx/figures/example_solid_solution_1.png        | Bin 0 -> 49563 bytes
 sphinx/figures/example_solid_solution_2.png        | Bin 0 -> 67683 bytes
 sphinx/figures/example_solid_solution_3.png        | Bin 0 -> 47309 bytes
 sphinx/figures/example_solid_solution_4.png        | Bin 0 -> 67497 bytes
 tests/test_endmembers.py                           |  73 ++++
 tests/test_eos.py                                  |  89 +++++
 tests/test_solidsolution.py                        |  16 +-
 tests/tests.py                                     |   1 +
 todo.txt                                           |  75 ++--
 37 files changed, 1186 insertions(+), 669 deletions(-)

diff --cc burnman/solutionmodel.py
index ac113db,896d55f..dca5a90
--- a/burnman/solutionmodel.py
+++ b/burnman/solutionmodel.py
@@@ -18,15 -18,13 +18,15 @@@ class SolutionModel(object)
      """
      This is the base class for a solution model,  intended for use
      in defining solid solutions and performing thermodynamic calculations
 -    on them.
 +    on them.  All minerals of type :class:`burnman.SolidSolution` use 
 +    a solution model for defining how the endmembers in the solid solution 
 +    interact.
  
-     A user wanting a new solution model should define the functions for
-     excess_gibbs_free_energy and excess_volume.  In the base class these
-     return zero, so if this class is used then the Gibbs free energy and molar
-     volume of a solution are just the weighted arithmetic averages of the
-     different endmember values.
+     A user wanting a new solution model should define the functions below.
+     In the base class all of these return zero, so if the solution model 
+     does not implement them, they essentially have no effect, and 
+     then the Gibbs free energy and molar volume of a solid solution are 
+     just the weighted arithmetic averages of the different endmember values.
      """
  
      def __init__(self):