Difference between revisions of "Relax 3.1.6"

From relax wiki
Jump to navigation Jump to search
(User function HTML manual links.)
m (→‎Changes: Switch to the {{relax developer link}} template to remove dead Gna! links.)
 
(13 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
{{lowercase title}}
 
{{lowercase title}}
  
= Description =
+
{{infobox relax release
 +
| version = 3.1.6
 +
| prev    = 3.1.5
 +
| next    = 3.1.7
 +
| type    = Major feature and bugfix
 +
| date    = 28 February 2014
 +
| manual  = yes
 +
}}
  
<onlyinclude>
+
== Description ==
 +
 
 +
<section begin=description/>
 
This is a major feature and bugfix release. A comprehensive tutorial has been added to the relaxation dispersion chapter of the manual which shows, step-by-step, the [http://www.nmr-relax.com/manual/relaxation_dispersion_auto_analysis_in_GUI.html dispersion analysis in the GUI] using screenshots.  Other changes include improved PDB chain ID support, a new mode for running a relax script and then entering the prompt UI mode, multiple file reading by the [http://www.nmr-relax.com/manual/spectrum_read_intensities.html spectrum.read_intensities user function], and improvements to the relaxation dispersion analysis. A number of major bugs in the dispersion analysis concerning different relaxation delay times for different experiments and for improved handling of the offset have also been fixed. A number of important GUI bugs have also been fixed. All users are recommended to upgrade to this version of relax.
 
This is a major feature and bugfix release. A comprehensive tutorial has been added to the relaxation dispersion chapter of the manual which shows, step-by-step, the [http://www.nmr-relax.com/manual/relaxation_dispersion_auto_analysis_in_GUI.html dispersion analysis in the GUI] using screenshots.  Other changes include improved PDB chain ID support, a new mode for running a relax script and then entering the prompt UI mode, multiple file reading by the [http://www.nmr-relax.com/manual/spectrum_read_intensities.html spectrum.read_intensities user function], and improvements to the relaxation dispersion analysis. A number of major bugs in the dispersion analysis concerning different relaxation delay times for different experiments and for improved handling of the offset have also been fixed. A number of important GUI bugs have also been fixed. All users are recommended to upgrade to this version of relax.
</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 3.1.6 <br/>
Version 3.1.6
+
(28 February 2014, from /trunk) <br/>
(28 February 2014, from /trunk)
 
 
http://svn.gna.org/svn/relax/tags/3.1.6
 
http://svn.gna.org/svn/relax/tags/3.1.6
 +
<section end=metadata/>
  
== Features ==
+
=== Features ===
  
 +
<section begin=features/>
 
*  Full support for PDB chain IDs in the internal structural object.
 
*  Full support for PDB chain IDs in the internal structural object.
 
*  Improvements for the devel_scripts/python_seek.py for finding all installed Python versions and modules.  Individual modules can now be specified on the command line.
 
*  Improvements for the devel_scripts/python_seek.py for finding all installed Python versions and modules.  Individual modules can now be specified on the command line.
Line 34: Line 47:
 
*  Improved colour coding of relax log messages in the relax manual.
 
*  Improved colour coding of relax log messages in the relax manual.
 
*  The relaxation dispersion auto-analysis now creates the chi2.out text file.  This is for more easily comparing the chi-squared values between analyses.
 
*  The relaxation dispersion auto-analysis now creates the chi2.out text file.  This is for more easily comparing the chi-squared values between analyses.
 +
<section end=features/>
  
 +
=== Changes ===
  
== Changes ==
+
<section begin=changes/>
 
 
 
*  Converted the chain ID list in the internal structural object to the CHAIN_ID_LIST module variable.
 
*  Converted the chain ID list in the internal structural object to the CHAIN_ID_LIST module variable.
 
*  The internal structure object method _pdb_chain_id_to_mol_index() now uses the CHAIN_ID_LIST string.  This allows for the full PDB chain ID range to be supported.
 
*  The internal structure object method _pdb_chain_id_to_mol_index() now uses the CHAIN_ID_LIST string.  This allows for the full PDB chain ID range to be supported.
Line 60: Line 74:
 
*  Epydoc docstring fix for the pipe_control.structure.main.load_spins() function.
 
*  Epydoc docstring fix for the pipe_control.structure.main.load_spins() function.
 
*  Created the Mf.test_bug_21615_incomplete_setup_failure GUI tests.  This is designed to catch [https://gna.org/bugs/?21615 bug #21615] as reported by Ivan Leung (ivanhoe dott leung att chem dott ox dot ac dot uk).  Included are the data files Ivan attached to the bug report truncated to two residues.  The GUI test follows exactly the steps outlined by Ivan.
 
*  Created the Mf.test_bug_21615_incomplete_setup_failure GUI tests.  This is designed to catch [https://gna.org/bugs/?21615 bug #21615] as reported by Ivan Leung (ivanhoe dott leung att chem dott ox dot ac dot uk).  Included are the data files Ivan attached to the bug report truncated to two residues.  The GUI test follows exactly the steps outlined by Ivan.
*  Deleted the ancient, unused 'quit' argument of the relax interpreter object.  This code was identified in a post by Troels Linnet at http://thread.gmane.org/gmane.science.nmr.relax.devel/5000/focus=5003.  This argument never worked correctly and has not been used for many, many years.  Many code paths in relax needed to be updated to remove the argument.
+
*  Deleted the ancient, unused 'quit' argument of the relax interpreter object.  This code was identified in a post by {{relax developer link|username=tlinnet|text=Troels Linnet}} at http://thread.gmane.org/gmane.science.nmr.relax.devel/5000/focus=5003.  This argument never worked correctly and has not been used for many, many years.  Many code paths in relax needed to be updated to remove the argument.
 
*  Shifted the pedantic flag to escalate flag. The option -p would instead be used for the option --prompt.  Fix for [https://gna.org/support/?3117 sr #3117 - Functionality to inspect interactively after running script - The equivalence to python -i].
 
*  Shifted the pedantic flag to escalate flag. The option -p would instead be used for the option --prompt.  Fix for [https://gna.org/support/?3117 sr #3117 - Functionality to inspect interactively after running script - The equivalence to python -i].
 
*  Added the -p --prompt option for running a relax script and inspect interactively.  Fix for [https://gna.org/support/?3117 sr #3117 - Functionality to inspect interactively after running script - The equivalence to python -i].
 
*  Added the -p --prompt option for running a relax script and inspect interactively.  Fix for [https://gna.org/support/?3117 sr #3117 - Functionality to inspect interactively after running script - The equivalence to python -i].
Line 79: Line 93:
 
*  Added the unit test infrastructure for testing the specific_analyses.relax_disp package.  This currently includes the package __all__ list unit test.
 
*  Added the unit test infrastructure for testing the specific_analyses.relax_disp package.  This currently includes the package __all__ list unit test.
 
*  Updated the specific_analyses.relax_disp package __all__ list.  This was identified in the previously committed unit test.
 
*  Updated the specific_analyses.relax_disp package __all__ list.  This was identified in the previously committed unit test.
*  Added the infrastructure for the unit tests of the specific_analyses.relax_disp.disp_data module.  This is in response to the post http://thread.gmane.org/gmane.science.nmr.relax.scm/19963/focus=5046 by Troels, and is described in my response at http://thread.gmane.org/gmane.science.nmr.relax.scm/19963/focus=5048.
+
*  Added the infrastructure for the unit tests of the specific_analyses.relax_disp.disp_data module.  This is in response to the post http://thread.gmane.org/gmane.science.nmr.relax.scm/19963/focus=5046 by {{relax developer link|username=tlinnet|text=Troels}}, and is described in my response at http://thread.gmane.org/gmane.science.nmr.relax.scm/19963/focus=5048.
 
*  Created two new LaTeX commands for improving the layout of Python code in the relax manual.  These are \pysep and \pyus which will be used to format the Python module separator character and the Python underscore character respectively.  They are used in the \module{}, \pycode{}, etc.  commands to add the '.\linebreak[0]' and '\_\linebreak[0]' text to allow for improved and consistent line breaking.
 
*  Created two new LaTeX commands for improving the layout of Python code in the relax manual.  These are \pysep and \pyus which will be used to format the Python module separator character and the Python underscore character respectively.  They are used in the \module{}, \pycode{}, etc.  commands to add the '.\linebreak[0]' and '\_\linebreak[0]' text to allow for improved and consistent line breaking.
 
*  Complete reformatting of the base LaTeX files.  The paragraph structure has been changed so that each sentence now starts on a new line.  This is for better tracking of changes (via 'svn diff' for example), for better searchability of certain text elements using command line tools such as 'grep', and for easier easier use of the 'sed' tool.  The change tracking is most important as it allows for finer granularity - a small change will now only be shown as a change in one sentence rather than the whole paragraph, allowing the change to be identified more easily.  It also allows for easier commit maintenance.
 
*  Complete reformatting of the base LaTeX files.  The paragraph structure has been changed so that each sentence now starts on a new line.  This is for better tracking of changes (via 'svn diff' for example), for better searchability of certain text elements using command line tools such as 'grep', and for easier easier use of the 'sed' tool.  The change tracking is most important as it allows for finer granularity - a small change will now only be shown as a change in one sentence rather than the whole paragraph, allowing the change to be identified more easily.  It also allows for easier commit maintenance.
Line 193: Line 207:
 
*  Removed functional return of reference intensity in R<sub>1&rho;</sub>, since this does not exists.  Regarding [https://gna.org/bugs/?21344 bug #21344 - Handling of in sparse acquired R<sub>1&rho;</sub> dataset with missing combinations of time and spin-lock field strengths].
 
*  Removed functional return of reference intensity in R<sub>1&rho;</sub>, since this does not exists.  Regarding [https://gna.org/bugs/?21344 bug #21344 - Handling of in sparse acquired R<sub>1&rho;</sub> dataset with missing combinations of time and spin-lock field strengths].
 
*  Removed function return_intensity(), as this is no longer in use.  Regarding [https://gna.org/bugs/?21344 bug #21344 - Handling of in sparse acquired R<sub>1&rho;</sub> dataset with missing combinations of time and spin-lock field strengths].  Reference: http://www.mail-archive.com/relax-devel@gna.org/msg05020.html.
 
*  Removed function return_intensity(), as this is no longer in use.  Regarding [https://gna.org/bugs/?21344 bug #21344 - Handling of in sparse acquired R<sub>1&rho;</sub> dataset with missing combinations of time and spin-lock field strengths].  Reference: http://www.mail-archive.com/relax-devel@gna.org/msg05020.html.
 +
<section end=changes/>
  
 +
=== Bugfixes ===
  
== Bugfixes ==
+
<section begin=bugfixes/>
 
 
 
*  Minor bugfix for the internal structural object add_model() method.  The internal structural object was being called with self as an argument, which would default to the chain_id keyword argument.  The result would be relax state files with multiple copies of the internal structural object embedded in the structural XML section.
 
*  Minor bugfix for the internal structural object add_model() method.  The internal structural object was being called with self as an argument, which would default to the chain_id keyword argument.  The result would be relax state files with multiple copies of the internal structural object embedded in the structural XML section.
 
*  Fix for [https://gna.org/bugs/?21605 bug #21605, the failure of the Frame_order.test_generate_rotor2_distribution system test].  The bug is due to the fact that numpy.float16 is not defined on all systems.  Older numpy versions do not have this.  Therefore the float16 value is now imported from lib.check_types where it is aliased to float32 when not defined.
 
*  Fix for [https://gna.org/bugs/?21605 bug #21605, the failure of the Frame_order.test_generate_rotor2_distribution system test].  The bug is due to the fact that numpy.float16 is not defined on all systems.  Older numpy versions do not have this.  Therefore the float16 value is now imported from lib.check_types where it is aliased to float32 when not defined.
Line 206: Line 221:
 
*  Fix for [https://gna.org/bugs/?21665 bug #21665 - Running a CPMG analysis with two fields at two delay times].
 
*  Fix for [https://gna.org/bugs/?21665 bug #21665 - Running a CPMG analysis with two fields at two delay times].
 
*  Fix for [https://gna.org/bugs/?21344 bug #21344 - Handling of in sparse acquired R<sub>1&rho;</sub> dataset with missing combinations of time and spin-lock field strengths].
 
*  Fix for [https://gna.org/bugs/?21344 bug #21344 - Handling of in sparse acquired R<sub>1&rho;</sub> dataset with missing combinations of time and spin-lock field strengths].
 +
<section end=bugfixes/>
 +
 +
== Links ==
 +
 +
<section begin=links/>
 +
For reference, the announcement for this release can also be found at following links:
 +
 +
* [http://wiki.nmr-relax.com/Relax_3.1.6 Official release notes on the relax wiki].
 +
* {{gna link|url=gna.org/forum/forum.php?forum_id=2443|text=Gna! news item}}.
 +
* [http://article.gmane.org/gmane.science.nmr.relax.announce/52 Gmane mailing list archive].
 +
* [http://www.mail-archive.com/relax-announce%40gna.org/msg00046.html The Mail Archive].
 +
* [https://mail.gna.org/public/relax-announce/2014-03/msg00000.html Local archives].
 +
* [http://marc.info/?l=relax-announce&m=139380076732405&w=2 Mailing list ARChives (MARC)].
 +
 +
{{:Softpedia}}
 +
<section end=links/>
 +
 +
== Announcements ==
 +
 +
{{:relax release announcements}}
  
  
= See also =
+
== See also ==
  
[[Category:Release_Notes]]
+
* [http://www.nmr-relax.com/api/3.1/ The relax 3.1 API documentation]
 +
{{:relax release see also}}
 +
[[Category:Relaxation dispersion analysis]]

Latest revision as of 11:43, 15 October 2020


Official relax releases
relax logo
relax version 3.1.6
Previous version Next version
← relax 3.1.5 relax 3.1.7 →

Release type Major feature and bugfix
Release date 28 February 2014

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

Description

This is a major feature and bugfix release. A comprehensive tutorial has been added to the relaxation dispersion chapter of the manual which shows, step-by-step, the dispersion analysis in the GUI using screenshots. Other changes include improved PDB chain ID support, a new mode for running a relax script and then entering the prompt UI mode, multiple file reading by the spectrum.read_intensities user function, and improvements to the relaxation dispersion analysis. A number of major bugs in the dispersion analysis concerning different relaxation delay times for different experiments and for improved handling of the offset have also been fixed. A number of important GUI bugs have also been fixed. All users are recommended to upgrade to this version of relax.


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 3.1.6
(28 February 2014, from /trunk)
http://svn.gna.org/svn/relax/tags/3.1.6


Features

  • Full support for PDB chain IDs in the internal structural object.
  • Improvements for the devel_scripts/python_seek.py for finding all installed Python versions and modules. Individual modules can now be specified on the command line.
  • The pedantic command line option -p, --pedantic has been renamed to -e, --escalate.
  • The new prompt command line option -p, --prompt causes the relax prompt mode to launch after running a script to allow relax to be inspected interactively.
  • Better organisation of the relax command line options into groups, as shown by running 'relax -h'.
  • A tutorial for using the relaxation dispersion analysis in the GUI has been added to the manual. This includes step-by-step instructions with many screenshots.
  • Improvements to the manual including better and consistent line breaking for the GUI menu item text, user functions, file and directory paths, and Python module paths.
  • The spectrum.read_intensities user function can now load multiple files simultaneously, allowing for simplified use in the GUI.
  • Addition of a new GUI window element for loading multiple files.
  • Improvements to the sequence data input GUI window including the item count being displayed and a 'Delete' button to remove the last element.
  • Improvement for the relaxation dispersion auto-analysis - the names of the automatically created data pipes are now unique by appending the name of the data pipe bundle to the end. This allows multiple dispersion auto-analyses to exist simultaneously in the GUI or within one relax state file.
  • The relaxation dispersion analysis now handles deselected spins.
  • Improved colour coding of relax log messages in the relax manual.
  • The relaxation dispersion auto-analysis now creates the chi2.out text file. This is for more easily comparing the chi-squared values between analyses.


Changes


Bugfixes


Links

For reference, the announcement for this release can also be found at following links:

Softpedia also has information about the newest relax releases:


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.


See also