:py:mod:`gnome.outputters.kmz_templates`
========================================

.. py:module:: gnome.outputters.kmz_templates

.. autoapi-nested-parse::

   templates for the kmz  outputter



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


Functions
~~~~~~~~~

.. autoapisummary::

   gnome.outputters.kmz_templates.build_one_timestep



Attributes
~~~~~~~~~~

.. autoapisummary::

   gnome.outputters.kmz_templates.caveat
   gnome.outputters.kmz_templates.header_template
   gnome.outputters.kmz_templates.point_template
   gnome.outputters.kmz_templates.timestep_header_template
   gnome.outputters.kmz_templates.one_run_header
   gnome.outputters.kmz_templates.one_run_footer
   gnome.outputters.kmz_templates.timestep_footer
   gnome.outputters.kmz_templates.footer


.. py:data:: caveat
   :value: 'This trajectory was produced by GNOME (General NOAA Operational Modeling Environment), and...'

   

.. py:data:: header_template
   :value: Multiline-String

    .. raw:: html

        <details><summary>Show Value</summary>

    .. code-block:: python

        """<?xml version="1.0" encoding="UTF-8"?>
        <kml xmlns="http://www.opengis.net/kml/2.2">
          <Document>
            <name>{kml_name}</name>
            <open>1</open>
            <description><![CDATA[<b>Valid for:</b> {valid_timestring}<br>
                                  <b>Issued:</b>{issued_timestring} <br>
                                  {caveat}]]>
            </description>
        
            <Style id="RedDotIcon">
              <IconStyle>
                 <scale>0.2</scale>
                 <color>ff0000ff</color>
                 <Icon>
                    <href>dot.png</href>
                 </Icon>
                  <hotSpot x="0.5"  y="0.5" xunits="fraction" yunits="fraction"/>
              </IconStyle>
              <LabelStyle>
                 <color>00000000</color>
              </LabelStyle>
            </Style>
        
            <Style id="BlackDotIcon">
              <IconStyle>
                 <scale>0.2</scale>
                 <Icon>
                    <href>dot.png</href>
                 </Icon>
                 <color>ff000000</color>
                 <hotSpot x="0.5"  y="0.5" xunits="fraction" yunits="fraction"/>
              </IconStyle>
              <LabelStyle>
                 <color>00000000</color>
              </LabelStyle>
            </Style>
        
            <Style id="YellowDotIcon">
              <IconStyle>
                 <scale>0.2</scale>
                 <Icon>
                    <href>dot.png</href>
                 </Icon>
                 <color>ff00ffff</color>
                 <hotSpot x="0.5"  y="0.5" xunits="fraction" yunits="fraction"/>
              </IconStyle>
              <LabelStyle>
                 <color>00000000</color>
              </LabelStyle>
            </Style>
        
            <Style id="RedXIcon">
              <IconStyle>
                 <scale>0.2</scale>
                 <color>ff0000ff</color>
                 <Icon>
                    <href>x.png</href>
                 </Icon>
                  <hotSpot x="0.5"  y="0.5" xunits="fraction" yunits="fraction"/>
              </IconStyle>
              <LabelStyle>
                 <color>00000000</color>
              </LabelStyle>
            </Style>
        
            <Style id="BlackXIcon">
              <IconStyle>
                 <scale>0.2</scale>
                 <Icon>
                    <href>x.png</href>
                 </Icon>
                 <color>ff000000</color>
                 <hotSpot x="0.5"  y="0.5" xunits="fraction" yunits="fraction"/>
              </IconStyle>
              <LabelStyle>
                 <color>00000000</color>
              </LabelStyle>
            </Style>
        
            <Style id="YellowXIcon">
              <IconStyle>
                 <scale>0.2</scale>
                 <Icon>
                    <href>x.png</href>
                 </Icon>
                 <color>ff00ffff</color>
                 <hotSpot x="0.5"  y="0.5" xunits="fraction" yunits="fraction"/>
              </IconStyle>
              <LabelStyle>
                 <color>00000000</color>
              </LabelStyle>
            </Style>
        """

    .. raw:: html

        </details>

   

.. py:data:: point_template
   :value: Multiline-String

    .. raw:: html

        <details><summary>Show Value</summary>

    .. code-block:: python

        """             <Point>
                             <altitudeMode>relativeToGround</altitudeMode>
                             <coordinates>{:.6f},{:.6f},1.000000</coordinates>
                     </Point>
        """

    .. raw:: html

        </details>

   

.. py:data:: timestep_header_template
   :value: Multiline-String

    .. raw:: html

        <details><summary>Show Value</summary>

    .. code-block:: python

        """<Folder>
          <name>{date_string}:{certain}</name>
        """

    .. raw:: html

        </details>

   

.. py:data:: one_run_header
   :value: Multiline-String

    .. raw:: html

        <details><summary>Show Value</summary>

    .. code-block:: python

        """    <Placemark>
              <name>{certain} {status} Splots </name>
              <styleUrl>{style}</styleUrl>
              <TimeSpan id="ID">
                <begin>{start_time}</begin>     <!-- kml:dateTime -->
                <end>{end_time}</end>         <!-- kml:dateTime -->
              </TimeSpan>
              <MultiGeometry>
        """

    .. raw:: html

        </details>

   

.. py:data:: one_run_footer
   :value: Multiline-String

    .. raw:: html

        <details><summary>Show Value</summary>

    .. code-block:: python

        """      </MultiGeometry>
            </Placemark>
        """

    .. raw:: html

        </details>

   

.. py:data:: timestep_footer
   :value: Multiline-String

    .. raw:: html

        <details><summary>Show Value</summary>

    .. code-block:: python

        """
        </Folder>
        """

    .. raw:: html

        </details>

   

.. py:function:: build_one_timestep(floating_positions, beached_positions, start_time, end_time, uncertain)


.. py:data:: footer
   :value: Multiline-String

    .. raw:: html

        <details><summary>Show Value</summary>

    .. code-block:: python

        """
          </Document>
        </kml>
        """

    .. raw:: html

        </details>