Merge pull request #1973 from mccode-dev/pre-3.5.27-doc-touchup

Document new install batches for McStas/McXtrace from conda-forge

Author: willend

CHANGES_McStas

@@ -55,11 +55,78 @@
 * Modified by: PW November 2024: version 3.5.12
 * Modified by: PW December 2024: version 3.5.16
 * Modified by: PW February 2025: version 3.5.24
+* Modified by: PW February 2025: version 3.5.24
 *
-* This file is part of McStas 3.5.24, released February 19th 2025.
+* This file is part of McStas 3.5.27, released April 29th 2025.
 * It gives a 'changes' list from the beginning of the project
 *
 *******************************************************************************/
+Changes in McStas/McXtrace 3.5.27, April 29th, 2025
+## What's Changed
+
+### Common new features and patches for McStas and McXtrace (tools, random numbers etc.)
+* Update rootmccode to work with new version of ROOT by @ebknudsen in https://github.com/mccode-dev/McCode/pull/1862
+* Add wrapper for mc/mxdisplay-cad on Windows by @willend in https://github.com/mccode-dev/McCode/pull/1888
+* Input flag -y / --yes applies all instrument parameter default values by @willend in https://github.com/mccode-dev/McCode/pull/1914
+* PowderN and SX fixes: cif2hkl now searches correctly files using Open_File/real path, and sets 'barns=1' by @farhi in https://github.com/mccode-dev/McCode/pull/1952
+* Correct implementation to use unit64_t (achieves a correct 64bit RNG also on Windows...) by @willend in https://github.com/mccode-dev/McCode/pull/1955 and https://github.com/mccode-dev/McCode/pull/1966
+* Add simple test of KISS RNG across platforms and compilers by @willend in https://github.com/mccode-dev/McCode/pull/1956
+* Suppress const char in the cif2hkl fcts by @willend in https://github.com/mccode-dev/McCode/pull/1957
+* Use mcpl 2.0 proper on Windows. by @willend in https://github.com/mccode-dev/McCode/pull/1962
+
+### New McStas specific features and patches
+* Full adaptation of "spin-component nullification" after "spin up/down measurement" by @willend in https://github.com/mccode-dev/McCode/pull/1886 (see also discussion on [mcstas-users](https://mailman2.mcstas.org/pipermail/mcstas-users/2025q2/001566.html)
+* Add component name in "segno" related Exit/Error statement by @willend in https://github.com/mccode-dev/McCode/pull/1895
+* Allow further geometries for He3 cell component by @willend in https://github.com/mccode-dev/McCode/pull/1915
+* Contributed component Source_custom by @pablogila in https://github.com/mccode-dev/McCode/pull/1911 and https://github.com/mccode-dev/McCode/pull/1946
+* Update MCPL_input.comp by @g5t in https://github.com/mccode-dev/McCode/pull/1924
+* PowderN: remove a static variable declare from SHARE section by @willend in https://github.com/mccode-dev/McCode/pull/1945
+* Comp updates from work on ESS SKADI by @willend in https://github.com/mccode-dev/McCode/pull/1948
+* Add COPY SHARE to Diaphragm Slit-alias-comp + add in McXtrace by @willend in https://github.com/mccode-dev/McCode/pull/1950
+
+### New McXtrace specific features and patches
+* McXtrace: data: refactor reflec_xraydb.py: refactor by @farhi in https://github.com/mccode-dev/McCode/pull/1897
+* McXtrace: work in data/reflec_xraydb script by @farhi in https://github.com/mccode-dev/McCode/pull/1916
+* mcxtrace:powderN: Update PowderN.comp: reduce nb of printed warnings by @farhi in https://github.com/mccode-dev/McCode/pull/1919
+* McXtrace: Fluorescence handling ala PowderN by @willend in https://github.com/mccode-dev/McCode/pull/1942
+* mcxtrace: instrument.y sync from mcstas by @willend in https://github.com/mccode-dev/McCode/pull/1943
+* Add Diaphragm Slit-alias-comp in McXtrace  by @willend in https://github.com/mccode-dev/McCode/pull/1950
+* McXtrace: samples: add Fluo+PowderN component by @farhi in https://github.com/mccode-dev/McCode/pull/1951
+* @farhi mcgui tooltip edits from https://github.com/mccode-dev/McCode/pull/1952 by @willend in https://github.com/mccode-dev/McCode/pull/1953
+* Mcxtrace fluo sx 1 by @farhi in https://github.com/mccode-dev/McCode/pull/1972
+
+### Platform support and packaging, continuous integration
+* A few minor commits for Install (sudo -E) and libgsl dependency. by @farhi in https://github.com/mccode-dev/McCode/pull/1867
+* Expand nighty test suite to macOS and Windows by @willend in https://github.com/mccode-dev/McCode/pull/1870
+* Fix paths in mcxtrace testsuite script by @willend in https://github.com/mccode-dev/McCode/pull/1871
+* Try to run the basic test using mpich on macOS by @willend in https://github.com/mccode-dev/McCode/pull/1873
+* Enable mpi for windows in test CI by @willend in https://github.com/mccode-dev/McCode/pull/1875
+* Enable MPI, NCrystal and MCPL in windows-test-CI by @willend in https://github.com/mccode-dev/McCode/pull/1876
+* Add libnexus-dev on Ubuntu nightly test by @willend in https://github.com/mccode-dev/McCode/pull/1878
+* Correct path for mcxtrace nightly testsuite by @willend in https://github.com/mccode-dev/McCode/pull/1879
+* Cppcheck hints by @willend in https://github.com/mccode-dev/McCode/pull/1881
+* Return to mpich on basictest by @willend in https://github.com/mccode-dev/McCode/pull/1882
+* Fix issue 1883 by setting mpirun --mca params by @willend in https://github.com/mccode-dev/McCode/pull/1884
+* Return None in mctest if no mccode.sim was written by @willend in https://github.com/mccode-dev/McCode/pull/1885
+* MacInstall: add comment on forcing open permission with command by @farhi in https://github.com/mccode-dev/McCode/pull/1890
+* First stab at adding basic windows MSVC test by @tkittel in https://github.com/mccode-dev/McCode/pull/1898
+* Doc correction for MCPL install-location in Windows legacy by @willend in https://github.com/mccode-dev/McCode/pull/1900
+* Restores MPIFLAGS configuration on non-windows platforms. by @willend in https://github.com/mccode-dev/McCode/pull/1904
+* Disable macos/openmpi in favour of macos/mpich for now by @willend in https://github.com/mccode-dev/McCode/pull/1906
+* Add Windows / arm64 in CI (only msvc and sans MPI for now) by @willend in https://github.com/mccode-dev/McCode/pull/1954
+* Suppess various warnings from msvc on Windows: use %li -> %zi in printfs by @willend in https://github.com/mccode-dev/McCode/pull/1958
+* Suppress msvc warnings about implicit mkdir() and getpid() by @willend in https://github.com/mccode-dev/McCode/pull/1959
+* mcrun and msvc: drop -lm and -o instr.exe by @willend in https://github.com/mccode-dev/McCode/pull/1960
+* More warning suppression msvc by @willend in https://github.com/mccode-dev/McCode/pull/1961
+* Minor fixes post 3.5.26 by @willend in https://github.com/mccode-dev/McCode/pull/1969
+
+
+## New Contributors
+* @pablogila made their first contribution in https://github.com/mccode-dev/McCode/pull/1911
+
+**Full Changelog**: https://github.com/mccode-dev/McCode/compare/v3.5.24...v3.5.27
+
+
 Changes in McStas/McXtrace 3.5.24, February 19th, 2025
 ## What's Changed
 

CHANGES_McXtrace

@@ -15,6 +15,72 @@
 *
 * Documentation: CHANGES_McXtrace
 *************************************************************************/
+Changes in McStas/McXtrace 3.5.27, April 29th, 2025
+## What's Changed
+
+### Common new features and patches for McStas and McXtrace (tools, random numbers etc.)
+* Update rootmccode to work with new version of ROOT by @ebknudsen in https://github.com/mccode-dev/McCode/pull/1862
+* Add wrapper for mc/mxdisplay-cad on Windows by @willend in https://github.com/mccode-dev/McCode/pull/1888
+* Input flag -y / --yes applies all instrument parameter default values by @willend in https://github.com/mccode-dev/McCode/pull/1914
+* PowderN and SX fixes: cif2hkl now searches correctly files using Open_File/real path, and sets 'barns=1' by @farhi in https://github.com/mccode-dev/McCode/pull/1952
+* Correct implementation to use unit64_t (achieves a correct 64bit RNG also on Windows...) by @willend in https://github.com/mccode-dev/McCode/pull/1955 and https://github.com/mccode-dev/McCode/pull/1966
+* Add simple test of KISS RNG across platforms and compilers by @willend in https://github.com/mccode-dev/McCode/pull/1956
+* Suppress const char in the cif2hkl fcts by @willend in https://github.com/mccode-dev/McCode/pull/1957
+* Use mcpl 2.0 proper on Windows. by @willend in https://github.com/mccode-dev/McCode/pull/1962
+
+### New McStas specific features and patches
+* Full adaptation of "spin-component nullification" after "spin up/down measurement" by @willend in https://github.com/mccode-dev/McCode/pull/1886 (see also discussion on [mcstas-users](https://mailman2.mcstas.org/pipermail/mcstas-users/2025q2/001566.html)
+* Add component name in "segno" related Exit/Error statement by @willend in https://github.com/mccode-dev/McCode/pull/1895
+* Allow further geometries for He3 cell component by @willend in https://github.com/mccode-dev/McCode/pull/1915
+* Contributed component Source_custom by @pablogila in https://github.com/mccode-dev/McCode/pull/1911 and https://github.com/mccode-dev/McCode/pull/1946
+* Update MCPL_input.comp by @g5t in https://github.com/mccode-dev/McCode/pull/1924
+* PowderN: remove a static variable declare from SHARE section by @willend in https://github.com/mccode-dev/McCode/pull/1945
+* Comp updates from work on ESS SKADI by @willend in https://github.com/mccode-dev/McCode/pull/1948
+* Add COPY SHARE to Diaphragm Slit-alias-comp + add in McXtrace by @willend in https://github.com/mccode-dev/McCode/pull/1950
+
+### New McXtrace specific features and patches
+* McXtrace: data: refactor reflec_xraydb.py: refactor by @farhi in https://github.com/mccode-dev/McCode/pull/1897
+* McXtrace: work in data/reflec_xraydb script by @farhi in https://github.com/mccode-dev/McCode/pull/1916
+* mcxtrace:powderN: Update PowderN.comp: reduce nb of printed warnings by @farhi in https://github.com/mccode-dev/McCode/pull/1919
+* McXtrace: Fluorescence handling ala PowderN by @willend in https://github.com/mccode-dev/McCode/pull/1942
+* mcxtrace: instrument.y sync from mcstas by @willend in https://github.com/mccode-dev/McCode/pull/1943
+* Add Diaphragm Slit-alias-comp in McXtrace  by @willend in https://github.com/mccode-dev/McCode/pull/1950
+* McXtrace: samples: add Fluo+PowderN component by @farhi in https://github.com/mccode-dev/McCode/pull/1951
+* @farhi mcgui tooltip edits from https://github.com/mccode-dev/McCode/pull/1952 by @willend in https://github.com/mccode-dev/McCode/pull/1953
+* Mcxtrace fluo sx 1 by @farhi in https://github.com/mccode-dev/McCode/pull/1972
+
+### Platform support and packaging, continuous integration
+* A few minor commits for Install (sudo -E) and libgsl dependency. by @farhi in https://github.com/mccode-dev/McCode/pull/1867
+* Expand nighty test suite to macOS and Windows by @willend in https://github.com/mccode-dev/McCode/pull/1870
+* Fix paths in mcxtrace testsuite script by @willend in https://github.com/mccode-dev/McCode/pull/1871
+* Try to run the basic test using mpich on macOS by @willend in https://github.com/mccode-dev/McCode/pull/1873
+* Enable mpi for windows in test CI by @willend in https://github.com/mccode-dev/McCode/pull/1875
+* Enable MPI, NCrystal and MCPL in windows-test-CI by @willend in https://github.com/mccode-dev/McCode/pull/1876
+* Add libnexus-dev on Ubuntu nightly test by @willend in https://github.com/mccode-dev/McCode/pull/1878
+* Correct path for mcxtrace nightly testsuite by @willend in https://github.com/mccode-dev/McCode/pull/1879
+* Cppcheck hints by @willend in https://github.com/mccode-dev/McCode/pull/1881
+* Return to mpich on basictest by @willend in https://github.com/mccode-dev/McCode/pull/1882
+* Fix issue 1883 by setting mpirun --mca params by @willend in https://github.com/mccode-dev/McCode/pull/1884
+* Return None in mctest if no mccode.sim was written by @willend in https://github.com/mccode-dev/McCode/pull/1885
+* MacInstall: add comment on forcing open permission with command by @farhi in https://github.com/mccode-dev/McCode/pull/1890
+* First stab at adding basic windows MSVC test by @tkittel in https://github.com/mccode-dev/McCode/pull/1898
+* Doc correction for MCPL install-location in Windows legacy by @willend in https://github.com/mccode-dev/McCode/pull/1900
+* Restores MPIFLAGS configuration on non-windows platforms. by @willend in https://github.com/mccode-dev/McCode/pull/1904
+* Disable macos/openmpi in favour of macos/mpich for now by @willend in https://github.com/mccode-dev/McCode/pull/1906
+* Add Windows / arm64 in CI (only msvc and sans MPI for now) by @willend in https://github.com/mccode-dev/McCode/pull/1954
+* Suppess various warnings from msvc on Windows: use %li -> %zi in printfs by @willend in https://github.com/mccode-dev/McCode/pull/1958
+* Suppress msvc warnings about implicit mkdir() and getpid() by @willend in https://github.com/mccode-dev/McCode/pull/1959
+* mcrun and msvc: drop -lm and -o instr.exe by @willend in https://github.com/mccode-dev/McCode/pull/1960
+* More warning suppression msvc by @willend in https://github.com/mccode-dev/McCode/pull/1961
+* Minor fixes post 3.5.26 by @willend in https://github.com/mccode-dev/McCode/pull/1969
+
+
+## New Contributors
+* @pablogila made their first contribution in https://github.com/mccode-dev/McCode/pull/1911
+
+**Full Changelog**: https://github.com/mccode-dev/McCode/compare/v3.5.24...v3.5.27
+
+
 Changes in McStas/McXtrace 3.5.24, February 19th, 2025
 ## What's Changed
 

INSTALL-McStas/Docker/README.md

@@ -1,4 +1,4 @@
-# Running McStas and McXtrace 3.5.24 in Docker / podman etc.
+# Running McStas and McXtrace 3.5.27 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.5.24 on Linux and Unix.
+# Install McStas 3.5.27 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.5.24 On Debian class systems (including Ubuntu, mint etc.):
+## Install McStas 3.5.27 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.5.24 with tools (mcrun/mcplot etc.) by
+allows you to install mcstas 3.5.27 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.5.24
+# Installation instructions for McStas 3.5.27
 
 Please consult the individual platform instructions:
 

INSTALL-McStas/Windows/README.md

@@ -1,16 +1,16 @@
-# Installation of McStas 3.5.24 on Windows 64 bit systems
+# Installation of McStas 3.5.27 on Windows 64 bit Intel systems
+## *IMPORTANT: active internet connection required during installation*
 
-* Please install the [McStas 3.5.24 metapackage](https://download.mcstas.org/mcstas-3.5.24/Windows/McStas-Metapackage-3.5.24-win64.exe)
-* To enable use of MCPL with McStas 3.5.24 on Windows, please:
- 1) Grant yourself write permission to `c:\mcstas-3.5.24\miniconda3`
- 2) Locate and run the executable `mcstas-mcpl-NSIS64-3.5.24-mingw64.exe` from the [single-packages folder](https://download.mcstas.org/mcstas-3.5.24/Windows/single-packages)
- 3) During installation, please specify `c:\mcstas-3.5.24\miniconda3` as installation directory
- 4) After installation, place the mcpl-related `.bat` files from the [extras folder](https://download.mcstas.org/mcstas-3.5.24/Windows/extras) folder in `c:\mcstas-3.5.24\miniconda3\bin`
-
-
-* An alternative to installing this cross-compiled verison is to follow the instructions
-posted under [WSL](WSL/README.md) to install the "Windows subsystem for Linux" and run the Debian binaries there
-* Or use [conda-forge](../conda/README.md)
+* Please either of:
+  1. **Recommended:**
+    * Install [Visual Studio including c/c++ support](https://learn.microsoft.com/en-us/cpp/build/building-on-the-command-line?view=msvc-170#download-and-install-the-tools) (Any version of Visual Studio itself should do. Please install at minumum "Desktop development with c++" selecting VS2019 build tools. You can also use newer VS2022 build tools, but VS2019 must be present also.
+	* Use the [mcstas-conda](mcstas-conda.bat) batch script to install the latest mcstas from `conda-forge` 
+  2. **Legacy:**
+    * install the legacy-style MinGW based [McStas 3.5.27 metapackage](https://download.mcstas.org/mcstas-3.5.27/Windows/McStas-Metapackage-3.5.27-win64.exe) - now includes MCPL. Option 2 is also 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.  Option 3 is also functional on `arm64` processors.
+	
+If you are `conda-forge` knowledgable already, you may also simply install a new environment as explained in [conda-forge](../conda/README.md)
 
 ## Internet access required:
 * If you are behind a proxy server, please use the commands

INSTALL-McStas/Windows/WSL/README.md

@@ -1,4 +1,4 @@
-# Installation of McStas 3.5.24 on Windows 64 bit systems - using WSL
+# Installation of McStas 3.5.27 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.5.24 Debian packages
+## Install the McStas 3.5.27 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/Windows/mcstas-conda.bat

@@ -0,0 +1,43 @@
+@mkdir %USERPROFILE%\AppData\Roaming\micromamba
+@cd %USERPROFILE%\AppData\Roaming\micromamba
+@echo Downloading latest micromamba
+@set URL=https://github.com/mamba-org/micromamba-releases/releases/latest/download/micromamba-win-64
+@curl -L -o micromamba.exe %URL%
+@echo Requesting init of micromamba on the shell
+@.\micromamba.exe shell init --shell cmd.exe
+@.\micromamba.exe shell hook -s cmd.exe
+@.\micromamba config append channels conda-forge
+@.\micromamba config set channel_priority strict
+@echo Checking for existing mcstas environment
+@.\micromamba env list > tmpfile
+@setlocal
+
+@set FOUND=N
+@for /f %%i in ('@findstr mcstas tmpfile') do (
+  @echo Found existing environment called %%i!
+  @set FOUND=Y
+)
+
+@if /I %FOUND%==N goto INSTALL
+
+:CHOICE
+@choice /C YN /M "Press Y to remove mcstas env or N to Cancel."
+@if '%ERRORLEVEL%'=='1' goto REMOVE
+@if '%ERRORLEVEL%'=='2' goto END
+
+:REMOVE
+@echo Removing mcstas env
+@.\micromamba env remove -n mcstas -y
+
+:INSTALL
+@echo Starting installation of McStas and dependencies
+@.\micromamba.exe create -n mcstas mcstas -y
+
+@echo Creating desktop shortcut to new environment
+
+@echo start %USERPROFILE%\AppData\Roaming\mamba\condabin\micromamba activate mcstas > %USERPROFILE%\Desktop\mcstas-shell-conda.bat
+
+:END
+@echo End of script
+@pause
+@endlocal