:py:mod:`gnome.environment.names`
=================================

.. py:module:: gnome.environment.names

.. autoapi-nested-parse::

   Module that provides the names used when processing netcdf files

   Each type of Environment object has a set of names that it uses
   to determine what the contents of a netcdf file are.

   **cf_names:**

   These are "standard names", as defined by the CF metadata standard:

   https://cfconventions.org/standard-names.html

   These are the best options to use, as the are standardized. When loading a netcdf file, the Environment
   objects will first look for variable with cf_names, to identify their meaning. If no
   variables exist with the standard names, then common variable names will be used.

   **nc_names:**

   These are common variable names used for the variables PyGNOME uses. If you set the variable names in
   a netcdf files to one these names, PYGNOME should be able to load the file.

   **Name Mapping:**



   **grid_temperature**

     Default Names: water_t, temp


     CF Standard Names: sea_water_temperature, sea_surface_temperature


   **grid_salinity**

     Default Names: salt


     CF Standard Names: sea_water_salinity, sea_surface_salinity


   **grid_sediment**

     Default Names: sand_06


     CF Standard Names:


   **ice_concentration**

     Default Names: ice_fraction, aice


     CF Standard Names: sea_ice_area_fraction


   **bathymetry**

     Default Names: h


     CF Standard Names: depth


   **grid_current**

    Default Names for u: u, U, water_u, curr_ucmp, u_surface, u_sur

    Default Names for v: v, V, water_v, curr_vcmp, v_surface, v_sur

    Default Names for w: w, W


    CF Standard Names for u: eastward_sea_water_velocity, surface_eastward_sea_water_velocity

    CF Standard Names for v: northward_sea_water_velocity, surface_northward_sea_water_velocity

    CF Standard Names for w: upward_sea_water_velocity


   **grid_wind**

    Default Names for u: air_u, Air_U, air_ucmp, wind_u, u-component_of_wind_height_above_ground, UWind

    Default Names for v: air_v, Air_V, air_vcmp, wind_v, v-component_of_wind_height_above_ground, VWind


    CF Standard Names for u: eastward_wind, eastward wind

    CF Standard Names for v: northward_wind, northward wind


   **ice_velocity**

    Default Names for u: ice_u, uice

    Default Names for v: ice_v, vice


    CF Standard Names for u: eastward_sea_ice_velocity

    CF Standard Names for v: northward_sea_ice_velocity



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


Functions
~~~~~~~~~

.. autoapisummary::

   gnome.environment.names.insert_names_table
   gnome.environment.names.build_names_table



Attributes
~~~~~~~~~~

.. autoapisummary::

   gnome.environment.names.nc_names


.. py:data:: nc_names

   

.. py:function:: insert_names_table(table_text)

   function to insert the names table into the docstring

   should be run when name mapping is updated.


.. py:function:: build_names_table()

   This builds the table of names for the docstring (and the docs)

   NOTE: it could use some fancier rst formatting ...