This is a reimplementation from scratch of the C++ Hyperon prototype in the Rust programming language. This project replaces the previous prototype. See Python examples to become familiar with Hyperon features.

If you find troubles with the installation, see the Troubleshooting section below.

Install latest stable Rust, see Rust installation page.

Build and test the library:

cd ./lib
cargo build
cargo test

To enable logging during tests execute:

RUST_LOG=hyperon=debug cargo test

Prerequisites (must be executed in the top directory of the repository):

cargo install cbindgen
python -m pip install conan==1.47
python -m pip install -e ./python[dev]

Setup build:

mkdir -p build
cd build
cmake ..

Build and run tests:

make
make check

To run release build use following instead of cmake ..:

cmake -DCMAKE_BUILD_TYPE=Release ..

In order to run Python examples you need adding Python libraries into the PYTHONPATH after compilation:

cd build
export PYTHONPATH=$PYTHONPATH:`pwd`/python:`pwd`/../python

Different IDEs may require different tweaks to support the languages used in the codebase. The language servers which we use for development are:

• Rust Language Server;
• clangd, generate compile commands for the clangd using cmake variable:

  cmake -DCMAKE_EXPORT_COMPILE_COMMANDS=Y ..
  

• Python LSP server.

If you see the following cmake output:

ERROR: Not able to automatically detect '/usr/bin/cc' version
ERROR: Unable to find a working compiler
WARN: Remotes registry file missing, creating default one in /root/.conan/remotes.json
ERROR: libcheck/0.15.2: 'settings.compiler' value not defined

Try to create the default Conan profile manually:

conan profile new --detect default

If it doesn't help, then try to manually add compiler, compiler.version and compiler.libcxx values in the default Conan profile (~/.conan/profiles/default). For example:

conan profile update settings.compiler=gcc default
conan profile update settings.compiler.version=7 default
conan profile update settings.compiler.libcxx=libstdc++ default

Please ensure you are using the latest stable version:

rustup update stable

A docker image can be used to run a reproducible environment. See instructions inside the Dockerfile. If the docker image doesn't work, please raise an issue.