Skip to content

Commit

Permalink
Update about.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
Arianna Renzini committed May 22, 2024
1 parent 7a8aea9 commit 71e4ab0
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions docs/about.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,15 @@
==============================================
About ``popstock``
==============================================

`\tt popstock`: a python--based open--source package for the rapid computation of gravitational-wave background (GWB) fractional energy density spectra such as :math: `\Omega_{\rm GW}`, for a given realization of events, and its ensemble average :math: `\bar{\Omega}_{\rm GW}` for a given set of hyper-parameters :math: `\Lambda`.

Other than the standard python scientific libraries `numpy` and `scipy`, the main dependencies of the `popstock` package are:

* `astropy`: a core python library used by astronomers
* `bilby`: one of the most popular bayesian inference libraries for GW astronmy
* `gwpopulation`: a collection of parametric binary black hole mass, redshift, and spin population models.

The `popstock` package also relies on `multiprocessing` (included in most python distributions) to parallelize the computations for the large number of samples required for high-precision GWB evaluation.

The gravitational-wave waveforms required to compute `\Omega_{\rm GW}` are imported by `bilby` from the LIGO Scientific Collaboration Algorithm Library (LAL), which is also required during package installation.

0 comments on commit 71e4ab0

Please sign in to comment.