From f6889db7f50870795d4617b2185e70a4a76e8878 Mon Sep 17 00:00:00 2001 From: Toon Verstraelen Date: Mon, 8 Jun 2015 00:51:42 -0700 Subject: [PATCH] First shot at release planning --- doc/intro_horton_overview.rst | 2 +- doc/tech_ref.rst | 4 ++-- doc/tech_ref_release_planning.rst | 37 ++++++++++++++++++++++++++++++- 3 files changed, 39 insertions(+), 4 deletions(-) diff --git a/doc/intro_horton_overview.rst b/doc/intro_horton_overview.rst index d3bd362b..6a3f82aa 100644 --- a/doc/intro_horton_overview.rst +++ b/doc/intro_horton_overview.rst @@ -68,7 +68,7 @@ What HORTON is (or is hoped to be): alternative capabilities or better computational performance). To faciliate the use of HORTON within other programs, we guarantee no major `API `_ changes for - at least twelve months after each major release. Ensuring that HORTON can be + at least eighteen months after each major release. Ensuring that HORTON can be used in all three ways (as part of a larger program; as a stand-alone program; outside other programs) is a fundamental design principle of HORTON. diff --git a/doc/tech_ref.rst b/doc/tech_ref.rst index e5f13248..8fceaa26 100644 --- a/doc/tech_ref.rst +++ b/doc/tech_ref.rst @@ -25,13 +25,13 @@ Reference Documentation .. toctree:: :maxdepth: 3 - tech_ref_release_planning tech_ref_contributors + tech_ref_release_planning tech_ref_release_history tech_ref_file_formats tech_ref_grids tech_ref_gaussian_basis + tech_ref_functionals tech_ref_acronyms tech_ref_dictionary - tech_ref_functionals tech_ref_literature diff --git a/doc/tech_ref_release_planning.rst b/doc/tech_ref_release_planning.rst index a37f5003..47866126 100644 --- a/doc/tech_ref_release_planning.rst +++ b/doc/tech_ref_release_planning.rst @@ -23,7 +23,7 @@ Release planning ################ Stable API and beta code ------------------------- +======================== In order to ensure that users and developers spend as little time as possible performing maintenance work unrelated to research, the developers of HORTON have @@ -37,6 +37,9 @@ will not change the behaviour of your code. access private members of classes directly (i.e. _array in Matrix), you can expect breakage even between bugfix releases! +HORTON releases are given version numbers according to the `Semantic Versioning +Specification `_, which directly relates to API stability: + - Major releases (i.e. 1.x.x -> 2.x.x) will not guarantee compatiblity with past versions. @@ -63,3 +66,35 @@ will not change the behaviour of your code. * They do not adhere to this stable API policy. We reserve the right to break API in beta features at any time. + + +Unstable code in HORTON 2.0.0 +============================= + +Some parts of the 2.0.0 version have no stable API yet because of known problems +or because the code was not fully reviewed yet. + +* :py:mod:`horton.correaltedwfn` +* :py:mod:`horton.perturbation_theory` +* :py:mod:`horton.orbital_entanglement` +* :py:mod:`horton.orbital_utils` +* :py:mod:`horton.orbital_localization` + +In future release, we will report in this sectoin the API changes for the +unstable parts. + + +Features in development +======================= + +The following features are planned or are in a certain state of development. +If you are interested in testing or cobtributing in any of these areas, send a +mail to `the HORTON mailing list +`_. + +======== ======================================================================= + Target Feature +======== ======================================================================= + 2.1.0 MGGA Functionals + 2.1.0 Range-separated exchange integrals +======== =======================================================================