ASDF - Advanced Scientific Data Format

CI Status Downstream CI Status https://readthedocs.org/projects/asdf/badge/?version=latest https://codecov.io/gh/asdf-format/asdf/branch/main/graphs/badge.svg https://zenodo.org/badge/18112754.svg https://img.shields.io/pypi/l/asdf.svg pre-commit https://img.shields.io/badge/code%20style-black-000000.svg

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

The Advanced Scientific Data Format (ASDF) is a next-generation interchange format for scientific data. This package contains the Python implementation of the ASDF Standard. More information on the ASDF Standard itself can be found here.

The ASDF format has the following features:

  • A hierarchical, human-readable metadata format (implemented using YAML)

  • Numerical arrays are stored as binary data blocks which can be memory mapped. Data blocks can optionally be compressed.

  • The structure of the data can be automatically validated using schemas (implemented using JSON Schema)

  • Native Python data types (numerical types, strings, dicts, lists) are serialized automatically

  • ASDF can be extended to serialize custom data types

Note

This is the Advanced Scientific Data Format - if you are looking for the Adaptable Seismic Data Format, 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 Deprecations page for more information. Also see What’s New for a description of other major changes.

Getting Started

Extending ASDF

API Documentation

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.

Resources

See also

Index