Merge pull request #609 from geodynamics/burnman-2.0

Burnman 2.0

Readme.md

@@ -1,4 +1,4 @@
-[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.8104293.svg)](https://doi.org/10.5281/zenodo.8104293)
+[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.14165625.svg)](https://doi.org/10.5281/zenodo.14165625)
 [![DOI](https://joss.theoj.org/papers/10.21105/joss.05389/status.svg)](https://doi.org/10.21105/joss.05389)
 
 # BurnMan - a Python toolkit for planetary geophysics, geochemistry and thermodynamics
@@ -21,14 +21,15 @@ Source code: https://github.com/geodynamics/burnman
 
 Forums: https://community.geodynamics.org/c/burnman
 
-Authors (as of 2023):
+Authors (as of 2024):
 * Bob (Robert) Myhill (main contributor)
 * Cayman Unterborn
 * Ian Rose
 * Sanne Cottaar
 * Timo Heister
 * Juliane Dannberg
 * Rene Gassmoeller
+* Robert Farla
 
 ## Citing BurnMan
 
@@ -39,9 +40,10 @@ If you use BurnMan in your work, we ask that you cite the following publications
     planetary geophysics, geochemistry and thermodynamics. Journal of Open Source Software.
     https://doi.org/10.21105/joss.05389
 
-  - Myhill, R., Cottaar, S., Heister, T., Rose, I., and Unterborn, C. (2023):
-    BurnMan v1.2.0 [Software]. Computational Infrastructure for Geodynamics. Zenodo.
-    https://doi.org/10.5281/zenodo.8104293
+  - Myhill, R., Cottaar, S., Heister, T., Rose, I., Unterborn, C.,
+    Dannberg, J., Gassmoeller, R. and Farla, R. (2024):
+    BurnMan v2.0.0 [Software]. Computational Infrastructure for Geodynamics. Zenodo.
+    https://doi.org/10.5281/zenodo.14165625
 
   - Cottaar S., Heister, T., Rose, I., and Unterborn, C., (2014). BurnMan: A
     lower mantle mineral physics toolkit, Geochemistry, Geophysics, and

burnman/__init__.py

@@ -177,9 +177,10 @@
     planetary geophysics, geochemistry and thermodynamics. Journal of Open Source Software.
     `(https://doi.org/10.21105/joss.05389) <https://doi.org/10.21105/joss.05389>`_
 
-  - Myhill, R., Cottaar, S., Heister, T., Rose, I., and Unterborn, C. (2023):
-    BurnMan v1.2.0 [Software]. Computational Infrastructure for Geodynamics. Zenodo.
-    `(https://doi.org/10.5281/zenodo.8104293) <https://doi.org/10.5281/zenodo.8104293>`_
+  - Myhill, R., Cottaar, S., Heister, T., Rose, I., Unterborn, C.,
+    Dannberg, J., Gassmoeller, R. and Farla, R. (2024):
+    BurnMan v2.0.0 [Software]. Computational Infrastructure for Geodynamics. Zenodo.
+    `(https://doi.org/10.5281/zenodo.14165625) <https://doi.org/10.5281/zenodo.14165625>`_
 
   - Cottaar S., Heister, T., Rose, I., and Unterborn, C., (2014). BurnMan: A
     lower mantle mineral physics toolkit, Geochemistry, Geophysics, and

changelog.txt

@@ -1,5 +1,23 @@
 Changelog
 ---------
+Release v2.0.0 (November 14, 2024) includes
+  - Compatibility with Python 3.12.
+  - Compatibility with new versions of numpy (1.26.0), scipy (1.14.0),
+    cvxpy (1.6.0), pycddlib (3.0.0), matplotlib (3.9.0).
+  - New: The evaluate method now allows users to specify different compositions
+    as well as pressures and temperatures.
+  - New: Non-orthotropic anisotropy in AnisotropicMaterial.
+  - New: Addition of an AnisotropicSolution class.
+  - New: Addition of a RelaxedSolution class, that calculates second derivatives
+    while allowing isochemical variables to change to minimise the
+    thermodynamic potential.
+  - New: The Stixrude and Lithgow-Bertelloni (2024) dataset.
+  - New: The Holland, Green and Powell (2018) solution models.
+  - New: A large range of published pressure calibrants (many thanks to Robert Farla).
+  - Fix: The generic PolynomialSolution model now has correct second derivatives.
+  - Improved: Consistent naming of isentropic properties (rather than adiabatic).
+  - Improved: Explicit specification of Reuss (isostress) properties.
+
 Release v1.2.0 (July 1, 2023) includes
   - Two new helper functions:
     :func:`burnman.tools.chemistry.reactions_from_stoichiometric_matrix`

docs/conf.py

@@ -13,6 +13,16 @@
 import os
 import sys
 
+# Define the canonical URL if you are using a custom domain on Read the Docs
+html_baseurl = os.environ.get("READTHEDOCS_CANONICAL_URL", "")
+
+# Tell Jinja2 templates the build is running on Read the Docs
+if os.environ.get("READTHEDOCS", "") == "True":
+    if "html_context" not in globals():
+        html_context = {}
+    html_context["READTHEDOCS"] = True
+
+
 sys.path.insert(0, os.path.abspath(".."))
 sys.path.insert(0, os.path.abspath("../examples"))
 sys.path.insert(0, os.path.abspath("../tutorial"))
@@ -33,8 +43,8 @@
 author = "Robert Myhill, Sanne Cottaar, Timo Heister, Ian Rose, Cayman Unterborn"
 
 # The short X.Y version.
-v = burnman.__version__.split('.')
-version = f'{v[0]}.{v[1]}'
+v = burnman.__version__.split(".")
+version = f"{v[0]}.{v[1]}"
 # The full version, including alpha/beta/rc tags
 release = burnman.__version__
 
@@ -307,4 +317,4 @@
 # texinfo_show_urls = 'footnote'
 
 # Example configuration for intersphinx: refer to the Python standard library.
-intersphinx_mapping = {"http://docs.python.org/": None}
+intersphinx_mapping = {'python': ('https://docs.python.org/3', None)}

docs/index.rst

@@ -33,9 +33,10 @@ If you use BurnMan in your work, we ask that you cite the following publications
    planetary geophysics, geochemistry and thermodynamics. Journal of Open Source Software.
    `(https://doi.org/10.21105/joss.05389) <https://doi.org/10.21105/joss.05389>`_
 
- - Myhill, R., Cottaar, S., Heister, T., Rose, I., and Unterborn, C. (2023):
-   BurnMan v1.2 [Software]. Computational Infrastructure for Geodynamics. Zenodo.
-   `(https://doi.org/10.5281/zenodo.8104293) <https://doi.org/10.5281/zenodo.8104293>`_
+ - Myhill, R., Cottaar, S., Heister, T., Rose, I., Unterborn, C.,
+   Dannberg, J., Gassmoeller, R. and Farla, R. (2024):
+   BurnMan v2.0.0 [Software]. Computational Infrastructure for Geodynamics. Zenodo.
+   `(https://doi.org/10.5281/zenodo.14165625) <https://doi.org/10.5281/zenodo.14165625>`_
 
  - Cottaar S., Heister, T., Rose, I., and Unterborn, C. (2014). BurnMan: A
    lower mantle mineral physics toolkit, Geochemistry, Geophysics, and

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "burnman"
-version = "1.3.0a0"
+version = "2.0.1a0"
 description = "A thermoelastic and thermodynamic toolkit for the Earth and planetary sciences"
 license = "GPL"
 authors = ["The BurnMan Team <[email protected]>",]