..  _getting_started:

***************
Getting started
***************

New to ``xarray-spatial``? Start here.

* :doc:`why_xarray_spatial` -- what the library does and how it differs
  from GDAL-based tools.
* :doc:`installation` -- Python and platform requirements, environment
  setup, and the optional dependency extras.
* :doc:`quickstart` -- a runnable first analysis on synthetic terrain,
  with no data download.
* :doc:`examples_and_data` -- the ``xrspatial`` command-line tool for
  downloading the example notebooks and sample datasets.

From there, the :doc:`user guide </user_guide/index>` has worked examples
for every module, and the :doc:`API reference </reference/index>`
documents each function.

.. toctree::
   :maxdepth: 2
   :hidden:

   why_xarray_spatial
   installation
   quickstart
   examples_and_data