#!/usr/bin/env python3
# Copyright (c) 2021, GeoVista Contributors.
#
# This file is part of GeoVista and is distributed under the 3-Clause BSD license.
# See the LICENSE file in the package root directory for licensing details.

"""
DYNAMICO Mesh (Projected)
-------------------------

This example demonstrates how to render a projected unstructured hexagon/pentagon mesh.

📋 Summary
^^^^^^^^^^

Creates a mesh from 2D latitude and longitude unstructured cell bounds.

The resulting mesh contains hexagonal cells tessellated around 12 pentagon cells,
which are centered over the 12 vertices of a base icosahedron.

It uses surface air pressure data from the DYNAMICO project, a new dynamical core
for the Laboratoire de Météorologie Dynamique (LMD-Z), the atmospheric General
Circulation Model (GCM) part of Institut Pierre-Simon Laplace (IPSL-CM) Earth
System Model. The data targets the mesh faces/cells.

Note that a graticule and Natural Earth coastlines are rendered, and the
mesh is also transformed to the Polyconic pseudo-conical projection.

.. tags::

    component: coastlines, component: graticule,
    domain: meteorology,
    load: unstructured,
    projection: crs,
    version: 0.1.0

----

"""  # noqa: D205,D212,D400

from __future__ import annotations

import geovista as gv
from geovista.pantry.data import dynamico


def main() -> None:
    """Plot a projected DYNAMICO unstructured mesh.

    Notes
    -----
    .. versionadded:: 0.1.0

    """
    # Load the sample data.
    sample = dynamico()

    # Create the mesh from the sample data.
    mesh = gv.Transform.from_unstructured(
        sample.lons,
        sample.lats,
        data=sample.data,
        name=f"{sample.name} / {sample.units}",
    )

    # Plot the unstructured mesh.
    crs = "+proj=poly"
    p = gv.GeoPlotter(crs=crs)
    p.add_mesh(mesh, scalar_bar_args={"fmt": "%.0f"})
    p.add_coastlines()
    p.add_graticule()
    p.add_text(
        f"DYNAMICO Icosahedral ({crs})",
        position="upper_left",
        font_size=10,
    )

    # Define a specific camera position.
    p.view_xy()
    p.camera.zoom(1.2)

    p.add_axes()
    p.show()


if __name__ == "__main__":
    main()