dianna.utils.downloader
=======================

.. py:module:: dianna.utils.downloader

.. autoapi-nested-parse::

   DIANNA file downloader.

   Instructions for adding a new file:

   There are three dictionaries defining the available files:
   one for models, one for labels, one for data.
   Each entry has the (output) filename as key, and a list with the URL and sha256 hash as value.
   The sha256 hash can be obtained locally with `sha256sum <filename>`. Alternatively,
   set the hash to None and download the file with the `download` function.
   the sha256 sum will be printed to the command line and can be inserted into this file.
   Do not forget to prefix it with `sha256:`



Functions
---------

.. autoapisummary::

   dianna.utils.downloader.list_available_files
   dianna.utils.downloader.download


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

.. py:function:: list_available_files()

   Lists DIANNA-related model, data, and label files available for download.


.. py:function:: download(file, file_type, path=pooch.os_cache('dianna'))

   Download a file.

   :param file: name of the file. Use list_available_files() to get an overview
   :type file: str
   :param file_type: model, data, or label
   :type file_type: str
   :param path: download directory (default: OS cache directory)
   :type path: str

   :returns: Full path to downloaded file (str)