README.txt

   1 This version of PsN is tested with perl-5.8.4
   2 Depending on your distribution you may have to install the following
   3 perl packages:
   4
   5 Math::Random
   6 Storable::Store
   7
   8 All available from CPAN ( www.cpan.org )
   9
  10   Changelog
  11 ----------------------------------------------
  12
  13 Changes from 2.1.10 to 2.2.0
  14
  15 Features
  16
  17  - Automatic incrementation of directory names are a bit smarter (no
  18    more "directory modelfit_dirX is in the way" messages).
  19
  20  - Clean is much more stringent and intelligent and now manages to
  21    remove entire tool directories if desired.
  22
  23  - option list printed from "-h|-?" only shows utility specific options.
  24
  25  - Default values configurable on a per utility basis.
  26
  27  - Online documentation improved
  28
  29  - Parallel run of NONMEM is not aborted as before if a outputfile is
  30    not correctly parsed. It is just ignored, as if it had not
  31    minimized successfully. (actually it is the output parser that
  32    doesn't die, but the effect is the same)
  33
  34  - Parallel run is a bit nicer to the system when compiling many
  35    NONMEMS. By adding a configurable delay between starts.
  36
  37  - Matlab and R scripts for various plots from cdd and bootstrap
  38    results are distributed with PsN.
  39
  40  - Vast improvments in results presentations from all tools.
  41
  42  - Improvements in rerun algoritm with new "min_retries" option.
  43
  44  - Output from running utilties are much nicer.
  45
  46  - new "-quick_summary" prints minimization message and ofv value for
  47    each finished run. As does "-verbose" option which also prints
  48    "R:X" for each retrie (X is the retrie number).
  49
  50  - new "-summary" options prints diagnostics about the tool run when
  51    it is finished. For "execute" the "-summary" option will have the
  52    same function as the "sumo" utiltiy as well as some diagnostics.
  53
  54 Bugs
  55  -
  56
  57 Internal changes
  58  - Cleanup of dubious utility options.
  59  - Option help sorted alphabetically.
  60  - "flush", "target" removed from model.
  61  - "remove_temp_files" removed from modelfit.
  62
  63 Changes from 2.1.9 to 2.1.10
  64
  65 Features
  66 - The 'picky' option of all utilities now triggers on
  67         COVARIANCE STEP ABORTED         and
  68         PROGRAM TERMINATED BY OBJ
  69
  70 Changes from 2.1.8 to 2.1.9
  71
  72 Features
  73  - Nordugrid support reintroduced (but will probably not be developed further)
  74  - Sumo now supports multiple problems and subproblems.
  75  - Sumo has new option "precision" which control the number of digits
  76    to present estimates with.
  77  - An extra 'short' logfile is output from the scm with the most important
  78    information.
  79
  80 Bugs
  81  - Bootstrap option "stratify_on" doesn't work with columns defined in
  82    extra data files given with "extra_data" option. Not Fixed.
  83  - Resumes of scm's with extra_data_files is now possible. Still some
  84    problems with scm's where search_direction=both.
  85  - LSF options was not communicated properly between tools and subtools
  86    so submission of bootstraps, llp, cdd and scm did not work. Fixed.
  87  - Default values for LSF can now be configured in psn.conf.
  88  - Print order of modelfiles places $MIX before $PRED. Fixed.
  89  - extra_files option was broken. Fixed.
  90
  91 Internal Changes
  92  - Tool will always fork subtools, this will save memory in the scm (and
  93    other recursive tools).
  94  - Common options need only be specified once. In one of three categories:
  95    model_options, tool_options, script_options.
  96  - models can now be created with "reference" objects. This solved the
  97    scm resume problem.
  98  - Added function to model that cleans extra data code.
  99
 100 Changes from 2.1.7 to 2.1.8
 101
 102 Features
 103  - Rudimentary support for execution on Platform LSF grid systems is now
 104    included. The following extra attributes are available to all tools
 105    for controlling the execution:
 106
 107        run_on_lsf       - Use LSF
 108        lsf_queue        - Use this queue on the grid
 109        lsf_options      - General options for the grid queuing system.
 110        lsf_project_name - Optional. May be used by the grid system
 111                           administrator to register control project
 112                           cpu usage.
 113        lsf_job_name     - Optional. May be used by a grid system
 114                           administrator to control multiple runs on a
 115                           grid system.
 116
 117  - All tools now have a raw_results file holding the diagnotics and
 118    parameter estimates for each NONMEM run.
 119  - All tools now handles model files containing one $PROBLEM and no
 120    SUBPROBLEMS only.
 121  - The Bootstrap and CDD routines now create separate files holding
 122    information about which individuals that were included/excluded
 123    in/from each created data set.
 124  - The Bootstrap results file now has warnings section to better
 125    display which runs that were used for result calculations and which
 126    were not
 127  - PsN now tries to read psn.conf from the users home directory. (Will
 128    require some extra documentation).
 129  - Optimized modelfit thread operation by removing Storable::Store.
 130  - The clean options has four levels of operation.
 131
 132         0 - No cleaning at all.
 133         1 - Clean more, but make sure resumes work (this is default).
 134         2 - Clean more, but make sure summarize work.
 135         3 - Clean everything, keeping only results and logs.
 136
 137  - Some attributes and accessors of the PsN-Core class 'output' have
 138    had their names changed to make it more clear what their purposes
 139    are:
 140         termination           is now called     minimization_successful
 141         termination_message   is now called     minimization_message
 142         covstep_termination   is now called     covariance_step_successful
 143
 144    these attributes are new:
 145
 146         covariance_step_warnings (boolean; 0 or 1)
 147         estimate_near_boundary (boolean; 0 or 1)
 148
 149    The attribute which was previously called termination could have the
 150    values 0, 0.5 and 1 for 'minimization terminates', 'minimization
 151    successful but warnings or errors were printed from the covariance
 152    step' and finally 'minimization successful'. The new attribute
 153    'minimization_successful' can only take the values 0 and 1 and the
 154    new attribute covariance_step_warnings now takes the value 1 when
 155    covariance step warnings were found. Checks are also perfomed to
 156    test whether the estimates are close to any boundary.
 157  - Html documents is now generated from command line help text.
 158    which ensures that they are consistent and up to date.
 159  - Personal configuration file now available under Unix like OS:s
 160
 161 Bugs
 162  - Options specific to modelfiles were ignored in some Utilties.
 163  - Gradients now output in windows. Just like with nmfe.
 164  - Bootstrap now consumes considerably less memory.
 165  - Removed unused/obsolete "resume" function from modelfit.
 166  - Sorted method entries in modelfit diagram.
 167  - Fixed bugs in parsing of OFV and eigenvalues.
 168
 169 Changes from 2.1.6 to 2.1.7
 170
 171 Bugs
 172  - "clean" and "compress" options now work under Windows.
 173  - SCM now handles crashed runs appropriately.
 174  - The ofv_forward, ofv_backward, p_forward and p_backward options of
 175    scm now works as they should.
 176
 177 Features
 178  - SCM improvements. The final model is now available in the
 179    first-level scm directory of each step.
 180  - The Utilties -help option is improved. You can now give a list of
 181    options to -help for specific documentation of those options, like
 182    so:
 183
 184    $ scm -help do_not_drop
 185
 186  - Minor changes in how the [nm_version] section in psn.conf i
 187    handled. Look in the psn.conf file that is distributed with PsN for
 188    more information.
 189  - SDE modelfiles are now supported. (see the -sde_records option)
 190  - The update_inits method of the model class now accepts an output
 191    file name as input.
 192  - Some attributes and accessors of the PsN-Core class 'output' have
 193    had their names changed to make it more clear what their purposes
 194    are:
 195         finalgrad          is now called     final_gradient
 196         parampath          is now called     parameter_path
 197         gradientpath       is now called     gradient_path
 198         covterm            is now called     covstep_termination
 199  - The Utilties now saves the command line that started it in a file
 200    "command.txt" under the corresponding directory.
 201  - Added a "silent" option to the Utilties that quenches all output.
 202  - "nice" option added to utilties that allows you to set priority in
 203    unix.
 204  - Rudimentary support for NorduGrid reinstated.
 205  - Installer script rewritten. It now supports Perl installations in
 206    nonstandard directories. Discrepancies between *nix and MSWin32 is
 207    smaller.
 208
 209 Internal changes
 210  - The code that is autogenerated with "dia2code" is optimized a
 211    bit and saves a hash "__valid_parameters" in each object, which
 212    allows the constructors to be used as a generic (shallow) copy.
 213
 214 Misc
 215  - continuous spelled correctly throughout SCM.
 216
 217
 218 Changes from 2.1.5 to 2.1.6
 219
 220 Bugs
 221  - Stratify_on bug in bootstrap method fixed.
 222  - Data files in directories different from model file are now
 223    possible.
 224  - Path name handling reimplemented. Relative paths are now handled
 225    better.
 226  - Models that generate table files would make PsN complain about
 227    missing files.
 228  - Its now possible to specify multiple output names as a
 229    comma-separated list to execute.
 230  - The scm can now go backwards.
 231  - Handling of table files now responds to the
 232    "ignore_missing_output_files" flag.
 233  - nmtran error messages was lost in Windows 2K. Execution of nmtran
 234    is more plattform independent now.  It uses a temporary file, but
 235    it is never bigger than the nmtran messages.
 236  - Fixed a bug that limited choice of compiler under unix.
 237  - Typo in scm utility fixed. (included_relations in backwards step).
 238
 239 Features
 240  - Added support for "$NONPARAMETRIC" record in model files.
 241  - A few improved error messages related to parsing of model files.
 242  - The SCM config file now features sections for parameter bounds and
 243    user-defined code
 244
 245 Internal changes
 246  - psn.conf settings are now available as global variables. psn.conf
 247    is only parsed once.