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

.. _zip_codas_instructions:

Download documentation and processing demo directories
--------------------------------------------------------

.. NOTE:: **If you are using a prebuilt Virtual Computer, you can skip this step**


At this point, you should have a working conda Python environment,
you have used Mercurial to clone our repositories into ``~/adcpcode/programs``,
and you have installed all the CODAS code.  Now we are going to get
components supporting topgraphy, documentation, and demos.

The components to be downloaded are zip archives served from
https://currents.soest.hawaii.edu/docs/zipped.  The most reliable way
to download them is by using the ``curl`` utility which is available
by default on MacOS.  You can probably right-click on the items and
select "download", but they may not land where you want them to be.
Follow the instructions below for a consistent result.

To download and install everything in the appropriate location, execute::

   cd ~/adcpcode/programs
   curl -O https://currents.soest.hawaii.edu/docs/zipped/adcp_doc.zip
   unzip adcp_doc.zip
   curl -O https://currents.soest.hawaii.edu/docs/zipped/codas_demos.zip
   unzip codas_demos.zip

The first of these contains the same documentation you are reading now:

+------------------------+-------------------------+--------------------------------------+
| zip archive            |         subdirectory    |  contents                            |
+========================+=========================+======================================+
| **DOCUMENTATION**      |                                                                |
+------------------------+-------------------------+--------------------------------------+
| adcp_doc.zip           | adcp_doc                |  - same contents as on WWW           |
+------------------------+-------------------------+--------------------------------------+

The second contains tutorial and demo material:

+---------------------------+---------------------------+----------------------------------------+
| zip archive               |         subdirectory      |  contents                              |
+===========================+===========================+========================================+
| **DEMO PROCESSING**       |                                                                    |
+---------------------------+---------------------------+----------------------------------------+
| codas_demos_proc.zip      | codas_demos/adcp_pyproc   |  - Python3 CODAS Processing Tutorials  |
+---------------------------+---------------------------+----------------------------------------+
|                           | codas_demos/uhdas_data    |  - UHDAS data                          |
+---------------------------+---------------------------+----------------------------------------+
|                           | codas_demos/vmdas_data    |  - VmDAS data                          |
+---------------------------+---------------------------+----------------------------------------+



Your **codas_demos** directory structure should look like this after unpacking:

.. image:: /images/codas_setup_config/codas_demos_layout.png
   :alt: codas_demos directory structure
   :scale: 100


The fourth and final step in getting CODAS processing to work, is
to download suitable topography.

(Return to :ref:`TOP <CODAS-packages>`)