Cite

If you use cogsworth in a scientific publication we ask that you please cite it and its dependencies. cogsworth could not function without many of the excellent papers and software packages on which it depends. We’ve tried to make it as painless as possible for you to be able to cite the specific dependencies for your individual use case.

For any Population or StarFormationHistory you can call get_citations() to get a personalised and specific (a) acknowledgement sentence for your manuscript and (b) the associated BibTeX information.

For example, say you create an extremely basic population that uses the default parameters:

import cogsworth
p = cogsworth.pop.Population(5, processes=6)
p.create_population(with_timing=False)

p.get_citations()

You can paste this acknowledgement into the relevant section of your manuscript:
This research made use of \texttt{cogsworth} and its dependencies \citep{cogsworth:joss,cosmic:apj,gala:joss}. The \texttt{cogsworth} population used a galaxy model based on the following papers \citep{Wagg+2022,Frankel+2018,Bovy+2016,Bovy+2019,McMillan+2011}. 
The associated bibtex can be found in cogsworth.bib
Good luck with the paper writing ◝(ᵔᵕᵔ)◜

As you use further cogsworth features, each new citation will be tracked. For example if you also calculate observable properties and checked which binaries are observable by Gaia your citations might look like this.

p.get_observables()
p.get_gaia_observed_bin_nums()

p.get_citations()

You can paste this acknowledgement into the relevant section of your manuscript:
This research made use of \texttt{cogsworth} and its dependencies \citep{cogsworth:joss,cosmic:apj,gala:joss}. The \texttt{cogsworth} population used a galaxy model based on the following papers \citep{Wagg+2022,Frankel+2018,Bovy+2016,Bovy+2019,McMillan+2011}. Population observables were estimated using dust maps and MIST isochrones \citep{MIST0,MIST1,Paxton+2011,Paxton+2013,Paxton+2015,Paxton+2018,bayestar2019}. Observability of systems with Gaia was predicted using an empirical selection function \citep{gaia-selection-function}. 
The associated bibtex can be found in cogsworth.bib
Good luck with the paper writing ◝(ᵔᵕᵔ)◜

Note

This tutorial was generated from a Jupyter notebook that can be found here.