artist.util
===========

.. py:module:: artist.util

.. autoapi-nested-parse::

   Bundle all classes that implement util functionality in ``ARTIST``.



Submodules
----------

.. toctree::
   :maxdepth: 1

   /autoapi/artist/util/config_dictionary/index
   /autoapi/artist/util/environment_setup/index
   /autoapi/artist/util/index_mapping/index
   /autoapi/artist/util/nurbs/index
   /autoapi/artist/util/raytracing_utils/index
   /autoapi/artist/util/type_mappings/index
   /autoapi/artist/util/utils/index


Functions
---------

.. autoapisummary::

   artist.util.set_logger_config


Package Contents
----------------

.. py:function:: set_logger_config(level: int = logging.INFO, log_file: str | pathlib.Path | None = None, log_to_stdout: bool = True, colors: bool = True) -> None

   Set up the logger. Should only need to be done once. Generally, logging should only be done on the master rank.

   Parameters
   ----------
   level : int
       The default level for logging. Default is ``logging.INFO``.
   log_file : str | Path | None
       The file to save the log to.
   log_to_stdout : bool
       A flag indicating if the log should be printed on stdout. Default is True.
   colors : bool
       A flag for using colored logs. Default is True.