ecpi.common Package

Functions

add_path_current_module(p_module, p_file) function to define a path
add_path_data_ref_eclairs(p_file) add to p_file the path of the ECLAIRs data simulation or analysis directory.
add_path_eclairs(p_file) add to p_file the path of the ECLAIRs directory.
add_path_output_eclairs(p_file) add to p_file the path of the ECLAIRs output directory.
add_path_process_eclairs(p_file) add to p_file the path of the ECLAIRs processing directory.
add_path_tests_eclairs(p_file) add to p_file the path of the ECLAIRs test directory.
get_root_eclairs() get the path of the ECLAIRs directory.

generic classes, functions. Could be used by other projects.

Summary

Reference

add_path_current_module(p_module, p_file)[source]

function to define a path :param p_module: path of module :param p_file: path of file

Returns:a path at the same level that p_module
Return type:string
add_path_data_ref_eclairs(p_file)[source]

add to p_file the path of the ECLAIRs data simulation or analysis directory.

Returns:absolute path of p_file
Return type:string
add_path_eclairs(p_file)[source]

add to p_file the path of the ECLAIRs directory.

Returns:absolute path of p_file
Return type:string
add_path_output_eclairs(p_file)[source]

add to p_file the path of the ECLAIRs output directory.

The ECLAIRs output directory is ECLAIRs/OUTPUT. It is a non commited directory.

Returns:absolute path of p_file
Return type:string
add_path_process_eclairs(p_file)[source]

add to p_file the path of the ECLAIRs processing directory.

The ECLAIRs test directory is ECLAIRs/DATA_PROCESS. It is a non committed directory.

Returns:absolute path of p_file
Return type:string
add_path_tests_eclairs(p_file)[source]

add to p_file the path of the ECLAIRs test directory.

The ECLAIRs test directory is ECLAIRs/DATA_TEST. It is a non committed directory.

Returns:absolute path of p_file
Return type:string
get_root_eclairs()[source]

get the path of the ECLAIRs directory.

Returns:path of the root of the ECLAIRs directory
Return type:string