Where to find information
---------------------------

All paths are relative to the base of the processing
directory (where you see dbinfo.txt, cruise_info.txt, adcpdb, etc)


+----------------------------------------+----------------------------------------------+
|  (what to check)  How Do I ...         |      where/how to check it                   |
+========================================+==============================================+
| ... find is a summary of               | ``cruise_info.txt``  (fill in yourself)      |
|    processing steps?                   |                                              |
+----------------------------------------+----------------------------------------------+
| ... find what transducer               |  - ``adcpdb/dbname.cnh`` (certainly)         |
| angle was used in processing?          |  - ``cruise_info.txt``    (probably)         |
+----------------------------------------+----------------------------------------------+
| ... see instrument settings            | - ``adcpdb/dbname.cnh``                      |
|    used in data collection?            |                                              |
+----------------------------------------+----------------------------------------------+
| ... see settings used                  | in the "config" directory, ONE of these      |
|    in old Matlab processing            |  - ``cruiseid_cfg.m``, ``cruiseid_proc.m``   |
+----------------------------------------+----------------------------------------------+
| ... see settings used                  | in the "config" directory,                   |
|    in more recent Matlab processing    |  - proc_setup_onship.py                      |
+----------------------------------------+----------------------------------------------+
| ... see settings used                  | in the "config" directory                    |
|    in all-Python processing            |  - ``cruiseid_proc.py``                      |
+----------------------------------------+----------------------------------------------+
| ... determine whether a heading        | ``cal/rotate/scn.hdg`` (variables are:       |
|    correction was present?             |   ``dday, h_mean, h_last, dh``)              |
+----------------------------------------+----------------------------------------------+
| ...  examime the quality of            | ``cal/rotate/ens_hcorr.asc, *.png``          |
|      the heading  correction device    |                                              |
|      as applied to data                |                                              |
+----------------------------------------+----------------------------------------------+
| ... tell whether a separate rotation   | ``cal/rotate/rotate.log``                    |
|     was applied? (or scale factor)     |                                              |
+----------------------------------------+----------------------------------------------+
| ... examine watertrack                 |  ``cal/watertrk/adcpcal.out, *.png``         |
|     calibration?                       |                                              |
+----------------------------------------+----------------------------------------------+
| ... examine bottomtrack                |  ``cal/botmtrk/btcaluv.out, *.png``          |
|     calibration?                       |                                              |
+----------------------------------------+----------------------------------------------+
| ... plot navigation?                   |                                              |
|      ... from codas database:          | ``plot_nav.py nav/dbname.gps``               |
|      ... from rbins:                   |  ``plot_rnav.py --help``                     |
+----------------------------------------+----------------------------------------------+
| ... look at processed data?            |  ``dataviewer.py adcpdb/dbname``             |
+----------------------------------------+----------------------------------------------+
| ... make matlab files?                 |  ``quick_adcp.py --steps2rerun matfiles``    |
+----------------------------------------+----------------------------------------------+
| ... view rbins?                        |  ``plot_rbins.py  --help``                   |
|                                        |                                              |
| ... view ADCP raw data?                |  ``plot_rawadcp.py --help``                  |
+----------------------------------------+----------------------------------------------+
| ... see a summary of uhdas files?      | ``uhdas_info.py --help``                     |
+----------------------------------------+----------------------------------------------+
| ... see a summary of VmDAS files?      |  ``vmdas_info.py --help``                    |
+----------------------------------------+----------------------------------------------+
| ... compare data from 2  instruments?  |  ``dataviewer.py -c sonar1 sonar2``          |
+----------------------------------------+----------------------------------------------+
| ... get a modern python                |   ``uhdas_proc_gen.py --help``               |
|     configuration file for             |                                              |
|     processing?                        |                                              |
+----------------------------------------+----------------------------------------------+
| ... know if I must                     |  With Python processing, it's relatively     |
|     remake gbins?                      |  fast and unless you just made them with     |
|                                        |  your present code, they probably need to    |
|                                        |  redone.                                     |
|                                        |                                              |
|                                        |  Any of these requires new gbins:            |
|                                        |  - if they were generated with matlab        |
|                                        |  - if you are changing serial inputs         |
|                                        |  - if you remade the rbins                   |
|                                        |                                              |
+----------------------------------------+----------------------------------------------+
| ... remake gbins?                      | Add this line to q_py.cnt (control file)     |
|                                        |    ``--update_gbin``                         |
|                                        |  (rename the original first)                 |
+----------------------------------------+----------------------------------------------+
| ... look at gbin or                    |  - view rbins: plot_rbins.py ...             |
|     rbin data?                         |  - programming: load and plot it yourself    |
|                                        |                                              |
|                                        |       * ``BinfileSet`` (python load)         |
|                                        |       * ``RbinSet`` (python load -- uses QC) |
|                                        |       * ``read_bin.m`` (matlab load)         |
|                                        |                                              |
+----------------------------------------+----------------------------------------------+
| ... know if I must                     |   Rarely, but these are good reasons:        |
|     remake rbins?                      |                                              |
|                                        |   - if there are unexplained gaps in your    |
|                                        |     data (old cruises) this might            |
|                                        |     patch them                               |
|                                        |   - if there are multiple cruise legs, the   |
|                                        |     rbins at the end of the earlier          |
|                                        |     legs might not have been completed       |
|                                        |   - **REMAKE the gbins** if you              |
|                                        |     make new rbins                           |
|                                        |                                              |
+----------------------------------------+----------------------------------------------+
| ... remake rbins?                      | ``asc2bin.py --help`` (for UHDAS)            |
|                                        | ``serasc2bin --help`` (for VmDAS)            |
|                                        | ``mk_rbin.py --help`` (for uhdas; gets most) |
+----------------------------------------+----------------------------------------------+
| ... account for horizontal GPS         | ``quick_adcp.py --steps2rerun navsteps:calib |
|       and ADCP separation?             | --xducer_dx X --xducer_dy Y --auto``         |
|                                        |                                              |
|                                        |   - X is the displacement in the port        |
|                                        |     direction                                |
|                                        |   - Y is the displacement along the keel     |
|                                        |                                              |
|                                        |  More detail about the ADCP-transducer       |
|                                        |   horizontal offset can be found             |
|                                        |  :ref:`here <xducer_dxdy>`.                  |
+----------------------------------------+----------------------------------------------+


.. toctree::
   :maxdepth: 1