.. DO NOT EDIT.
.. THIS FILE WAS AUTOMATICALLY GENERATED BY SPHINX-GALLERY.
.. TO MAKE CHANGES, EDIT THE SOURCE PYTHON FILE:
.. "auto_gallery/plot_example_topo.py"
.. LINE NUMBERS ARE GIVEN BELOW.

.. only:: html

    .. note::
        :class: sphx-glr-download-link-note

        :ref:`Go to the end <sphx_glr_download_auto_gallery_plot_example_topo.py>`
        to download the full example code.

.. rst-class:: sphx-glr-example-title

.. _sphx_glr_auto_gallery_plot_example_topo.py:


Plot topography
===========================

This example demonstrates how to display a topography using plot_topo from the plot module.

.. GENERATED FROM PYTHON SOURCE LINES 7-21

.. code-block:: Python

    import matplotlib.pyplot as plt

    from pytopomap.tools import read_tiff
    from pytopomap.plot import plot_topo

    # Load topography data from a GeoTIFF file (available on github)
    url = r"https://raw.githubusercontent.com/marcperuz/pytopomap/main/data/z.tif"
    x, y, z = read_tiff(url)

    # Basic usage: default topographic plot with hillshading and automatic contour intervals
    axe = plot_topo(z, x, y)

    plt.show()




.. image-sg:: /auto_gallery/images/sphx_glr_plot_example_topo_001.png
   :alt: plot example topo
   :srcset: /auto_gallery/images/sphx_glr_plot_example_topo_001.png
   :class: sphx-glr-single-img





.. GENERATED FROM PYTHON SOURCE LINES 22-33

Customized display with advanced parameters
-------------------------------------------
You can adjust many parameters such as:

- 'contour_step': spacing of contour lines

- 'vert_exag': vertical exaggeration in hillshading

- 'sea_level' and 'sea_color': simulate sea by coloring low-lying areas

- 'azdeg' and 'altdeg': lighting direction and altitude for hillshading

.. GENERATED FROM PYTHON SOURCE LINES 33-46

.. code-block:: Python


    axe = plot_topo(
        z, x, y,
        contour_step=10.,        # contour every 10 meters
        vert_exag=1.5,           # exaggerate elevation relief
        sea_color='blue',        # color sea areas in blue
        sea_level=1,             # set sea threshold at 1 meter
        azdeg=180,               # light coming from the south
        altdeg=25                # low-angle lighting for more contrast
    )

    plt.show()




.. image-sg:: /auto_gallery/images/sphx_glr_plot_example_topo_002.png
   :alt: plot example topo
   :srcset: /auto_gallery/images/sphx_glr_plot_example_topo_002.png
   :class: sphx-glr-single-img





.. GENERATED FROM PYTHON SOURCE LINES 47-60

Advanced styling
----------------
Control line appearance and labeling with:

- 'contours_prop': style of regular contours

- 'contours_bold_prop': style of bold contours

- 'label_contour': whether to label bold contours

- 'contour_labels_properties': font size, color etc.

- 'contour_label_effect': add outline effects for better readability

.. GENERATED FROM PYTHON SOURCE LINES 60-73

.. code-block:: Python


    axe = plot_topo(
        z, x, y,
        contour_step=20,
        step_contour_bold=40,
        contours_prop={"colors": "grey", "linestyles": "dashed", "linewidths": 0.4},
        contours_bold_prop={"colors": "black", "linewidths": 1.0},
        label_contour=True,
        contour_labels_properties={"fontsize": 8, "fmt": "%.0f"},
    )

    plt.show()




.. image-sg:: /auto_gallery/images/sphx_glr_plot_example_topo_003.png
   :alt: plot example topo
   :srcset: /auto_gallery/images/sphx_glr_plot_example_topo_003.png
   :class: sphx-glr-single-img





.. GENERATED FROM PYTHON SOURCE LINES 74-77

Using interpolation for smoother shading
----------------------------------------
You can also control how the hillshading is displayed using interpolation.

.. GENERATED FROM PYTHON SOURCE LINES 77-85

.. code-block:: Python


    axe = plot_topo(
        z, x, y,
        interpolation="bilinear",  # smooth shading
        alpha=0.8,                 # semi-transparent hillshading
    )

    plt.show()



.. image-sg:: /auto_gallery/images/sphx_glr_plot_example_topo_004.png
   :alt: plot example topo
   :srcset: /auto_gallery/images/sphx_glr_plot_example_topo_004.png
   :class: sphx-glr-single-img






.. rst-class:: sphx-glr-timing

   **Total running time of the script:** (0 minutes 1.945 seconds)


.. _sphx_glr_download_auto_gallery_plot_example_topo.py:

.. only:: html

  .. container:: sphx-glr-footer sphx-glr-footer-example

    .. container:: sphx-glr-download sphx-glr-download-jupyter

      :download:`Download Jupyter notebook: plot_example_topo.ipynb <plot_example_topo.ipynb>`

    .. container:: sphx-glr-download sphx-glr-download-python

      :download:`Download Python source code: plot_example_topo.py <plot_example_topo.py>`

    .. container:: sphx-glr-download sphx-glr-download-zip

      :download:`Download zipped: plot_example_topo.zip <plot_example_topo.zip>`


.. only:: html

 .. rst-class:: sphx-glr-signature

    `Gallery generated by Sphinx-Gallery <https://sphinx-gallery.github.io>`_