[cig-commits] [commit] doc_updates: Slight reorganization (8643314)
cig_noreply at geodynamics.org
cig_noreply at geodynamics.org
Tue Dec 30 17:05:17 PST 2014
Repository : https://github.com/geodynamics/burnman
On branch : doc_updates
Link : https://github.com/geodynamics/burnman/compare/cf7932b4f8f614aadcab607f27b465eed7c47594...a41c029377e68165d090c9727dd8df9f74d4e819
>---------------------------------------------------------------
commit 86433147fd12a96b2f16b1610b61c7923c6acef6
Author: ian-r-rose <ian.r.rose at gmail.com>
Date: Tue Dec 30 17:03:30 2014 -0800
Slight reorganization
>---------------------------------------------------------------
86433147fd12a96b2f16b1610b61c7923c6acef6
sphinx/materials.rst | 16 ++++------------
sphinx/thermodynamics.rst | 16 +++++++++-------
2 files changed, 13 insertions(+), 19 deletions(-)
diff --git a/sphinx/materials.rst b/sphinx/materials.rst
index 7de70c7..1a8a422 100644
--- a/sphinx/materials.rst
+++ b/sphinx/materials.rst
@@ -11,19 +11,11 @@ Burnman operates on materials (type :class:`~burnman.material.Material`) most pr
.. inheritance-diagram:: burnman.Material burnman.Composite burnman.Mineral burnman.solutionmodel.SolutionModel burnman.solidsolution.SolidSolution burnman.mineral_helpers.HelperSpinTransition
-Base Classes
-------------
-
-Materials
-^^^^^^^^^
+Material Base Class
+-------------------
.. autoclass:: burnman.material.Material
-Solution models
-^^^^^^^^^^^^^^^
-
-.. autoclass:: burnman.solutionmodel.SolutionModel
-
Minerals
--------
@@ -38,8 +30,8 @@ Solid solutions
.. autoclass:: burnman.solidsolution.SolidSolution
-Solid solution helpers (deprecated)
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Mineral helpers
+^^^^^^^^^^^^^^^
.. autoclass:: burnman.mineral_helpers.HelperSpinTransition
diff --git a/sphinx/thermodynamics.rst b/sphinx/thermodynamics.rst
index 79e4b48..88e8156 100644
--- a/sphinx/thermodynamics.rst
+++ b/sphinx/thermodynamics.rst
@@ -2,11 +2,16 @@
Thermodynamics
==============
-Burnman has a number of functions which deal with the thermodynamics of single phases and aggregates.
+Burnman has a number of functions and classes which deal with the thermodynamics of single phases and aggregates.
+Solution models
+---------------
-Chemistry processing
---------------------
+.. autoclass:: burnman.solutionmodel.SolutionModel
+
+
+Chemistry parsing
+-----------------
.. autofunction:: burnman.processchemistry.read_masses
.. autofunction:: burnman.processchemistry.dictionarize_formula
@@ -17,11 +22,8 @@ Chemistry processing
.. autofunction:: burnman.processchemistry.ordered_compositional_array
-Thermodynamics
---------------
-
Chemical potentials
-^^^^^^^^^^^^^^^^^^^
+-------------------
.. autofunction:: burnman.chemicalpotentials.chemical_potentials
.. autofunction:: burnman.chemicalpotentials.fugacity
More information about the CIG-COMMITS
mailing list