Install Windows prerequisites for EMOD source code#

This section describes the software packages or utilities must be installed on computers running Windows 10, Windows Server 12, and Windows HPC Server 12 (64-bit) to build the EMOD executable (Eradication.exe) from source code and run regression tests.

If additional software is needed for the prerequisite software due to your specific environment, the installer for the prerequisite software should provide instructions. For example, if Microsoft MPI v10 requires additional Visual C++ redistributable packages, the installer will display that information.

Note

IDM does not provide support or guarantees for any third-party software, even software that we recommend you install. Send feedback if you encounter any issues, but any support must come from the makers of those software packages and their user communities.

Install prerequisites for running simulations#

The following software packages are required to run simulations using Eradication.exe. You can skip this section you already installed the pre-built Eradication.exe using the instructions in EMOD installation for generic, Install EMOD for HIV, or Install EMOD for malaria.for malaria.

  1. Install the Microsoft HPC Pack 2019 Client Utilities Redistributable Package (64-bit). See https://www.microsoft.com/en-us/download/details.aspx?id=101361 for instructions.

  2. Install the Microsoft MPI v10. See https://www.microsoft.com/en-us/download/details.aspx?id=100593 for instructions, being sure to run the MSMpiSetup.exe file.

  3. Install the Microsoft Visual C++ 2022 Redistributable (64-bit). See https://docs.microsoft.com/en-us/cpp/windows/latest-supported-vc-redist for instructions.

Install prerequisites for compiling from source code#

The following software packages are required to build Eradication.exe from EMOD source code on Windows 10, Windows Server 12, and Windows HPC Server 12 (64-bit).

Visual Studio#

  1. Purchase a license from Microsoft or use an MSDN subscription to install Visual Studio 2022 (Professional, Premium, or Ultimate). Other versions of Visual Studio are not supported.

    While you can use a free copy of Visual Studio Community, IDM does not test on or support this version.

  2. Select Desktop development with C++ during installation.

Python#

Python is required for building the disease-specific Eradication.exe and running Python scripts.

  1. In a web browser, go to https://www.python.org/downloads/release/python-399/ to install Python 3.9 64-bit.

  2. Scroll down and download one of the x86-64 bit installers (you may use the executable installer or the web-based installer.)

  3. Double-click the executable file and, in the installer window, select the Add Python 3.9 to PATH checkbox and click Customize installation.

  4. On the Optional Features window that opens, leave all default values selected and click Next. The Python package manager, pip, is used to install other Python packages.

  5. If you are running EMOD locally, IDM recommends that you select the Advanced Options window to customize the installation directory to “C:\Python39”.

    You may install Python in another location, but the Python plotting scripts included in the EMOD scenarios zip file assume that Python is installed directly under the C: drive. If you install it elsewhere, you may need to edit those scripts when using the scenarios to learn about EMOD functionality.

  6. Click Install. When installation is complete, click Close.

  7. To verify installation, open a Command Prompt window and type the following:

    python --version

  1. From Control Panel, select Advanced system settings, and then click Environment Variables.

    • To build the source code using Python 3.9 64-bit, add a new variable called IDM_PYTHON3X_PATH and set it to the directory where you installed Python 3.9 64-bit, and then click OK.

  2. Restart Visual Studio if it was open when you set the environment variables.

HPC SDK#

Boost#

  1. Go to https://sourceforge.net/projects/boost/files/boost/1.77.0/ and select one of the compressed files.

  2. Unpack the libraries to the location of your choice. If unpacking the files results duplicate folders with an extra level of nesting (for example, C://boost_1_77_0//boost_1_77_0), delete the extra folder.

  3. From Control Panel, select Advanced system settings, and then click Environment Variables.

  4. Add a new variable called IDM_BOOST_PATH and set it to the directory where you installed Boost, and then click OK.

  5. Restart Visual Studio if it was open when you set the environment variable.

(Optional) SCons#

SCons is required for the building disease-specific Eradication.exe and is optional for the monolithic Eradication.exe that includes all simulation types.

  1. Open a Command Prompt window and enter the following:

    pip install wheel
pip install scons

Install prerequisites for running regression tests#

The following plotting software is required for running regression tests, where graphs of model output are created both before and after source code changes are made to see if those changes created a discrepancy in the regression test output. For more information, see Regression testing.

NumPy#

We recommended that you download some of the NumPy Python package from http://www.lfd.uci.edu/~gohlke/pythonlibs, a page compiled by Christoph Gohlke, University of California, Irvine. The libraries there include linear algebra packages that are not included by default with the standard Windows packages. They are compiled Windows binaries, including the 64-bit versions required by EMOD. The naming convention used lists the Python version after “cp”, for example “cp39-cp39m”, and the Windows bit version after “win”, for example “win_amd64”.

The NumPy package adds support for large, multi-dimensional arrays and matrices to Python.

  1. Go to http://www.lfd.uci.edu/~gohlke/pythonlibs/#numpy and select the WHL file for NumPy 1.22.1 (64-bit) that is compatible with Python 3.9 64-bit.

  2. Save the file to your Python installation directory.

  3. Open a Command Prompt window and navigate to the Python installation directory, then enter the following, substituting the name of the specific NumPy WHL file you downloaded:

    pip install numpy-1.x.x+mkl-cp39-cp39m-win_amd64.whl

Python packages#

The Python packages dateutil, six, and pyparsing provide text parsing and datetime functionality.

Note

Be sure NumPy is installed before you install Matplotlib.

  1. Open a Command Prompt window and enter the following:

    pip install python-dateutil
pip install pyparsing
pip install matplotlib
pip install future

(Optional) R#

The IDM test team uses R 4.1.2 (64-bit) for regression testing, but it is considered optional.

R is a free software environment for statistical computing and graphics.