snews_pt.snews_pt_utils
=======================

.. py:module:: snews_pt.snews_pt_utils

.. autoapi-nested-parse::

   Utility tools for snews_pt



Attributes
----------

.. autoapisummary::

   snews_pt.snews_pt_utils.log
   snews_pt.snews_pt_utils.default_detector_file


Functions
---------

.. autoapisummary::

   snews_pt.snews_pt_utils.set_env
   snews_pt.snews_pt_utils.retrieve_detectors
   snews_pt.snews_pt_utils.isnotebook
   snews_pt.snews_pt_utils.display_gif
   snews_pt.snews_pt_utils.set_name


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

.. py:data:: log

.. py:data:: default_detector_file

.. py:function:: set_env(env_path=None)

   Set environment parameters

   :param env_path: path for the environment file.
                    Use default settings if not given
   :type env_path: str, (optional)


.. py:function:: retrieve_detectors(detectors_path=default_detector_file)

   Retrieve the name-ID-location of the participating detectors.

   :param detectors_path: path to detector properties. File needs to be in JSON format
   :type detectors_path: str, optional

   :rtype: None


.. py:function:: isnotebook()

   Tell if the script is running on a notebook


.. py:function:: display_gif()

   Some fun method to display an alert gif
   If running on notebook.



.. py:function:: set_name(detector_name='TEST', _return=False)

   set your detector's name.
   Messages sent with detector_name="TEST" will be ignored at the server
   Alerts can still be subscribed and listened as "TEST"