.. image:: _static/epom.png
    :width: 200px
    :height: 200px
    :align: center
    :alt: logo

.. _how_to_access:

How to Access the Notebooks
===========================

.. index:: access
.. index:: Python; notebooks

The **e-learning Python for Ocean Mapping** (ePOM) notebooks can be accessed in the three alternative ways:

- By accessing the `CCOM/JHC <http://ccom.unh.edu/>`_ :term:`servers<server>`.
- By installing `NOAA Pydro <https://svn.pydro.noaa.gov/Docs/html/Pydro/universe_overview.html>`_ *(Windows-only)*.
- By cloning the ePOM's GitHub repositories.


.. index:: ePOM; server

Access to the CCOM/JHC ePOM Servers
-----------------------------------

This option relies on the `CCOM/JHC <http://ccom.unh.edu/>`_ ePOM :term:`servers<server>`.
It is the easiest way to obtain access to the ePOM notebooks. You only need:

- An updated, modern :term:`browser` (e.g., `Mozilla Firefox <https://www.mozilla.org/en-US/firefox/>`_, `Google Chrome <https://www.google.com/chrome/>`_, `Apple Safari <https://www.apple.com/safari/>`_).
- An Internet connection.

The `CCOM/JHC <http://ccom.unh.edu/>`_ ePOM :term:`servers<server>` are configured with a `Python <https://www.python.org/>`_ environment that has `JupyterHub <https://jupyter.org/hub>`_
and all the required packages to run the notebooks. In order to access the `CCOM/JHC <http://ccom.unh.edu/>`_ ePOM :term:`servers<server>`, you need an username.
For obtaining an username, write to `epom@ccom.unh.edu <mailto:epom@ccom.unh.edu>`_.

Once obtained the username, read the following instructions:

* :ref:`python_basics`
* :ref:`ocean_data_science`


.. index:: Pydro

Installation of NOAA Pydro
--------------------------

`NOAA Pydro <https://svn.pydro.noaa.gov/Docs/html/Pydro/universe_overview.html>`_ is a free suite of open-source software tools used to support hydrography and cartography.
You can download the `NOAA Pydro <https://svn.pydro.noaa.gov/Docs/html/Pydro/universe_overview.html>`_ installers from the `NOAA Pydro download page <https://svn.pydro.noaa.gov/Docs/html/Pydro/downloads.html>`_. Pydro **only** works on Windows.

To have a full `NOAA Pydro <https://svn.pydro.noaa.gov/Docs/html/Pydro/universe_overview.html>`_ installation, download the following two files into the same folder,
then run the *PydroSetup* installer. It will automatically find and install the *PydroSupplemental* installer.

The ePOM notebooks are part of `NOAA Pydro <https://svn.pydro.noaa.gov/Docs/html/Pydro/universe_overview.html>`_. Once that you have installed `NOAA Pydro <https://svn.pydro.noaa.gov/Docs/html/Pydro/universe_overview.html>`_, you can access the notebooks
through a menu entry in Pydro Explorer (:numref:`pydro_explorer`).

.. _pydro_explorer:
.. figure:: ./_static/pydro_explorer.png
    :width: 600px
    :align: center
    :alt: Pydro Explorer
    :figclass: align-center

    The **Programming Basics with Python** menu entry in Pydro Explorer.

Pydro Explorer also provides the option to remove all the applied changes and thus restore the initial notebooks.


.. index:: ePOM; GitHub

Cloning the GitHub Repositories
-------------------------------

This third option assumes some previous knowledge on how to use `git <https://git-scm.com/>`_ and create a `NOAA Pydro <https://svn.pydro.noaa.gov/Docs/html/Pydro/universe_overview.html>`_ environment.

A common use case for this option is the willingness to contribute to the ePOM project by proposing improvements.

You can access (and clone) the ePOM's GitHub repositories at the following urls:

* `Programming Basics with Python <https://github.com/hydroffice/python_basics>`_
* `Introduction to Ocean Data Sciene <https://github.com/hydroffice/ocean_data_science>`_