.. _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/

.. note::

   ASDF 2.15 introduced a number of deprecation warnings in preparation
   for changes planned for ASDF 3.0. Please see the :ref:`deprecations`
   page for more information. Also see :ref:`whats_new` for a description
   of other major changes.

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
  asdf/developer_api

Developer Overview
==================

Currently a work in progress. Intended to give an overview of how the various
parts of ASDF interact and which modules do what and how.

.. toctree::
  :maxdepth: 1

  asdf/developer_overview

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) standard
  <asdf-standard:asdf-standard>`.

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

Index
=====

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