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