.. _python_read_codas:



Python direct read access to CODAS data
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

**get_profiles**: getting all bins and all profiles from a CODAS database

       * extract averaged data, every bin and every profile, including
         access to many variables (time, position, velocity,
         amplitude, temperature, heading)


       * example:  using ``dbname`` as the name of the database
         (i.e. the CODAS database file collection exists
         as ``adcpdb/dbname*.blk``


::

           from pycurrents.codas import get_profiles
           data=get_profiles(dbname)



..

Typical variables of immediate interest are:

|
|


+---------------------+---------------------------------------------------------------------+
| variable            |   description                                                       |
+=====================+=====================================================================+
|  ``dday``           | Time at the end of the ensemble, days from start of year.           |
|                     |                                                                     |
|                     | Jan 1 noon UTC is 0.5 (not 1.5)                                     |
+---------------------+---------------------------------------------------------------------+
|  ``lon``, ``lat``   | Longitude, Latitude from GPS at the end of the ensemble.            |
+---------------------+---------------------------------------------------------------------+
|  ``u``, ``v``       | Ocean zonal and meridional velocity component profiles.             |
+---------------------+---------------------------------------------------------------------+
| ``uship``, ``vship``| Zonal and meridional velocity components of the ship.               |
+---------------------+---------------------------------------------------------------------+
|  ``heading``        | Mean ship heading during the ensemble.                              |
+---------------------+---------------------------------------------------------------------+
|  ``depth``          | Bin centers in nominal meters (no sound speed profile correction).  |
+---------------------+---------------------------------------------------------------------+
|  ``tr_temp``        | ADCP transducer temperature.                                        |
+---------------------+---------------------------------------------------------------------+
|  ``pg``             | Percent Good pings for u, v averaging after editing.                |
+---------------------+---------------------------------------------------------------------+
|  ``amp``            | Received signal strength in ADCP-specific units; no correction      |
|                     | for spreading or attenuation.                                       |
+---------------------+---------------------------------------------------------------------+
|  ``pflag``          | Profile Flags based on editing, used to mask u, v.                  |
+---------------------+---------------------------------------------------------------------+




.. toctree::