Skip to content

Latest commit

 

History

History
138 lines (98 loc) · 7.14 KB

INSTALLATION.md

File metadata and controls

138 lines (98 loc) · 7.14 KB

Building MCRA Core

Introduction

These are the instructions for building MCRA Core and the command-line (CLI) utility from source code. Refer to the README.md file if you only want to run the CLI utility without building the utility from sources.

System requirements

Supported Operating System

Windows 10, Windows 11, Windows Server 2016, Windows Server 2019, Windows Server 2022

Required software

The following software is needed to successfully compile the software. Install the software with local administrator rights and with Powershell ExecutionPolicy as Unrestricted.

Software Version Purpose Download URLs Required?
.NET SDK 8.0 Tools to build and run C# .NET applications Website Microsoft Required
R R-4.4.1 Statistical Analysis R Project site Required
RTools 4.4 To build R PBK model binaries RTools site Required
Python (and libRoadRunner) 3.12 To run PBK models based on SBML Python downloads site Required
Access Database Engine 2010 To read MS Access database files Microsoft website Optional 1
Git 2.0 or later To clone the MCRA Core repository for development Website Git Optional 2

|

1 Only needed when MS Access MDB files are used for input of the CLI utility.
2 Only needed when you want to develop and contribute to the MCRA Core source code.

Installing prerequites

Required software

.NET SDK

  • Download .NET 8.0 SDK, version Windows x64, from Microsoft website.
  • Run the installer and accept all defaults.

R

  • Download the R-4.4.1 installer from the R Project site.
  • Run the installer and accept all defaults.
    • In PowerShell console, running as Administrator, browse to folder .\Installation\R and run the command:
      PS> .\InstallRPackages.ps1

RTools

  • Download RTools 4.4 installer from the RTools site; beware that this version of RTools is compatible with the installed version of R.
  • Run the installer and accept all defaults. RTools will install directly on the system root in C:\rtools44.
  • Add two folders to your Windows System Environment Path variable (see also general Windows instructions):
    • In the lower left Windows area, search for "path"
    • Select Edit the System Environment Details
    • On the Advanced tab, click Environment Variables...
    • From the lower System Variables section, select Path, Edit, and add the following two directories:
      • C:\rtools44\mingw64\bin
      • C:\rtools44\usr\bin\
      Edit environment image
    • You may need to restart your computer

Python and libRoadRunner

Using manual downloads

  • Download Python version 3.12.x, Windows installer (64-bit), from the Python download site.

  • Run the installer:

    • Welcome screen, select:
      • Add python.exe to PATH
      • Customize installation
    • Optional Features, use all defaults, select Next.
    • Advanced Options:

      • Check Install Python 3.12 for all users

      • Customize install location to:

        C:\Python312

    Select Install to start the installation.

  • Install libRoadRunner 2.7.0. This Python package is required to run physiologically based kinetic (PBK) models in MCRA. Open a PowerShell console, and run the command:

    • pip install libroadrunner==2.7.0

Using MCRA Python install scripts

Folder .\Installation\Python contains two PowerShell scripts: (1) to create an install image, and (2) to install Python and MCRA-required Python packages. The install image can be used in an offline scenario, without an internet connection.

  • Open a PowerShell console, running as Administrator, and browse to folder .\Installation\Python, then run the script to create the install image:
PS> ./mcra-pyimage.ps1 [-ImageFolder "c:\mcra-py"]

Use the optional -ImageFolder command line argument to specify the target directory where the install image will be created. When -ImageFolder is not specified, it will use the current folder as default. After the install image has been created, run the install script in the image folder:

PS> ./mcra-pyinstall.ps1

Optional software

MS Access Database Engine 2010 Redistributable (optional)

This component is only necessary if you plan to use MS Access MDF files as input of the CLI utility.

  • Download the MS Access Database Engine 2010 Redistributable from de Microsoft Website.
    Note: a later version, for example 2016, may work but has not been tested. A known problem of the 2026 version is that the installation is aborted when a conflict is detected from mixing x86 and x64 Microsoft Office components.
  • Run the installer and accept all defaults.

Git (optional)

This component is only necessary if you plan to develop with MCRA Core and want version control.

  • Get the latest version of Git
  • Run the installer and accept all defaults.

Building the Code

  • Download Source Code
    • Create a local folder for the sources, e.g. C:\MCRA
    • Using Git: in console window:
    git clone https://github.com/rivm-syso/mcra-core.git -b dev
  • Install additional R libraries
    • In PowerShell console, running as Administrator, browse to folder .\Installation\R and run the command:
      PS> .\InstallRPackages.ps1
  • Build sources
    • Open PowerShell or a command prompt, browse to the root folder where you downloaded the sources, and run the command:
      dotnet build --configuration release mcra-core.sln
    This will build the release binaries, including the CLI tool. The CLI utility mcra.exe is located in folder C:\MCRA\mcra-core\MCRA.Simulation.Commander\bin\Release. For instructions on how to use the CLI utility, see README.md.