pylift.utilities
================

.. py:module:: pylift.utilities

.. autoapi-nested-parse::

   pylift.utilities module

   License: The MIT License (MIT)

   Copyright (c) 2024 Brandon C. Tapia



Attributes
----------

.. autoapisummary::

   pylift.utilities.imported_modules


Functions
---------

.. autoapisummary::

   pylift.utilities.cleanup_pylift
   pylift.utilities.read_json
   pylift.utilities.write_json


Module Contents
---------------

.. py:data:: imported_modules

.. py:function:: cleanup_pylift(user_files: list[str] = None, temp: bool = True, antechamber: bool = True, verbose: bool = True) -> dict

   pylift.utilities.cleanup_pylift

   Cleans up temporary files generated during program execution.

   :param user_files: List of additional file paths to be removed. Default is None.
   :type user_files: list[str]
   :param temp: Removes all files with tmp in their name
   :type temp: bool
   :param antechamber: Removes all extraneous files generated with Antechamber
   :type antechamber: bool

   :returns: information regarding the success/failure of deletion
   :rtype: dict


.. py:function:: read_json(in_json)

   pylift.utilities.read_json

   Reads a json file from pylift/ff_data directory


.. py:function:: write_json(dict_loc: dict, out_json: str) -> None

   *