utils
=====

Module: :py:mod:`fridom.framework.utils`

.. ==================================================
..  Template for modules that are __init__.py files
.. ==================================================



.. --------------------------------------------------
..  Submodules Section
.. --------------------------------------------------






.. --------------------------------------------------
..  Classes, Functions, and Variables Section
.. --------------------------------------------------





.. rubric:: Classes, Functions, and Variables





.. currentmodule:: fridom.framework.utils.mpi

.. autosummary::
   :toctree:
   :recursive:
   
   I_AM_MAIN_RANK
   MPI_AVAILABLE
   mpi_barrier
   get_mpi_size
   get_my_rank


.. currentmodule:: fridom.framework.utils.printing

.. autosummary::
   :toctree:
   :recursive:
   
   print_bar
   print_job_init_info


.. currentmodule:: fridom.framework.utils.formatting

.. autosummary::
   :toctree:
   :recursive:
   
   humanize_length
   humanize_time
   humanize_number


.. currentmodule:: fridom.framework.utils.filesystem

.. autosummary::
   :toctree:
   :recursive:
   
   chdir_to_submit_dir
   stdout_is_file


.. currentmodule:: fridom.framework.utils.array_ops

.. autosummary::
   :toctree:
   :recursive:
   
   SliceableAttribute
   modify_array
   random_array
   array_is_constant


.. currentmodule:: fridom.framework.utils.numpy_utils

.. autosummary::
   :toctree:
   :recursive:
   
   to_numpy
   to_seconds


.. currentmodule:: fridom.framework.utils.jax_utils

.. autosummary::
   :toctree:
   :recursive:
   
   jaxjit
   jaxify
   inspect_jitted_function
   free_memory


.. currentmodule:: fridom.framework.utils.decorators

.. autosummary::
   :toctree:
   :recursive:
   
   skip_on_doc_build
   cache_figure





.. automodule:: fridom.framework.utils
   :no-members:
   :no-inherited-members:
   :no-special-members:
   :no-private-members:
   :undoc-members:

.. ==================================================
..  Template for modules that are no __init__.py files
.. ==================================================