pipeline.src.flows.beacons
==========================

.. py:module:: pipeline.src.flows.beacons


Functions
---------

.. autoapisummary::

   pipeline.src.flows.beacons.extract_beacons
   pipeline.src.flows.beacons.extract_satellite_operators
   pipeline.src.flows.beacons.transform_beacons
   pipeline.src.flows.beacons.transform_satellite_operators
   pipeline.src.flows.beacons.load_beacons
   pipeline.src.flows.beacons.load_satellite_operators
   pipeline.src.flows.beacons.beacons_flow


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

.. py:function:: extract_beacons() -> pandas.DataFrame

   Extract beacon numbers of all vessels from Poseidon.


.. py:function:: extract_satellite_operators()

.. py:function:: transform_beacons(beacons: pandas.DataFrame) -> pandas.DataFrame

   Maps Posedion beacon status to Monitorfish `BeaconStatus` and maps the
   1, 0 and `np.nan` values in `is_coastal` to `True`, `False` and `None`
   respectively.

   :param beacons: DataFrame of beacons extracted from Poseidon
   :type beacons: pd.DataFrame

   :returns:

             beacons with status mapped to `BeaconStatus` and `is_coastal`
               mapped to `True`, `False` and `None`.
   :rtype: pd.DataFrame


.. py:function:: transform_satellite_operators(satellite_operators: pandas.DataFrame) -> pandas.DataFrame

.. py:function:: load_beacons(beacons)

.. py:function:: load_satellite_operators(satellite_operators)

.. py:function:: beacons_flow()