Files
CoolProp/wrappers/Python/__init__.py.template
2019-12-12 20:34:00 -07:00

73 lines
2.1 KiB
Plaintext

#Everything in this file is added to the bottom of the __init__.py file at buildtime
from . import CoolProp
from . import HumidAirProp
from . import State
from .unit_systems_constants import *
from .param_constants import *
from .phase_constants import *
def get_fluids():
"""
Get the list of fluids in CoolProp, according to their default name
"""
del_old = CP.get_config_string(CP.LIST_STRING_DELIMITER)
CP.set_config_string(CP.LIST_STRING_DELIMITER, b'|')
try:
fluids = CoolProp.get_global_param_string(b'fluids_list')
finally:
CP.set_config_string(CP.LIST_STRING_DELIMITER, del_old)
return fluids
__fluids__ = get_fluids()
def test():
"""
Run the tests in the test folder
"""
from .tests import runner
runner.run()
def 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: The path to the include folder for CoolProp
"""
import os
head,file = os.path.split(__file__)
return os.path.join(head,'include')
def 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
"""
import os, shutil
path_to_bib = os.path.join(os.path.split(__file__)[0],'CoolPropBibTeXLibrary.bib')
if file is None and folder is None:
shutil.copy2(path_to_bib,os.path.abspath(os.curdir))
elif file and folder is None:
shutil.copy2(path_to_bib,file)
elif folder and file is None:
shutil.copy2(path_to_bib,os.path.join(folder,file))
else:
raise ValueError('can only provide one of file or folder')