.. ......................................
.. UHDAS/CODAS restructured text document
.. ......................................


Description of External Packages
------------------------------------


These are (most of) the supporting packages required for full CODAS
Python processing.

This is a summary of packages and the reason for using them.  Versions
given correspond to Xubuntu 18.04.  Where noted, a specific version
is required; otherwise, updating to a newer version is probably fine
(but do it at your own risk: we may not have tested it).


+--------------------------+-----------------+-------------------------------------------------------+
| Package (version)        | Xubuntu 16.04   |   CODAS suite: components and purpose                 |
+==========================+=================+=======================================================+
| gcc (c-compiler)         | 7.3.0           |  Required: compile CODAS executables                  |
+--------------------------+-----------------+-------------------------------------------------------+
| python                   | 3.6 or 3.7      |   (not python2.7)  runs processing steps              |
+--------------------------+-----------------+-------------------------------------------------------+
| mercurial                | 4.5.3           |  version control, download or update CODAS software   |
+--------------------------+-----------------+-------------------------------------------------------+
| numpy                    | 1.13.3          |  replaces the numerical component of matlab           |
+--------------------------+-----------------+-------------------------------------------------------+
| matplotlib               | 2.1.1           |  replaces the graphical component of matlab           |
+--------------------------+-----------------+-------------------------------------------------------+
| basemap                  |                 |  replaces the m_map for use with topography           |
|                          |                 +-------------------------------------------------------+
|                          |                 |  requires installation of a bathymetry product        |
+--------------------------+-----------------+-------------------------------------------------------+
|  python Qt               | PyQt5           |  some critical CODAS Python interactive graphical     |
|                          |                 |  tools use Qt librarieds                              |
|                          |                 +-------------------------------------------------------+
|                          |                 |  -  codas ``dataviewer.py`` viewer                    |
|                          |                 |  -  codas ``gautoedit`` Python editing                |
|                          |                 |  -  VmDAS processing tool ``adcp_database_maker.py``  |
+--------------------------+-----------------+-------------------------------------------------------+
| ipython                  | 5.5.5           |  powerful interactive Python shell; plays well with   |
|                          |                 |  matplotlib to create an interactive environment      |
+--------------------------+-----------------+-------------------------------------------------------+
| netCDF4                  | 1.3.1           |  python3-netcdf4: extract data to network Common      |
|                          |                 |    Data Form                                          |
+--------------------------+-----------------+-------------------------------------------------------+