Merge pull request #2470 from willend/main

Various doc fixes etc toward release 3.7.0

Author: willend

CHANGES_McStas

@@ -61,11 +61,63 @@
 * Modified by: PW December 2025: version 3.6.1
 * Modified by: PW January 2026: version 3.6.5
 * Modified by: PW April 2026: version 3.6.14
+* Modified by: PW May 2026: version 3.7.0
 *
-* This file is part of McStas 3.6.14, released April 12th 2026.
+* This file is part of McStas 3.7.0, released May 21st 2026.
 * It gives a 'changes' list from the beginning of the project
 *
 *******************************************************************************/
+Changes in McStas/McXtrace 3.7.0, May 21st, 2026
+
+## What's Changed
+
+### Main new developments:
+#### Common McStas and McXtrace developments:
+* Up to 10 `USERVARS` supported with `Monitor_nD` (named `user0,...,user9`)
+* Qt5 → Qt6 across the package and dependencies
+* Bugfix: Fix of rare visualisation bug in `mcdisplay`/`mxdisplay` (e.g. box was not allowed as a comp name)
+* Doc improvements:
+  * `mcdoc`/`mxdoc` can render `.tex` and `.md` in addition to `.html`
+  * Example instruments come with an in-repo `README.md` generated via this mechanism
+  * See e.g. [McStas BNL_H8](https://github.com/mccode-dev/McCode/tree/main/mcstas-comps/examples/BNL/BNL_H8/README.md) or [McXtrace ESRF ID01](https://github.com/mccode-dev/McCode/tree/main/mcxtrace-comps/examples/ESRF/ESRF_ID01/README.md)
+* CI/test improvements:
+  *  `mcdisplay`/`mxdisplay` visualisation is performed as part of `mctest`/`mxtest`runs (→ CI)
+  * See top html files in [McStas](https://new-nightly.mcstas.org/todays-datafiles/) and [McXtrace](https://new-nightly.mcxtrace.org/todays-datafiles/) nightly test runs
+ 
+#### McStas specific developments:
+* Integrated support for [KDSource](https://github.com/KDSource/KDSource/releases/tag/v0.2.2) 
+  * New component `KDSource`
+  * For usage details, see example instrument [`Test_KDSource`](https://github.com/mccode-dev/McCode/tree/main/mcstas-comps/examples/Tests_MCPL_etc/Test_KDSource/README.md) and the [KDSource documentation website](https://kdsource.readthedocs.io/en/latest/)
+  * Available as automatic dependency on `conda-forge` based installations (including macOS and Windows 'installers'
+  * Not available as .deb package on Debian systems but may function by installing via pip. <br>**Recommendation**: Just use `conda-forge`.
+* Pulse-length adjustment available for `ESS_butterfly`
+  * Handled via specifically named instrument input parameter and `DEPENDENCY` line 
+  * See example instrument [`ESS_butterfly_Adjustable_Pulse`](https://github.com/mccode-dev/McCode/blob/main/mcstas-comps/examples/ESS/ESS_butterfly_Adjustable_Pulse/README.md)
+* `PowderN` now supports `NCrystal` `cfg`-strings.
+  * Forwards request to `NCrystal` that populates datastructures without intermediate `.laz/.lau` files
+  * See example instrument [Test_Powders](https://github.com/mccode-dev/McCode/blob/main/mcstas-comps/examples/Tests_samples/Test_Powders/README.md) - `comp=0` mode
+* Bugfixes:
+  * Fix to Union, orientation of loggers wrt. master comp
+  * Bugfixes to recently added improved Union mesh
+* Contributions from NBI/KU:
+  * `Inhomogenous_incoherent_process` in Union from @Lomholy, (via 'tinyexpr' string-expression inputs) - see rel. [test instrument](https://github.com/mccode-dev/McCode/blob/main/mcstas-comps/examples/Tests_union/Test_inhomogenous_process/README.md)
+  * New spinwave comp `SpinWave_BCO` from @SSBNS - see rel. [test instrument](https://github.com/mccode-dev/McCode/blob/main/mcstas-comps/examples/Tests_samples/Samples_SpinWave_BCO/README.md)
+  * [ESS KVASIR instrument proposal](https://github.com/mccode-dev/McCode/tree/main/mcstas-comps/examples/ESS/ESS_KVASIR/README.md) - backend instrument with MCPL input from BIFROST optic. @AmalieFalkenberg.  Includes Jupyter notebook in McStasScript syntax.
+* McStas component manual uses `.tex` snippets from generated via components `mcdoc`
+
+#### McXtrace specific developments:
+* Much improved [Union subsystem for McXtrace](https://github.com/mccode-dev/McCode/tree/main/mcxtrace-comps/union) by @ebknudsen. Makes use of [Xraylib](https://github.com/tschoonj/xraylib/wiki) for Compton and Rayleigh scattering models. 
+* Test instruments for the new Union processes, both from @ebknudsen 
+  * [PowderCompton_union](https://github.com/mccode-dev/McCode/blob/main/mcxtrace-comps/examples/Tests_union/PowderCompton_union/README.md) - Compton scattering and powder diffraction
+  * [Test_KN_Comp_Rayl_union](https://github.com/mccode-dev/McCode/blob/main/mcxtrace-comps/examples/Tests_union/Test_KN_Comp_Rayl_union/README.md) - test instrument using Klein-Nishina, Rayleigh, or Compton
+scattering processes.
+
+## New Contributors
+* @SSBNS made their first contribution in https://github.com/mccode-dev/McCode/pull/2373
+* @AmalieFalkenberg made their first contribution in https://github.com/mccode-dev/McCode/pull/2345
+
+**Full Changelog**: https://github.com/mccode-dev/McCode/compare/v3.6.14...v3.7.0
+
 Changes in McStas/McXtrace 3.6.14, April 12th, 2026
 ## What's Changed
 

CHANGES_McXtrace

@@ -15,6 +15,57 @@
 *
 * Documentation: CHANGES_McXtrace
 *************************************************************************/
+Changes in McStas/McXtrace 3.7.0, May 21st, 2026
+
+## What's Changed
+
+### Main new developments:
+#### Common McStas and McXtrace developments:
+* Up to 10 `USERVARS` supported with `Monitor_nD` (named `user0,...,user9`)
+* Qt5 → Qt6 across the package and dependencies
+* Bugfix: Fix of rare visualisation bug in `mcdisplay`/`mxdisplay` (e.g. box was not allowed as a comp name)
+* Doc improvements:
+  * `mcdoc`/`mxdoc` can render `.tex` and `.md` in addition to `.html`
+  * Example instruments come with an in-repo `README.md` generated via this mechanism
+  * See e.g. [McStas BNL_H8](https://github.com/mccode-dev/McCode/tree/main/mcstas-comps/examples/BNL/BNL_H8/README.md) or [McXtrace ESRF ID01](https://github.com/mccode-dev/McCode/tree/main/mcxtrace-comps/examples/ESRF/ESRF_ID01/README.md)
+* CI/test improvements:
+  *  `mcdisplay`/`mxdisplay` visualisation is performed as part of `mctest`/`mxtest`runs (→ CI)
+  * See top html files in [McStas](https://new-nightly.mcstas.org/todays-datafiles/) and [McXtrace](https://new-nightly.mcxtrace.org/todays-datafiles/) nightly test runs
+ 
+#### McStas specific developments:
+* Integrated support for [KDSource](https://github.com/KDSource/KDSource/releases/tag/v0.2.2) 
+  * New component `KDSource`
+  * For usage details, see example instrument [`Test_KDSource`](https://github.com/mccode-dev/McCode/tree/main/mcstas-comps/examples/Tests_MCPL_etc/Test_KDSource/README.md) and the [KDSource documentation website](https://kdsource.readthedocs.io/en/latest/)
+  * Available as automatic dependency on `conda-forge` based installations (including macOS and Windows 'installers'
+  * Not available as .deb package on Debian systems but may function by installing via pip. <br>**Recommendation**: Just use `conda-forge`.
+* Pulse-length adjustment available for `ESS_butterfly`
+  * Handled via specifically named instrument input parameter and `DEPENDENCY` line 
+  * See example instrument [`ESS_butterfly_Adjustable_Pulse`](https://github.com/mccode-dev/McCode/blob/main/mcstas-comps/examples/ESS/ESS_butterfly_Adjustable_Pulse/README.md)
+* `PowderN` now supports `NCrystal` `cfg`-strings.
+  * Forwards request to `NCrystal` that populates datastructures without intermediate `.laz/.lau` files
+  * See example instrument [Test_Powders](https://github.com/mccode-dev/McCode/blob/main/mcstas-comps/examples/Tests_samples/Test_Powders/README.md) - `comp=0` mode
+* Bugfixes:
+  * Fix to Union, orientation of loggers wrt. master comp
+  * Bugfixes to recently added improved Union mesh
+* Contributions from NBI/KU:
+  * `Inhomogenous_incoherent_process` in Union from @Lomholy, (via 'tinyexpr' string-expression inputs) - see rel. [test instrument](https://github.com/mccode-dev/McCode/blob/main/mcstas-comps/examples/Tests_union/Test_inhomogenous_process/README.md)
+  * New spinwave comp `SpinWave_BCO` from @SSBNS - see rel. [test instrument](https://github.com/mccode-dev/McCode/blob/main/mcstas-comps/examples/Tests_samples/Samples_SpinWave_BCO/README.md)
+  * [ESS KVASIR instrument proposal](https://github.com/mccode-dev/McCode/tree/main/mcstas-comps/examples/ESS/ESS_KVASIR/README.md) - backend instrument with MCPL input from BIFROST optic. @AmalieFalkenberg.  Includes Jupyter notebook in McStasScript syntax.
+* McStas component manual uses `.tex` snippets from generated via components `mcdoc`
+
+#### McXtrace specific developments:
+* Much improved [Union subsystem for McXtrace](https://github.com/mccode-dev/McCode/tree/main/mcxtrace-comps/union) by @ebknudsen. Makes use of [Xraylib](https://github.com/tschoonj/xraylib/wiki) for Compton and Rayleigh scattering models. 
+* Test instruments for the new Union processes, both from @ebknudsen 
+  * [PowderCompton_union](https://github.com/mccode-dev/McCode/blob/main/mcxtrace-comps/examples/Tests_union/PowderCompton_union/README.md) - Compton scattering and powder diffraction
+  * [Test_KN_Comp_Rayl_union](https://github.com/mccode-dev/McCode/blob/main/mcxtrace-comps/examples/Tests_union/Test_KN_Comp_Rayl_union/README.md) - test instrument using Klein-Nishina, Rayleigh, or Compton
+scattering processes.
+
+## New Contributors
+* @SSBNS made their first contribution in https://github.com/mccode-dev/McCode/pull/2373
+* @AmalieFalkenberg made their first contribution in https://github.com/mccode-dev/McCode/pull/2345
+
+**Full Changelog**: https://github.com/mccode-dev/McCode/compare/v3.6.14...v3.7.0
+
 Changes in McStas/McXtrace 3.6.14, April 12th, 2026
 ## What's Changed
 

INSTALL-McStas/Docker/README.md

@@ -1,4 +1,4 @@
-# Running McStas and McXtrace 3.6.14 in Docker / podman etc.
+# Running McStas and McXtrace 3.7.0 in Docker / podman etc.
 
 The container definition is available at [here](https://github.com/willend/jupyter-remote-desktop-proxy/tree/mcstas-mcxtrace-3.5) and is further on dockerhub under docker.io/mccode/mcstas-mcxtrace
 

INSTALL-McStas/Linux/README.md

@@ -1,4 +1,4 @@
-# Install McStas 3.6.14 on Linux and Unix.
+# Install McStas 3.7.0 on Linux and Unix.
 
 * We provide Debian packages, RedHat packages, and tar.gz's of "preconfigured" source code.
 

INSTALL-McStas/Linux/debian/README.md

@@ -1,4 +1,4 @@
-## Install McStas 3.6.14 On Debian class systems (including Ubuntu, mint etc.):
+## Install McStas 3.7.0 On Debian class systems (including Ubuntu, mint etc.):
 The packages have been tested to work correctly on Ubuntu 24.04.
 
 # Add the McCode repository
@@ -29,7 +29,7 @@ mcstas-tools-python-mcplot-pyqtgraph - python-tools-mcplot-pyqtgraph built using
 mcstas-tools-python-mcrun - python-tools-mcrun built using CMake
 ```
 The meta-package mcstas-suite-python (or mcstas-suite-python-ng)
-allows you to install mcstas 3.6.14 with tools (mcrun/mcplot etc.) by
+allows you to install mcstas 3.7.0 with tools (mcrun/mcplot etc.) by
 the simple apt-get command
 ```bash
 sudo apt-get install mcstas-suite-python

INSTALL-McStas/README.md

@@ -1,4 +1,4 @@
-# Installation instructions for McStas 3.6.14
+# Installation instructions for McStas 3.7.0
 
 Please consult the individual platform instructions:
 

INSTALL-McStas/Windows/README.md

@@ -1,4 +1,4 @@
-# Installation of McStas 3.6.14 on Windows 64 bit Intel systems (some support for arm64)
+# Installation of McStas 3.7.0 on Windows 64 bit Intel systems (some support for arm64)
 ## *IMPORTANT: active internet connection required during installation*
 
 * Please use either of:
@@ -10,7 +10,7 @@
     * Once install has completed, please use the `mcstas-shell` shortcut on the desktop - issue terminal command `mcgui` to start the McStas GUI. 
     * Option 1 *may* function `arm64` Windows, but will require installation of Visual Studio including both arm64 and x64_64 build tools for c++.
   2. **Legacy:**
-    * install the legacy-style MinGW based [McStas 3.6.14 metapackage](https://download.mcstas.org/mcstas-3.6.14/Windows/McStas-Metapackage-3.6.14-win64.exe)
+    * install the legacy-style MinGW based [McStas 3.7.0 metapackage](https://download.mcstas.org/mcstas-3.7.0/Windows/McStas-Metapackage-3.7.0-win64.exe)
     * Option 2 should be fully functional on `arm64` processors.
   3. **WSL:**
     * Use the directions available in [WSL](WSL/README.md) to install the "Windows subsystem for Linux" and run the Linux Debian binaries there. 

INSTALL-McStas/Windows/WSL/README.md

@@ -1,4 +1,4 @@
-# Installation of McStas 3.6.14 on Windows 64 bit systems - using WSL
+# Installation of McStas 3.7.0 on Windows 64 bit systems - using WSL
 *(WSL is the Windows Subsystem for Linux, aka. bash on Ubuntu on Windows)*
 
 
@@ -11,7 +11,7 @@ available, but we recommend Ubuntu)
 * To open it again later, simply issue bash in a terminal or through
 the start menu
 
-## Install the McStas 3.6.14 Debian packages
+## Install the McStas 3.7.0 Debian packages
 * Follow the
   [normal Debian installation instructions](../../Linux/debian/README.md)
   - essentially a matter of sudo apt-get install mcstas-suite-python

INSTALL-McStas/conda/README.md

@@ -1,6 +1,6 @@
-# Install McStas 3.6.14 through conda-forge (macOS, Linux or Windows host)
+# Install McStas 3.7.0 through conda-forge (macOS, Linux or Windows host)
 
-* We a set of conda-packages for installing McStas 3.6.14.x through conda
+* We a set of conda-packages for installing McStas 3.7.0.x through conda
 
 ## Get yourself a conda / mamba
 Due to the complex [licensing situation](https://discuss.scientific-python.org/t/response-to-anaconda-switch-to-paid-plans/1395) with the commercial Anaconda ecosystem, we clearly recommend McStas users to start from an open-source entry-point such as

INSTALL-McStas/macOS/README.md

@@ -1,4 +1,4 @@
-# Installation of McStas 3.6.14 on macOS 
+# Installation of McStas 3.7.0 on macOS 
 
 ## Supported macOS releases
 * macOS 11-15 (Big Sur and later, fully supported python tool set. Supported on both Intel and Apple Silicon,
@@ -7,16 +7,16 @@
 ## Steps to perform
 
 * Download the package:
-  [McStas 3.6.14 for macOS](https://download.mcstas.org/mcstas-3.6.14/macOS/mcstas-3.6.14-macOS-conda.tar.gz)
+  [McStas 3.7.0 for macOS](https://download.mcstas.org/mcstas-3.7.0/macOS/mcstas-3.7.0-macOS-conda.tar.gz)
  and unpack it (e.g. double-clicking should work).
 
 * Open the relevant folder for your local processor
 
-* Drag the McStas-3.6.14.app to /Applications and right-click + open to start the app:<br/>
+* Drag the McStas-3.7.0.app to /Applications and right-click + open to start the app:<br/>
 ![](screenshots/1_open-mcstas-from-Applications.png?raw=true)
 
 * Depending on your macOS version, security settings may initially prevent the app from opening, example from macOS 15 Sequoia:
-  - Initial warning that "McStas-3.6.14" was not opened<br/>
+  - Initial warning that "McStas-3.7.0" was not opened<br/>
   ![](screenshots/2_mcstas-not-opened.png?raw=true)
   - Next, go to System Preferences, Privacy and Security and select to
   "Open Anyway"<br/>
@@ -26,9 +26,9 @@
   - And finally give your password for installation to proceed<br/>
   ![](screenshots/5_admin-password.png?raw=true)
 
-* :warning: In case the last warning still does not allow to open the application, you may issue the following command in a Terminal: `sudo xattr -dr com.apple.quarantine /Applications/McStas-3.6.14.app`
+* :warning: In case the last warning still does not allow to open the application, you may issue the following command in a Terminal: `sudo xattr -dr com.apple.quarantine /Applications/McStas-3.7.0.app`
 
-* McStas 3.6.14 macOS app bundless are fully based on conda-forge and will "self-inject" all dependencies on first launch. Please follow any on-screen instructions given.
+* McStas 3.7.0 macOS app bundless are fully based on conda-forge and will "self-inject" all dependencies on first launch. Please follow any on-screen instructions given.
 
 * In case you have trouble accessing instrument files in certain areas
   of your disk, please give the McStas bundle "Full Disk Access"