Generated catalog figures for each published demographic model #1034
Conversation
…age: demesdraw [-h] [--version] {tubes,size_history} ...
Draw a Demes model.
positional arguments:
{tubes,size_history}
tubes Plot a demes-as-tubes schematic of the model and the
demes' relationships.
size_history Plot population size as a function of time for each
deme in the model.
optional arguments:
-h, --help show this help message and exit
--version show program's version number and exit
Codecov Report
@@ Coverage Diff @@
## main #1034 +/- ##
=======================================
Coverage 98.65% 98.65%
=======================================
Files 89 89
Lines 2899 2899
Branches 348 348
=======================================
Hits 2860 2860
Misses 31 31
Partials 8 8
Continue to review full report at Codecov.
|
There was a problem hiding this comment.
This is great, thanks for taking this on @aabiddanda. I just have a few quibbles noted below.
|
It looks like the pre-commit test is failing too. See here, for how to set that up so your code will automatially be checked when you commit. |
|
I see the images in the catalog when I build locally, but this doesn't seem to have propagated into readthedocs (e.g. https://stdpopsim.readthedocs.io/en/latest/catalog.html#sec_catalog_homsap_models_outofafrica_3g09). I thought that after #946 RTD was working again. @jeromekelleher do you get mails from RTD when it fails? |
|
Yes, sorry @grahamgower I have been getting failure emails from RTD but I didn't pay much attention. I'm afraid this has very little chance of working there, the environment is very limited. |
|
Ah, damn. Same old RTD I guess. The alternate docs home is still running fine though: https://popsim-consortium.github.io/stdpopsim-docs/main/catalog.html |
|
Excellent! Should we just turn off RTD then? |
|
Is there a way to do a redirect? |
|
@benjeffery, you did this with the tskit repos - what's the least-bad option for transitioning off RTD? We have a site up and running for the dev branch. |
|
For our repos, after some experimentation, that the attached were the redirects that worked best: |
|
Just here to say that the demography figures are beautiful and so useful @aabiddanda! Well done :) |
|
Agree! |
For each demographic model in
stdpopsimthat has a catalog entry in the documentation, the build process will generate a plot via thedemesdrawpackage that is saved to a directory and included in the HTML building.This represents an interim solution to #962 & #149, subject to changes in the
demesanddemesdrawAPIs. Some additional smaller edits are:docs/development.rstThe ideal here is that for each new model added to the catalog (if the model corresponds to a
demesmodel), it will automatically generate a graphical representation within the documentation. Any suggestions / stylistic edits welcome!