CoolProp package

Subpackages

• CoolProp.GUI package
  • Submodules
    • CoolProp.GUI.CoolPropGUI module
    • CoolProp.GUI.PsychScript module
  • Module contents
• CoolProp.Plots package
  • Submodules
    • CoolProp.Plots.Common module
      • Base2DObject
      • BaseDimension
      • BasePlot
      • BaseQuantity
      • EURunits
      • IsoLine
      • KSIunits
      • PropertyDict
      • SIunits
      • get_critical_point()
      • interpolate_values_1d()
      • is_string()
      • process_fluid_state()
    • CoolProp.Plots.ConsistencyPlots module
      • ConsistencyAxis
      • ConsistencyFigure
      • myprint()
      • split_pair()
      • split_pair_xy()
    • CoolProp.Plots.ConsistencyPlots_pcsaft module
      • ConsistencyAxis
      • ConsistencyFigure
      • myprint()
      • split_pair()
      • split_pair_xy()
    • CoolProp.Plots.Plots module
      • InlineLabel()
      • PropertyPlot
      • PropsPlot
    • CoolProp.Plots.PsychChart module
      • EnthalpyLines
      • HumidityLabels
      • HumidityLines
      • PlotFormatting
      • SaturationLine
      • indented_segment()
    • CoolProp.Plots.PsychScript module
    • CoolProp.Plots.SimpleCycles module
      • BaseCycle
      • EconomizedCycle()
      • SimpleCycle()
      • StateContainer
      • StatePoint
      • TwoStage()
    • CoolProp.Plots.SimpleCyclesCompression module
      • BaseCompressionCycle
      • SimpleCompressionCycle
    • CoolProp.Plots.SimpleCyclesExpansion module
      • BasePowerCycle
      • SimpleRankineCycle
    • CoolProp.Plots.Tests module
      • main()
    • CoolProp.Plots.psy module
  • Module contents
• CoolProp.tests package
  • Submodules
    • CoolProp.tests.runner module
      • run()
    • CoolProp.tests.test_CoolPropState module
      • check_1phase_first_derivatives()
      • check_sat_first_derivatives()
      • check_sat_second_derivatives()
      • first_derivative()
      • second_derivative()
      • teest_1phase_first_derivatives()
      • teest_sat_first_derivatives()
      • teest_sat_second_derivatives()
    • CoolProp.tests.test_Props module
      • PropsFailures
      • check_type()
      • test_input_types()
    • CoolProp.tests.test_plots module
      • test_back_compatibility()
      • test_new_code()
  • Module contents

Submodules

• CoolProp.AbstractState module
  • Bvirial()
  • Cvirial()
  • PIP()
  • Prandtl()
  • Q()
  • T()
  • T_critical()
  • T_reducing()
  • Tmax()
  • Tmin()
  • Ttriple()
  • acentric_factor()
  • all_critical_points()
  • alpha0()
  • alphar()
  • apply_simple_mixing_rule()
  • backend_name()
  • build_phase_envelope()
  • build_spinodal()
  • change_EOS()
  • chemical_potential()
  • compressibility_factor()
  • conductivity()
  • conductivity_contributions()
  • conformal_state()
  • cp0mass()
  • cp0molar()
  • cpmass()
  • cpmolar()
  • criticality_contour_values()
  • cvmass()
  • cvmolar()
  • d2alpha0_dDelta2()
  • d2alpha0_dDelta_dTau()
  • d2alpha0_dTau2()
  • d2alphar_dDelta2()
  • d2alphar_dDelta_dTau()
  • d2alphar_dTau2()
  • d3alpha0_dDelta2_dTau()
  • d3alpha0_dDelta3()
  • d3alpha0_dDelta_dTau2()
  • d3alpha0_dTau3()
  • d3alphar_dDelta2_dTau()
  • d3alphar_dDelta3()
  • d3alphar_dDelta_dTau2()
  • d3alphar_dTau3()
  • d4alphar_dDelta2_dTau2()
  • d4alphar_dDelta3_dTau()
  • d4alphar_dDelta4()
  • d4alphar_dDelta_dTau3()
  • d4alphar_dTau4()
  • dalpha0_dDelta()
  • dalpha0_dTau()
  • dalphar_dDelta()
  • dalphar_dTau()
  • delta()
  • first_partial_deriv()
  • first_saturation_deriv()
  • first_two_phase_deriv()
  • first_two_phase_deriv_splined()
  • fluid_names()
  • fluid_param_string()
  • fugacity()
  • fugacity_coefficient()
  • fundamental_derivative_of_gas_dynamics()
  • gas_constant()
  • get_binary_interaction_string()
  • get_fluid_constant()
  • get_fluid_parameter_double()
  • get_mass_fractions()
  • get_mole_fractions()
  • get_phase_envelope_data()
  • get_spinodal_data()
  • gibbsmass()
  • gibbsmass_excess()
  • gibbsmolar()
  • gibbsmolar_excess()
  • gibbsmolar_residual()
  • has_melting_line()
  • helmholtzmass()
  • helmholtzmass_excess()
  • helmholtzmolar()
  • helmholtzmolar_excess()
  • hmass()
  • hmass_excess()
  • hmolar()
  • hmolar_excess()
  • hmolar_residual()
  • ideal_curve()
  • isobaric_expansion_coefficient()
  • isothermal_compressibility()
  • keyed_output()
  • melting_line()
  • molar_mass()
  • mole_fractions_liquid()
  • mole_fractions_vapor()
  • name()
  • p()
  • p_critical()
  • phase()
  • pmax()
  • rhomass()
  • rhomass_critical()
  • rhomass_reducing()
  • rhomolar()
  • rhomolar_critical()
  • rhomolar_reducing()
  • saturated_liquid_keyed_output()
  • saturated_vapor_keyed_output()
  • saturation_ancillary()
  • second_partial_deriv()
  • second_saturation_deriv()
  • second_two_phase_deriv()
  • set_fluid_parameter_double()
  • set_mass_fractions()
  • set_mole_fractions()
  • set_volu_fractions()
  • smass()
  • smass_excess()
  • smolar()
  • smolar_excess()
  • smolar_residual()
  • specify_phase()
  • speed_sound()
  • surface_tension()
  • tangent_plane_distance()
  • tau()
  • trivial_keyed_output()
  • true_critical_point()
  • umass()
  • umass_excess()
  • umolar()
  • umolar_excess()
  • unspecify_phase()
  • update()
  • update_with_guesses()
  • viscosity()
  • viscosity_contributions()
  • volumemass_excess()
  • volumemolar_excess()
• CoolProp.BibtexParser module
  • BibTeXerClass
    • BibTeXerClass.getBibliography()
    • BibTeXerClass.getEntry()
    • BibTeXerClass.loadLibrary()
    • BibTeXerClass.stripCurls()
• CoolProp.CoolProp module
  • AbstractState
    • AbstractState.Bvirial()
    • AbstractState.Cvirial()
    • AbstractState.PIP()
    • AbstractState.Prandtl()
    • AbstractState.Q()
    • AbstractState.T()
    • AbstractState.T_critical()
    • AbstractState.T_reducing()
    • AbstractState.Tmax()
    • AbstractState.Tmin()
    • AbstractState.Ttriple()
    • AbstractState.acentric_factor()
    • AbstractState.all_critical_points()
    • AbstractState.alpha0()
    • AbstractState.alphar()
    • AbstractState.apply_simple_mixing_rule()
    • AbstractState.backend_name()
    • AbstractState.build_phase_envelope()
    • AbstractState.build_spinodal()
    • AbstractState.change_EOS()
    • AbstractState.chemical_potential()
    • AbstractState.compressibility_factor()
    • AbstractState.conductivity()
    • AbstractState.conductivity_contributions()
    • AbstractState.conformal_state()
    • AbstractState.cp0mass()
    • AbstractState.cp0molar()
    • AbstractState.cpmass()
    • AbstractState.cpmolar()
    • AbstractState.criticality_contour_values()
    • AbstractState.cvmass()
    • AbstractState.cvmolar()
    • AbstractState.d2alpha0_dDelta2()
    • AbstractState.d2alpha0_dDelta_dTau()
    • AbstractState.d2alpha0_dTau2()
    • AbstractState.d2alphar_dDelta2()
    • AbstractState.d2alphar_dDelta_dTau()
    • AbstractState.d2alphar_dTau2()
    • AbstractState.d3alpha0_dDelta2_dTau()
    • AbstractState.d3alpha0_dDelta3()
    • AbstractState.d3alpha0_dDelta_dTau2()
    • AbstractState.d3alpha0_dTau3()
    • AbstractState.d3alphar_dDelta2_dTau()
    • AbstractState.d3alphar_dDelta3()
    • AbstractState.d3alphar_dDelta_dTau2()
    • AbstractState.d3alphar_dTau3()
    • AbstractState.d4alphar_dDelta2_dTau2()
    • AbstractState.d4alphar_dDelta3_dTau()
    • AbstractState.d4alphar_dDelta4()
    • AbstractState.d4alphar_dDelta_dTau3()
    • AbstractState.d4alphar_dTau4()
    • AbstractState.dalpha0_dDelta()
    • AbstractState.dalpha0_dTau()
    • AbstractState.dalphar_dDelta()
    • AbstractState.dalphar_dTau()
    • AbstractState.delta()
    • AbstractState.first_partial_deriv()
    • AbstractState.first_saturation_deriv()
    • AbstractState.first_two_phase_deriv()
    • AbstractState.first_two_phase_deriv_splined()
    • AbstractState.fluid_names()
    • AbstractState.fluid_param_string()
    • AbstractState.fugacity()
    • AbstractState.fugacity_coefficient()
    • AbstractState.fundamental_derivative_of_gas_dynamics()
    • AbstractState.gas_constant()
    • AbstractState.get_binary_interaction_double
    • AbstractState.get_binary_interaction_string()
    • AbstractState.get_fluid_constant()
    • AbstractState.get_fluid_parameter_double()
    • AbstractState.get_mass_fractions()
    • AbstractState.get_mole_fractions()
    • AbstractState.get_phase_envelope_data()
    • AbstractState.get_spinodal_data()
    • AbstractState.gibbsmass()
    • AbstractState.gibbsmass_excess()
    • AbstractState.gibbsmolar()
    • AbstractState.gibbsmolar_excess()
    • AbstractState.gibbsmolar_residual()
    • AbstractState.has_melting_line()
    • AbstractState.helmholtzmass()
    • AbstractState.helmholtzmass_excess()
    • AbstractState.helmholtzmolar()
    • AbstractState.helmholtzmolar_excess()
    • AbstractState.hmass()
    • AbstractState.hmass_excess()
    • AbstractState.hmolar()
    • AbstractState.hmolar_excess()
    • AbstractState.hmolar_residual()
    • AbstractState.ideal_curve()
    • AbstractState.isobaric_expansion_coefficient()
    • AbstractState.isothermal_compressibility()
    • AbstractState.keyed_output()
    • AbstractState.melting_line()
    • AbstractState.molar_mass()
    • AbstractState.mole_fractions_liquid()
    • AbstractState.mole_fractions_vapor()
    • AbstractState.name()
    • AbstractState.p()
    • AbstractState.p_critical()
    • AbstractState.phase()
    • AbstractState.pmax()
    • AbstractState.rhomass()
    • AbstractState.rhomass_critical()
    • AbstractState.rhomass_reducing()
    • AbstractState.rhomolar()
    • AbstractState.rhomolar_critical()
    • AbstractState.rhomolar_reducing()
    • AbstractState.saturated_liquid_keyed_output()
    • AbstractState.saturated_vapor_keyed_output()
    • AbstractState.saturation_ancillary()
    • AbstractState.second_partial_deriv()
    • AbstractState.second_saturation_deriv()
    • AbstractState.second_two_phase_deriv()
    • AbstractState.set_binary_interaction_double
    • AbstractState.set_binary_interaction_string
    • AbstractState.set_fluid_parameter_double()
    • AbstractState.set_mass_fractions()
    • AbstractState.set_mole_fractions()
    • AbstractState.set_volu_fractions()
    • AbstractState.smass()
    • AbstractState.smass_excess()
    • AbstractState.smolar()
    • AbstractState.smolar_excess()
    • AbstractState.smolar_residual()
    • AbstractState.specify_phase()
    • AbstractState.speed_sound()
    • AbstractState.surface_tension()
    • AbstractState.tangent_plane_distance()
    • AbstractState.tau()
    • AbstractState.trivial_keyed_output()
    • AbstractState.true_critical_point()
    • AbstractState.umass()
    • AbstractState.umass_excess()
    • AbstractState.umolar()
    • AbstractState.umolar_excess()
    • AbstractState.unspecify_phase()
    • AbstractState.update()
    • AbstractState.update_with_guesses()
    • AbstractState.viscosity()
    • AbstractState.viscosity_contributions()
    • AbstractState.volumemass_excess()
    • AbstractState.volumemolar_excess()
  • FluidsList()
  • HAProps()
  • HAPropsSI()
  • HAProps_Aux()
  • PhaseSI()
  • Props()
  • PropsSI()
  • PyCriticalState
    • PyCriticalState.T
    • PyCriticalState.hmolar
    • PyCriticalState.p
    • PyCriticalState.rhomolar
    • PyCriticalState.smolar
    • PyCriticalState.stable
  • PyGuessesStructure
    • PyGuessesStructure.T
    • PyGuessesStructure.hmolar
    • PyGuessesStructure.p
    • PyGuessesStructure.rhomolar
    • PyGuessesStructure.rhomolar_liq
    • PyGuessesStructure.rhomolar_vap
    • PyGuessesStructure.smolar
    • PyGuessesStructure.x
    • PyGuessesStructure.y
  • PyPhaseEnvelopeData
    • PyPhaseEnvelopeData.K
    • PyPhaseEnvelopeData.Q
    • PyPhaseEnvelopeData.T
    • PyPhaseEnvelopeData.TypeI
    • PyPhaseEnvelopeData.hmolar_liq
    • PyPhaseEnvelopeData.hmolar_vap
    • PyPhaseEnvelopeData.iTsat_max
    • PyPhaseEnvelopeData.icrit
    • PyPhaseEnvelopeData.ipsat_max
    • PyPhaseEnvelopeData.lnT
    • PyPhaseEnvelopeData.lnp
    • PyPhaseEnvelopeData.lnrhomolar_liq
    • PyPhaseEnvelopeData.lnrhomolar_vap
    • PyPhaseEnvelopeData.p
    • PyPhaseEnvelopeData.rhomolar_liq
    • PyPhaseEnvelopeData.rhomolar_vap
    • PyPhaseEnvelopeData.smolar_liq
    • PyPhaseEnvelopeData.smolar_vap
    • PyPhaseEnvelopeData.x
    • PyPhaseEnvelopeData.y
  • PySpinodalData
    • PySpinodalData.M1
    • PySpinodalData.delta
    • PySpinodalData.tau
  • State
    • State.Fluid
    • State.MM
    • State.Phase()
    • State.Prandtl
    • State.Props()
    • State.Q
    • State.T
    • State.Tsat
    • State.copy()
    • State.cp
    • State.cp0
    • State.cv
    • State.dpdT
    • State.get_MM()
    • State.get_Q()
    • State.get_T()
    • State.get_Tsat()
    • State.get_cond()
    • State.get_cp()
    • State.get_cp0()
    • State.get_cv()
    • State.get_dpdT()
    • State.get_h()
    • State.get_p()
    • State.get_rho()
    • State.get_s()
    • State.get_speed_sound()
    • State.get_subcooling()
    • State.get_superheat()
    • State.get_u()
    • State.get_visc()
    • State.h
    • State.k
    • State.p
    • State.pAS
    • State.phase
    • State.rho
    • State.s
    • State.set_Fluid()
    • State.speed_test()
    • State.subcooling
    • State.superheat
    • State.u
    • State.update()
    • State.update_Trho()
    • State.update_ph()
    • State.visc
  • add_fluids_as_JSON()
  • apply_simple_mixing_rule()
  • cair_sat()
  • config_key_description()
  • extract_backend()
  • extract_fractions()
  • generate_update_pair()
  • get_BibTeXKey()
  • get_REFPROPname()
  • get_aliases()
  • get_config_as_json_string()
  • get_config_bool()
  • get_config_double()
  • get_config_int()
  • get_config_string()
  • get_debug_level()
  • get_errstr()
  • get_fluid_param_string()
  • get_global_param_string()
  • get_mixture_binary_pair_data()
  • get_mixture_binary_pair_pcsaft()
  • get_parameter_index()
  • get_parameter_information()
  • get_phase_index()
  • is_trivial_parameter()
  • rebuildState()
  • saturation_ancillary()
  • set_config_as_json_string()
  • set_config_bool()
  • set_config_double()
  • set_config_int()
  • set_config_string()
  • set_debug_level()
  • set_departure_functions()
  • set_interaction_parameters()
  • set_mixture_binary_pair_data()
  • set_mixture_binary_pair_pcsaft()
  • set_predefined_mixtures()
  • set_reference_state()
• CoolProp.HumidAirProp module
• CoolProp.State module
• CoolProp.constants module

Module contents

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