Skip to content

Latest commit

 

History

History
119 lines (79 loc) · 7.08 KB

INSTALL.md

File metadata and controls

119 lines (79 loc) · 7.08 KB

SIMRES - neutron ray-tracing simulation

SIMRES is an application for simulation of neutron beams using Monte Carlo ray-tracing method. It has been developed for instrument scientists as a tool for realistic simulation of neutron beam characteristics, optimization of instrument parameters, planning of experiments as well as simulation of synthetic data for validation of data analysis methods.

Homepage: http://neutron.ujf.cas.cz/restrax
SIMRES repository: https://github.com/saroun/simres
User guide: http://neutron.ujf.cas.cz/restrax/download/simres-guide.pdf

CONTENTS

Terms of use

see COPYING.md

Binary distributions

Requirements

Java Runtime Environment

SIMRES GUI is build in Java and requires a 64-bit version of Java JRE or SDK to execute (minimum version is 1.8). On Linux, it can be installed e.g. as (Ubuntu, Debian):
sudo apt install openjdk-8-jre

On Windows, there are two options:

  • Get the instaler from https://www.java.com/en/download/manual.jsp and choose the Windows 64 bit offline version. Note that by default, this site offers only the 32 bit version so you need to choose the 64 bit installer manually. Note also that Oracle has recently changed their license conditions for end users so that you may not be eligible for using this JRE.

  • Choose the open source GPL-licensed JDK from https://openjdk.java.net/. Binary distributions should be available at https://jdk.java.net/.

When Java JRE or SDK is installed at Program Files\Java\[some name], the SIMRES installer should find it. Otherwise you need to provide a path to it by editting the JRE variable in ./simresGUI_win32.bat manually.

Other Runtime Libraries

Read additional information provided with the download links. In general, the Windows binary distributions are build using the Mingw-w64 package and required runtime libraries should be included in the binary distribution.
On Linux, the GNU gcc package is used and required runtime libraries (in particular, libgfortran) should be installed by the system admin. This also depends on the version of gcc the SIMRES binaries were compiled against. At present, the binary distribution for Linux is built on Ubuntu 18.04 with gcc version 7.4.0, therefore libgfortran.so.4 is required.

Linux

  • Get the binary package at http://neutron.ujf.cas.cz/restrax/download and unpack it.
  • Run command [sudo] perl Install.pl [target directory] from the distribution directory to install SIMRES. If the target directory is ".", SIMRES is installed to /opt/simres and an executable link is made to /usr/bin/simres (requires sudo privileges).
  • Run the program by executing [target directory]/simresGUI (or just simres for the standard installation). See the user guide at [target directory]/doc/simres-guide.pdf for more information.

Windows

  • Get the installer at http://neutron.ujf.cas.cz/restrax/download (the installer is packed in a zip archive to prevent Windows from blocking its execution).
  • Execute the installer and follow instructions.
  • Run the program (a launch icon should be on the desktop and in the Start menu. See the user guide for more information (a link is provided in the Start menu in the Simres folder).
  • Some antivirus programs like AVG may hinder the first launch of the program. If this happens, press RESET on the control panel to restart the kernel.

Building from the source

Get source files from git repository

  • Clone SIMRES from GitHub repository:
    git clone --recurse-submodules https://github.com/saroun/simres
    Alternatively, it is possible to download source distribution as a zip archive at http://neutron.ujf.cas.cz/restrax/download and unpack it to a new folder.

Add 3rd party software

  • Get PGPLOT source files:
    get the source distribution at http://www.astro.caltech.edu/~tjp/pgplot, Version 5.2.2. Unpack the archive to ./3dparty/pgplot.

  • Get the Java3D library for your OS and architecture and make sure the submodule simresUI can see it. Refer to the Requirements section of ./submodules/simresUI/README.md for details.

Compile on Windows

Edit the build.bat script from the source distribution to make sure that the required toolchain is available. Specifically, the following tools are required:

To build SIMRES core:

  • perl for makefile configuration
  • mingw-w64 compiler suite including gfortran

To build JSDRIV Windows server for PGPLOT:

  • lazbuild command line compiler from Lazarus IDE. See submodules/jsdriv_server/README.md for details.

To build GUI:

  • Java SDK (version 1.8 or later)
  • ant builder
  • Java3D package, see submodules/simresUI/README.md for instructions.

Run build.bat. This will perform all necessary steps: configure, compile and install SIMRES to ./distr. See the content of build.bat for the make commands which can also be used to build the core, PGPLOT driver and GUI separately. After execution of the script, it should be possible to run SIMRES by executing .\distr\simres.bat. For running a test in command mode, execute e.g. .\distr\simres.bat -test 0. For building an installer, see the last section below.

Compile on Linux

Make sure that the required toolchain is available. Specifically, the following tools are required:

  • gcc compilers suite with gfortran
    sudo apt-get install gcc gfortran make
  • libX11 headers
    sudo apt-get install libx11-dev
  • Java development kit
    sudo apt-get install openjdk-8-jdk-headless
  • Ant builder
    sudo apt-get install ant
  • Java3D package
    see submodules/simresUI/README.md for instructions.

Run the script build.sh. This will perform all necessary steps: configure, compile and install SIMRES to ./distr. See the content of build.sh for the make commands which can also be used to build the core, PGPLOT driver and GUI separately. After execution of the script, it should be possible to run SIMRES by executing ./distr/simres. For running a test in command mode, execute e.g. ./distr/simres -test 0. For building a binary package, see the last section below.

Building of binary distribution packages

Windows

  • If you want to build a self-contained binary distribution, copy all required runtime libraries to the ./rtlib/windows subdirectory. For example, when building with mingw-w64 on Windows, the libraries libgcc_s_seh-1.dll and libquadmath-0.dll are required.
  • After building and testing the distribution (see Compile on Windows), run the script ZipBin.pl. Add the "-inno" option to build Windows installer using the INNO Setup utility iscc:
    perl ZipBin.pl -inno

Linux

  • After building and testing the distribution (see Compile on Linux), run the script ZipBin.pl:
    perl ZipBin.pl

  • To create source distribution, run:
    perl ZipSrc.pl