pyatran.runtime.store_results

pyatran.runtime.store_results(runpath, target, save_inputs=True, save_executable=True, create_dirs=True)

Store SCIATRAN runtime in ZIP format.

By default, the full runtime directory will be stored, ensuring full reproducibility of the SCIATRAN run.

Parameters:

runpath : str

The SCIATRAN runtime directory to be saved.

target : str

The zip file to be created.

save_inputs : bool, optional

If True, the input files from the directory DATA_IN will be stored in the zipfile. Defaults to True.

save_executable : bool, optional

If True, the SCIATRAN executable will be stored in the zipfile. Defaults to True.

create_dirs : bool, optional

If True, automatically create all directories so that the output file can be created at target.

Notes

The kwarg save_executable treats any file inside the runtime directory which is not contained in DATA_IN, DATA_OUT, or does not end in .inp or .log as executable. While this is not optimal, it is the only way to definitely not miss the executable.