carputils
Doxygen code documentation for the python framework controlling openCARP
|
Functions | |
def | load_pscript (exp_file) |
Reads and returns the content of a script. More... | |
def | write_pscript (pscript, pscript_name, bundle_dir) |
Copy the protocol script to the experiment bundle folder. More... | |
def | write_metadata_file (metadata_s, bundle_dir) |
Copy the metadata file into the bundle. More... | |
def | copy_folder_in_bundle (folder_name, exp_dir, bundle_dir) |
Copy a folder from the experiment folder to the bundle folder. More... | |
def | copy_mesh_dir_in_bundle (exp_name, bundle_dir) |
Copy the folder MESH_DIR/exp_name/ (configured in settings.yaml) in the bundle folder if it exists. More... | |
def | create_zip (dir_path) |
Creates a zip archive of the given directory, at the same location. More... | |
def carputils.bundle.bundleio.copy_folder_in_bundle | ( | folder_name, | |
exp_dir, | |||
bundle_dir | |||
) |
Copy a folder from the experiment folder to the bundle folder.
folder_name | str name of the folder to copy (path must be relative to exp_dir) |
exp_dir | str absolute path to experiment directory |
bundle_dir | str absolute path to bundle directory |
def carputils.bundle.bundleio.copy_mesh_dir_in_bundle | ( | exp_name, | |
bundle_dir | |||
) |
Copy the folder MESH_DIR/exp_name/ (configured in settings.yaml) in the bundle folder if it exists.
Can erase mesh data already put in the bundle.
exp_name | str name of the experiment |
bundle_dir | str directory of the bundle folder |
def carputils.bundle.bundleio.create_zip | ( | dir_path | ) |
Creates a zip archive of the given directory, at the same location.
dir_path | str path to the directory to archive |
def carputils.bundle.bundleio.load_pscript | ( | exp_file | ) |
Reads and returns the content of a script.
exp_file | str path to the input file |
def carputils.bundle.bundleio.write_metadata_file | ( | metadata_s, | |
bundle_dir | |||
) |
Copy the metadata file into the bundle.
metadata_s | str string containing the content of the yml metadata file |
bundle_dir | str path to the bundle folder |
def carputils.bundle.bundleio.write_pscript | ( | pscript, | |
pscript_name, | |||
bundle_dir | |||
) |
Copy the protocol script to the experiment bundle folder.
pscript | str string to write in the file |
pscript_name | str name of the file to write |
bundle_dir | str path to the bundle folder |