.. highlight:: none

.. _compile_install:

Compile and install CODAS components
-------------------------------------------

.. 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,
and you have used Mercurial to clone our repositories
into ``~/adcpcode/programs``.

Check your Python environment.  Your prompt should include
``(pycodas)``; if it doesn't, execute ``conda activate pycodas``.  You
can also check your python version::

    python --version

should return something like::

    Python 3.9.1

The version number will depend on when and how you installed or last updated
Python.

In the following, administrative privileges are needed for some
operations, and obtained using ``sudo``.

Compile and install ``codas3`` (C code for libraries and executables) first.

For a **conda-based** installation::

    cd ~/adcpcode/programs/codas3
    ./waf configure --python_env
    ./waf build
    ./waf install
    cd ~

The ``--python_env`` option for the conda case will install to
standard locations in the pycodas environment within your home directory tree,
so no administrative permissions are required.

Now we compile the C extension code in the ``pycurrents`` package, and
install it along with the ``uhdas`` and ``onship`` packages. Most of
the CODAS processing tools are in ``pycurrents``.

For the **conda-based** installation::

    cd ~/adcpcode/programs/pycurrents
    pip3 install .
    cd ../uhdas
    pip3 insatll .
    cd ../onship
    pip3 install .
    cd ~

.. Note::
    The ``uhdas`` installation here is only for obtaining access to code used
    in processing data acquired with UHDAS.  It does not constitute the UHDAS
    system itself.

Now that you have compiled and installed CODAS C and Python
code, it is time for the next step: getting the non-Mercurial components.

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