Skip to content
/ pttools Public

Simulation software for phase transitions in the early universe

Notifications You must be signed in to change notification settings

CFT-HY/pttools

Repository files navigation

README

CI Docs macOS Windows

PTtools is Python library for calculating hydrodynamical quantities around expanding bubbles of the new phase in an early universe phase transition, and the resulting gravitational wave power spectrum in the sound shell model.

References

Submodules

  • bubble: Tools for computing the fluid shells (velocity and enthalpy as a function of scaled radius). Also includes some scripts for plotting.
  • speedup: Computational utilities used by the other modules.
  • ssmttools: Tools for computing the GW spectra from the fluid shells.

Branches

  • main: Stable version, from which releases are created.
  • dev: Developments for later inclusion in the main branch.
  • droplet-dev: Development of different solution types.
  • eos-dev: Development of support for different equations of state.

Documentation

As this repository is not yet public, the documentation is not yet hosted directly on the web. Documentation for the releases can be found at the releases page.

The documentation is automatically generated for new commits, and the resulting documentation can be found at the GitHub Actions results by selecting the latest successful docs workflow and then scrolling down to the artifacts section. There you can find a zip file containing the documentation in various formats.

The recommended way to browse the documentation is to unpack the zip file and then open html/index.html with a web browser.

Who do I talk to?