Difference between revisions of "Relax 1.3.16"
Jump to navigation
Jump to search
(Lots of links to the API documentation and the HTML manual.) |
|||
| (8 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
{{lowercase title}} | {{lowercase title}} | ||
| − | = Description = | + | {{infobox relax release |
| + | | version = 1.3.16 | ||
| + | | prev = 1.3.15 | ||
| + | | next = 2.2.0 | ||
| + | | keywords = Manual | ||
| + | | type = Documentation | ||
| + | | date = 11 May 2012 | ||
| + | | manual = yes | ||
| + | }} | ||
| + | |||
| + | == Description == | ||
<section begin=description/> | <section begin=description/> | ||
| − | This is mainly a documentation release. The [http://www.nmr-relax.com/manual/index.html relax user manual] has been significantly updated - changes include the expansion and completion of the [http://www.nmr-relax.com/manual/Model_free_analysis.html model-free analysis chapter], addition of graphical user interface (GUI) screenshots and descriptions, a description of | + | This is mainly a documentation release. The [http://www.nmr-relax.com/manual/index.html relax user manual] has been significantly updated - changes include the expansion and completion of the [http://www.nmr-relax.com/manual/Model_free_analysis.html model-free analysis chapter], addition of graphical user interface (GUI) screenshots and descriptions, a description of {{gna link|url=gna.org/users/varioustoxins|text=Gary Thompson's}} [http://www.nmr-relax.com/manual/multi_processor_framework.html multi-processor framework], and general updates and improvements throughout. For those who install relax using the scons 'install' target, the pyc and pyo files are now properly created for faster startup. The Bruker Protein Dynamics Centre user function class 'pdc' has been renamed to 'bruker' because of Bruker's absorption of the PDC into the Bruker Dynamics Centre. These user functions, as well as the BMRB user functions, have been added to the menu system in the GUI. Finally a test suite bug triggered in the Fink relax installation has been eliminated. If you would like improved documentation or would like to use any of the other changes, please update to this version. |
<section end=description/> | <section end=description/> | ||
| − | = Download = | + | == Download == |
<section begin=download/> | <section begin=download/> | ||
| Line 13: | Line 23: | ||
<section end=download/> | <section end=download/> | ||
| − | = CHANGES file = | + | == CHANGES file == |
<section begin=metadata/> | <section begin=metadata/> | ||
| Line 21: | Line 31: | ||
<section end=metadata/> | <section end=metadata/> | ||
| − | == Features == | + | === Features === |
<section begin=features/> | <section begin=features/> | ||
* The scons 'install' target now creates both *.pyc and *.pyo files during installation - this should result in faster relax startup times. | * The scons 'install' target now creates both *.pyc and *.pyo files during installation - this should result in faster relax startup times. | ||
* The test suite now passes on the Fink relax installation on Mac OS X as the ancient and very dead PyXML module is now being detected and worked around. | * The test suite now passes on the Fink relax installation on Mac OS X as the ancient and very dead PyXML module is now being detected and worked around. | ||
| − | * Renamed the 'pdc' user function class to [http://www.nmr-relax.com/api/1.3/prompt.bruker-module.html 'bruker'] and removed all references to 'protein' - this is due to the Bruker absorption of the Protein Dynamics Centre into the Bruker Dynamics Centre announced at | + | * Renamed the 'pdc' user function class to [http://www.nmr-relax.com/api/1.3/prompt.bruker-module.html 'bruker'] and removed all references to 'protein' - this is due to the Bruker absorption of the Protein Dynamics Centre into the Bruker Dynamics Centre announced at {{gna mailing list url|relax-users/2012-04/msg00011.html}} (Message-id: <4F7AE13B.6010309@bruker.de>) by Dr. Klaus-Peter Neidig (peter dott neidig att bruker-biospin dott de). |
* Updates and improvements throughout the [http://www.nmr-relax.com/manual/index.html relax user manual]. | * Updates and improvements throughout the [http://www.nmr-relax.com/manual/index.html relax user manual]. | ||
| − | * Added a new section to the introduction chapter of the user manual for | + | * Added a new section to the introduction chapter of the user manual for {{gna link|url=gna.org/users/varioustoxins|text=Gary Thompson's}} [http://www.nmr-relax.com/manual/multi_processor_framework.html multi-processor framework]. |
* Added screenshots and descriptions of the graphical user interface (GUI) to the introduction and all of the analysis chapters of the relax user manual. | * Added screenshots and descriptions of the graphical user interface (GUI) to the introduction and all of the analysis chapters of the relax user manual. | ||
* The GUI and logging/teeing modes are now compatible with each other. | * The GUI and logging/teeing modes are now compatible with each other. | ||
| Line 34: | Line 44: | ||
<section end=features/> | <section end=features/> | ||
| − | == Changes == | + | === Changes === |
<section begin=changes/> | <section begin=changes/> | ||
* Improved debugging of the observers in the status singleton object. | * Improved debugging of the observers in the status singleton object. | ||
* Changed the behaviour of the [http://www.nmr-relax.com/api/1.3/arg_check-module.html arg_check module] so that the functions can return answers. | * Changed the behaviour of the [http://www.nmr-relax.com/api/1.3/arg_check-module.html arg_check module] so that the functions can return answers. | ||
| − | * The [http://www.nmr-relax.com/api/1.3/test_suite.gui_tests.bmrb.Bmrb-class.html#test_bmrb_rw Bmrb.test_bmrb_rw GUI test] now uses the base [http://www.nmr-relax.com/api/1.3/test_suite.gui_tests.base_classes.GuiTestCase-class.html#execute_uf execute_uf() method] for the [http://www.nmr-relax.com/manual/ | + | * The [http://www.nmr-relax.com/api/1.3/test_suite.gui_tests.bmrb.Bmrb-class.html#test_bmrb_rw Bmrb.test_bmrb_rw GUI test] now uses the base [http://www.nmr-relax.com/api/1.3/test_suite.gui_tests.base_classes.GuiTestCase-class.html#execute_uf execute_uf() method] for the [http://www.nmr-relax.com/manual/pipe_create.html pipe.create] call - this is part of the simplification of the user function interfaces. |
* A number of the pipe GUI user function front ends now use the [http://www.nmr-relax.com/api/1.3/gui.wizard.Wiz_page-class.html wizard page] element_*() methods to simplify the code base. | * A number of the pipe GUI user function front ends now use the [http://www.nmr-relax.com/api/1.3/gui.wizard.Wiz_page-class.html wizard page] element_*() methods to simplify the code base. | ||
* The [http://www.nmr-relax.com/api/1.3/gui.wizard.Wiz_page-class.html#element_string_list wizard page element_string_list() method] can now create the special Combo_list objects. | * The [http://www.nmr-relax.com/api/1.3/gui.wizard.Wiz_page-class.html#element_string_list wizard page element_string_list() method] can now create the special Combo_list objects. | ||
| Line 92: | Line 102: | ||
<section end=changes/> | <section end=changes/> | ||
| − | == Bugfixes == | + | === Bugfixes === |
<section begin=bugfixes/> | <section begin=bugfixes/> | ||
| Line 110: | Line 120: | ||
<section end=bugfixes/> | <section end=bugfixes/> | ||
| − | = Links = | + | == Links == |
<section begin=links/> | <section begin=links/> | ||
For reference, the following links are also part of the announcement for this release: | For reference, the following links are also part of the announcement for this release: | ||
* [http://wiki.nmr-relax.com/Relax_1.3.16 Official release notes] | * [http://wiki.nmr-relax.com/Relax_1.3.16 Official release notes] | ||
| − | * | + | * {{gna link|url=gna.org/forum/forum.php?forum_id=2348|text=Gna! news item}} |
* [http://article.gmane.org/gmane.science.nmr.relax.announce/4 Gmane] | * [http://article.gmane.org/gmane.science.nmr.relax.announce/4 Gmane] | ||
* [http://www.mail-archive.com/relax-announce%40gna.org/msg00028.html Mail archive] | * [http://www.mail-archive.com/relax-announce%40gna.org/msg00028.html Mail archive] | ||
| Line 122: | Line 132: | ||
<section end=links/> | <section end=links/> | ||
| − | = Announcements = | + | == Announcements == |
{{:relax release announcements}} | {{:relax release announcements}} | ||
| − | = See also = | + | == See also == |
| + | * [http://www.nmr-relax.com/api/1.3/ The relax 1.3 API documentation] | ||
{{:relax release see also}} | {{:relax release see also}} | ||
[[Category:Documentation]] | [[Category:Documentation]] | ||
Latest revision as of 11:48, 14 October 2020
 | |||||
| relax version 1.3.16 | |||||
| |||||
| Keywords | Manual | ||||
|---|---|---|---|---|---|
| Release type | Documentation | ||||
| Release date | 11 May 2012 | ||||
|
| |||||
 The relax 1.3.16 user manual | |||||
Contents
Description
This is mainly a documentation release. The relax user manual has been significantly updated - changes include the expansion and completion of the model-free analysis chapter, addition of graphical user interface (GUI) screenshots and descriptions, a description of Gary Thompson's multi-processor framework, and general updates and improvements throughout. For those who install relax using the scons 'install' target, the pyc and pyo files are now properly created for faster startup. The Bruker Protein Dynamics Centre user function class 'pdc' has been renamed to 'bruker' because of Bruker's absorption of the PDC into the Bruker Dynamics Centre. These user functions, as well as the BMRB user functions, have been added to the menu system in the GUI. Finally a test suite bug triggered in the Fink relax installation has been eliminated. If you would like improved documentation or would like to use any of the other changes, please update to this version.
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 1.3.16
(11 May 2012, from /1.3)
http://svn.gna.org/svn/relax/tags/1.3.16
Features
- The scons 'install' target now creates both *.pyc and *.pyo files during installation - this should result in faster relax startup times.
- The test suite now passes on the Fink relax installation on Mac OS X as the ancient and very dead PyXML module is now being detected and worked around.
- Renamed the 'pdc' user function class to 'bruker' and removed all references to 'protein' - this is due to the Bruker absorption of the Protein Dynamics Centre into the Bruker Dynamics Centre announced at https://www.nmr-relax.com/mail.gna.org/public/relax-users/2012-04/msg00011.html (Message-id: <4F7AE13B.6010309@bruker.de>) by Dr. Klaus-Peter Neidig (peter dott neidig att bruker-biospin dott de).
- Updates and improvements throughout the relax user manual.
- Added a new section to the introduction chapter of the user manual for Gary Thompson's multi-processor framework.
- Added screenshots and descriptions of the graphical user interface (GUI) to the introduction and all of the analysis chapters of the relax user manual.
- The GUI and logging/teeing modes are now compatible with each other.
- Expansion and completion of the model-free chapter of the relax user manual.
Changes
- Improved debugging of the observers in the status singleton object.
- Changed the behaviour of the arg_check module so that the functions can return answers.
- The Bmrb.test_bmrb_rw GUI test now uses the base execute_uf() method for the pipe.create call - this is part of the simplification of the user function interfaces.
- A number of the pipe GUI user function front ends now use the wizard page element_*() methods to simplify the code base.
- The wizard page element_string_list() method can now create the special Combo_list objects.
- Created the wizard page ResetChoices() method for resetting the list of values in a ComboBox.
- Created a Clear() wizard page method for clearing a specific GUI element.
- The wizard page element_string() GUI element creator read_only flag now defaults to False.
- The read_only=True flag to wizard_elements.Base_value now sets a TextCtrl to the background colour.
- The wizard_elements.Base_value.SetValue() method now works properly with the ComboBox.
- The wizard_elements.Base_value class now can set the element to be read only.
- Created generic_fns.pipes.PIPE_DESC_LIST which is the PIPE_DESC as a list, sorted by VALID_TYPES (to be used in the GUI user functions).
- Better ComboBox support in wizard_elements.Base_value class - now strings and data are separate (if the data is supplied), and the GetValue() method now returns the client data rather than the string value.
- Modified the wizard_elements.Base_value base GUI element class to handle combo boxes.
- The Bmrb.test_bmrb_rw GUI test now uses the new execute_uf() method for the bmrb.citation user function.
- Created the GUI test base method execute_uf() for executing a user function.
- The bmrb.citation GUI user function now uses the new wizard page element_*() methods for the GUI elements.
- Created a new wizard element for inputting integers.
- Created a new wizard element for inputting strings.
- Created the Bmrb.test_bmrb_rw GUI test.
- Completed the GUI interface for the bmrb.citation user function.
- Created a new wizard GUI element for lists of lists of strings.
- Abstracted out most of the String_list wizard element into the List base class.
- The bmrb.citation GUI user function now uses the new wizard page string list GUI element.
- Completed the wizard string list GUI element.
- Added the edit-rename Oxygen icons.
- Created a new String_list wizard GUI element class and associated element_string_list() method.
- Created a new infrastructure in the wizards for handling more advanced GUI elements.
- The Mf.test_write_results system test now checks for the ancient PyXML.
- Added the xml module import tests to the dep_check module.
- The relax system information print out now includes information about the XML modules.
- Added an initial but far from complete bmrb.citation user function page and menu element.
- Added the BMRB icon in various sizes to the graphics directory and icon paths.
- Updated all the BMRB user function front ends to the modern docstring design.
- Created a special Bruker add icon for use in the relaxation data GUI element.
- Added a button to the relaxation data GUI element for calling the bruker.read user function.
- Improved the bruker.read user function docstring.
- Created the bruker.read GUI user function page and menu entry.
- Added the Bruker logo in various formats for use in the relax GUI.
- Converted the bruker.read user function prompt interface to the new design.
- Renamed the PDC to Bruker DC in the test suite.
- Updated the development chapter of the relax user manual to be more current - this includes removing the text saying that the GUI is yet to be coded!
- Added mpi4py to the list of relax dependencies in the manual.
- Added GUI sections to the end of the NOE, R1+R2 and model-free chapters of the user manual.
- The list of figures in the relax user manual is now on a new page.
- Updated the open source infrastructure chapter of the relax user manual.
- Added a screenshot of the new relax 1.3.15 version in script mode.
- Significant updates to the introduction chapter of the relax user manual: The text has been updated to match the current relax versions. All mention of the dead SRLS theory has been eliminated. Screenshots of all the GUI windows and analyses have been added to prettify the chapter, and the text for the GUI has been rewritten for the new GUI design.
- Added a number of GUI screenshots for use in the [www.nmr-relax.com/manual/index.html relax user manual] - these were taken from http://www.nmr-relax.com/screenshots.html.
- Added colons to all entries of the abbreviation chapter in the relax user manual.
- Updated and completed the installation chapter of the relax user manual - a lot of the text was 4-6 years out of date.
- Some small edits to the release checklist document.
- Removed more maths from the HTML user manual section titles.
Bugfixes
- Improved error reporting for multiple vectors in a model-free analysis (bug #18807).
- Updated the deselect.read user function call in the noe.py sample script to match relax_fit.py (bug #19717).
- The relax_fit.py sample script deselect.read user function now has all columns specified (bug #19717).
- Improved the error message system for the spin ID matching multiple spins (bug #19717).
- Fix for the test suite GUI tests - one of the state system tests was removing the frame order analysis from the generic_fns.pipes.VALID_TYPES list with a pop() call.
- Simplified the wizard_elements.Base_value ResetChoices() method - this is an attempt to fix some racing conditions under wxGTK, triggered in the test suite.
- Fix for the bmrb.citation user function documentation.
- The Mf.test_write_results system test now checks for the ancient PyXML - this ancient version from 2004 which should be eliminated, if installed, causes the toprettyxml() changes in Python 2.7.3 to be overridden.
- The alignment tensor user functions can now all handle the situation whereby no tensors exist.
- Fix for the scons 'install' target for the byte-compilation of the *.pyc files.
- Fix for the χ2 references in the maths chapter of the relax user manual.
- Fix for the ANSI escape sequences for colouring text for when an isatty() method does not exist.
- Fix for the creation of the HTML user manual http://www.nmr-relax.com/manual/index.html file.
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.
See also
- The combined release notes for all relax versions (warning, this is very large).
- The combined release descriptions for all relax versions.
- The combined release metadata for all relax versions.
- The combined release features for all relax versions.
- The combined release changes for all relax versions (warning, this is very large).
- The combined release bugfixes for all relax versions.
- The combined release announcement links for all relax versions.
