https://github.com/jrbourbeau/pyunfold
Tip revision: 148ce043974f4f49ccfe39233894711017cdb8bd authored by Deployment Bot (from Travis CI) on 19 November 2018, 04:57:08 UTC
Deploy jrbourbeau/pyunfold to github.com/jrbourbeau/pyunfold.git:gh-pages
Deploy jrbourbeau/pyunfold to github.com/jrbourbeau/pyunfold.git:gh-pages
Tip revision: 148ce04
changelog.html
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Release Notes — PyUnfold 0.5.0 documentation</title>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Contributing" href="contributing.html" />
<link rel="prev" title="Mathematical Derivations" href="mathematics.html" />
<script src="_static/js/modernizr.min.js"></script>
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href="index.html">
<img src="_static/simple@2x.png" class="logo" alt="Logo"/>
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<p class="caption"><span class="caption-text">Getting Started</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="overview.html">Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="examples.html">Examples</a></li>
<li class="toctree-l1"><a class="reference internal" href="why.html">Why PyUnfold?</a></li>
</ul>
<p class="caption"><span class="caption-text">User Guide</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="callbacks.html">Callbacks</a></li>
<li class="toctree-l1"><a class="reference internal" href="api.html">PyUnfold API</a></li>
<li class="toctree-l1"><a class="reference internal" href="mathematics.html">Mathematical Derivations</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Release Notes</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#version-0-5-0-2018-11-18">Version 0.5.0 (2018-11-18)</a></li>
<li class="toctree-l2"><a class="reference internal" href="#version-0-4-2018-06-03">Version 0.4 (2018-06-03)</a></li>
<li class="toctree-l2"><a class="reference internal" href="#version-0-3-2018-05-15">Version 0.3 (2018-05-15)</a></li>
<li class="toctree-l2"><a class="reference internal" href="#version-0-2-2-2018-05-04">Version 0.2.2 (2018-05-04)</a></li>
<li class="toctree-l2"><a class="reference internal" href="#version-0-2-1-2018-05-04">Version 0.2.1 (2018-05-04)</a></li>
<li class="toctree-l2"><a class="reference internal" href="#version-0-2-2018-05-04">Version 0.2 (2018-05-04)</a></li>
<li class="toctree-l2"><a class="reference internal" href="#version-0-1-2018-04-05">Version 0.1 (2018-04-05)</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li>
<li class="toctree-l1"><a class="reference internal" href="citing.html">Citing PyUnfold</a></li>
</ul>
<p class="caption"><span class="caption-text">Useful links</span></p>
<ul>
<li class="toctree-l1"><a class="reference external" href="https://github.com/jrbourbeau/pyunfold">PyUnfold @ GitHub</a></li>
<li class="toctree-l1"><a class="reference external" href="https://pypi.org/project/pyunfold/">PyUnfold @ PyPI</a></li>
<li class="toctree-l1"><a class="reference external" href="https://anaconda.org/conda-forge/pyunfold">PyUnfold @ conda-forge</a></li>
<li class="toctree-l1"><a class="reference external" href="https://github.com/jrbourbeau/pyunfold/issues">Issue Tracker</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">PyUnfold</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html">Docs</a> »</li>
<li>Release Notes</li>
<li class="wy-breadcrumbs-aside">
<!-- User defined GitHub URL -->
<a href="https://github.com/jrbourbeau/pyunfold" class="fa fa-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<style>
/* CSS overrides for sphinx_rtd_theme */
/* 24px margin */
.nbinput.nblast,
.nboutput.nblast {
margin-bottom: 19px; /* padding has already 5px */
}
/* ... except between code cells! */
.nblast + .nbinput {
margin-top: -19px;
}
.admonition > p:before {
margin-right: 4px; /* make room for the exclamation icon */
}
</style>
<div class="section" id="release-notes">
<h1>Release Notes<a class="headerlink" href="#release-notes" title="Permalink to this headline">¶</a></h1>
<div class="section" id="version-0-5-0-2018-11-18">
<h2>Version 0.5.0 (2018-11-18)<a class="headerlink" href="#version-0-5-0-2018-11-18" title="Permalink to this headline">¶</a></h2>
<p><strong>New Features</strong>:</p>
<ul class="simple">
<li>Adds unfolding matrix to output of <code class="docutils literal notranslate"><span class="pre">iterative_unfold</span></code> (See <a class="reference external" href="https://github.com/jrbourbeau/pyunfold/pull/88">PR #88</a>).</li>
<li>Adds <code class="docutils literal notranslate"><span class="pre">CallbackList</span></code> container for storing a collection of <code class="docutils literal notranslate"><span class="pre">Callback</span></code> objects (See <a class="reference external" href="https://github.com/jrbourbeau/pyunfold/pull/101">PR #101</a>).</li>
</ul>
<p><strong>Changes</strong>:</p>
<ul class="simple">
<li>Adds a check to <code class="docutils literal notranslate"><span class="pre">Mixer</span></code> to ensure response matrices are two-dimensional. An error is raised if a non-2D response matrix is input (See <a class="reference external" href="https://github.com/jrbourbeau/pyunfold/pull/90">PR #90</a>).</li>
<li>Removes unnecessary NumPy array copies in <code class="docutils literal notranslate"><span class="pre">Mixer</span></code> and <code class="docutils literal notranslate"><span class="pre">CovarianceMatrix</span></code> object (See <a class="reference external" href="https://github.com/jrbourbeau/pyunfold/pull/99">PR #99</a>).</li>
<li>Vectorized some operations in <code class="docutils literal notranslate"><span class="pre">Mixer</span></code> and <code class="docutils literal notranslate"><span class="pre">CovarianceMatrix</span></code> objects (See <a class="reference external" href="https://github.com/jrbourbeau/pyunfold/pull/102">PR #102</a>).</li>
</ul>
<p><strong>Bug Fixes</strong>:</p>
<ul class="simple">
<li>Fixed bug in Bayes factor test statistic <code class="docutils literal notranslate"><span class="pre">calc</span></code> method (See <a class="reference external" href="https://github.com/jrbourbeau/pyunfold/pull/93">PR #93</a>).</li>
</ul>
<p><strong>Documentation</strong>:</p>
<ul class="simple">
<li>Add nbsphinx prolog to examples with link to interactive Binder notebook
(See <a class="reference external" href="https://github.com/jrbourbeau/pyunfold/pull/96">PR #96</a>).</li>
<li>Corrected the accepted <code class="docutils literal notranslate"><span class="pre">ts</span></code> parameters in the <code class="docutils literal notranslate"><span class="pre">iterative_unfold</span></code> docstring
(See <a class="reference external" href="https://github.com/jrbourbeau/pyunfold/pull/91">PR #91</a>).</li>
</ul>
</div>
<div class="section" id="version-0-4-2018-06-03">
<h2>Version 0.4 (2018-06-03)<a class="headerlink" href="#version-0-4-2018-06-03" title="Permalink to this headline">¶</a></h2>
<p><strong>Changes</strong>:</p>
<ul class="simple">
<li>Adds check to <code class="docutils literal notranslate"><span class="pre">iterative_unfold</span></code> for negative values in input
distributions. An error is raised if negative efficiencies, responses, or
observed data distributions are input.
(See <a class="reference external" href="https://github.com/jrbourbeau/pyunfold/pull/73">PR #73</a>)</li>
<li>Adds several documentation updates in response to JOSS reviewer comments
(See
<a class="reference external" href="https://github.com/jrbourbeau/pyunfold/pull/83">PR #83</a>,
<a class="reference external" href="https://github.com/jrbourbeau/pyunfold/pull/82">PR #82</a>,
<a class="reference external" href="https://github.com/jrbourbeau/pyunfold/pull/77">PR #77</a>,
<a class="reference external" href="https://github.com/jrbourbeau/pyunfold/pull/76">PR #76</a>,
<a class="reference external" href="https://github.com/jrbourbeau/pyunfold/pull/71">PR #71</a>,
<a class="reference external" href="https://github.com/jrbourbeau/pyunfold/pull/70">PR #70</a>, and
<a class="reference external" href="https://github.com/jrbourbeau/pyunfold/pull/69">PR #69</a>)</li>
</ul>
<p><strong>Bug Fixes</strong>:</p>
<ul class="simple">
<li>Fixes environment used for running the “Tutorial” and “Advanced Techniques”
example notebooks on binder. (See <a class="reference external" href="https://github.com/jrbourbeau/pyunfold/pull/68">PR #68</a>)</li>
</ul>
</div>
<div class="section" id="version-0-3-2018-05-15">
<h2>Version 0.3 (2018-05-15)<a class="headerlink" href="#version-0-3-2018-05-15" title="Permalink to this headline">¶</a></h2>
<p><strong>New Features</strong>:</p>
<ul class="simple">
<li>Adds cause bin group support to <code class="docutils literal notranslate"><span class="pre">SplineRegularizer</span></code> for independent
regularization. (See <a class="reference external" href="https://github.com/jrbourbeau/pyunfold/pull/47">PR #47</a>)</li>
<li>Adds <code class="docutils literal notranslate"><span class="pre">cov_type</span></code> parameter to the <code class="docutils literal notranslate"><span class="pre">iterative_unfold</span></code> function. This adds
the option to choose between using the Multinomial or Poisson form of the
covariance matrix.
(See <a class="reference external" href="https://github.com/jrbourbeau/pyunfold/pull/50">PR #50</a>)</li>
<li>Adds check for negative values in <code class="docutils literal notranslate"><span class="pre">prior</span></code> input to <code class="docutils literal notranslate"><span class="pre">iterative_unfold</span></code>.
(See <a class="reference external" href="https://github.com/jrbourbeau/pyunfold/pull/63">PR #63</a>)</li>
</ul>
<p><strong>Changes</strong>:</p>
<ul class="simple">
<li>Makes <code class="docutils literal notranslate"><span class="pre">data</span></code>, <code class="docutils literal notranslate"><span class="pre">response</span></code>, <code class="docutils literal notranslate"><span class="pre">efficiencies</span></code>, and associated uncertainties
parameters in <code class="docutils literal notranslate"><span class="pre">iterative_unfold</span></code> keyword arguments. Now they can be input
in any order. (See <a class="reference external" href="https://github.com/jrbourbeau/pyunfold/pull/46">PR #46</a>)</li>
<li>Changes default prior in <code class="docutils literal notranslate"><span class="pre">iterative_unfold</span></code> from Jeffreys prior to a
uniform prior. (See <a class="reference external" href="https://github.com/jrbourbeau/pyunfold/pull/52">PR #52</a>)</li>
</ul>
<p><strong>Bug Fixes</strong>:</p>
<ul class="simple">
<li>Fixes bug in calculation of Jeffreys prior.
(See <a class="reference external" href="https://github.com/jrbourbeau/pyunfold/pull/52">PR #52</a>)</li>
</ul>
</div>
<div class="section" id="version-0-2-2-2018-05-04">
<h2>Version 0.2.2 (2018-05-04)<a class="headerlink" href="#version-0-2-2-2018-05-04" title="Permalink to this headline">¶</a></h2>
<p><strong>Changes</strong>:</p>
<ul class="simple">
<li>Adds checks for optional PyTables testing dependency. (See <a class="reference external" href="https://github.com/jrbourbeau/pyunfold/pull/43">PR #43</a>)</li>
</ul>
</div>
<div class="section" id="version-0-2-1-2018-05-04">
<h2>Version 0.2.1 (2018-05-04)<a class="headerlink" href="#version-0-2-1-2018-05-04" title="Permalink to this headline">¶</a></h2>
<p><strong>Changes</strong>:</p>
<ul class="simple">
<li>Adds <code class="docutils literal notranslate"><span class="pre">MANIFEST.in</span></code> file to package additional files with source distribution.</li>
</ul>
</div>
<div class="section" id="version-0-2-2018-05-04">
<h2>Version 0.2 (2018-05-04)<a class="headerlink" href="#version-0-2-2018-05-04" title="Permalink to this headline">¶</a></h2>
<p><strong>New Features</strong>:</p>
<ul class="simple">
<li>Added <code class="docutils literal notranslate"><span class="pre">SplineRegularizer</span></code> callback to perform smoothing at each unfolding iteration. (See <a class="reference external" href="https://github.com/jrbourbeau/pyunfold/pull/27">PR #27</a>)</li>
<li>Added <code class="docutils literal notranslate"><span class="pre">Logger</span></code> callback to write test statistic information to stdout. (See <a class="reference external" href="https://github.com/jrbourbeau/pyunfold/pull/18">PR #18</a>)</li>
<li>Added contributing guide to the documentation page. (See <a class="reference external" href="https://github.com/jrbourbeau/pyunfold/pull/31">PR #31</a>)</li>
<li>Added <code class="docutils literal notranslate"><span class="pre">setup_prior</span></code> convenience function to help validate user prior input (See <a class="reference external" href="https://github.com/jrbourbeau/pyunfold/pull/35">PR #35</a>)</li>
</ul>
<p><strong>Changes</strong>:</p>
<ul class="simple">
<li>Removed <code class="docutils literal notranslate"><span class="pre">datadist.py</span></code> module. (See <a class="reference external" href="https://github.com/jrbourbeau/pyunfold/pull/19">PR #19</a>)</li>
<li>Vectorized <code class="docutils literal notranslate"><span class="pre">covmatrix.py</span></code> module. (See <a class="reference external" href="https://github.com/jrbourbeau/pyunfold/pull/24">PR #24</a>)</li>
<li>Removed <code class="docutils literal notranslate"><span class="pre">covmatrix</span></code> and <code class="docutils literal notranslate"><span class="pre">loadstats</span></code> modules. (See <a class="reference external" href="https://github.com/jrbourbeau/pyunfold/pull/38">PR #38</a>)</li>
</ul>
<p><strong>Bug Fixes</strong>:</p>
<ul class="simple">
<li>Fixed typos in the online documentation (See <a class="reference external" href="https://github.com/jrbourbeau/pyunfold/pull/26">PR #26</a>)</li>
</ul>
</div>
<div class="section" id="version-0-1-2018-04-05">
<h2>Version 0.1 (2018-04-05)<a class="headerlink" href="#version-0-1-2018-04-05" title="Permalink to this headline">¶</a></h2>
<p><strong>New Features</strong>:</p>
<ul class="simple">
<li>Initial release that includes <code class="docutils literal notranslate"><span class="pre">iterative_unfold</span></code> function.</li>
</ul>
</div>
</div>
</div>
</div>
<footer>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2018, James Bourbeau, Zigfried Hampel-Arias
</p>
</div>
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>