Installation Tutorial for Windows

August 25, 2023 ยท View on GitHub

The following is a more detailed description of the installation process of BanditPAM for Windows.

Prerequisites

Please ensure the following dependencies are installed:

  • Visual Studio (2022 is recommended) with "Desktop development with C++" workload: via the Visual Studio download page
  • The Armadillo library: via git clone https://gitlab.com/conradsnicta/armadillo-code.git armadillo in the headers directory
  • CARMA: via the instructions in its guide
  • Python3: if not installed, we recommend installing Python3 via Anaconda
  • pip for your Python3 installation: this should be completed if installing via Anaconda above
  • The necessary python packages: via python -m pip install -r requirements.txt

BanditPAM Installation

CMake Build:

  1. Run cd scripts and then sh retrieve_windows_cmake_files.sh to retrieve the files necessary for the Windows CMake build
  2. Add the Visual Studio IDE location to PATH in Environment Variables (e.g. C:\Program Files\Microsoft Visual Studio\2022\Community\Common7\IDE).
  3. Add ${project_dir}\headers\armadillo\examples\lib_win64 to PATH
  4. Run devenv BanditPAM.sln /Build "Release|x64" after cmake .. in a prompt other than Git Bash
  5. The .exe will be located in build/src/Release

Python Build:

  1. Run python -m pip install banditpam, OR
  2. Follow these steps:
    1. Add the location of cl.exe to PATH in Environment Variables (e.g. C:\Program Files\Microsoft Visual Studio\2022\Community\VC\Tools\MSVC\14.34.31933\bin\Hostx64\x64).
    2. Run python -m pip install . in the home directory (/BanditPAM)
    3. Run cd scripts && sh retrieve_windows_python_files.sh && cd ..
    4. Run python -m pip install . in the home directory (/BanditPAM)