File: index.rst

package info (click to toggle)
python-asdf 2.7.2-1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye, sid
  • size: 3,248 kB
  • sloc: python: 13,104; makefile: 125
file content (86 lines) | stat: -rw-r--r-- 1,911 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
**************************************
ASDF - Advanced Scientific Data Format
**************************************

``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/asdf_tool
   asdf/changes

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

.. toctree::
  :maxdepth: 2

  asdf/extensions.rst

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

Contributing and reporting issues
=================================

We welcome feedback and contributions of all kinds. Contributions of code,
documentation, or general feedback are all appreciated.

Feature requests and bug reports for the Python implementation can be posted at
`ASDF's github page <https://github.com/spacetelescope/asdf>`_.

The ASDF Standard itself also has a repository on github. Suggestions for
improvements to the ASDF Standard can be reported `here
<https://github.com/spacetelescope/asdf-standard>`_.

See also
========

- The `Advanced Scientific Data Format (ASDF) standard
  <https://asdf-standard.readthedocs.io/>`__

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

Index
=====

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