Skip to content

Commit

Permalink
Document demography arg to sim_ancestry.
Browse files Browse the repository at this point in the history
Closes #1488
  • Loading branch information
jeromekelleher committed Mar 2, 2021
1 parent c03b336 commit a153f35
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion msprime/ancestry.py
Original file line number Diff line number Diff line change
Expand Up @@ -993,13 +993,13 @@ def _parse_sim_ancestry(
def sim_ancestry(
samples=None,
*,
demography=None,
sequence_length=None,
discrete_genome=None,
recombination_rate=None,
gene_conversion_rate=None,
gene_conversion_tract_length=None,
population_size=None,
demography=None,
ploidy=None,
model=None,
initial_state=None,
Expand Down Expand Up @@ -1029,6 +1029,15 @@ def sim_ancestry(
is usually associated with :math:`k` sample *nodes* (or genomes) when
``ploidy`` = :math:`k`. See :ref:`sec_ancestry_samples` for further details.
Either ``samples`` or ``initial_state`` must be specified.
:param demography: The demographic model to simulate, describing the
extant and ancestral populations, their population sizes and growth
rates, their migration rates, and demographic events affecting the
populations over time. See the :ref:`sec_demography` section for
details on how to specify demographic models and
:ref:`sec_ancestry_samples` for details on how to specify the
populations that samples are drawn from. If not specified (or None) we
default to a single population with constant size 1
(see also the ``population_size`` parameter).
:param int ploidy: The number of monoploid genomes per sample individual
(Default=2). See :ref:`sec_ancestry_ploidy` for usage examples.
:param float sequence_length: The length of the genome sequence to simulate.
Expand Down

0 comments on commit a153f35

Please sign in to comment.