:py:mod:`geovista.cache`
========================

.. py:module:: geovista.cache

.. autoapi-nested-parse::

   
   Convenience functions to access, download and cache :mod:`geovista` resources.













   .. rubric:: Notes

   .. versionadded:: 0.1.0



   ..
       !! processed by numpydoc !!


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


Functions
~~~~~~~~~

.. autoapisummary::

   geovista.cache.pooch_mute
   geovista.cache.reload_registry



Attributes
~~~~~~~~~~

.. autoapisummary::

   geovista.cache.BASE_URL
   geovista.cache.CACHE
   geovista.cache.DATA_VERSION
   geovista.cache.GEOVISTA_CACHEDIR
   geovista.cache.GEOVISTA_DATA_VERSION
   geovista.cache.GEOVISTA_POOCH_MUTE
   geovista.cache.RETRY_ATTEMPTS


.. py:function:: pooch_mute(silent = True)

   
   Control the :mod:`pooch` cache manager logger verbosity.

   Updates the status variable :data:`GEOVISTA_POOCH_MUTE`.

   :Parameters:

       **silent** : :class:`python:bool`, optional
           Whether to silence or activate the :mod:`pooch` cache manager logger messages
           to the console.











   .. rubric:: Notes

   .. versionadded:: 0.5.0



   ..
       !! processed by numpydoc !!

.. py:function:: reload_registry(fname = None)

   
   Refresh the registry of the :data:`CACHE`.

   See :meth:`pooch.Pooch.load_registry` for more details.

   :Parameters:

       **fname** : :class:`python:str`, optional
           The filename of the registry to be loaded. If ``None``, defaults to
           the ``cache/registry.txt`` resource file packaged with :mod:`geovista`.











   .. rubric:: Notes

   .. versionadded:: 0.1.0



   ..
       !! processed by numpydoc !!

.. py:data:: BASE_URL
   :type:  str
   :value: 'https://github.com/bjlittle/geovista-data/raw/{version}/assets/'


   
   Base URL for :mod:`geovista` resources.
















   ..
       !! processed by numpydoc !!

.. py:data:: CACHE
   :type:  pooch.Pooch

   
   Cache manager for :mod:`geovista` resources.
















   ..
       !! processed by numpydoc !!

.. py:data:: DATA_VERSION
   :type:  str
   :value: '2024.07.0'


   
   The ``geovista-data`` repository version for :mod:`geovista` resources.
















   ..
       !! processed by numpydoc !!

.. py:data:: GEOVISTA_CACHEDIR
   :type:  str
   :value: 'GEOVISTA_CACHEDIR'


   
   Environment variable to override :mod:`pooch` cache manager path.
















   ..
       !! processed by numpydoc !!

.. py:data:: GEOVISTA_DATA_VERSION
   :type:  str

   
   Environment variable to override default :attr:`DATA_VERSION`.
















   ..
       !! processed by numpydoc !!

.. py:data:: GEOVISTA_POOCH_MUTE
   :type:  bool

   
   Verbosity status of the :mod:`pooch` cache manager logger.
















   ..
       !! processed by numpydoc !!

.. py:data:: RETRY_ATTEMPTS
   :type:  int
   :value: 3


   
   The number of retry attempts to download a resource.
















   ..
       !! processed by numpydoc !!