tiny bugfix
[PsN.git] / README.txt
blob263720c49a3ff7eac8ab9509d4ac29cfdf3a86cb
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:
5 Math::Random
6 Storable::Store
8 All available from CPAN ( www.cpan.org )
10   Changelog
11 ----------------------------------------------
13 Changes from 2.1.8 to 2.1.9
15 Features
16  - Nordugrid support reintroduced (but will probably not be developed further)
17  - Sumo now supports multiple problems and subproblems.
18  - Sumo has new option "precision" which control the number of digits
19    to present estimates with.
21 Bugs
22  - Bootstrap option "stratify_on" doesn't work with columns defined in 
23    extra data files given with "extra_data" option. Not Fixed.
24  - Resumes of scm's with extra_data_files is now possible. Still some 
25    problems with scm's where search_direction=both.
26  - LSF options was not communicated properly between tools and subtools
27    so submission of bootstraps, llp, cdd and scm did not work. Fixed.
28  - Default values for LSF can now be configured in psn.conf.
29  - Print order of modelfiles places $MIX before $PRED. Fixed.
30  - extra_files option was broken. Fixed.
32 Internal Changes
33  - Tool will allways fork subtools, this will save memory in the scm (and
34    other recursive tools).
35  - Common options need only be specified once. In one of three categories:
36    model_options, tool_options, script_options.
37  - models can now be created with "reference" objects. This solved the
38    scm resume problem.
39  - Added function to model that cleans extra data code.
41 Changes from 2.1.7 to 2.1.8
43 Features
44  - Rudimentary support for execution on Platform LSF grid systems is now
45    included. The following extra attributes are available to all tools
46    for controlling the execution:
48        run_on_lsf       - Use LSF
49        lsf_queue        - Use this queue on the grid
50        lsf_options      - General options for the grid queuing system.
51        lsf_project_name - Optional. May be used by the grid system
52                           administrator to register control project
53                           cpu usage.
54        lsf_job_name     - Optional. May be used by a grid system
55                           administrator to control multiple runs on a
56                           grid system.
58  - All tools now have a raw_results file holding the diagnotics and
59    parameter estimates for each NONMEM run.
60  - All tools now handles model files containing one $PROBLEM and no
61    SUBPROBLEMS only.
62  - The Bootstrap and CDD routines now create separate files holding
63    information about which individuals that were included/excluded
64    in/from each created data set.
65  - The Bootstrap results file now has warnings section to better
66    display which runs that were used for result calculations and which
67    were not
68  - PsN now tries to read psn.conf from the users home directory. (Will
69    require some extra documentation).
70  - Optimized modelfit thread operation by removing Storable::Store.
71  - The clean options has four levels of operation.
73         0 - No cleaning at all.
74         1 - Clean more, but make sure resumes work (this is default).
75         2 - Clean more, but make sure summarize work.
76         3 - Clean everything, keeping only results and logs.
78  - Some attributes and accessors of the PsN-Core class 'output' have
79    had their names changed to make it more clear what their purposes
80    are:
81         termination           is now called     minimization_successful
82         termination_message   is now called     minimization_message
83         covstep_termination   is now called     covariance_step_successful
85    these attributes are new:
87         covariance_step_warnings (boolean; 0 or 1)
88         estimate_near_boundary (boolean; 0 or 1)
90    The attribute which was previously called termination could have the
91    values 0, 0.5 and 1 for 'minimization terminates', 'minimization
92    successful but warnings or errors were printed from the covariance
93    step' and finally 'minimization successful'. The new attribute
94    'minimization_successful' can only take the values 0 and 1 and the
95    new attribute covariance_step_warnings now takes the value 1 when
96    covariance step warnings were found. Checks are also perfomed to
97    test whether the estimates are close to any boundary.
98  - Html documents is now generated from command line help text.
99    which ensures that they are consistent and up to date.
100  - Personal configuration file now available under Unix like OS:s
102 Bugs
103  - Options specific to modelfiles were ignored in some Utilties.
104  - Gradients now output in windows. Just like with nmfe.
105  - Bootstrap now consumes considerably less memory.
106  - Removed unused/obsolete "resume" function from modelfit.
107  - Sorted method entries in modelfit diagram.
108  - Fixed bugs in parsing of OFV and eigenvalues.
110 Changes from 2.1.6 to 2.1.7
112 Bugs
113  - "clean" and "compress" options now work under Windows.
114  - SCM now handles crashed runs appropriately.
115  - The ofv_forward, ofv_backward, p_forward and p_backward options of
116    scm now works as they should.
118 Features
119  - SCM improvements. The final model is now available in the
120    first-level scm directory of each step.
121  - The Utilties -help option is improved. You can now give a list of
122    options to -help for specific documentation of those options, like
123    so:
124    
125    $ scm -help do_not_drop
127  - Minor changes in how the [nm_version] section in psn.conf i
128    handled. Look in the psn.conf file that is distributed with PsN for
129    more information.
130  - SDE modelfiles are now supported. (see the -sde_records option)
131  - The update_inits method of the model class now accepts an output
132    file name as input.
133  - Some attributes and accessors of the PsN-Core class 'output' have
134    had their names changed to make it more clear what their purposes
135    are:
136         finalgrad          is now called     final_gradient
137         parampath          is now called     parameter_path
138         gradientpath       is now called     gradient_path
139         covterm            is now called     covstep_termination 
140  - The Utilties now saves the command line that started it in a file
141    "command.txt" under the corresponding directory.
142  - Added a "silent" option to the Utilties that quenches all output.
143  - "nice" option added to utilties that allows you to set priority in
144    unix.
145  - Rudimentary support for NorduGrid reinstated.
146  - Installer script rewritten. It now supports Perl installations in
147    nonstandard directories. Discrepancies between *nix and MSWin32 is
148    smaller.
150 Internal changes
151  - The code that is autogenerated with "dia2code" is optimized a
152    bit and saves a hash "__valid_parameters" in each object, which
153    allows the constructors to be used as a generic (shallow) copy.
155 Misc
156  - continuous spelled correctly throughout SCM.
159 Changes from 2.1.5 to 2.1.6
161 Bugs
162  - Stratify_on bug in bootstrap method fixed.
163  - Data files in directories different from model file are now
164    possible.
165  - Path name handling reimplemented. Relative paths are now handled
166    better.
167  - Models that generate table files would make PsN complain about
168    missing files.
169  - Its now possible to specify multiple output names as a
170    comma-separated list to execute.
171  - The scm can now go backwards.
172  - Handling of table files now responds to the
173    "ignore_missing_output_files" flag.
174  - nmtran error messages was lost in Windows 2K. Execution of nmtran
175    is more plattform independent now.  It uses a temporary file, but
176    it is never bigger than the nmtran messages.
177  - Fixed a bug that limited choice of compiler under unix.
178  - Typo in scm utility fixed. (included_relations in backwards step).
180 Features
181  - Added support for "$NONPARAMETRIC" record in model files.
182  - A few improved error messages related to parsing of model files.
183  - The SCM config file now features sections for parameter bounds and
184    user-defined code
186 Internal changes
187  - psn.conf settings are now available as global variables. psn.conf
188    is only parsed once.