:py:mod:`cddm.conf`
===================

.. py:module:: cddm.conf

.. autoapi-nested-parse::

   Configuration and constants



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

.. py:function:: get_home_dir()

   Return user home directory


.. py:data:: HOMEDIR
   

   Users home directory

.. py:data:: CDDM_CONFIG_DIR
   

   Config directory where cddm.ini lives

.. py:data:: NUMBA_CACHE_DIR
   

   Numba cache directory, where compiled functions are written

.. py:data:: CONF
   

   Configuration file filename

.. py:data:: NUMBA_CACHE
   :annotation: = False

   Specifiess whether we use numba caching or not

.. py:function:: is_module_installed(name)

   Checks whether module with name 'name' is istalled or not


.. py:function:: detect_number_of_cores()

   detect_number_of_cores()

   Detect the number of cores in this system.

   :returns: **out** -- The number of cores in this system.
   :rtype: int


.. py:function:: disable_mkl_threading()

   Disables mkl threading.


.. py:function:: enable_mkl_threading()

   Enables mkl threading.


.. py:class:: CDDMConfig

   Bases: :py:obj:`object`

   DDMM settings are here. You should use the set_* functions in the
   conf.py module to set these values


.. py:function:: print_config()

   Prints all compile-time and run-time configurtion parameters and settings.


.. py:function:: set_verbose(level)

   Sets verbose level (0-2) used by compute functions.


.. py:function:: set_showlib(name)

   Set library for live video view


.. py:function:: set_fftlib(name='numpy.fft')

   Sets fft library. Returns previous setting.


.. py:function:: set_rfft2lib(name='numpy.fft')

   Sets fft library. Returns previous setting.


.. py:function:: set_fft_threads(n)

   Sets number of threads used in fft functions.


.. py:function:: set_numba_threads(n)

   Sets number of threads used in numba-accelerated functions.