:py:mod:`gnome.basic_types`
===========================

.. py:module:: gnome.basic_types

.. autoapi-nested-parse::

   basic_types.py

   The python version of the various type definitions used

   Imports all the symbols from cy_basic_types.pyx

   Adds some for Python-only use



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

Classes
~~~~~~~

.. autoapisummary::

   gnome.basic_types.wind_datasources
   gnome.basic_types.fate
   gnome.basic_types.numerical_methods




Attributes
~~~~~~~~~~

.. autoapisummary::

   gnome.basic_types.ts_format
   gnome.basic_types.oil_status
   gnome.basic_types.spill_type
   gnome.basic_types.seconds
   gnome.basic_types.oil_status_map
   gnome.basic_types.np_long
   gnome.basic_types.mover_type
   gnome.basic_types.world_point_type
   gnome.basic_types.windage_type
   gnome.basic_types.water_current_type
   gnome.basic_types.datetime_value_2d
   gnome.basic_types.datetime_value_1d
   gnome.basic_types.world_point
   gnome.basic_types.velocity_rec
   gnome.basic_types.time_value_pair
   gnome.basic_types.ebb_flood_data
   gnome.basic_types.tide_height_data
   gnome.basic_types.w_point_2d
   gnome.basic_types.long_point
   gnome.basic_types.triangle_data
   gnome.basic_types.cell_data
   gnome.basic_types.status_code_type
   gnome.basic_types.id_type
   gnome.basic_types.date_rec


.. py:data:: ts_format

   

.. py:data:: oil_status

   

.. py:data:: spill_type

   

.. py:data:: seconds

   

.. py:data:: oil_status_map

   

.. py:data:: np_long

   

.. py:data:: mover_type

   

.. py:data:: world_point_type

   

.. py:data:: windage_type

   

.. py:data:: water_current_type

   

.. py:data:: datetime_value_2d

   

.. py:data:: datetime_value_1d

   

.. py:class:: wind_datasources


   Bases: :py:obj:`enum.IntEnum`

   Enum where members are also (and must be) ints

   Initialize self.  See help(type(self)) for accurate signature.

   .. py:attribute:: undefined
      :value: 0

      

   .. py:attribute:: file
      :value: 1

      

   .. py:attribute:: manual
      :value: 2

      

   .. py:attribute:: nws
      :value: 3

      

   .. py:attribute:: buoy
      :value: 4

      


.. py:class:: fate


   Bases: :py:obj:`enum.IntEnum`

   An enum for weathering status. The numpy array will contain np.uint8
   datatype. Can still define 2 more flags as 2**6, 2**7
   These are bit flags

   Initialize self.  See help(type(self)) for accurate signature.

   .. py:attribute:: non_weather
      :value: (1,)

      

   .. py:attribute:: surface_weather
      :value: (2,)

      

   .. py:attribute:: subsurf_weather
      :value: (4,)

      

   .. py:attribute:: skim
      :value: (8,)

      

   .. py:attribute:: burn
      :value: (16,)

      

   .. py:attribute:: disperse
      :value: (32,)

      


.. py:class:: numerical_methods


   Bases: :py:obj:`enum.IntEnum`

   Enum where members are also (and must be) ints

   Initialize self.  See help(type(self)) for accurate signature.

   .. py:attribute:: Euler
      :value: 0

      

   .. py:attribute:: RK2
      :value: 1

      

   .. py:attribute:: RK4
      :value: 2

      


.. py:data:: world_point

   

.. py:data:: velocity_rec

   

.. py:data:: time_value_pair

   

.. py:data:: ebb_flood_data

   

.. py:data:: tide_height_data

   

.. py:data:: w_point_2d

   

.. py:data:: long_point

   

.. py:data:: triangle_data

   

.. py:data:: cell_data

   

.. py:data:: status_code_type

   

.. py:data:: id_type

   

.. py:data:: date_rec