[Python] Add utility to query HDF support

Cantera · Jan 12, 2023 · 240f9bb · 240f9bb
1 parent 0d79adb
commit 240f9bb
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 0 deletions.
diff --git a/interfaces/cython/cantera/_utils.pxd b/interfaces/cython/cantera/_utils.pxd
@@ -72,6 +72,7 @@ cdef extern from "cantera/base/global.h" namespace "Cantera":
     cdef void Cxx_suppress_thermo_warnings "Cantera::suppress_thermo_warnings" (cbool)
     cdef void Cxx_use_legacy_rate_constants "Cantera::use_legacy_rate_constants" (cbool)
     cdef string CxxGitCommit "Cantera::gitCommit" ()
+    cdef cbool CxxUsesHighFive "Cantera::usesHighFive" ()
     cdef cbool CxxDebugModeEnabled "Cantera::debugModeEnabled" ()
 
 

diff --git a/interfaces/cython/cantera/_utils.pyx b/interfaces/cython/cantera/_utils.pyx
@@ -93,6 +93,23 @@ def use_legacy_rate_constants(pybool legacy):
     """
     Cxx_use_legacy_rate_constants(legacy)
 
+def hdf_support():
+    """
+    Returns list of libraries that include HDF support:
+    - 'h5py': HDF support by Python package 'h5py'.
+    - 'HighFive': if Cantera was compiled with C++ HighFive HDF support.
+    """
+    out = []
+    try:
+        pkg_resources.get_distribution("h5py")
+    except pkg_resources.DistributionNotFound:
+        pass
+    else:
+        out.append("h5py")
+    if CxxUsesHighFive():
+        out.append("HighFive")
+    return set(out)
+
 cdef Composition comp_map(X) except *:
     if isinstance(X, (str, bytes)):
         return parseCompString(stringify(X))