Usage

After pip installing TransitionListener, you can easily start using it from your terminal. It is really simple to get started.

Configuration files

All it takes is a human-readable configuration file, a YAML file, which specifies the model parameters, scanning ranges, and desired outputs.

You can find example configuration files in the config/ directory of the TransitionListener repository.

Single point evaluation

Let’s say you have created a configuration file named example-point-scan.yaml in the config/ directory, which specifies a benchmark point which you would like to know of whether it features a first-order phase transition and what gravitational-wave signal it produces.

You can run TransitionListener using the command line interface as follows:

$ tl -c config/example-point-scan.yaml -v True

This command will execute TransitionListener with the specified configuration file and enable verbose output. This will print detailed information about the progress of the computation to the terminal. When the computation is finished, the results will be saved to the scans directory to a subfolder as specified in the configuration file. In there you will find various output files, including …

Grid and line scans

If you want to run a small grid scan using the command line interface, you can use the following command:

$ tl -c config/example-grid-scan.yaml -j 10

The -j flag specifies the number of parallel jobs to run. Here we took 10 jobs. This can speed up the scan significantly on multi-core machines. After the scan is complete, the results will be saved in the specified output directory. You will find various output files, including the gravitational-wave spectra for each parameter point in the scan….

Alternatively, you can also run a line scan using the following command:

$ tl -c config/example-line-scan.yaml -j 5

This will perform a line scan over the specified parameter range with 5 parallel jobs. The results will be saved in the output directory as specified in the configuration file. The output is very similar to the grid scan case.

Random and nested sampling scans

You can also run a random scan by using the following command:

$ tl -c config/example-random-scan.yaml -j 8

This will perform a random scan over the specified parameter ranges with 8 parallel jobs. The results will be saved in the output directory in a csv file. You can use this file to analyze the results further or visualize them using your preferred plotting tools.

If you are interested in performing a nested sampling scan using mpi for parallelization you can use the following command:

$ mpiexec -n 16 tl -c config/example-nested-scan.yaml

This will run a nested sampling scan with 16 parallel processes. The results will be saved in both a csv file in the specified output directory.

For detailed installation instructions and usage examples please refer to the following sections:

For more information, visit the documentation at https://tasillo.de/TransitionListener_development or check out the code repository at https://github.com/tasicarl/TransitionListener.