CoolProp package#

Subpackages#

Submodules#

Module contents#

Package init for the nanobind-based CoolProp build (COOLPROP_NANOBIND=ON).

This mirrors the legacy (Cython) CoolProp/__init__.py surface verbatim so the v8 package presents the same import tree: CoolProp.CoolProp is the nanobind core (it also exports the _capi PyCapsule used by the State shim), CoolProp.HumidAirProp is a thin SI re-export shim, CoolProp.State is the capsule shim, and the pure-Python submodules (Plots, BibtexParser, GUI, tests) are shipped unchanged. Keep this in lock-step with the legacy __init__.py (see bd CoolProp-r9sq.3, the import-tree parity gate).

CoolProp.copy_BibTeX_library(file=None, folder=None)#

Copy the CoolProp BibTeX library file to the file given by file, or the folder given by folder

If no inputs are provided, the file will be copied to the current working directory

Parameters:

  • file (string) – Provide if you want to put the file into a given file

  • folder (string) – Provide if you want to put the CoolPropBibTeXLibrary.bib file into the given folder

CoolProp.get(s)#

This is just a shorthand function for getting a parameter from CoolProp.get_global_param_string

CoolProp.get_include_directory()#

Get the include directory for CoolProp header files that are needed if you want to compile anything else that uses the CoolProp Cython extension type

Returns:

include_directory

Return type:

The path to the include folder for CoolProp

CoolProp.test()#

Run the tests in the test folder