From 7e7880d48f5fa2627e920ac66495521896223993 Mon Sep 17 00:00:00 2001 From: Sebastiaan Huber Date: Tue, 21 Sep 2021 10:08:50 +0200 Subject: [PATCH] Docs: add compatibility policy for Quantum ESPRESSO Added the current compatibility to the matrix in the README.md together with the new explicit policy. Section is added to the documentation that links the README.md. --- README.md | 17 ++++++++++------- docs/source/index.rst | 7 +++++++ 2 files changed, 17 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 683aaf3fd..77c8c3d53 100644 --- a/README.md +++ b/README.md @@ -8,13 +8,16 @@ This is the official AiiDA plugin for [Quantum ESPRESSO](https://www.quantum-esp ## Compatibility matrix -| Plugin | AiiDA | Python | -|-|-|-| -| `v3.4.0 < v4.0.0` | | [![PyPI pyversions](https://img.shields.io/pypi/pyversions/aiida-quantumespresso.svg)](https://pypi.org/project/aiida-quantumespresso.svg) | -| `v3.3.0 < v3.4.0` | | [![PyPI pyversions](https://img.shields.io/pypi/pyversions/aiida-quantumespresso.svg)](https://pypi.org/project/aiida-quantumespresso.svg) | -| `v3.1.0 < v3.3.0` | | [![PyPI pyversions](https://img.shields.io/pypi/pyversions/aiida-quantumespresso.svg)](https://pypi.org/project/aiida-quantumespresso.svg) | -| `v3.0.0 < v3.1.0` | | [![PyPI pyversions](https://img.shields.io/pypi/pyversions/aiida-quantumespresso/3.0.0.svg)](https://pypi.org/project/aiida-quantumespresso/3.0.0/) | -| `v2.0.0 < v3.0.0` | | [![PyPI pyversions](https://img.shields.io/pypi/pyversions/aiida-quantumespresso/2.1.svg)](https://pypi.python.org/pypi/aiida-quantumespresso/2.1.0/) | +| Plugin | AiiDA | Python | Quantum ESPRESSO | +|-|-|-|-| +| `v3.4.0 < v4.0.0` | | [![PyPI pyversions](https://img.shields.io/pypi/pyversions/aiida-quantumespresso.svg)](https://pypi.org/project/aiida-quantumespresso.svg) | 6.0, 6.1, 6.2, 6.3, 6.4, 6.5, 6.6, 6.7 | +| `v3.3.0 < v3.4.0` | | [![PyPI pyversions](https://img.shields.io/pypi/pyversions/aiida-quantumespresso.svg)](https://pypi.org/project/aiida-quantumespresso.svg) | 6.0, 6.1, 6.2, 6.3, 6.4, 6.5, 6.6, 6.7 | +| `v3.1.0 < v3.3.0` | | [![PyPI pyversions](https://img.shields.io/pypi/pyversions/aiida-quantumespresso.svg)](https://pypi.org/project/aiida-quantumespresso.svg) | 6.0, 6.1, 6.2, 6.3, 6.4, 6.5, 6.6, 6.7 | +| `v3.0.0 < v3.1.0` | | [![PyPI pyversions](https://img.shields.io/pypi/pyversions/aiida-quantumespresso/3.0.0.svg)](https://pypi.org/project/aiida-quantumespresso/3.0.0/) | 6.0, 6.1, 6.2, 6.3, 6.4, 6.5, 6.6, 6.7 | +| `v2.0.0 < v3.0.0` | | [![PyPI pyversions](https://img.shields.io/pypi/pyversions/aiida-quantumespresso/2.1.svg)](https://pypi.python.org/pypi/aiida-quantumespresso/2.1.0/) | 6.0, 6.1, 6.2, 6.3, 6.4, 6.5, 6.6, 6.7 | + +Starting from `aiida-quantumespresso==4.0`, the last three minor versions of Quantum ESPRESSO are supported. +Older versions are supported up to a maximum of two years. ## Installation To install from PyPI, simply execute: diff --git a/docs/source/index.rst b/docs/source/index.rst index 58ba12442..b32a9acbe 100755 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -30,6 +30,10 @@ You can install ``aiida-quantumespresso`` in your Python environment using ``pip Note that this command will also install the ``aiida-core`` package as one of its dependencies. For more information on how to install AiiDA and the required services in different environments, we refer to the |aiida-core documentation|_. +Compatibility +============= +For an overview of the plugin's compatibility with Python, AiiDA and Quantum ESPRESSO, please refer to the |README.md of the repository|_. + Getting Started =============== @@ -116,3 +120,6 @@ If you use this plugin and/or AiiDA for your research, please cite the following .. _NCCR MARVEL: http://nccr-marvel.ch/ .. _MaX – Materials Design at the Exascale: http://www.max-centre.eu/ .. _`swissuniversities P-5 project "Materials Cloud"`: https://www.materialscloud.org/swissuniversities + +.. |README.md of the repository| replace:: ``README.md`` of the repository +.. _README.md of the repository: https://github.com/aiidateam/aiida-quantumespresso/blob/develop/README.md