Setting Up the Development Environment

System Requirements

• An IDE with support for C++ and CMake

  • Visual Studio 2022
    • Make sure you enable C/C++ development tools at installation
  • Visual Studio Code
    • Also install C/C++ Extension Pack
    • In Windows: Also install Build Tools for Visual Studio

• A Java 8 development kit (JDK)

  • Oracle
  • Open SDK Temurin

• A MPI Development Kit:

  • Windows: MSMPI SDK
  • Linux and MacOs: MPICH

• A Git installation

  • Windows: Git for Windows
    • Includes Git Bash and Terminal

• A Python distribution with pip tool installed

  • For example: Anaconda Python Distribution

Quick Setup

1) Create and configure a public-private key pair for GitHub

# Use Git Bash in windows
ssh-keygen -t ed25519 -C "your@email.com"

Copy the contents of the file containing the public key: ~/.ssh/id_ed25519.pub. Then, in GitHub, click your icon and go to Settings. There go to the SSH and GPG section and click on New SSH key. Then copy the contents of your public key in the input text.

2) Clone the repository

Open a terminal and execute

git clone git@github.com:KhiopsML/khiops.git

Note: If you have problems with a proxy (Connection timeout or Connection refused) configure to connect SSH over HTTPS

3) Install pre-commit in the repository

# Install the pre-commit Python package
pip install pre-commit

# This installs the hooks on the repo and runs them on all files
# It may take a bit of time the first time
cd khiops
pre-commit install
pre-commit run --all-files

4) Compile

4.1) In Visual Studio Code

• Make sure you have installed the extension mentioned above.
• Open VS Code go to the menu File -> Open Folder and select your local khiops folder
• At the bottom bar you can select a debug or release preset (ex: Windows MSVC Release) and then click on the "⚙ Build" button nearby.

4.2) In Visual Studio 2022

• Open Visual Studio and select Open Local Folder and select your local khiops folder
  • This may take a few minutes to finish, you can see the current status by selecting the CMake output in the output sub-window.
• At the top bar you can select a debug or release preset (ex: Windows MSVC Release) and select the menu **Build -> Build All"

4.3) From the command line

• Go to the khiops folder
• For a given preset (ex: windows-msvc-release) execute

cmake --preset windows-msvc-release         # add --fresh to regenerate
cmake --build --preset windows-msvc-release # add --clean to clean