pylift.utilities

pylift.utilities module

License: The MIT License (MIT)

Copyright (c) 2024 Brandon C. Tapia

Attributes

imported_modules

Functions

cleanup_pylift(→ dict)

pylift.utilities.cleanup_pylift

read_json(in_json)

pylift.utilities.read_json

write_json(→ None)

Module Contents

pylift.utilities.imported_modules[source]
pylift.utilities.cleanup_pylift(user_files: list[str] = None, temp: bool = True, antechamber: bool = True, verbose: bool = True) → dict[source]

pylift.utilities.cleanup_pylift

Cleans up temporary files generated during program execution.

Parameters:

  • user_files (list[str]) – List of additional file paths to be removed. Default is None.

  • temp (bool) – Removes all files with tmp in their name

  • antechamber (bool) – Removes all extraneous files generated with Antechamber

Returns:

information regarding the success/failure of deletion

Return type:

dict

pylift.utilities.read_json(in_json)[source]

pylift.utilities.read_json

Reads a json file from pylift/ff_data directory

pylift.utilities.write_json(dict_loc: dict, out_json: str) → None[source]