.. _tutorials:

Tutorials
#########

PySTAC-Client Introduction
--------------------------

- :tutorial:`GitHub version <pystac-client-introduction.ipynb>`
- :ref:`Docs version </tutorials/pystac-client-introduction.ipynb>`

This tutorial gives an introduction to using pystac-client with a STAC API

STAC Metadata Visualization
---------------------------

- :tutorial:`GitHub version <stac-metadata-viz.ipynb>`
- :ref:`Docs version </tutorials/stac-metadata-viz.ipynb>`

This tutorial gives an introduction to using hvplot to visualize
STAC metadata and Item geometries on a map.

CQL2 Filtering
---------------------------

- :tutorial:`GitHub version <cql2-filter.ipynb>`
- :ref:`Docs version </tutorials/cql2-filter.ipynb>`

This tutorial gives an introduction to using CQL2-JSON filtering in searches to
search by arbitrary STAC Item properties.

Item Search with Intersects
-----------------------------------------------------

- :tutorial:`GitHub version <item-search-intersects.ipynb>`
- :ref:`Docs version </tutorials/item-search-intersects.ipynb>`

This tutorial demonstrates the use of different Python library
object types that can be used for the `intersects`
search parameter.

Calculating Coverage Percentage of the AOI by an Item
-----------------------------------------------------

- :tutorial:`GitHub version <aoi-coverage.ipynb>`
- :ref:`Docs version </tutorials/aoi-coverage.ipynb>`

This tutorial demonstrates the use of pystac-client to calculate the
percentage an Item's geometry that intesects with the area of interest
(AOI) specified in the search by the `intersects` parameter.

Authentication
--------------

- :tutorial:`GitHub version <authentication.md>`
- :ref:`Docs version </tutorials/authentication.md>`

This tutorial demontrates different ways the pystac-client can be
used to access a private stac api, when protected with various
authentication mechanisms.