The HEPCE model is available to users through multiple methods. That being said, HEPCE has been built and tested on machinese running ubuntu 24.04 and CI/CD tested on Windows machines. We recommend a basic installation either through building the source code or utilizing CMake's FetchContent feature. We do plan to eventually work towards providing a debaian package install as well.

Dependencies

HEPCE has several dependencies that require being satisified before installation. This is primarily a concern if you intend to build from source as FetchContent should generally manage the dependencies if installed that way. Our FetchContent_Declare statements all attempt to find_package before downloading, so if you choose to make use of specific versions of these dependencies you simply install the dependencies before attempting to install HEPCE.

Note: DataManagement is a Syndemics Lab library and under heavy development. It is NOT recommended to attempt to install a separate version.

Installing From Source

In order to install from source, clone the repository and run cmake. We provide workflows in the CMakePresets.json and encourage the use of them for easy building. Our primary workflow is built using the GCC compiler and the Ninja build system.

git clone https://github.com/SyndemicsLab/hep-ce.git
cd hep-ce
cmake --workflow gcc-release

We also provide a debug version that is slower, but prints more to the logger to help debug problems:

cmake --workflow gcc-debug

Installing with CMake

Since CMake 3.11, the FetchContent tool has been available to users. Early on in the design process, we made the decision to progress under the assumption that CMake will handle our dependencies and additional package managers can be installed as necessary and included in toolchain files. To install via FetchContent simply do:

include(FetchContent)
FetchContent_Declare(
    hepce
    GIT_REPOSITORY https://github.com/SyndemicsLab/hep-ce.git
    GIT_TAG main
)
option(HEPCE_INSTALL "Enable install for hep-ce project" ON)
option(HEPCE_BUILD_TESTS "Disable testing for hep-ce" OFF)
FetchContent_MakeAvailable(hepce)

This should produce a corresponding hepceConfig.cmake file for CMake linking and installation.

Previous: Home

Next: Data