.. _release_notes:


Release Notes
###############

This page lists the various |popy| releases to date:-

|popy| v1.0.2
================

Release date = 18/09/2019

Improvements
-------------

* Added ability to process scripts in :ref:`parallel`. This speeds up computation time for models with a large number of individuals and takes advantage of multi-core computers.
* Created :ref:`postprocess` section to allow filtering of data create by a |popy| model. For example with a :ref:`gen_script`
* Added ability to process multiple files in a directory with one command using '*' syntax, see :ref:`popy_run_multi_scripts`, :ref:`popy_check_multi_scripts`, :ref:`popy_format_multi_scripts`, :ref:`popy_edit_multi_scripts`,  :ref:`popy_view_multi_html`
* Speed improvements to core |joe| algorithm, :ref:`standard_errors` computation and plotting using :ref:`grph_script`.
* :ref:`mfit_script` now outputs a summary of the fitting results for all populations to a single .csv file.  
* Displaying the diagonal elements of |fx| variance matrices at each iteration. The off diagonal |fx| elements are only displayed at the end of fitting, due to space considerations.

Format Changes
---------------

* Simplified the structure of old 'LEVEL_PARAMS', replaced with :ref:`effects` which removes the redundant 'split_field' and 'split_dict' attributes.
* Renamed the 'output_mode' values in :ref:`output_scripts`, using shorter names 'gen_script_and_run' -> 'run', 'gen_script_only' -> 'create', 'no_output' -> 'none'.
* Renamed the 'FINITE_DIFF' method in :ref:`covariance` to 'SANDWICH'.

Note scripts in v1.0.1 and v1.0.0 format can be automatically updated to v1.0.2 using the :ref:`popy_format` tool.

Bug Fixes
----------

* Made :ref:`method_options_float_format_spec` change format of all float values in output scripts and summary html outputs. Only applied to subset before.
* Fixed bug in iteration number when displaying |objv| over time :ref:`obj_vs_time_fit_example1`

|popy| v1.0.1
================

Release date = 28/06/2019

This is mainly a bug fix release of |popy| 

Improvements
-------------

* The :ref:`standard_errors` are now output in an easy to read format, instead of the whole hessian matrix.
* Changed the configuration file entry required to compute standard errors see |covariance|.
* Log files apart from the main log file are now stored in a '_log' sub directory. 
* The :ref:`popy_run` tool now asks the user if they want to proceed if the main log file already exist for a given script. Previously only the existence of the output folder was checked. The can still skip this check using the '-o' option.

Bug Fixes
----------

* Licence manager was giving a date error in North American time zones.
* Bug in configuration file parser for |derivatives| section when encountering round brackets (as opposed to expected curly brackets) in :ref:`dosing_functions`. 
* Documentation contents page indexing in PDF was incorrect.


|popy| v1.0.0
===============

Release date = 24/05/2019

This is the first version of |popy|, so there are no bug fixes or new features
only the initial implementation.

Or in other words, all the features and bugs are new!