From d73dcaee9cb919ec8124f345ae4efaf1f9e9cf18 Mon Sep 17 00:00:00 2001 From: Pete R Jemian Date: Thu, 30 Jun 2022 21:19:45 -0500 Subject: [PATCH 01/16] DOC #1165 history --- manual/source/history.rst | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/manual/source/history.rst b/manual/source/history.rst index 60187f43e0..3d9cdb2db3 100644 --- a/manual/source/history.rst +++ b/manual/source/history.rst @@ -11,6 +11,18 @@ Two things to note about the development and history of NeXus: - The NIAC has already discussed many matters related to the format. +2022-07: + * `release v2022.06 ` + of NeXus Definitions + +2020-10: + * `release v2020.10 ` + of NeXus Definitions + +2020-01: + * `release v2020.1 ` + of NeXus Definitions + 2018-05: * `release v2018.5 ` of NeXus Definitions From ec7f1dc5dc864b1f4d171f28ca6f2c7e25beb54c Mon Sep 17 00:00:00 2001 From: Pete R Jemian Date: Thu, 30 Jun 2022 21:33:35 -0500 Subject: [PATCH 02/16] DOC #1165 work-in-progress --- CHANGES.rst | 85 ++++++++++++++++++++++++++++++++++++++--------------- 1 file changed, 62 insertions(+), 23 deletions(-) diff --git a/CHANGES.rst b/CHANGES.rst index 07ae241b6e..08322f63fa 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -1,55 +1,94 @@ .. This file describes user-visible changes between the versions. - This human-composed file has been useful in other projects - useful to point out specific issues and pull requests that - contribute to a release. It can be composed as issues/PRs - are resolved and then cited from the release page documentation. - Highlights from the Change History, especially new releases, - should be added to manual/source/history.rst. + should be added to manual/history.rst. + + subsections could include these headings (in this order), omit if no content + + Notice + Breaking Changes + New Features and/or Enhancements + Fixes + Maintenance + Deprecations + Contributors Change History ############## -:v2022.06: expected *2022-06* +v2022.06 +++++++++ + +expected release *2022-07-01* + +This release is the result of two NeXus Code Camps ... + +Notice +------ + +Breaking Changes +---------------- + +* Minimum Python requirement (for testing and building documentation): 3.7 - .. TODO: document more changes +* Publishing workflow completely rebuilt in Python now in ``/dev_tools/`` + directory (was in ``/utils/``). - * `#955 `_ - Documentation built and published from GitHub Actions workflow +* Included PDF files moved `/pdf/` to `/_static/`. - * `#952 `_ - - drop support for Python <3.7 when building documentation & testing NXDL files - - included PDF file subdirectory changed from `pdf/` to `_static/` +New Features / Enhancements +--------------------------- - * `#884 `_ - switch repository default branch from master to main +* New contributed definitions for electron microscopy. - * `#878 `_ - Minimum Python requirement now: 3.6 +* All classes provide a list of reST & HTML anchors to every defined item + (groups, fields, attributes, & links). - * All classes provide a list of reST & HTML anchors to - every defined item (groups, fields, attributes, & links). +* Full vocabulary (names of all groups, fields, attributes, and links) now built + and published in the manual. -:v2020.10: released *2020-12-08* +Maintenance +----------- + +* Documentation built and published from GitHub Actions workflow + +* Switch repository default branch from master to main. + +Deprecations +------------ + +Contributors +------------ + +v2020.10 +++++++++ + +released *2020-12-08* * see Release Notes wiki: https://github.com/nexusformat/definitions/wiki/releasenotes_v2020.10 -:v2020.1: released *2020-01-31* +v2020.1 ++++++++ + +released *2020-01-31* * see Release Notes wiki: https://github.com/nexusformat/definitions/wiki/releasenotes_v2020.1 * The manual is now published through GitHub Pages: https://manual.nexusformat.org * We have a DOI (with zenodo https://zenodo.org/record/3629571) that updates with each release of the definitions repository. The DOI link is noted on our GitHub home page. -:v2018.5: released *2018-05-15* +v2018.5 +++++++++ + +released *2018-05-15* * `v2018.5 `_ see release notes: https://github.com/nexusformat/definitions/wiki/releasenotes__v2018.5 * `#597 `_ changed versioning scheme and procedures -:releases before v2018.5: +Releases before v2018.5 ++++++++++++++++++++++++ * 3.3 * 3.2 From e9ea603196bdab32ba3dd736c6ea3261c2d81d01 Mon Sep 17 00:00:00 2001 From: Pete R Jemian Date: Fri, 1 Jul 2022 09:32:03 -0500 Subject: [PATCH 03/16] DOC #1165 --- CHANGES.rst | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/CHANGES.rst b/CHANGES.rst index 08322f63fa..92be60f3a5 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -22,7 +22,17 @@ v2022.06 expected release *2022-07-01* -This release is the result of two NeXus Code Camps ... +This release is the result of NeXus Code Camps in 2021-03 and 2022-06, +a virtual NIAC meeting in 2022-03, and substantial work by both NeXus +Community and NIAC members. + +============= ======== +activity quantity +============= ======== +Pull Requests 134 +Issues 101 +Commits 250 +============= ======== Notice ------ From 748aa9f5ccd4abf7548d0578c740a6ff43a854d3 Mon Sep 17 00:00:00 2001 From: Pete R Jemian Date: Fri, 1 Jul 2022 09:44:58 -0500 Subject: [PATCH 04/16] DOC #1165 work in progress --- CHANGES.rst | 36 +++++++++++++++++++++++++++++------- 1 file changed, 29 insertions(+), 7 deletions(-) diff --git a/CHANGES.rst b/CHANGES.rst index 92be60f3a5..4ebd1562be 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -22,9 +22,13 @@ v2022.06 expected release *2022-07-01* -This release is the result of NeXus Code Camps in 2021-03 and 2022-06, -a virtual NIAC meeting in 2022-03, and substantial work by both NeXus -Community and NIAC members. +This release is the result of +a virtual NIAC meeting in 2022-03, +NeXus Code Camps in 2021-03 and 2022-06, +and substantial work by both the NeXus Community and NIAC members. + +Summary statistics from the GitHub definitions repository show +this activity since the (previous) v2020.10 release: ============= ======== activity quantity @@ -40,17 +44,22 @@ Notice Breaking Changes ---------------- +* Included PDF files moved `/pdf/` to `/_static/`. + * Minimum Python requirement (for testing and building documentation): 3.7 -* Publishing workflow completely rebuilt in Python now in ``/dev_tools/`` - directory (was in ``/utils/``). +* ``NXsnsevent`` & ``NXsnshisto`` category changed to ``application`` (was ``base``) -* Included PDF files moved `/pdf/` to `/_static/`. +* ``NXspecdata`` contributed definition withdrawn and removed. + +* Publishing workflow completely rebuilt in Python now in ``/dev_tools/`` + directory (was in ``/utils/``). All Python code adheres to automated + code style checking (``black`` and ``flake8``). New Features / Enhancements --------------------------- -* New contributed definitions for electron microscopy. +* New contributed definitions for electron microscopy, X-ray ptychography. * All classes provide a list of reST & HTML anchors to every defined item (groups, fields, attributes, & links). @@ -58,9 +67,17 @@ New Features / Enhancements * Full vocabulary (names of all groups, fields, attributes, and links) now built and published in the manual. +* new ``NX_COMPLEX`` datatype to describe complex numbers. + Maintenance ----------- +* Add ``depends_on`` (field) and ``NXtransformations`` (group) to more base classes. + +* Various documentation revised: + + * Description of links + * Documentation built and published from GitHub Actions workflow * Switch repository default branch from master to main. @@ -71,6 +88,11 @@ Deprecations Contributors ------------ +In addition to the NIAC members, these people have made contributions +to this release: + +* + v2020.10 ++++++++ From 55134f8f6908c8ac347240943afe5dac3f9f43ec Mon Sep 17 00:00:00 2001 From: Pete R Jemian Date: Fri, 1 Jul 2022 10:34:44 -0500 Subject: [PATCH 05/16] DOC #1165 from wiki release notes --- CHANGES.rst | 90 ++++++++++++++++++++++++++++++++++++++++++++++------- 1 file changed, 79 insertions(+), 11 deletions(-) diff --git a/CHANGES.rst b/CHANGES.rst index 4ebd1562be..5d9ccec046 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -50,48 +50,116 @@ Breaking Changes * ``NXsnsevent`` & ``NXsnshisto`` category changed to ``application`` (was ``base``) -* ``NXspecdata`` contributed definition withdrawn and removed. - * Publishing workflow completely rebuilt in Python now in ``/dev_tools/`` directory (was in ``/utils/``). All Python code adheres to automated code style checking (``black`` and ``flake8``). +* Removed ``NXlog`` group called ``temperature``. + New Features / Enhancements --------------------------- -* New contributed definitions for electron microscopy, X-ray ptychography. - * All classes provide a list of reST & HTML anchors to every defined item (groups, fields, attributes, & links). -* Full vocabulary (names of all groups, fields, attributes, and links) now built - and published in the manual. +* New + + * contributed definitions: + + * atom probe microscopy + * electron microscopy + * ellipsometry + * multidimensional photoemission spectroscopy + * ``NXregion`` + * X-ray photon correlation spectroscopy + + * Full vocabulary (names of all groups, fields, attributes, and links) now built + and published in the manual. + + * ``NX_COMPLEX`` data type to describe complex numbers. -* new ``NX_COMPLEX`` datatype to describe complex numbers. + * ``NX_COUNT`` unit type to describe counting events. Maintenance ----------- -* Add ``depends_on`` (field) and ``NXtransformations`` (group) to more base classes. +* Add -* Various documentation revised: + * ``depends_on`` (field) and ``NXtransformations`` (group) + to more base classes. + * ``NXdetector``: ``image_key`` + * ``NXdetector``, ``NXmx``: ``countrate_correction_lookup_table`` - * Description of links +* Change GitHub default branch to ``main`` (was ``master``). + +* Clarify: + + * naming rule of NXDL XML files + * symbol table in NXDL files + * ``NXdetector``: ``dimensions`` + * how ``default`` attribute is used to find the plottable data + * ``NXBeam``: various symbols and polarization fields * Documentation built and published from GitHub Actions workflow * Switch repository default branch from master to main. +* Units of flux corrected. + +* Various documentation revised: + + * Description of links + Deprecations ------------ +* ``incr`` attribute of ``dimensionType`` +* ``NXspecdata`` contributed definition withdrawn and removed. + Contributors ------------ In addition to the NIAC members, these people have made contributions to this release: -* +* Advanced Light Source + + * Dylan McReynolds + * Ron Pandolfi + * Juliane Reinhardt + * Padraic Shafer + +* Advanced Photon Source + + * Daniel Ching + * Miaoqi Chu + * Suresh Narayanan + * Qingteng Zhang + +* Dectris + + * sophie.hotz + * kal.conley + +* Diamond + + * Tim Snow + +* European Synchrotron Radiation Facility + + * Wout de Nolf + +* FAIRmat + + * Carola Emminger + * Florian Dobener + * Markus Kühbach + * Andrea Albino + +* National Synchrotron Light Source II + + * Abby Giles + * Andi Barbour v2020.10 ++++++++ From 724a150967cdbdaba9a0e2d53cf2f5ae4c2134f6 Mon Sep 17 00:00:00 2001 From: Pete R Jemian Date: Fri, 1 Jul 2022 10:42:01 -0500 Subject: [PATCH 06/16] DOC #1165 more contributors --- CHANGES.rst | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/CHANGES.rst b/CHANGES.rst index 5d9ccec046..2676b94a33 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -138,8 +138,8 @@ to this release: * Dectris - * sophie.hotz - * kal.conley + * Sophie Hotz + * Kal Conley * Diamond @@ -156,6 +156,11 @@ to this release: * Markus Kühbach * Andrea Albino +* GitHub users + + * cmmngr + * domna (Florian Dobener) + * National Synchrotron Light Source II * Abby Giles From fdb6766fb08187a8d810c686c6e1f1472f3b0939 Mon Sep 17 00:00:00 2001 From: Pete R Jemian Date: Fri, 1 Jul 2022 10:45:11 -0500 Subject: [PATCH 07/16] DOC #1165 re-arrange --- CHANGES.rst | 36 ++++++++++++++++++------------------ 1 file changed, 18 insertions(+), 18 deletions(-) diff --git a/CHANGES.rst b/CHANGES.rst index 2676b94a33..4adf451e8d 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -56,29 +56,30 @@ Breaking Changes * Removed ``NXlog`` group called ``temperature``. -New Features / Enhancements ---------------------------- +New Features +------------ -* All classes provide a list of reST & HTML anchors to every defined item - (groups, fields, attributes, & links). +* contributed definitions: -* New + * atom probe microscopy + * electron microscopy + * ellipsometry + * multidimensional photoemission spectroscopy + * ``NXregion`` + * X-ray photon correlation spectroscopy - * contributed definitions: +* Full vocabulary (names of all groups, fields, attributes, and links) now built + and published in the manual. - * atom probe microscopy - * electron microscopy - * ellipsometry - * multidimensional photoemission spectroscopy - * ``NXregion`` - * X-ray photon correlation spectroscopy +* ``NX_COMPLEX`` data type to describe complex numbers. - * Full vocabulary (names of all groups, fields, attributes, and links) now built - and published in the manual. +* ``NX_COUNT`` unit type to describe counting events. - * ``NX_COMPLEX`` data type to describe complex numbers. +Enhancements +------------ - * ``NX_COUNT`` unit type to describe counting events. +* All classes provide a list of reST & HTML anchors to every defined item + (groups, fields, attributes, & links). Maintenance ----------- @@ -119,8 +120,7 @@ Deprecations Contributors ------------ -In addition to the NIAC members, these people have made contributions -to this release: +In addition to the NIAC members, these people have contributed to this release: * Advanced Light Source From 1f0de804296f015773e8eb7da03802e64458192c Mon Sep 17 00:00:00 2001 From: Pete R Jemian Date: Fri, 1 Jul 2022 10:52:03 -0500 Subject: [PATCH 08/16] DOC #1165 --- CHANGES.rst | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/CHANGES.rst b/CHANGES.rst index 4adf451e8d..1d9c457948 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -161,6 +161,10 @@ In addition to the NIAC members, these people have contributed to this release: * cmmngr * domna (Florian Dobener) +* Helmholtz-Zentrum Berlin für Materialien und Energie + + * Heike Görzig + * National Synchrotron Light Source II * Abby Giles From 00908e65e59f919de784cf0a23b82d4e982c460e Mon Sep 17 00:00:00 2001 From: Pete R Jemian Date: Fri, 1 Jul 2022 10:56:17 -0500 Subject: [PATCH 09/16] DOC #1165 --- CHANGES.rst | 8 -------- 1 file changed, 8 deletions(-) diff --git a/CHANGES.rst b/CHANGES.rst index 1d9c457948..24863e39ed 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -145,10 +145,6 @@ In addition to the NIAC members, these people have contributed to this release: * Tim Snow -* European Synchrotron Radiation Facility - - * Wout de Nolf - * FAIRmat * Carola Emminger @@ -161,10 +157,6 @@ In addition to the NIAC members, these people have contributed to this release: * cmmngr * domna (Florian Dobener) -* Helmholtz-Zentrum Berlin für Materialien und Energie - - * Heike Görzig - * National Synchrotron Light Source II * Abby Giles From 5f80dc60f521e2fbf80d428d0cb30e01094d6484 Mon Sep 17 00:00:00 2001 From: Pete R Jemian Date: Fri, 1 Jul 2022 11:01:46 -0500 Subject: [PATCH 10/16] DOC #1165 --- CHANGES.rst | 5 ----- 1 file changed, 5 deletions(-) diff --git a/CHANGES.rst b/CHANGES.rst index 24863e39ed..b23450ca95 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -152,11 +152,6 @@ In addition to the NIAC members, these people have contributed to this release: * Markus Kühbach * Andrea Albino -* GitHub users - - * cmmngr - * domna (Florian Dobener) - * National Synchrotron Light Source II * Abby Giles From 3e002eab80cb33c3cde266bc77c9160dd7f02dc6 Mon Sep 17 00:00:00 2001 From: Pete R Jemian Date: Fri, 1 Jul 2022 11:31:39 -0500 Subject: [PATCH 11/16] DOC #1165 cite the wiki release notes --- CHANGES.rst | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/CHANGES.rst b/CHANGES.rst index b23450ca95..53e5b58133 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -17,6 +17,13 @@ Change History ############## +Highlights of each release are described below. +For more details, see our wiki [#]_ which provides links to the +Release Notes (itemized list of changes) for any release. + +.. [#]: https://github.com/nexusformat/definitions/wiki/Release-Notes + + v2022.06 ++++++++ @@ -38,8 +45,9 @@ Issues 101 Commits 250 ============= ======== -Notice ------- +.. nothing to report here + Notice + ------ Breaking Changes ---------------- From 49a9f6816c3a0e53dfa6ab4be3f6f3922883e755 Mon Sep 17 00:00:00 2001 From: Pete R Jemian Date: Fri, 1 Jul 2022 11:33:18 -0500 Subject: [PATCH 12/16] DOC #1165 reST --- CHANGES.rst | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/CHANGES.rst b/CHANGES.rst index 53e5b58133..281c2d29e5 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -17,11 +17,9 @@ Change History ############## -Highlights of each release are described below. -For more details, see our wiki [#]_ which provides links to the -Release Notes (itemized list of changes) for any release. - -.. [#]: https://github.com/nexusformat/definitions/wiki/Release-Notes +Highlights of each release are described below. For more details, see our wiki +(https://github.com/nexusformat/definitions/wiki/Release-Notes) +which provides links to the Release Notes (itemized list of changes) for any release. v2022.06 From 20e0a2492fcc99db84139889fe649b1ac1481b68 Mon Sep 17 00:00:00 2001 From: Pete R Jemian Date: Fri, 1 Jul 2022 11:36:37 -0500 Subject: [PATCH 13/16] DOC #1165 --- CHANGES.rst | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/CHANGES.rst b/CHANGES.rst index 281c2d29e5..517ebfcd07 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -50,18 +50,18 @@ Commits 250 Breaking Changes ---------------- -* Included PDF files moved `/pdf/` to `/_static/`. +* Included PDF files moved ``/pdf/`` to ``/_static/``. * Minimum Python requirement (for testing and building documentation): 3.7 -* ``NXsnsevent`` & ``NXsnshisto`` category changed to ``application`` (was ``base``) +* ``NXlog``: Removed group named ``temperature``. -* Publishing workflow completely rebuilt in Python now in ``/dev_tools/`` +* ``NXsnsevent`` & ``NXsnshisto``: category changed to ``application`` (was ``base``) + +* Publishing workflow completely rebuilt in Python, now in ``/dev_tools/`` directory (was in ``/utils/``). All Python code adheres to automated code style checking (``black`` and ``flake8``). -* Removed ``NXlog`` group called ``temperature``. - New Features ------------ From 4f68fdde2f569d8d69b84c29c1797f639c9557ba Mon Sep 17 00:00:00 2001 From: Pete R Jemian Date: Fri, 1 Jul 2022 11:38:49 -0500 Subject: [PATCH 14/16] DOC #1165 --- CHANGES.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGES.rst b/CHANGES.rst index 517ebfcd07..9fbd4c673c 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -147,7 +147,7 @@ In addition to the NIAC members, these people have contributed to this release: * Sophie Hotz * Kal Conley -* Diamond +* Diamond Light Source * Tim Snow From 2950150271bad44c9da3e112aa0ed30ce05be1b2 Mon Sep 17 00:00:00 2001 From: Pete R Jemian Date: Mon, 4 Jul 2022 16:34:17 -0500 Subject: [PATCH 15/16] DOC #1165 per review --- CHANGES.rst | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/CHANGES.rst b/CHANGES.rst index 9fbd4c673c..dfd2bcadcc 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -43,6 +43,9 @@ Issues 101 Commits 250 ============= ======== +See the wiki for more details: +https://github.com/nexusformat/definitions/wiki/releasenotes__v2022.06 + .. nothing to report here Notice ------ @@ -54,7 +57,7 @@ Breaking Changes * Minimum Python requirement (for testing and building documentation): 3.7 -* ``NXlog``: Removed group named ``temperature``. +* ``NXsample``: Removed group named ``temperature``. * ``NXsnsevent`` & ``NXsnshisto``: category changed to ``application`` (was ``base``) From 2268b5cdfc07b9bec7eb86598ccbf1b1b14d4745 Mon Sep 17 00:00:00 2001 From: Pete R Jemian Date: Tue, 5 Jul 2022 07:12:17 -0500 Subject: [PATCH 16/16] DOC #1165 ready for merge --- CHANGES.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGES.rst b/CHANGES.rst index dfd2bcadcc..6dfecb062a 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -25,7 +25,7 @@ which provides links to the Release Notes (itemized list of changes) for any rel v2022.06 ++++++++ -expected release *2022-07-01* +released *2022-07-05* This release is the result of a virtual NIAC meeting in 2022-03,