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