Theoretical and Numerical Aspects of Nuclear Physics project by Lorenzo Fabbri and Francesco Orso Pancaldi.

Follows the instructions of Morten Hjorth-Jensen's project.

Dependencies and Dev container

• To run the program: tbb (since the C++ atomic header requires it)
• To generate documentation: doxygen, graphviz

The program has a Dev container configuration file, so if the container is created (for example from VS Code) all required dependencies are automatically installed. As the code was developed and tested inside a container, using one also guarantees the absence of OS-specific bugs. To run a Dev container from VS Code, follow the guide or, in short:

1. Install VS Code.
2. Install Docker.
3. Install the VS Code Dev container extension.
4. Open the program in VS Code, and either:
   • build the container from the pop-up window in the bottom-right that appears after opening, or
   • type in the top bar > Dev Containers: Build and Open in a Container.

Usage (Linux, includes the Dev container)

• To run the program:

  cmake -S . -B build -D BUILD_MAIN=ON -D CMAKE_BUILD_TYPE=Release
  cmake --build build
  build/main-vmc
  

• To run the tests (and save a log)

  cmake -S . -B build -D BUILDT_ALL=ON
  cmake --build build
  cd build
  make test
  

  To build a specific test(s) define, instead of BUILDT_ALL, the variable(s) BUILDT_XXX, where XXX is among:

  • HO_1P1D
  • HO_1P2D
  • HO_2P1D
  • BOX_1P1D
  • STAT

  Multiple variables can be defined in the same command. Example:

  cmake -S . -B build -D BUILDT_HO_1P1D=ON BUILDT_HO_1P2D=ON BUILDT_HO_2P1D=ON
  cmake --build build
  cd build
  make test
  

Documentation

Available on github pages.

Alternatively, it can be built locally by running

doxygen

in the main directory and viewed by opening ./docs/html/index.html in a browser. There are warnings since some functions (for example, operator+= for Coordinate) are not documented. This is by choice, since those are so simple that documenting them would just clutter both the code and the html page.

When building locally, do not generate a new Doxygen configuration file.

General remarks

1. There is an error message while building the container:

   Error: there is no registered task type 'cppbuild'. Did you miss installing an extension that provides a corresponding task provider?

   It is completely harmless. See the related issue.

2. The work was split in the following way: Francesco coded the parts 1b, 1d, 1f of the project, Lorenzo coded 1c, 1e, 1g. Each part was first implemented in a branch which was then merged after a pull request. Also there may be some cleanup or bugfixing branches here and there.