File: index.rst

package info (click to toggle)
python-asdf 2.14.3-1%2Bdeb12u1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 2,280 kB
  • sloc: python: 16,612; makefile: 124
file content (102 lines) | stat: -rw-r--r-- 1,851 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
.. _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/legacy

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

Resources
=========

.. toctree::
  :maxdepth: 1

  asdf/contributing
  asdf/CODE_OF_CONDUCT.md
  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`