.. _asdf:

**************************************
ASDF - Advanced Scientific Data Format
**************************************

.. only:: html

  .. include:: ../README.rst
      :start-after: begin-badges:
      :end-before: end-badges:

`asdf` is a tool for reading and writing Advanced Scientific Data
Format (ASDF) files.

.. include:: ../README.rst
    :start-after: begin-summary-text:
    :end-before: end-summary-text:

.. note::

    This is the **A**\ dvanced **S**\ cientific **D**\ ata **F**\ ormat - if
    you are looking for the
    **A**\ daptable **S**\ eismic **D**\ ata **F**\ ormat,
    go here: http://seismic-data.org/


Getting Started
===============

.. toctree::
  :maxdepth: 2

  _asdf/install
  _asdf/overview
  _asdf/features
  _asdf/config
  _asdf/asdf_tool

.. _extending:

Extending ASDF
==============

.. toctree::
  :maxdepth: 2

  _asdf/extending/use_cases
  _asdf/extending/uris
  _asdf/extending/schemas
  _asdf/extending/resources
  _asdf/extending/converters
  _asdf/extending/extensions
  _asdf/extending/manifests
  _asdf/extending/compressors
  _asdf/extending/validators

API Documentation
=================

.. toctree::
  :maxdepth: 1

  _asdf/user_api/index
  _asdf/developer_api

Resources
=========

.. toctree::
  :maxdepth: 1

  _asdf/contributing
  _asdf/CODE_OF_CONDUCT
  _asdf/release_and_support
  _asdf/whats_new
  _asdf/deprecations
  _asdf/changes
  _asdf/citation

See also
========

- The :ref:`Advanced Scientific Data Format (ASDF) specification
  <asdf-standard:asdf-standard>`.

- `asdf` Python package distribution on `pypi <https://pypi.org/project/asdf/>`_

Index
=====

* :ref:`genindex`
* :ref:`modindex`