Package Resources

libcbm.resources.get_cbm_defaults_path()

Gets the path to the packaged cbm defaults sqlite database

Returns:

path to the bundled database

Return type:

str

libcbm.resources.get_cbm_exn_parameters_dir()

gets a path to a directory containing default parameters for libcbm.cbm_exn.cbm_exn_model

Returns:

cbm_exn parameters

Return type:

str

libcbm.resources.get_libcbm_bin_path()

Returns bundled, OS specific compiled libcbm C/C++ library

Raises:
  • RuntimeError – 32 bit systems are not supported

  • RuntimeError – unknown platform.system() value

Returns:

path to the bundled, compiled dll, so or dylib file

Return type:

str

libcbm.resources.get_local_dir()

Gets the directory containing this script

Returns:

full path to the the script’s directory

Return type:

str

libcbm.resources.get_test_resources_dir()

gets a path to a directory containing files for integration testing and examples

Returns:

test resources path

Return type:

str

libcbm.resources.cbm_defaults_queries.get_query(query_filename)

read the contents of a file stored in the same directory as this module.

Parameters:

query_filename (str) – the name of a file stored in the same directory as this module

Returns:

the contents of the file

Return type:

str

libcbm.resources.cbm_defaults_queries.get_script_dir()

Returns the directory containing this script file

Returns:

the directory containing this module

Return type:

str