API Reference
=============

This is the auto-generated API reference documentation.

Core
----

The top-level stactools namespace.

These core functions and classes provide building blocks for working with STAC
catalogs and creating new STAC metadata.

Input and output
~~~~~~~~~~~~~~~~

.. automodule:: stactools.core.io
    :members:

.. automodule:: stactools.core.io.xml
    :members:

General utilities
~~~~~~~~~~~~~~~~~

.. automodule:: stactools.core.utils
    :members:

Antimeridian support
~~~~~~~~~~~~~~~~~~~~

.. automodule:: stactools.core.utils.antimeridian
    :members:

Converting assets
~~~~~~~~~~~~~~~~~

.. automodule:: stactools.core.utils.convert
    :members:

Running subprocesses
~~~~~~~~~~~~~~~~~~~~

.. automodule:: stactools.core.utils.subprocess
    :members:

Adding items to catalogs
~~~~~~~~~~~~~~~~~~~~~~~~

.. automodule:: stactools.core.add
    :members:

Adding the raster extension
~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. automodule:: stactools.core.add_raster
    :members:

Copying
~~~~~~~

.. automodule:: stactools.core.copy
    :members:

Creating
~~~~~~~~

.. automodule:: stactools.core.create
    :members:

Laying out STAC catalogs
~~~~~~~~~~~~~~~~~~~~~~~~

.. automodule:: stactools.core.layout
    :members:

Merging
~~~~~~~

.. automodule:: stactools.core.merge
    :members:

Reprojection
~~~~~~~~~~~~

.. automodule:: stactools.core.projection
    :members:

Raster footprint generation
~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. automodule:: stactools.core.utils.raster_footprint
    :members:

Geometry
~~~~~~~~

.. automodule:: stactools.core.geometry
    :members:

Testing
-------

Utilities for tests, usually used in stactools-packages.

Command line testing
~~~~~~~~~~~~~~~~~~~~

.. automodule:: stactools.testing.cli_test
    :members:

Fetching and using test data
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. automodule:: stactools.testing.test_data
    :members:
