flip_api.utils.constants
========================

.. py:module:: flip_api.utils.constants


Attributes
----------

.. autoapisummary::

   flip_api.utils.constants.SERVICE_UNAVAILABLE_MESSAGE
   flip_api.utils.constants.ACCESS_REQUEST_TEMPLATE_NAME
   flip_api.utils.constants.IMAGING_CREDENTIALS_TEMPLATE_NAME
   flip_api.utils.constants.IMAGING_PROJECT_ACCESS_TEMPLATE_NAME
   flip_api.utils.constants.JOB_TYPES_REQUIRED_FILES_S3_NAME
   flip_api.utils.constants.BASE_URL
   flip_api.utils.constants.ADMIN_EMAIL_1
   flip_api.utils.constants.ADMIN_EMAIL_2
   flip_api.utils.constants.ADMIN_EMAIL_3
   flip_api.utils.constants.RESEARCHER_EMAIL
   flip_api.utils.constants.VIEWER_EMAIL


Functions
---------

.. autoapisummary::

   flip_api.utils.constants.job_types_required_files_name
   flip_api.utils.constants.job_types_required_files_s3_key


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

.. py:data:: SERVICE_UNAVAILABLE_MESSAGE
   :value: 'The server is unable to process any requests at the moment, please try again later.'


.. py:data:: ACCESS_REQUEST_TEMPLATE_NAME
   :value: 'flip-access-request'


.. py:data:: IMAGING_CREDENTIALS_TEMPLATE_NAME
   :value: 'flip-xnat-credentials'


.. py:data:: IMAGING_PROJECT_ACCESS_TEMPLATE_NAME
   :value: 'flip-xnat-added-to-project'


.. py:function:: job_types_required_files_name(fl_backend: flip_api.domain.schemas.types.FLBackend) -> str

   Local filename for the per-backend job-types/required-files manifest.

   :param fl_backend: The FL backend the manifest belongs to (``nvflare`` or ``flower``).
   :type fl_backend: FLBackend

   :returns: The manifest filename, e.g. ``job_types_and_required_files.nvflare.json``.
   :rtype: str


.. py:data:: JOB_TYPES_REQUIRED_FILES_S3_NAME
   :value: 'required_files.json'


.. py:function:: job_types_required_files_s3_key(fl_backend: flip_api.domain.schemas.types.FLBackend) -> str

   S3 key (relative to ``FL_APP_BASE_BUCKET``) of the per-backend required-files manifest.

   :param fl_backend: The FL backend whose manifest to locate (``nvflare`` or ``flower``).
   :type fl_backend: FLBackend

   :returns: The per-backend key, e.g. ``nvflare/required_files.json``.
   :rtype: str


.. py:data:: BASE_URL

.. py:data:: ADMIN_EMAIL_1
   :value: 'aicentreflip@gmail.com'


.. py:data:: ADMIN_EMAIL_2
   :value: 'alexandre.triay_bagur@kcl.ac.uk'


.. py:data:: ADMIN_EMAIL_3
   :value: 'rafael.dias@kcl.ac.uk'


.. py:data:: RESEARCHER_EMAIL
   :value: 'rafaelagd@gmail.com'


.. py:data:: VIEWER_EMAIL
   :value: 'triayalex@gmail.com'