README.md

HybridLeads

Installation

1. Container

   • Pull the image:

   docker pull ghcr.io/chiamin/hybridleads:latest
   

   • Build the image by yourself:

   docker build --no-cache --force-rm -t hybridleads .
   

   • Run the container:

   docker run --rm -it -v $(pwd):/home ghcr.io/chiamin/hybridleads:latest
   

   Note: replace the image name ghcr.io/chiamin/hybridleads:latest by hybridleads if you're building the image by yourself.

   • Package version:
     • gcc 12.2.0
     • c++17
     • cmake 3.10^
     • ITensor v3.1.11
     • armadillo 11.4.x
     • Catch2 v3.2.0
     • trompeloeil v43
   • Environment variables: The compiling flags for ITensor,
     • CCCOM="g++ -m64 -std=c++17 -fconcepts -fPIC"
     • PLATFORM="lapack"
     • BLAS_LAPACK_LIBFLAGS="-lpthread -L/usr/lib -lblas -llapack"

2. Build from scratch

   There're few prior requirements,

   • lapack, blas
   • ITensor
   • itensor.utility
   • armadillo

Run the tests

Catch2 is also the framework that ITensor adopted for unit test. It requires to compile the sources with cmake.

To compile the tests, one can do (within tests/ folder)

cmake -B build
make -C build

The resulting executables are test_*.exe (in tests/build/).

If mocking is needed in the unit test, one may consider trompeloeil.

Run other main executables

Compiling flags are pre-set as enviroment variables in the Docker container, one can do

make -e

to use those flags.

Then, for instance, one can run the executable hybridleads/itdvp/itdvp.exe by

./itdvp.exe input

with the parameters been assigned in itdvp/input, see here for the more detailed documentation on input files.

Dependency Management

Apart from the known package managers, like conan or vcpkg, here we adopt git submodule to do the dependency management for few reasons, (i) ITensor is unavailable on both ecosystems, and (ii) itensor.utility is a personal project and is also unavailable on both ecosystems. Git submodule is a compromised solution.

1. To add a new submodule

   git submodule add -b {branch_name} {git_repo_url} {folder_name}
   

   The optional directory name should be placed under ext/, i.e. {folder_name} should be something like ext/{repo_name}.

   If the above command fails, one could also try the manual checkout to specify the branch or tag afterwards.

2. To update an existig submodule to its newest version

   git submodule update --remote {repo_name}
   

   or manually checkout to newer tag or version within the directory where the submodule seats in.