Installation Strategy
--------------------------


We are documenting three ways to get a computer set up with CODAS
processing software.  There are others, for instance Homebrew (on
OSX), but choosing one of these three methods will save a great deal
of time.


**(Option #1) Virtual Computer:**

Install virtualization software such as
`Virtual Box <https://www.virtualbox.org/>`_ (free virtualization
software, runs on OSX, Windows, and Linux), download and
"import" the file containing a pre-built CODAS processing
computer with everything already installed and set up:

   - many fewer steps than other options
   - CODAS software is already installed and tested
   - includes topography
   - you can delete it when you don't want it anymore
   - the demos (for processing) are all copy-paste tested on the virtual machine
   - the virtual machine is Linux
   - actual data are kept on the user's computer (not inside
     the virtual computer) so they can be accessed and
     backed up with familiar tools

This is the best way to start out, and probably the only way to go if
you have a Windows computer.

- Follow `these instructions <virtual_computer/index.html>`_.
  You can then go straight to processing.

-----

**(Option #2) Anaconda on your own computer**:


Install components on a computer that is already running a compatible
operating system (Linux, OSX) using Anaconda.

Although there are several ways to install the collection of software
required for CODAS ADCP processing, we have chosen to document the use
of Anaconda, as a good one-stop-shopping mechanism for installing the
third party components required.  For the time being, this seems like
a good approach.

Anyone with OSX or Linux, might consider this.
Our documentation for the Virtual Computer (above) should work for any of these
operating systems, but the Anaconda documentation is geared towards OSX users.

      - advantages:

           + you already have a computer and are familiar with the
             operating system

           + you can have a Python2 and Python3 environment and switch
             between them (if so desired)

      - disadvantages:

           + takes a little more time to install than the Virtual Computer

- To install the CODAS suite on your computer, work your way through
  `these steps <anaconda_install/index.html>`_ to install Anaconda so it will
  support CODAS processing.

- Then `install and configure CODAS <codas_config/index.html>`_,
  and your computer will be ready for processing.

----

**(Option #3) Ubuntu**:

Install a recommended version of Ubuntu (Linux) and put the
components on that new machine (presently Xubuntu 18.04)

      - advantages:

           + concise and tested installation instructions, at least for
             one version

      - disadvantages:

           + must start by installing the operating system
           + Linux may be unfamiliar


Scenarios

      (a) these instructions work for your computer
      (b) you want to install it on a new computer
      (c) you want to install it on a virtual machine

- Follow `these instructions <ubuntu_install/index.html>`_ to install
  required third-part programs on a recommended Ubuntu distribution.

- Then you are ready
  to  `install and configure CODAS <codas_config/index.html>`_,
  and your computer will be ready for processing.