PySTAC Documentation
####################
PySTAC is a library for working with `SpatioTemporal Asset Catalogs (STAC)
`_ in `Python 3 `_. Some nice features
of PySTAC are:
* Reading and writing STAC version 1.0. Future versions will read older versions of
STAC, but always write the latest supported version. See :ref:`stac_version_support`
for details.
* In-memory manipulations of STAC catalogs.
* Extend the I/O of STAC metadata to provide support for other platforms (e.g. cloud
providers).
* Easy, efficient crawling of STAC catalogs. STAC objects are only read in when needed.
* Easily write "absolute published", "relative published" and "self-contained" catalogs
as :stac-spec:`described in the best practices documentation
`.
.. raw:: html
.. grid:: 1 2 2 2
:gutter: 2
.. grid-item-card:: Get Started
* :doc:`installation`: Instructions for installing the basic package as well as
extras.
* :doc:`quickstart`: Jupyter notebook tutorial on using PySTAC for reading &
writing STAC catalogs.
.. grid-item-card:: Go Deeper
* :doc:`concepts`: Overview of how various concepts and structures from the STAC
Specification are implemented within PySTAC.
* :doc:`tutorials`: In-depth tutorials on using PySTAC for a number of different
applications.
* :doc:`api`: Detailed API documentation of PySTAC classes, methods, and functions.
Related Projects
================
* `pystac-client `__: A Python client for
working with STAC Catalogs and APIs.
* `stactools `__: A command line tool and
library for working with STAC.
* `sat-stac `__: A Python 3 library for reading
and working with existing Spatio-Temporal Asset Catalogs (STAC). *Much of PySTAC
builds on the code and concepts of* ``sat-stac``.
.. toctree::
:maxdepth: 2
:hidden:
installation
quickstart
concepts
api
tutorials
contributing