BubbleProfiler

BubbleProfiler is a C++ library for calculating the bounce solution and Euclidean action associated with a cosmological phase transition.

Quickstart

Requirements

The following dependencies are required to build BubbleProfiler:

• CMake
• C++11 compatible compiler (g++ >= 4.8.1 or clang++ >= 3.8 or icpc >= 15.0)
• Boost, specifically the components
  • Boost.Program_options
  • Boost.Filesystem
  • Boost.System
• Eigen 3
• GiNaC
• GNU scientific library
• NLopt

The following dependencies are optional:

• Doxygen, for building the documentation
• Python 2.7.x or Python 3.x, for running some examples

Building BubbleProfiler

BubbleProfiler uses CMake to configure its build system. To build the library and command line executable,

1. Create a build directory in which to build the package:

    mkdir build
   

2. Run CMake from this directory to configure the build system:

    cd build
    cmake ..
   

3. Compile the core library and command line executable:

    cmake --build .
   

4. Optionally, build and run the unit tests:

    cmake --build . --target 'check'
   

5. Optionally, build the example programs:

    cmake --build . --target 'examples'
   

6. Optionally, build the package documentation:

    cmake --build . --target 'docs'
   

7. Optionally, install the library and executables:

    cmake --build . --target 'install'
   

After building the package, the build directory will contain the subdirectories

• bin/, containing the main command line executable and the example programs, if compiled
• docs/, containing the package documentation, if generated
• examples/, containing example scripts, if generated
• include/, containing generated header files
• lib/, containing the BubbleProfiler library
• test/, containing test binaries and output, if compiled

For more detailed instructions and help with the build and installation process, refer to the accompanying INSTALL.md file.

Running BubbleProfiler

BubbleProfiler consists of two core components, a command line executable for standalone use and a library to be used in your own programs. The executable run_cmd_line_potential calculates the action and, optionally, the field profiles for the bounce solution, given a potential and set of fields. For example, the bounce action for a potential involving two scalar fields may be calculated using

./bin/run_cmd_line_potential \
     --potential "(x^2 + y^2)*(1.8*(x - 1)^2 + 0.2*(y-1)^2 - 0.4)" \
     --field x --field y --local-minimum 0 0

A summary of the possible options for the program may be printed using ./bin/run_cmd_line_potential --help. Detailed information about the program and its options may be found in the accompanying manual.

Package content

The following subdirectories are included within the BubbleProfiler source distribution:

• cmake/ contains modules and scripts used by the CMake build system
• docs/ contains source files required for building the documentation
• examples/ contains examples demonstrating the use of BubbleProfiler
• include/ contains the C++ header files provided by the package
• src/ contains the C++ source files from which the package is built
• test/ contains the package unit tests
• utils/ contains helpful utility scripts, primarily for the package developers

Additional information regarding the purpose and content of individual files in the package may be found in the documentation.

License

BubbleProfiler is licensed under the BSD 3-Clause license. See the accompanying LICENSE file for details.