Class Main

The main GUI class.

Instance Methods

__init__(self, parent=None, id=-1, title="")
Initialise the main relax GUI frame.

about_relax(self, event=None)
The about message for relax.

action_export_bmrb(self, event=None)
Export the contents of the current data pipe for BMRB deposition.

action_state_save(self, event=None)
Save the program state.

action_state_save_as(self, event=None)
Save the program state with file name selection.

add_start_screen(self)
Create a start screen for the main window when no analyses exist.

build_toolbar(self)
Create the toolbar.

close_windows(self)
Throw a warning to close all of the non-essential windows when execution is locked.

contact_relax(self, event=None)
Write an email to the relax mailing-list using the standard mailing program.

enable(self)
Enable and disable certain parts of the main window with the execution lock.

exit_gui(self, event=None)
Catch the main window closure and perform the exit procedure.

init_data(self)
Initialise the data used by the GUI interface.

free_file_format_settings(self, event=None)
Open the free file format settings window.

references(self, event=None)
Display the references relevant for relax.

relax_manual(self, event=None)
Display the relax manual.

reset(self)
Reset the GUI.

run_test_suite(self, event=None, categories=['system','unit','gui','verification'])
Execute the full test suite.

run_test_suite_gui(self, event=None)
Execute the GUI tests.

run_test_suite_sys(self, event=None)
Execute the system tests.

run_test_suite_unit(self, event=None)
Execute the unit tests.

run_test_suite_verification(self, event=None)
Execute the verification tests.

show_controller(self, event=None)
Display the relax controller window.

show_pipe_editor(self, event=None)
Display the data pipe editor window.

show_prompt(self, event=None)
Display the relax prompt window.

show_results_viewer(self, event=None)
Display the analysis results.

show_results_viewer_safe(self, warn=False)
Display the analysis results in a thread safe wx.CallAfter call.

show_results_viewer_no_warn(self)
Display the analysis results.

show_tree(self, event=None)
Display the molecule, residue, and spin tree window.

state_load(self, event=None, file_name=None)
Load the program state.

state_save(self)
Save the program state.

sync_ds(self, upload=False)
Synchronise the GUI and the relax data store, both ways.

system_cwd(self, event=None)
Change the system current working directory.

uf_call(self, event=None)
Catch the user function call to properly specify the parent window.

update_status_bar(self)
Update the status bar info.

Class Variables

min_width = 1000

min_height = 600

Method Details

about_relax(self, event=None)

The about message for relax.

Parameters:

• event (wx event) - The wx event.

action_export_bmrb(self, event=None)

Export the contents of the current data pipe for BMRB deposition.

Parameters:

• event (wx event) - The wx event.

action_state_save(self, event=None)

Save the program state.

Parameters:

• event (wx event) - The wx event.

action_state_save_as(self, event=None)

Save the program state with file name selection.

Parameters:

• event (wx event) - The wx event.

close_windows(self)

Throw a warning to close all of the non-essential windows when execution is locked.

This is to speed up the calculations by avoiding window updates.

contact_relax(self, event=None)

Write an email to the relax mailing-list using the standard mailing program.

Parameters:

• event (wx event) - The wx event.

exit_gui(self, event=None)

Catch the main window closure and perform the exit procedure.

Parameters:

• event (wx event) - The wx event.

free_file_format_settings(self, event=None)

Open the free file format settings window.

Parameters:

• event (wx event) - The wx event.

references(self, event=None)

Display the references relevant for relax.

Parameters:

• event (wx event) - The wx event.

relax_manual(self, event=None)

Display the relax manual.

Parameters:

• event (wx event) - The wx event.

run_test_suite(self, event=None, categories=['system','unit','gui','verification'])

Execute the full test suite.

Parameters:

• event (wx event) - The wx event.
• categories (list of str) - The list of test categories to run, for example ['system', 'unit', 'gui', 'verification'] for all tests.

run_test_suite_gui(self, event=None)

Execute the GUI tests.

Parameters:

• event (wx event) - The wx event.

run_test_suite_sys(self, event=None)

Execute the system tests.

Parameters:

• event (wx event) - The wx event.

run_test_suite_unit(self, event=None)

Execute the unit tests.

Parameters:

• event (wx event) - The wx event.

run_test_suite_verification(self, event=None)

Execute the verification tests.

Parameters:

• event (wx event) - The wx event.

show_controller(self, event=None)

Display the relax controller window.

Parameters:

• event (wx event) - The wx event.

show_pipe_editor(self, event=None)

Display the data pipe editor window.

Parameters:

• event (wx event) - The wx event.

show_prompt(self, event=None)

Display the relax prompt window.

Parameters:

• event (wx event) - The wx event.

show_results_viewer(self, event=None)

Display the analysis results.

Parameters:

• event (wx event) - The wx event.

show_results_viewer_safe(self, warn=False)

Display the analysis results in a thread safe wx.CallAfter call.

Parameters:

• warn (bool) - A flag which if True will cause a message dialog to appear warning about keeping the window open with the execution lock.

show_tree(self, event=None)

Display the molecule, residue, and spin tree window.

Parameters:

• event (wx event) - The wx event.

state_load(self, event=None, file_name=None)

Load the program state.

Parameters:

• event (wx event) - The wx event.
• file_name (str) - The name of the file to load (for dialogless operation).

sync_ds(self, upload=False)

Synchronise the GUI and the relax data store, both ways.

This method allows the GUI information to be uploaded into the relax data store, or for the information in the relax data store to be downloaded by the GUI.

Parameters:

• upload (bool) - A flag which if True will cause the GUI to send data to the relax data store. If False, data will be downloaded from the relax data store to update the GUI.

system_cwd(self, event=None)

Change the system current working directory.

Parameters:

• event (wx event) - The wx event.

uf_call(self, event=None)

Catch the user function call to properly specify the parent window.

Parameters:

• event (wx event) - The wx event.