Skip to content

Latest commit

 

History

History
62 lines (44 loc) · 1.65 KB

index.rst

File metadata and controls

62 lines (44 loc) · 1.65 KB

pyXpcm: Ocean Profile Classification Model

pyXpcm is a python package to create and work with ocean Profile Classification Model that consumes and produces Xarray objects. Xarray objects are N-D labeled arrays and datasets in Python.

An ocean Profile Classification Model allows to automatically assemble ocean profiles in clusters according to their vertical structure similarities. The geospatial properties of these clusters can be used to address a large variety of oceanographic problems: front detection, water mass identification, natural region contouring (gyres, eddies), reference profile selection for QC validation, etc... The vertical structure of these clusters furthermore provides a highly synthetic representation of large ocean areas that can be used for dimensionality reduction and coherent intercomparisons of ocean data (re)-analysis or simulations.

Documentation

Getting Started

.. toctree::
    :maxdepth: 1
    :hidden:
    :caption: Getting Started

    overview
    install
    model_catalogue

User guide

.. toctree::
    :maxdepth: 1
    :hidden:
    :caption: User guide

    example.ipynb
    pcm_prop.ipynb
    io.ipynb
    debug_perf.ipynb


Help & reference

.. toctree::
    :maxdepth: 1
    :hidden:
    :caption: Help & reference

    bibliography
    whats-new
    api