.. _api_doc_ref:

icepyx Documentation (API)
==========================

.. image:: classes_user_uml.svg
  :width: 600
  :alt: UML Class Diagram illustrating the public-facing classes within icepyx, their attributes and methods, their relationships (e.g. component classes).

icepyx class diagram illustrating the library's public-facing classes, their attributes and methods, and their relationships.
Additional UML diagrams, including a more detailed, developer UML class diagram showing hidden parameters,
are available on `GitHub in the icepyx/doc/source/user_guide/documentation/ directory <https://github.com/icesat2py/icepyx/tree/development/doc/source/user_guide/documentation>`_.
Diagrams are updated automatically after a pull request (PR) is approved and before it is merged to the development branch.

.. toctree::
   :maxdepth: 1

   query
   read
   variables
   components
   types