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


Updating from Mercurial Repositories
====================================


Our source code and most documentation are in Mercurial repositories
to allow version control, documentation of changes, and access
`over the web <https://currents.soest.hawaii.edu/hg>`_.  Mercurial also
provides an easy and efficient way to update your code.

.. NOTE::  Although the CODAS processing code **can** be updated using
          Mercurial, there are occasional changes to the installation
          procedure that can cause problems with a normal update, in
          which case it is sometimes better to just throw away
          the old version and start over -- it all depends on how
          old your installation is.  This may require additional cleanup,
          deleting old installed versions, etc.  The most recent such
          examples were the change from distutils to setuptools for
          "installation" of CODAS Python libraries (2021), and
          utilization of 'pip' (2023).  

          If you have a question
          about this, please email uhdas@hawaii.edu and we'll help you figure out
          the best way forward.

------

Contents:

.. include::  hg_intro.rst
.. include::  hg_update.rst



.. toctree::
   :hidden: