Merge pull request #226 from ax3l/topic-version010alpha

Version: 0.1.0-alpha
openPMD · Jun 6, 2018 · 52b0c54 · 52b0c54
2 parents 9c83e19 + afe1a9e
commit 52b0c54
Show file tree

Hide file tree

Showing 4 changed files with 26 additions and 5 deletions.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -3,7 +3,12 @@
 Changelog
 =========
 
-1.0.0
------
+0.1.0-alpha
+-----------
+**Date:** 2018-06-06
 
-*TBD*
+This is the first developer release of openPMD-api.
+
+Both HDF5 and ADIOS1 are implemented as backends with serial and parallel I/O support.
+The C++11 API is considered alpha state with few changes expected to come.
+We also ship an unstable preview of the Python3 API.
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -80,7 +80,7 @@
 # The short X.Y version.
 version = u'0.1.0'
 # The full version, including alpha/beta/rc tags.
-release = u'0.1.0-dev'
+release = u'0.1.0-alpha'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -31,6 +31,22 @@ Implemented backends include HDF5 and ADIOS.
  }
  </style>
 
+Supported openPMD Standard Versions
+-----------------------------------
+
+openPMD-api is a library using `semantic versioning <https://semver.org/>`_, starting with version 1.0.0.
+
+The supported version of the `openPMD standard <https://github.com/openPMD/openPMD-standard>`_ are reflected as follows:
+``standardMAJOR.apiMAJOR.apiMINOR``.
+
+=================== ===================================
+openPMD-api version supported openPMD standard versions
+=================== ===================================
+``0.1.0+`` (alpha) ``1.0.0-1.1.0``
+``1.0.0+`` ``1.X`` (not released yet)
+``2.0.0+`` ``2.X`` (not released yet)
+=================== ===================================
+
 ************
 Installation
 ************

diff --git a/include/openPMD/version.hpp b/include/openPMD/version.hpp
@@ -24,7 +24,7 @@
 #define OPENPMDAPI_VERSION_MAJOR 0
 #define OPENPMDAPI_VERSION_MINOR 1
 #define OPENPMDAPI_VERSION_PATCH 0
-#define OPENPMDAPI_VERSION_LABEL "dev"
+#define OPENPMDAPI_VERSION_LABEL "alpha"
 
 // maximum supported version of the openPMD standard (read & write)
 #define OPENPMD_STANDARD_MAJOR 1