CCP4i2: the new graphical user interface to the CCP4 program suite.
Potterton L, Agirre J, Ballard C, Cowtan K, Dodson E, Evans PR, Jenkins HT, Keegan R, Krissinel E, Stevenson K, Lebedev A, McNicholas SJ, Nicholls RA, Noble M, Pannu NS, Roth C, Sheldrick G, Skubak P, Turkenburg J, Uski V, von Delft F, Waterman D, Wilson K, Winn M, Wojdyr M. · 2018
Read CCP4i2: the new graphical user interface to the CCP4 program suite. by Potterton L, Agirre J, Ballard C, Cowtan K, Dodson E, Evans PR, Jenkins HT, Keegan R, Krissinel E, Stevenson K, Lebedev A, McNicholas SJ, Nicholls RA, Noble M, Pannu NS, Roth C, Sheldrick G, Skubak P, Turkenburg J, Uski V, von Delft F, Waterman D, Wilson K, Winn M, Wojdyr M. (2018) in the Tower of Babel, a free online library of public-domain works preserved in clean, searchable text. No sign-up. The full text is served as a plain-text file at a predictable URL, where text is present: https://antarctic-labs.com/tower-of-babel/europmc-pmc5947771.txt.
Introduction
Potterton and a large team of co-authors present CCP4i2, the new graphical interface to the CCP4 program suite. Their software paper appeared in Acta Crystallographica Section D. CCP4 is a long-running suite for macromolecular crystallography. The older interface, CCP4i, rested on an outdated toolkit. CCP4i2 replaces it with a modern design. It also adds a Python framework for automation.
The team aimed to automate the main stages of structure solution. Users should not need deep knowledge of file formats or program inputs. The interface tracks work in a database as tasks run. The paper describes the design and its goals. It serves crystallographers who solve structures with the suite.
Catalog record
| CREATOR | Potterton L, Agirre J, Ballard C, Cowtan K, Dodson E, Evans PR, Jenkins HT, Keegan R, Krissinel E, Stevenson K, Lebedev A, McNicholas SJ, Nicholls RA, Noble M, Pannu NS, Roth C, Sheldrick G, Skubak P, Turkenburg J, Uski V, von Delft F, Waterman D, Wilson K, Winn M, Wojdyr M. |
|---|---|
| YEAR | 2018 |
| COLLECTION | PAPERS |
| FORMAT | TXT |
| FILE SIZE | 71 KB |
| LICENSE | CC BY 4.0 |
| RIGHTS | CC BY |
| SOURCE | Europe PMC |
Browse the full library · About the Tower of Babel
Full text
The opening of the work, from the library's hosted text:
CCP4i2: the new graphical user interface to the CCP4 program suite By Liz Potterton, Jon Agirre, Charles Ballard, Kevin Cowtan, Eleanor Dodson, Phil R Evans, Huw T Jenkins, Ronan Keegan, Eugene Krissinel, Kyle Stevenson, Andrey Lebedev, Stuart J McNicholas Published in: Acta Crystallographica. Section D, Structural Biology DOI: 10.1107/S2059798317016035 ABSTRACT CCP4i2 is a graphical user interface to the CCP4 (Collaborative Computational Project, Number 4) software suite and a Python language framework for software automation. Keywords: graphical user interfaces, structure solution, CCP4, CCP4i2, automation, pipelines INTRODUCTION CCP4 (Collaborative Computational Project, Number 4) began in 1979 as a forum for collaboration between academic macromolecular crystallography (MX) software developers. Today, it is best known for supporting and releasing a suite of programs (Winn et al., 2011 ▸) that have been contributed by a wide range of developers, and for organizing meetings and workshops that are particularly geared to educating inexperienced crystallographers. CCP4 has several permanent staff who ensure that the software suite is robust, multi-platform, easy to install, regularly updated and well documented. They provide online support and training workshops, and maintain an active peer-supported bulletin board. Prior to about 2003, crystallographers using the program suite normally had to use the command line and scripting to run the programs. CCP4i (Potterton et al., 2002 ▸), the first widely used graphical user interface (GUI) to the suite, simplified and expedited use of the suite and provided tools to view files and to track the structure-solution process in a database. Similar graphical interfaces for MX programs include HKL2MAP (Pape & Schneider, 2004 ▸), HKL-3000 (Minor et al., 2006 ▸) and PHENIX (Echols et al., 2012 ▸). A different approach, which provides a graphical view of electron-density maps and models with interactive tools geared mostly to model building, is used in Coot (Emsley et al., 2010 ▸). The graphical interface in CCP4i, based on the poorly supported Tcl/Tk toolkit, is now out of date, and consequently the time is right for the CCP4i2 project to provide an alternative automation and GUI system, informed by more modern GUI principles and the lessons learned from the implementation of CCP4i. The key objectives are to provide high-level tasks that automate the main stages of structure solution and to remove the need for specialized knowledge of file formats, program input, program log-file organization and so forth. Within CCP4i2 the workflow and the scientific decisions that control the tasks and display the task results are designed to be as transparent as possible, and care has been taken to keep the underlying data accessible. A key objective for CCP4i2 is to improve accessibility for inexperienced crystallographers, enabling straightforward structure solution using a default approach, with clear reports and documentation allowing users to understand the process and investigate results. We have also sought to enable more experienced crystallographers to fine-tune each step to address more difficult problems. Key information about the structure-solution process is captured in a database, which maintains a record of all of the jobs run and all of the data imported and generated. The user interface 1.1. CCP4i2 comprises three main elements: a database-backed project/job-management system, a scripting/reporting framework and a graphical user interface to these elements. The majority of a user’s experience of a software suite is determined by its user interface, and this is described here. The user is encouraged to organize their work into projects: typically, one project might result in one solved structure. The user views the status of a project through a project window, as shown in Fig. 1 ▸. The left-hand side of this window is the ‘job list’, a nested list of all jobs and data objects associated with the project, and the right-hand side is initially a ‘task menu’, a list of all available tasks organized into modules corresponding to the stages in structure solution. When the user chooses a task from the menu, the menu is replaced by the appropriate ‘task input’ frame. When a job has been executed, the ‘task input’ frame is replaced by a ‘report’ frame which presents the results from the task. For longer running tasks the ‘report’ frame will be updated continuously while the task is running. [Figure: Three views of the project window. (a) The task menu. (b) A task input frame. (c) A task report.] The ‘Input’ usually has several tabs, with the topmost tab being labelled ‘input data’ and allowing the user to select the input data for the task. The other tabs provide control over different aspects of the task, but typically the user only needs to select sufficient input data for the task, which will then run with sensible default parameters. All data objects (coordinates, reflections, phases etc.) are stored in discrete files, but the database maintains a user-editable label for each file, which is intended to be more meaningful than the file’s path in the filesystem. The crystallographer using CCP4i2 is encouraged to think in terms of a ‘data object’ rather than a ‘file’: the user need only be concerned with the data content, as the software will handle file storage in the background. The widgets to select input data all have a similar appearance (Fig. 2 ▸), with a drop-down menu that lists the labels of any appropriate data that are already present in the project. Such data must have been either imported or created by a previous job in the project. In many situations defaults are selected automatically, being the data from the most recently run job. There are buttons to the right of the drop-down menu to download data from web servers, to select data from other projects in the CCP4i2 database or to import files from the local filesystem. On the left of the widget is the ‘icon button’, with an icon indicating the type of data and an associated contextual menu to access documentation as well as functionality to display, copy or paste data. The contextual menu offers additional functionality specific to the given data type, such as selecting a limited set of atoms from a coordinate data object. [Figure: Fragment of a typical task input showing the widgets to select data corresponding to ‘Reflections’ and ‘Phases’.] Tasks are designed to require minimal user input. Where input is essential but not yet provided by the user, the corresponding widget is highlighted in red. Similarly, control parameters provided by the task interface are validated against developer-specified criteria, with inappropriate input highlighted in red and execution of the task prevented until inconsistencies have been addressed. The interface is dynamic in that the available detailed options may be updated dependent on the user’s data selection. All files and jobs have a label assigned by default. However, the user may edit these labels to make them more meaningful and descriptive, which may aid them when reviewing the project in the future. There is also a ‘Comment’ tab next to the ‘Input’ and ‘Results’ tabs where the user may enter more detailed comments on a specific job. The job list (Fig. 3 ▸) shows all of the jobs associated with the project, listed with the most recent first and with icons indicating status (for example ‘pending’ or ‘running’). Many jobs have an associated ‘evaluation’, for example the R values for