:py:mod:`mlair.reference_models.abstract_reference_model`
=========================================================

.. py:module:: mlair.reference_models.abstract_reference_model


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

Classes
~~~~~~~

.. autoapisummary::

   mlair.reference_models.abstract_reference_model.AbstractReferenceModel
   mlair.reference_models.abstract_reference_model.AbstractReferenceB2share




Attributes
~~~~~~~~~~

.. autoapisummary::

   mlair.reference_models.abstract_reference_model.__author__
   mlair.reference_models.abstract_reference_model.__date__


.. py:data:: __author__
   :annotation: = Felix Kleinert

   

.. py:data:: __date__
   :annotation: = 2021-01-29

   

.. py:class:: AbstractReferenceModel(*args, **kwargs)

   Bases: :py:obj:`abc.ABC`

   Abstract reference model. All classes providing some reference or competitor models must inherent from this class.

   .. py:method:: make_reference_available_locally(self, *args)
      :abstractmethod:


   .. py:method:: is_reference_available_locally(reference_path) -> bool
      :staticmethod:

      Checks if reference is available locally
      :param reference_path: look in this path for data



.. py:class:: AbstractReferenceB2share(b2share_hosturl: str, b2share_bucket: str, b2share_key: str)

   Bases: :py:obj:`AbstractReferenceModel`

   Abstract class for reference models located on b2share (eudat or fz-juelich)
   See also https://github.com/EUDAT-Training/B2SHARE-Training/blob/master/api/01_Retrieve_existing_record.md


   .. py:method:: b2share_url(self)
      :property:


   .. py:method:: bar_custom(self, current, total, width=80)


   .. py:method:: download_from_b2share(self, tmp_download_path: str)


   .. py:method:: make_reference_available_locally(self)
      :abstractmethod: