Skip to content

Latest commit

 

History

History
111 lines (89 loc) · 2.21 KB

index.rst

File metadata and controls

111 lines (89 loc) · 2.21 KB
Raw
orphan:

openPMD C++ & Python API

This library provides an abstract API for openPMD file handling. It provides both support for writing & reading into various formats and works both serial and parallel (MPI). Implemented backends include HDF5 and ADIOS1.

Doxygen

The latest Doxygen docs for the C++ API are published at:

http://www.openpmd.org/openPMD-api

/* front page: hide chapter titles * needed for consistent HTML-PDF-EPUB chapters */ div#installation.section, div#usage.section, div#development.section, div#backends.section, div#utilities.section { display:none; }

Supported openPMD Standard Versions

openPMD-api is a library using semantic versioning, starting with version 1.0.0.

The supported version of the openPMD standard are reflected as follows: standardMAJOR.apiMAJOR.apiMINOR.

openPMD-api version supported openPMD standard versions
1.0.0+ 1.0.1-1.1.0 (not released yet)
2.0.0+ 2.0.0+ (not released yet)
0.1.0-0.9.0 (alpha) 1.0.0-1.1.0

Installation

.. toctree::
   :caption: INSTALLATION
   :maxdepth: 1
   :hidden:

   install/install
   install/changelog
   install/upgrade

Usage

.. toctree::
   :caption: USAGE
   :maxdepth: 1
   :hidden:

   usage/firstwrite
   usage/firstread
   usage/serial
   usage/parallel
   usage/examples

Development

.. toctree::
   :caption: DEVELOPMENT
   :maxdepth: 1
   :hidden:

   dev/contributing
   dev/repostructure
   dev/backend
   dev/dependencies
   dev/buildoptions
   dev/sphinx
   dev/doxygen
   dev/release

Backends

.. toctree::
   :caption: BACKENDS
   :maxdepth: 1
   :hidden:

   backends/json
   backends/adios1

Utilities

.. toctree::
   :caption: UTILITIES
   :maxdepth: 1
   :hidden:

   utilities/benchmark.rst