Difference between revisions of "Relax 2.2.2"

From relax wiki
Jump to navigation Jump to search
m (→‎Description: Transclusion markup for the summary page.)
(→‎Bugfixes: Link fix)
(19 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
{{lowercase title}}
 
{{lowercase title}}
  
= Description =
+
{{infobox relax release
 +
| version  = 2.2.2
 +
| prev    = 2.2.1
 +
| next    = 2.2.3
 +
| keywords = Model-free analysis
 +
| type    = Minor bugfix
 +
| date    = 12 February 2013
 +
| manual  = yes
 +
}}
  
<onlyinclude>
+
== Description ==
 +
 
 +
<section begin=description/>
 
This is a minor bug fix release which resolves an important issue, introduced somewhere within the last few relax releases, whereby missing relaxation data is not handled properly in a model-free analysis.  A number of other small bugs have also been fixed - please see below for details.  If you plan on performing a new model-free analysis, upgrading to this version is recommended.
 
This is a minor bug fix release which resolves an important issue, introduced somewhere within the last few relax releases, whereby missing relaxation data is not handled properly in a model-free analysis.  A number of other small bugs have also been fixed - please see below for details.  If you plan on performing a new model-free analysis, upgrading to this version is recommended.
</onlyinclude>
+
<section end=description/>
  
= Download =
+
== Download ==
  
 +
<section begin=download/>
 
The new relax versions can be downloaded from http://www.nmr-relax.com/download.html. If binary distributions are not yet available for your platform and you manage to compile the binary modules, please consider contributing these to the relax project (described in section 3.6 of the relax manual, http://www.nmr-relax.com/manual/relax_distribution_archives.html).  
 
The new relax versions can be downloaded from http://www.nmr-relax.com/download.html. If binary distributions are not yet available for your platform and you manage to compile the binary modules, please consider contributing these to the relax project (described in section 3.6 of the relax manual, http://www.nmr-relax.com/manual/relax_distribution_archives.html).  
 +
<section end=download/>
  
 +
== CHANGES file ==
  
= CHANGES file =
+
<section begin=metadata/>
 
+
Version 2.2.2 <br/>
Version 2.2.2
+
(12 February 2013, from /trunk) <br/>
(12 February 2013, from /trunk)
 
 
http://svn.gna.org/svn/relax/tags/2.2.2
 
http://svn.gna.org/svn/relax/tags/2.2.2
 +
<section end=metadata/>
  
== Features ==
+
=== Features ===
  
 +
<section begin=features/>
 
*  Improvements to the relax [http://www.nmr-relax.com/api/ API documentation].
 
*  Improvements to the relax [http://www.nmr-relax.com/api/ API documentation].
 +
<section end=features/>
  
== Changes ==
+
=== Changes ===
  
 +
<section begin=changes/>
 
*  Updated the release checklist to include the devel_scripts/log_converter.py script usage.
 
*  Updated the release checklist to include the devel_scripts/log_converter.py script usage.
 
*  Modified the relax manual subtitle as this is no longer only for relaxation analysis.
 
*  Modified the relax manual subtitle as this is no longer only for relaxation analysis.
Line 35: Line 51:
 
*  Addition of the generic_fns package docstring.
 
*  Addition of the generic_fns package docstring.
 
*  Added a module docstring for the main relax module.
 
*  Added a module docstring for the main relax module.
*  Created the State.test_bug_20480 system test to catch bug #20480, the failure to load a saved relax model-free state in the GUI (https://gna.org/bugs/?20480).  This bug was reported by Stanislava Panova (https://gna.org/users/stacy).
+
*  Created the State.test_bug_20480 system test to catch [https://gna.org/bugs/?20480 bug #20480, the failure to load a saved relax model-free state in the GUI].  This bug was reported by [https://gna.org/users/stacy Stanislava Panova].
*  Created the Mf.test_bug_20479_gui_final_pipe GUI test to catch bug #20479, the model-free analysis failure in the GUI after setting the protocol mode to local tm. (https://gna.org/bugs/?20479).  This bug was reported by Stanislava Panova (https://gna.org/users/stacy).
+
*  Created the Mf.test_bug_20479_gui_final_pipe GUI test to catch [https://gna.org/bugs/?20479 bug #20479, the model-free analysis failure in the GUI after setting the protocol mode to local &tau;<sub>m</sub>].  This bug was reported by [https://gna.org/users/stacy Stanislava Panova].
 
*  Added a printout to the GUI test case base check_exceptions() method to explain what is happening.
 
*  Added a printout to the GUI test case base check_exceptions() method to explain what is happening.
*  Large expansion of the Mf.test_bug_20479_gui_final_pipe GUI test.  Instead of loading the bug #20480 state file, now the entire GUI analysis starting from scratch and using the relaxation data files is performed remotely by the test.  This is necessary because the result of the bug is present in the state file.
+
*  Large expansion of the Mf.test_bug_20479_gui_final_pipe GUI test.  Instead of loading the [https://gna.org/bugs/?20480 bug #20480] state file, now the entire GUI analysis starting from scratch and using the relaxation data files is performed remotely by the test.  This is necessary because the result of the bug is present in the state file.
 
*  Added spherical diffusion to the optimisation in the Mf.test_bug_20479_gui_final_pipe GUI test.
 
*  Added spherical diffusion to the optimisation in the Mf.test_bug_20479_gui_final_pipe GUI test.
 
*  Added a global model print out to the Mf.test_bug_20479_gui_final_pipe GUI test.  This is to help identify where failures occur.
 
*  Added a global model print out to the Mf.test_bug_20479_gui_final_pipe GUI test.  This is to help identify where failures occur.
Line 44: Line 60:
 
*  Added skips for some GUI tests when wxPython version '2.9.4.1 gtk2 (classic)' is used.  There are a number of bugs in this version which cannot be worked around in certain GUI tests, so they must be skipped.
 
*  Added skips for some GUI tests when wxPython version '2.9.4.1 gtk2 (classic)' is used.  There are a number of bugs in this version which cannot be worked around in certain GUI tests, so they must be skipped.
 
*  More wxPython version '2.9.4.1 gtk2 (classic)' bug avoidances in the GUI tests.  Now the auto-analyses do not check the gauges in the relax controller at the end of the auto NOE, Rx, and model-free analyses, as reading gauge values is faulty in this version.  The Rx test is no longer skipped for this wxPython version.
 
*  More wxPython version '2.9.4.1 gtk2 (classic)' bug avoidances in the GUI tests.  Now the auto-analyses do not check the gauges in the relax controller at the end of the auto NOE, Rx, and model-free analyses, as reading gauge values is faulty in this version.  The Rx test is no longer skipped for this wxPython version.
*  Improved the printout from the align_tensor.matrix_angles user function.  The relax_io.write_data() function is being used and the tensors are now identified by name rather than index.
+
*  Improved the printout from the [http://www.nmr-relax.com/manual/align_tensor_matrix_angles.html align_tensor.matrix_angles user function].  The relax_io.write_data() function is being used and the tensors are now identified by name rather than index.
*  Improved the printouts from the align_tensor.svd user function.
+
*  Improved the printouts from the [http://www.nmr-relax.com/manual/align_tensor_svd.html align_tensor.svd user function].
 
*  The relax program introduction now includes the revision number for subversion checked out copied.  This allows for better identification of the code base being used.
 
*  The relax program introduction now includes the revision number for subversion checked out copied.  This allows for better identification of the code base being used.
 
*  Fixes for the Pcs.test_structural_noise system test.  As this is based on random functions, sometimes, though rarely, the test fails.  Now the simulation accuracy has been increased and the tests are less rigorous.
 
*  Fixes for the Pcs.test_structural_noise system test.  As this is based on random functions, sometimes, though rarely, the test fails.  Now the simulation accuracy has been increased and the tests are less rigorous.
 
*  Spacing fixes as identified by the Python 2to3 conversion program.
 
*  Spacing fixes as identified by the Python 2to3 conversion program.
 +
<section end=changes/>
  
 +
=== Bugfixes ===
  
== Bugfixes ==
+
<section begin=bugfixes/>
 
 
 
*  Epydoc documentation fix - a circular import in the GUI code paths has been broken.  This affects the API documentation at http://www.nmr-relax.com/api/.
 
*  Epydoc documentation fix - a circular import in the GUI code paths has been broken.  This affects the API documentation at http://www.nmr-relax.com/api/.
 
*  Fix for the failed loading of states in the GUI.  This problem was caught by the State.test_bug_20480 GUI test.  If the loading of a state file fails,sometimes the relax data store can contain partial information from that file.  Now if the loading fails in the GUI, relax is reset.
 
*  Fix for the failed loading of states in the GUI.  This problem was caught by the State.test_bug_20480 GUI test.  If the loading of a state file fails,sometimes the relax data store can contain partial information from that file.  Now if the loading fails in the GUI, relax is reset.
*  Fix for bug #20480, the failure to load a saved relax model-free state in the GUI (https://gna.org/bugs/?20480).  This was reported by Stanislava Panova (https://gna.org/users/stacy).  The problem was that the state file was saved after a RelaxError occurred during the model-free analysis.  The GUI data store information states that the active data pipe is called 'final'.  But an error occurred prior to the 'final' data pipe being created.  The fix was to allow the state to be loaded even if the GUI data store information has been corrupted.
+
*  Fix for [https://gna.org/bugs/?20480 bug #20480, the failure to load a saved relax model-free state in the GUI].  This was reported by [https://gna.org/users/stacy Stanislava Panova].  The problem was that the state file was saved after a RelaxError occurred during the model-free analysis.  The GUI data store information states that the active data pipe is called 'final'.  But an error occurred prior to the 'final' data pipe being created.  The fix was to allow the state to be loaded even if the GUI data store information has been corrupted.
*  Fix for bug #20479 - the failure of non-fully automated model-free analyses in the GUI.  This bug was reported by Stanislava Panova (https://gna.org/users/stacy) at https://gna.org/bugs/?20479.  The problem is GUI specific and was when running each diffusion model one after the other.  The GUI was setting the base data pipe to the 'final' data pipe, which is a clear error.
+
*  Fix for [https://gna.org/bugs/?20479 bug #20479 - the failure of non-fully automated model-free analyses in the GUI].  This bug was reported by [https://gna.org/users/stacy Stanislava Panova].  The problem is GUI specific and was when running each diffusion model one after the other.  The GUI was setting the base data pipe to the 'final' data pipe, which is a clear error.
*  Fix for bug #20481 (https://gna.org/bugs/?20481).  This is the bug where the dauvergne_protocol model-free auto-analysis expects the prolate and oblate spheroids and ellipsoid to be optimised.  It was caught by the Mf.test_bug_20479_gui_final_pipe GUI test.
+
*  Fix for [https://gna.org/bugs/?20481 bug #20481], the bug where the dauvergne_protocol model-free auto-analysis[d'Auvergne and Gooley, 2007][d'Auvergne and Gooley, 2008] expects the prolate and oblate spheroids and ellipsoid to be optimised.  It was caught by the Mf.test_bug_20479_gui_final_pipe GUI test.
*  Bug fix for the diffusion tensor PDB creation in the dauvergne_protocol model-free auto-analysis.  The call to the structure.create_diff_tensor_pdb user function now only occurs if structural data is present.
+
*  Bug fix for the diffusion tensor PDB creation in the dauvergne_protocol model-free auto-analysis.  The call to the [http://www.nmr-relax.com/manual/structure_create_diff_tensor_pdb.html structure.create_diff_tensor_pdb user function] now only occurs if structural data is present.
 +
<section end=bugfixes/>
 +
 
 +
== Links ==
 +
 
 +
<section begin=links/>
 +
For reference, the following links are also part of the announcement for this release:
 +
* [http://wiki.nmr-relax.com/Relax_2.2.2 Official release notes]
 +
* [https://gna.org/forum/forum.php?forum_id=2377 Gna! news item]
 +
* [http://article.gmane.org/gmane.science.nmr.relax.announce/39 Gmane]
 +
* [http://www.mail-archive.com/relax-announce%40gna.org/msg00035.html Mail Archive]
 +
* [https://mail.gna.org/public/relax-announce/2013-02/msg00001.html Local archives]
 +
* [http://marc.info/?l=relax-announce&m=136080199609019&w=2 MARC]
 +
<section end=links/>
 +
 
 +
== Announcements ==
 +
{{:relax release announcements}}
 +
 
 +
 
 +
== References ==
  
 +
* [*d'Auvergne and Gooley, 2007] {{#lst:Citations|dAuvergneGooley07}}
 +
* [*d'Auvergne and Gooley, 2008] {{#lst:Citations|dAuvergneGooley08b}}
 +
<HarvardReferences/>
  
= See also =
+
== See also ==
  
[[Category:Release_Notes]]
+
* [http://www.nmr-relax.com/api/2.2/ The relax 2.2 API documentation]
 +
{{:relax release see also}}
 +
[[Category:Model-free analysis]]

Revision as of 17:12, 3 November 2015


Official relax releases
relax logo
relax version 2.2.2
Previous version Next version
← relax 2.2.1 relax 2.2.3 →

Keywords Model-free analysis
Release type Minor bugfix
Release date 12 February 2013

The PDF version of the relax 2.2.2 user manual The relax 2.2.2 user manual

Description

This is a minor bug fix release which resolves an important issue, introduced somewhere within the last few relax releases, whereby missing relaxation data is not handled properly in a model-free analysis. A number of other small bugs have also been fixed - please see below for details. If you plan on performing a new model-free analysis, upgrading to this version is recommended.


Download

The new relax versions can be downloaded from http://www.nmr-relax.com/download.html. If binary distributions are not yet available for your platform and you manage to compile the binary modules, please consider contributing these to the relax project (described in section 3.6 of the relax manual, http://www.nmr-relax.com/manual/relax_distribution_archives.html).


CHANGES file

Version 2.2.2
(12 February 2013, from /trunk)
http://svn.gna.org/svn/relax/tags/2.2.2


Features


Changes

  • Updated the release checklist to include the devel_scripts/log_converter.py script usage.
  • Modified the relax manual subtitle as this is no longer only for relaxation analysis.
  • Docstring fix for the maths_fns.vectors.random_unit_vector() function (this is for the API documentation at http://www.nmr-relax.com/api/).
  • Epydoc docstring fix for the dfunc_standard() N-state model target function (this is for the API documentation at http://www.nmr-relax.com/api/).
  • Epydoc docstring fixes for the diffusion tensor objects of the relax data store.
  • Added and edited a number of module docstrings.
  • Module and package docstrings additions/improvements for the SCons scripts.
  • Lots of module and package docstring updates for the analysis specific code.
  • Module docstring additions and improvements for the relax data store modules.
  • Addition of the generic_fns package docstring.
  • Added a module docstring for the main relax module.
  • Created the State.test_bug_20480 system test to catch bug #20480, the failure to load a saved relax model-free state in the GUI. This bug was reported by Stanislava Panova.
  • Created the Mf.test_bug_20479_gui_final_pipe GUI test to catch bug #20479, the model-free analysis failure in the GUI after setting the protocol mode to local τm. This bug was reported by Stanislava Panova.
  • Added a printout to the GUI test case base check_exceptions() method to explain what is happening.
  • Large expansion of the Mf.test_bug_20479_gui_final_pipe GUI test. Instead of loading the bug #20480 state file, now the entire GUI analysis starting from scratch and using the relaxation data files is performed remotely by the test. This is necessary because the result of the bug is present in the state file.
  • Added spherical diffusion to the optimisation in the Mf.test_bug_20479_gui_final_pipe GUI test.
  • Added a global model print out to the Mf.test_bug_20479_gui_final_pipe GUI test. This is to help identify where failures occur.
  • Proper handling of the dipole interaction wizard in the Mf.test_bug_20479_gui_final_pipe GUI test. This was causing the subsequent GUI tests to fail as the observer objects from the wizard were not all being unregistered.
  • Added skips for some GUI tests when wxPython version '2.9.4.1 gtk2 (classic)' is used. There are a number of bugs in this version which cannot be worked around in certain GUI tests, so they must be skipped.
  • More wxPython version '2.9.4.1 gtk2 (classic)' bug avoidances in the GUI tests. Now the auto-analyses do not check the gauges in the relax controller at the end of the auto NOE, Rx, and model-free analyses, as reading gauge values is faulty in this version. The Rx test is no longer skipped for this wxPython version.
  • Improved the printout from the align_tensor.matrix_angles user function. The relax_io.write_data() function is being used and the tensors are now identified by name rather than index.
  • Improved the printouts from the align_tensor.svd user function.
  • The relax program introduction now includes the revision number for subversion checked out copied. This allows for better identification of the code base being used.
  • Fixes for the Pcs.test_structural_noise system test. As this is based on random functions, sometimes, though rarely, the test fails. Now the simulation accuracy has been increased and the tests are less rigorous.
  • Spacing fixes as identified by the Python 2to3 conversion program.


Bugfixes

  • Epydoc documentation fix - a circular import in the GUI code paths has been broken. This affects the API documentation at http://www.nmr-relax.com/api/.
  • Fix for the failed loading of states in the GUI. This problem was caught by the State.test_bug_20480 GUI test. If the loading of a state file fails,sometimes the relax data store can contain partial information from that file. Now if the loading fails in the GUI, relax is reset.
  • Fix for bug #20480, the failure to load a saved relax model-free state in the GUI. This was reported by Stanislava Panova. The problem was that the state file was saved after a RelaxError occurred during the model-free analysis. The GUI data store information states that the active data pipe is called 'final'. But an error occurred prior to the 'final' data pipe being created. The fix was to allow the state to be loaded even if the GUI data store information has been corrupted.
  • Fix for bug #20479 - the failure of non-fully automated model-free analyses in the GUI. This bug was reported by Stanislava Panova. The problem is GUI specific and was when running each diffusion model one after the other. The GUI was setting the base data pipe to the 'final' data pipe, which is a clear error.
  • Fix for bug #20481, the bug where the dauvergne_protocol model-free auto-analysis[d'Auvergne and Gooley, 2007][d'Auvergne and Gooley, 2008] expects the prolate and oblate spheroids and ellipsoid to be optimised. It was caught by the Mf.test_bug_20479_gui_final_pipe GUI test.
  • Bug fix for the diffusion tensor PDB creation in the dauvergne_protocol model-free auto-analysis. The call to the structure.create_diff_tensor_pdb user function now only occurs if structural data is present.


Links

For reference, the following links are also part of the announcement for this release:


Announcements

If you would like to receive announcements about new relax versions, please subscribe to the relax announcement mailing list. This list only receives ~10 emails per year. It is archived at the SourceForge archives and in The Mail Archive.


References

  • [*d'Auvergne and Gooley, 2007] d'Auvergne, E. J. and Gooley, P. R. (2007). Set theory formulation of the model-free problem and the diffusion seeded model-free paradigm. Mol. BioSyst., 3(7), 483-494. (DOI: 10.1039/b702202f)
  • [*d'Auvergne and Gooley, 2008] d'Auvergne, E. J. and Gooley, P. R. (2008). Optimisation of NMR dynamic models II. A new methodology for the dual optimisation of the model-free parameters and the Brownian rotational diffusion tensor. J. Biomol. NMR, 40(2), 121-133. (DOI: 10.1007/s10858-007-9213-3)

<HarvardReferences/>

See also