Automated doc build for refs/heads/main

popsim-consortium · Dec 13, 2024 · 98a41ce · 98a41ce
1 parent 789ad8a
commit 98a41ce
Show file tree

Hide file tree

Showing 14 changed files with 24 additions and 1 deletion.
diff --git a/main/_images/sec_catalog_anapla_models_mallardblackduck_2l19.png b/main/_images/sec_catalog_anapla_models_mallardblackduck_2l19.png
diff --git a/main/_images/sec_catalog_homsap_models_americanadmixture_4b11.png b/main/_images/sec_catalog_homsap_models_americanadmixture_4b11.png
diff --git a/main/_images/sec_catalog_homsap_models_outofafrica_2t12.png b/main/_images/sec_catalog_homsap_models_outofafrica_2t12.png
diff --git a/main/_images/sec_catalog_homsap_models_outofafrica_3g09.png b/main/_images/sec_catalog_homsap_models_outofafrica_3g09.png
diff --git a/main/_images/sec_catalog_homsap_models_outofafrica_4j17.png b/main/_images/sec_catalog_homsap_models_outofafrica_4j17.png
diff --git a/main/_images/sec_catalog_homsap_models_outofafricaarchaicadmixture_5r19.png b/main/_images/sec_catalog_homsap_models_outofafricaarchaicadmixture_5r19.png
diff --git a/.../sec_catalog_homsap_models_outofafricaextendedneandertaladmixturepulse_3i21.png b/.../sec_catalog_homsap_models_outofafricaextendedneandertaladmixturepulse_3i21.png
diff --git a/main/_images/sec_catalog_homsap_models_papuansoutofafrica_10j19.png b/main/_images/sec_catalog_homsap_models_papuansoutofafrica_10j19.png
diff --git a/main/_images/sec_catalog_orysat_models_bottleneckmigration_3c07.png b/main/_images/sec_catalog_orysat_models_bottleneckmigration_3c07.png
diff --git a/main/_images/sec_catalog_pantro_models_bonoboghost_4k19.png b/main/_images/sec_catalog_pantro_models_bonoboghost_4k19.png
diff --git a/main/_images/sec_catalog_ponabe_models_twospecies_2l11.png b/main/_images/sec_catalog_ponabe_models_twospecies_2l11.png
diff --git a/main/_sources/tutorial.rst.txt b/main/_sources/tutorial.rst.txt
@@ -505,6 +505,19 @@ The number of "sampling" populations could be smaller than the number of populat
 since some models have ancient populations which are currently not allowed to be
 sampled from -- but that is not the case in this model.
 
+If working in a notebook, it's also possible to plot a schematic of your chosen model
+using the `demesdraw <https://grahamgower.github.io/demesdraw/>`__ python library.
+This provides both a ``size_history`` plot and a ``tubes`` visualization. E.g.
+
+.. code-block:: python
+
+    import demesdraw
+    graph = model.model.to_demes()
+    demesdraw.tubes(model.model.to_demes());
+
+Equivalent plots for all the available demographic models are also
+shown in the :ref:`sec_catalog`.
+
 Set up the contig
 -----------------
 

diff --git a/main/searchindex.js b/main/searchindex.js
diff --git a/main/tutorial.html b/main/tutorial.html
@@ -680,6 +680,16 @@ <h4>Pick a species and demographic model<a class="headerlink" href="#pick-a-spec
 The number of “sampling” populations could be smaller than the number of populations,
 since some models have ancient populations which are currently not allowed to be
 sampled from – but that is not the case in this model.</p>
+<p>If working in a notebook, it’s also possible to plot a schematic of your chosen model
+using the <a class="reference external" href="https://grahamgower.github.io/demesdraw/">demesdraw</a> python library.
+This provides both a <code class="docutils literal notranslate"><span class="pre">size_history</span></code> plot and a <code class="docutils literal notranslate"><span class="pre">tubes</span></code> visualization. E.g.</p>
+<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">demesdraw</span>
+<span class="n">graph</span> <span class="o">=</span> <span class="n">model</span><span class="o">.</span><span class="n">model</span><span class="o">.</span><span class="n">to_demes</span><span class="p">()</span>
+<span class="n">demesdraw</span><span class="o">.</span><span class="n">tubes</span><span class="p">(</span><span class="n">model</span><span class="o">.</span><span class="n">model</span><span class="o">.</span><span class="n">to_demes</span><span class="p">());</span>
+</pre></div>
+</div>
+<p>Equivalent plots for all the available demographic models are also
+shown in the <a class="reference internal" href="catalog.html#sec-catalog"><span class="std std-ref">Catalog</span></a>.</p>
 </section>
 <section id="set-up-the-contig">
 <h4>Set up the contig<a class="headerlink" href="#set-up-the-contig" title="Permalink to this heading"></a></h4>