Merge branch 'doc-preparations-3.6.0' of https://github.com/mccode-dev/McCode into doc-preparations-3.6.0

Author: willend

cmake/Modules/InstallMCCODE.cmake

@@ -397,6 +397,8 @@ macro(installMCCODE)
   endif()
 
   if(WINDOWS)
+    cmake_path( CONVERT "${MCCODE_RELPATH_BINDIR2TOOLDIR}" TO_NATIVE_PATH_LIST MCCODE_RELPATH_BINDIR2TOOLDIR)
+
     # Generate and install Windows setup scripts
     foreach (name env.bat env.m go.bat test.bat)
       configure_file(
@@ -413,7 +415,7 @@ macro(installMCCODE)
     install(PROGRAMS ${WORK}/support/${FLAVOR}-labenv.bat DESTINATION "${DEST_BINDIR}")
 
     # Python/Perl related batches special handling
-    foreach (name run.bat doc.bat test.bat viewtest.bat resplot.bat plot.bat display.bat gui.bat guistart.bat plot-pyqtgraph.bat plot-matplotlib.bat plot-matlab.bat display-webgl.bat display-webgl-classic.bat display-pyqtgraph.bat display-cad.bat display-matplotlib.bat display-mantid.bat)
+    foreach (name run.bat doc.bat test.bat viewtest.bat resplot.bat plot.bat display.bat gui.bat guistart.bat plot-pyqtgraph.bat plot-matplotlib.bat plot-matlab.bat display-webgl.bat display-webgl-classic.bat display-pyqtgraph.bat display-cad.bat display-matplotlib.bat display-mantid.bat display-matlab.bat)
       configure_file(
 	      cmake/support/run-scripts/${name}.in
 	      work/support/${MCCODE_PREFIX}${name}

cmake/support/run-scripts/display-matlab.bat.in

@@ -0,0 +1,3 @@
+@REM Isn't windows a lovely place???
+@set BINDIR=%~dp0
+@matlab -nosplash -r "addpath('%BINDIR%@MCCODE_RELPATH_BINDIR2TOOLDIR@\matlab\@MCCODE_PREFIX@display');mcdisplay @MCCODE_PREFIX@run %*"

cmake/support/run-scripts/plot-matlab.bat.in

@@ -1,6 +1,4 @@
-@CALL @CPACK_NSIS_INSTALL_ROOT@\bin\mccodeenv.bat
-@set BINDIR=%~dp0
-@SET PATH=%BINDIR%\@MCCODE_RELPATH_BINDIR2TOOLDIR@\matlab\@MCCODE_PREFIX@plot;%PATH%
-@REM Isn't windows a lovely place???
-@mcplot.m %*
-
+@CALL @CPACK_NSIS_INSTALL_ROOT@\bin\mccodeenv.bat
+@set BINDIR=%~dp0
+@REM Isn't windows a lovely place???
+@matlab -nosplash -r "addpath('%BINDIR%@MCCODE_RELPATH_BINDIR2TOOLDIR@\matlab\@MCCODE_PREFIX@plot');mcplot %*"

mcstas-comps/examples/Tests_union/Geometry_test/Geometry_test.instr

@@ -19,13 +19,14 @@
 * Use of all basic geometries, mesh(as a torus), sphere, cylinder, cone and box
 *
 * %Example: meshfile="torus.off" Detector: detector_scat_I=40.2053
+* %Example: meshfile="torus.STL" Detector: detector_scat_I=40.2053
 *
 * %Parameters
 *
 * %End
 *******************************************************************************/
 
-DEFINE INSTRUMENT Geometry_test(string meshfile="torus.off")
+DEFINE INSTRUMENT Geometry_test(string meshfile="torus.STL")
 
 DECLARE
 %{

mcstas-comps/union/Union_mesh.comp

@@ -222,8 +222,7 @@ void read_stl(char* filename,
       fclose(file);  
 
    } else {
-#ifndef _MSC_EXTENSIONS
-       FILE *file = Open_File(filename, "r", NULL);
+       FILE *file = Open_File(filename, "rb", NULL);
        // Read header
        char header[80];
        fread(header, sizeof(char), 80, file);
@@ -247,9 +246,6 @@ void read_stl(char* filename,
        }
 
       fclose(file);
-#else
-      fprintf(stderr,"Union_mesh ERROR:\n  Binary STL is not yet supported when compiling with MSVC.\n  Please convert file to e.g. ascii OFF via meshlab.\n.");
-#endif
    }
 
    *n_verts = 3* *n_faces;

tools/CMakeLists.txt

@@ -2,4 +2,5 @@ cmake_minimum_required(VERSION 3.17.0)
 cmake_policy(VERSION 3.17.0)
 
 #add_subdirectory(Legacy-Perl-cmdline)
-add_subdirectory(Python)
+add_subdirectory(Python)
+add_subdirectory(matlab)

tools/Python/mcdisplay/cad/mcdisplay.py

@@ -10,9 +10,11 @@
 
 import sys
 from pathlib import Path
+import subprocess
 
 sys.path.append(str(Path(__file__).resolve().parent.parent.parent))
 from mccodelib.instrgeom import Vector3d, DrawLine, DrawMultiline, DrawCircle
+from mccodelib import mccode_config
 
 
 def vector_to_tuple(v: Vector3d):
@@ -140,8 +142,19 @@ def instrument_to_assembly(inst):
 
 def main(instr=None, dirname=None, **kwds):
     from logging import basicConfig, INFO
+    import time
     basicConfig(level=INFO)
 
+    try:
+        # Try initial import or inform to install cadquery
+        from cadquery.occ_impl.geom import Matrix
+    except:
+        message="To use this display tool, please install the 'cadquery' Python package"
+        subprocess.Popen('%s %s' % (mccode_config.configuration['MCCODE']+"_errmsg", message), shell=True)
+        print(mccode_config.configuration['MCCODE']+": "+ message)
+        time.sleep(3)
+        quit()
+
     # output directory
     if dirname is None:
         from datetime import datetime as dt
@@ -158,7 +171,12 @@ def main(instr=None, dirname=None, **kwds):
 
     # Do the conversion to a CadQuery assembly, then save it to the desired location
     assembly = instrument_to_assembly(instrument)
-    assembly.save(str(root.joinpath(f"{Path(instr).stem}.{kwds.get('format','step')}")))
+    output = str(root.joinpath(f"{Path(instr).stem}.{kwds.get('format','step')}"))
+    assembly.save(output)
+
+    # Use mccode_config / the OS to open the resulting file...
+    if Path(output).is_file():
+        subprocess.Popen('%s %s' % (mccode_config.configuration['BROWSER'], output), shell=True)
 
 def output_format(astring):
     f = astring.lower()

tools/matlab/mcdisplay/CMakeLists.txt

@@ -69,16 +69,16 @@ set(WORK "${PROJECT_BINARY_DIR}/work")
 
 
 # Configure fallback script
-configure_file("${CMAKE_SOURCE_DIR}/mcdisplay.in" "${WORK}/${P}display" @ONLY)
+configure_file("${CMAKE_CURRENT_SOURCE_DIR}/mcdisplay.in" "${WORK}/${P}display" @ONLY)
 
 # Configure doc
 configure_file("${CMAKE_CURRENT_SOURCE_DIR}/mcdisplay-matlab.md.in" "${WORK}/${P}display-matlab.md" @ONLY)
 
 if(WINDOWS)
-  set(BINS "${PROJECT_SOURCE_DIR}/mcdisplay.m")
+  set(BINS "${CMAKE_CURRENT_SOURCE_DIR}/mcdisplay.m")
 else()
   set(BINS "${WORK}/${P}display")
-  set(BINS "${PROJECT_SOURCE_DIR}/mcdisplay.m")
+  set(BINS "${CMAKE_CURRENT_SOURCE_DIR}/mcdisplay.m")
 endif()
 
 
@@ -112,10 +112,6 @@ if(NOT WINDOWS)
     "${TOOLS_LIB}/mcdisplay" "${WORK}/${P}display"
     )
 
-  add_custom_target(
-    "CREATE_SYMLINK" ALL DEPENDS "${WORK}/${P}display"
-    )
-
   install(
     PROGRAMS "${WORK}/${P}display"
     DESTINATION ${DEST_BINDIR}

tools/matlab/mcdisplay/mcdisplay.m

@@ -334,9 +334,9 @@
     this_line = output{index};
     this_line = strrep(this_line, 'MCDISPLAY: ','[x,y,z]=');
     eval([ this_line ';' ]);  % executes multiline(..), return a set of points (local coords)
-    X = [ X x ];
-    Y = [ Y y ];
-    Z = [ Z z ];
+    X = [ X NaN x ];
+    Y = [ Y NaN y ];
+    Z = [ Z NaN z ];
   end
 end