Worm algorithm

• v4.1

  • ~~ adding chance to worm delete at worm update step. ~~
    • might not satisfy DBC.
  • can deal with any hermitian matrix. (not need to real-valued hamiltonian)
  • can deal with similarity-transformed hamiltonian.

• 4.2

  • reduce probability of zero-worm
  • warp zero-worm
  • delete worm

• v4.3

  • automatically reduce sign.
    • chose unit cell by ourself, then find the best local similarity transformation.7
  • make container handle cuda.

• v5

  • dockerfile update.

    • poor performance on M1 mac

      • gRPC FUSE
        • cmkae configure (second time) takes 6.43
      • volume mount
        • cmkae configure (second time) takes 3.53

• v1.2

  • OS-X get some error when import torchvision. (/home/user/miniconda3/envs/py39/lib/python3.9/site-packages/torchvision/io/image.py:13)
  • Please just ignore that.

environment preparation

• Docker

  • use docker container inside .devcontainer

• python

  • anaconda

  • use pip
    • setup with pip install -r .devcontainer/requirements.txt
    • export requirement with pip freeze > requirements.txt
      • note that you need to delete PyGObject==3.42.0 and add --extra-index-url https://download.pytorch.org/whl/cpu before calling torch packages.

• Julia

  • x86_64-linux-gnu
    • wget https://julialang-s3.julialang.org/bin/linux/x64/1.8/julia-1.8.5-linux-x86_64.tar.gz (see https://julialang.org/downloads/)
    • add export PATH="$PATH:/home/sammy/julia-1.8.1/bin" to .bashrc

• packages

  • libconfig when installing libconfig, you need to make sure to install with -DBUILD_SHARED_LIBS=OFF. With this you can install static library. If you rather want to install with shared libs, you need to set option(BUILD_SHARED_LIBS "Enable shared library" OFF) in cmake/libconfig.cmake and add path to ".so" to LD_LIBRARY_PATH by export.

  • boost You might install boost in two different ways. One with apt-get and the other with conda(pip). If you try to use boost library with find_package in cmake, you may find out it will search first in conda environment. If you want to use boost with apt-get, do one of following things.

    • add set(CMAKE_FIND_USE_SYSTEM_ENVIRONMENT_PATH FALSE) in CMakeLists.txt.
    • remove path to miniconda3 from PATH environment
    • alternatively (better answer), you can just add x86_64-linux-gnu(/usr/lib/aarch64-linux-gnu) on top of current $PATH by PATH="/usr/lib/x86_64-linux-gnu:$PATH"(PATH="/usr/lib/aarch64-linux-gnu:$PATH")

How to build the project

• Configure with cmake : cmake ..
• Build with make : make
  • If you installed ninja and want to use it, you can specify the number of threads by using cmake -GNinja .. and ninja -j<number_of_threads>

Run the test

For c++ projects with ctest

- For unit tests : `ctest`
- For integration tests, you have to check individually

For python projects with pytest

- Just run pytest with `pytest` 
  - All tests are supposed to be called from project root directory.
  - For example, `pytest python/rmsKit/rms_torch/tests/functions.py`
- All tests file must start with `test`