diff --git a/docs/source/library.rst b/docs/source/library.rst index 65e7c1e..822877b 100644 --- a/docs/source/library.rst +++ b/docs/source/library.rst @@ -2,7 +2,7 @@ Model Library ============= -popclass contains pre-loaded models that can be acceses by +popclass contains pre-loaded models that can be accessed by :code:`PopulationModel.from_library`. This page contains details on these available models. @@ -10,7 +10,7 @@ popsycle_singles_sukhboldn20 ---------------------------- This population model was generated using the Population Synthesis for Compact-object Lensing Events -or PopSyCLE. See the `code repositoy `_ +or PopSyCLE. See the `code repository `_ and paper :cite:`Lam2020`. The input parameters to the simulation were: .. code:: @@ -51,7 +51,7 @@ popsycle_singles_raithel18 -------------------------- This population model was generated using the Population Synthesis for Compact-object Lensing Events -or PopSyCLE. See the `code repositoy `_ +or PopSyCLE. See the `code repository `_ and paper :cite:`Lam2020`. The input parameters to the simulation were: .. code:: @@ -92,7 +92,7 @@ popsycle_singles_spera15 ------------------------ This population model was generated using the Population Synthesis for Compact-object Lensing Events -or PopSyCLE. See the `code repositoy `_ +or PopSyCLE. See the `code repository `_ and paper :cite:`Lam2020`. The input parameters to the simulation were: .. code:: @@ -127,3 +127,53 @@ The Galaxia "v3" galactic model parameters that were used: bulge_sigma_phi 100 bulge_sigma_z 100 bulge_patternspeed 40.00 + + +gbtds_nskick +------------------------ + +This set of population models follows the naming pattern ``gbtds_nskick{v}`` for v in (150, 250, 350, 450). + +It was generated using the Population Synthesis for Compact-object Lensing Events +or PopSyCLE. See the `code repository `_ +and paper :cite:`Lam2020`. + +For these models, the field pattern and settings were adjusted to the planned *Roman* Galactic Bulge Time Domain Survey. + +The input parameters to the simulation were: + +.. code:: + + BH_kick_speed_mean: 100 + IFMR: Spera15 + bin_edges_number: None + blend_rad: 0.09 + filter_name: H + n_obs: 600 + obs_time: 1825 + photometric_system: ubv + radius_cut: 3 + red_law: Damineli16 + theta_frac: 2 + multiplicity: None + binning: True + + +We generated four models with varying ``NS_kick_speed_mean`` (150, 250, 350, 450). +The mean NS kick speed is indicated in the model name. + +For the Galaxia galactic model, the parameters consistent with PopSyCLE "v3" were used: + +.. code:: + + bulge_Rc 2.54 + bulge_x0 0.7 + bulge_y0 0.424 + bulge_z0 0.424 + bulge_alpha 62.0 + bulge_beta 3.5 + bulge_gamma 91.3 + bulge_sigma_r 100 + bulge_sigma_phi 100 + bulge_sigma_z 100 + bulge_patternspeed 40.00 diff --git a/popclass/data/gbtds_nskick150.asdf b/popclass/data/gbtds_nskick150.asdf new file mode 100644 index 0000000..f901d6c Binary files /dev/null and b/popclass/data/gbtds_nskick150.asdf differ diff --git a/popclass/data/gbtds_nskick250.asdf b/popclass/data/gbtds_nskick250.asdf new file mode 100644 index 0000000..ed66703 Binary files /dev/null and b/popclass/data/gbtds_nskick250.asdf differ diff --git a/popclass/data/gbtds_nskick350.asdf b/popclass/data/gbtds_nskick350.asdf new file mode 100644 index 0000000..6aeadae Binary files /dev/null and b/popclass/data/gbtds_nskick350.asdf differ diff --git a/popclass/data/gbtds_nskick450.asdf b/popclass/data/gbtds_nskick450.asdf new file mode 100644 index 0000000..5dbe02f Binary files /dev/null and b/popclass/data/gbtds_nskick450.asdf differ diff --git a/popclass/model.py b/popclass/model.py index 85be525..6f095a8 100644 --- a/popclass/model.py +++ b/popclass/model.py @@ -15,6 +15,10 @@ "popsycle_singles_raithel18", "popsycle_singles_spera15", "popsycle_singles_sukhboldn20", + "gbtds_nskick150", + "gbtds_nskick250", + "gbtds_nskick350", + "gbtds_nskick450", ]