From 59e2394fb790886f3e6dca59b8996aacb24a1f51 Mon Sep 17 00:00:00 2001 From: Jerome Kelleher Date: Thu, 2 Jan 2020 17:28:22 +0000 Subject: [PATCH 1/4] Updated long_description. Closes #347 --- README.rst | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 71bb348dc..3fb387b16 100644 --- a/README.rst +++ b/README.rst @@ -1,2 +1,9 @@ -Standard models for population genetics simulations in msprime. +**Standard library of population genetic simulations** + +Stdpopsim is a community-maintained standard library of population genetic models. +Please see the `documentation `_ +for details. + +Stdpopsim is highly portable, and provides a number of +`installation options `_. From c16d87b819d9602f4cad328ac48f042543a1ccf9 Mon Sep 17 00:00:00 2001 From: Jerome Kelleher Date: Thu, 2 Jan 2020 17:35:01 +0000 Subject: [PATCH 2/4] Changelog for 0.1.1. --- CHANGELOG.rst | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 61f983cbf..9045abdd7 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -1,3 +1,25 @@ +-------------------- +[0.1.1] - 2020-01-02 +-------------------- + +Bugfix release. Fixes some distribution issues and temporarily removes the +PonPyg species. + +**Bug fixes**: + +- Pin the msprime and attrs packages to resolve some distribution problems + (:issue:`366`; :user:`jgallowa07` and :user:`gtsambos`). + +**New features**: + +- Provide citations for the genome assembly (:issue:`359`, :pr:`360`; + :user:`andrewkern` and :user:`grahamgower`). + +**Breaking changes**: + +- Temporarily remove the PonPyg species from the catalog to provide time + to fix issues with genomes and multi-species models (:issue:`365`). + -------------------- [0.1.0] - 2019-12-18 -------------------- From efb07994ae154027827de85f1941395ba1f268dd Mon Sep 17 00:00:00 2001 From: Jerome Kelleher Date: Thu, 2 Jan 2020 17:41:15 +0000 Subject: [PATCH 3/4] Basic conda docs. --- docs/installation.rst | 26 ++++++++++++++++++++++++-- 1 file changed, 24 insertions(+), 2 deletions(-) diff --git a/docs/installation.rst b/docs/installation.rst index dbe995bb1..a6813a468 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -27,8 +27,30 @@ Stdpopsim requires Python 3.5 or later. Conda ***** -.. todo:: The conda package for stdpopsim is currently under development and will - be available shortly. Please use pip for now. +Pre-built binary packages for ``stdpopsim`` are available through +`conda `_, and built using `conda-forge `_. +Packages for recent version of Python are available for Linux, OSX and Windows. Install +using:: + + $ conda install -c conda-forge stdpopsim + + ++++++++++++ +Quick Start ++++++++++++ + +1. Install ``conda`` using `miniconda `_. + Make sure you follow the instructions to fully activate your ``conda`` + installation! +2. Set up the `conda-forge channel `_ using + ``conda config --add channels conda-forge``. +3. Install stdpopsim: ``conda install stdpopsim``. +4. Try it out: ``stdpopsim --version``. + + +There are several different ways to obtain ``conda``. Please see the +`anaconda installation documentation `_ +for full details. .. _sec_installation_pip: From 11fa765a2d5d9e18e3465bfa2bda86ef0a13e761 Mon Sep 17 00:00:00 2001 From: Jerome Kelleher Date: Thu, 2 Jan 2020 17:50:00 +0000 Subject: [PATCH 4/4] Added sphinx-issues to requirements. --- docs/conf.py | 8 ++++++-- requirements/development.txt | 1 + requirements/rtd-conda-environment.yml | 1 + 3 files changed, 8 insertions(+), 2 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 277133f3e..207798bcd 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -28,7 +28,7 @@ # The short X.Y version version = '' # The full version, including alpha/beta/rc tags -release = '0.1.0' +release = '0.1.1' # -- General configuration --------------------------------------------------- @@ -49,7 +49,8 @@ 'sphinx.ext.viewcode', 'speciescatalog', 'sphinxarg.ext', - 'sphinxcontrib.programoutput' + 'sphinxcontrib.programoutput', + 'sphinx_issues', ] # Add any paths that contain templates here, relative to this directory. @@ -199,3 +200,6 @@ # If true, `todo` and `todoList` produce output, else they produce nothing. todo_include_todos = True + +# Github repo +issues_github_path = "popsim-consortium/stdpopsim" diff --git a/requirements/development.txt b/requirements/development.txt index ab4a864ce..b0c306f0b 100644 --- a/requirements/development.txt +++ b/requirements/development.txt @@ -5,6 +5,7 @@ nose setuptools_scm sphinx sphinx-argparse +sphinx-issues sphinx_rtd_theme sphinxcontrib-programoutput msprime diff --git a/requirements/rtd-conda-environment.yml b/requirements/rtd-conda-environment.yml index 9c19b617b..67f23a966 100644 --- a/requirements/rtd-conda-environment.yml +++ b/requirements/rtd-conda-environment.yml @@ -9,5 +9,6 @@ dependencies: - appdirs - msprime - sphinx-argparse + - sphinx-issues - sphinxcontrib-programoutput - humanize