Windows
Precompiled Distributable
The quickest way to get started with ISSM is to download one of our precompiled distributables. They have been tested on Windows 10 and 11.
Note
- ISSM is currently limited to basic capabilities on Windows. We will be working soon on supporting external packages such as Dakota and advanced capabiltites like modelling of solid earth processes.
- Currently, only the MATLAB interface to ISSM is supported on Windows.
After downloading the distributable, unpack it with the ‘Extract’ feature and move it to the desired location on disk.
You are now ready to get started with ISSM!
Compiling ISSM from Source
The following instructions detail how to create an environment for compiling ISSM from source on Windows. We rely on MSYS2 to provide a Linux-like interface and the MinGW compiler chain to generate native Windows executables and libraries. There may be other methods for achieving the above, which we invite you to share on the ISSM forum.
NOTE: You will have to use an Administrator user account for some of the following to work as intended
MSYS2
Install MSYS2
- Navigate to the MSYS2 website
- Download the installer
- When the download completes, run the installer
- Use the default value for ‘Installation Folder’
- Use the default value for ‘Start Menu shortcuts’
- Deselect ‘Run MSYS 64bit now’ and click the ‘Finish’ button
Set up shortcut for MSYS2 terminal emulator
- In the Windows ‘Search Bar’, search for “MSYS2”
- The ‘Best match’ should be ‘MSYS2 MSYS’; click ‘Open file location’
- In the resulting File Explorer window, right-click ‘MSYS2 MinGW 64-bit’ and select ‘Send to’ → ‘Desktop (create shortcut)’
- Right-click on the newly-created desktop shortcut and select ‘Properties’
- click the ‘Advanced…’ button
- check the box labeled ‘Run as administrator’
- click the ‘OK’ button
- click the ‘Apply’ button
- click the ‘OK’ button
Update the package database and install required packages
- Double-click the ‘MSYS2 MinGW 64-bit’ desktop shortcut
- At the resulting command prompt run,
$ pacman -Syuto update the database and base packages, entering “Y” when prompted
- The previous step will result in the window being closed, so double-click the ‘MSYS2 MinGW 64-bit’ desktop shortcut again
- At the resulting command prompt run,
$ pacman -Suuntil the resulting output is,
:: Starting core system upgrade... there is nothing to do :: Starting full system upgrade... there is nothing to do- Install necessary packages with,
$ pacman -S --needed base-devel git openssh python python-setuptools subversion unzip mingw-w64-x86_64-autotools mingw-w64-x86_64-cmake mingw-w64-x86_64-gcc-fortran mingw-w64-x86_64-toolchainentering “Y” or simply hitting the return key as needed
- Install necessary packages with,
- (Optional) Install Vim text editor with,
$ pacman -S vim
Scripting Interfaces
Follow the instructions for setting up the interface that you wish to use with ISSM.
MATLAB
Download and install the desired version of MATLAB from the MathWorks website. Make sure to install the optional ‘Mapping Toolbox’.
Python
The Python interface to ISSM on Windows is currently under development.
Shell profile
.bash_profile
- Open
/c/msys64/home/<USER>/.bash_profilefor editing (the easiest way to do this is with vim if you installed it in the previous step) - Add the following to the bottom of the file,
# Allow for NTFS symbolic links export MSYS=winsymlinks:nativestrict
.bashrc
- Open
/c/msys64/home/<USER>/.bashrcfor editing and add the following at the bottom of the file, ````MATLAB
# MATLAB_VER=”
" # Allows for easy resetting of MATLAB version added to path export MATLAB_PATH=$(cygpath -u $(cygpath -ms "/c/Program Files/MATLAB/${MATLAB_VER}")) export PATH="${MATLAB_PATH}/bin:${PATH}"
ISSM
# export ISSM_DIR=
where `<MATLAB_VER>` is the version of MATLAB that you have installed (for example, "R2023b") and `<ISSM_DIR>` is the path to the copy of the ISSM source code that you checked out (e.g. `/c/Users/<USER>/ISSM/src`, where `<USER>` is your username)
## Microsoft MPI
- Navigate to <a href="https://docs.microsoft.com/en-us/message-passing-interface/microsoft-mpi-release-notes" target="_blank">the 'Microsoft MPI Release Notes' webpage</a>
- Click the link for 'Microsoft Download Center' that corresponds with the latest release (take note of the version number that you download for the next step; it can also be found by going to 'Settings' / 'Apps & Features')
- Click the 'Download' button
- Make sure both boxes are checked, then click the 'Next' button
- Click the 'Save File' button for each file
- When the download completes, run each installer
- Follow the prompts, using the default installation directories
## External Packages
The following packages and installation scripts are recommended for a basic installation of ISSM on Windows,
msmpi install.sh petsc install-3.14-win-msys2-mingw-msmpi.sh triangle install-win-msys2-mingw.sh m1qn3 install-win-msys2-mingw.sh
{: .highlight-title }
> Important
>
> After successfully compiling and installing a package, run,
> ````
> source ${ISSM_DIR}/etc/environment.sh # bash, zsh
> ````
> or,
> ````
> source ${ISSM_DIR}/etc/environment.csh # csh
> ````
> so that the newly-installed package can be found by subsequent packages that may depend on it.
## Configuring and Compiling ISSM
We rely on the Autotools to allow us to configure and compile ISSM on a variety of systems. To begin, run,
cd ${ISSM_DIR} autoreconf -ivf
**NOTE**:
- Replace `<NUM_CPUS>` with the number of available CPU's
- `MATLAB_PATH` was defined previously in `bashrc`.
- `MSMPI_ROOT` will be defined after running,
````
$ source ${ISSM_DIR}/etc/environment.sh
- You may need to update the path to
libgfortranin the--with-fortran-liboption
Next, create a configuration file called configure.sh in ${ISSM_DIR}. Its contents will depend on the interface you will be using, the external packages and capabilities you wish to use, and the location of certain libraries and executables on disk. The following examples can be used for an installation of ISSM with basic capabilities,
MATLAB Interface
./configure \
--prefix=${ISSM_DIR} \
--with-numthreads=<NUM_CPUS> \
--with-matlab-dir=${MATLAB_PATH} \
--with-mpi-include="${MSMPI_ROOT}/include" \
--with-mpi-libdir="-Wl,-L${MSMPI_ROOT}/lib" \
--with-mpi-libflags="-Wl,-lmsmpi" \
--with-fortran-lib="-Wl,-L/c/msys64/mingw64/lib -Wl,-lgfortran" \
--with-metis-dir="${ISSM_DIR}/externalpackages/petsc/install" \
--with-parmetis-dir="${ISSM_DIR}/externalpackages/petsc/install" \
--with-blas-lapack-dir="${ISSM_DIR}/externalpackages/petsc/install" \
--with-scalapack-dir="${ISSM_DIR}/externalpackages/petsc/install" \
--with-mumps-dir="${ISSM_DIR}/externalpackages/petsc/install" \
--with-petsc-dir="${ISSM_DIR}/externalpackages/petsc/install" \
--with-triangle-dir="${ISSM_DIR}/externalpackages/triangle/install" \
--with-m1qn3-dir="${ISSM_DIR}/externalpackages/m1qn3/install" \
--with-semic-dir="${ISSM_DIR}/externalpackages/semic/install"
Again, you might need to make adjustments to the above configurations based on your system and needs. We have a number of resources to help here:
- Various external package install scripts and configurations in
${ISSM_DIR}/jenkins - ‘High-Performance Computing’ page
- ISSM Forum
- ISSM GitHub repository Discussions
If the configuration completed without any errors, ISSM can now be compiled,
$ cd ${ISSM_DIR}
$ make
$ make install
You are now ready to get started with ISSM!
(Optional) SSHd
NOTE: The following is probably not applicable to most users.
- Navigate to the MSYS2 ‘Setting up SSHd’ webpage
- Copy the contents of the code block and paste to a new text file
- Set the value of the variable
UNPRIV_NAMEto the desired user- If the user does not already exist, it will be created
- If the user does already exist, note the default password is the same that is used to log in to the Windows user account
- Save the file out to the location of your choice
- In a MSYS2 MinGW 64-bit shell instance, run the script
- If errors occur with messages about missing packages, install those packages and run the script again
- You can disregard the message,
cygrunsrv: Error removing a service: OpenService: Win32 error 1060: The specified service does not exist as an installed service.- The following message indicates that setup was successful,
The MSYS2 sshd service is starting. The MSYS2 sshd service was started successfully. - You can test that the service and your log in are working correctly by running,
ssh -l <UNPRIV_NAME> localhostwhere
<UNPRIV_NAME>is the same user that we authorized to use the service. You should be prompted to accept an ECDSA fingerprint, you which you respond “yes”. Then, enter the password for this account. If all goes well, you should now have a prompt that reads, ````
- The following message indicates that setup was successful,