Batch jobs

Batch jobs#

The Batches feature in ASAP enables the simultaneous configuration of project types, project parameters, calculator and calculator parameters for a selected set of projects.
You can hand-pick multiple projects at once by clicking single projects while holding down the Ctrl key. Alternatively, click a project, next press down the Shift key and click another project. This way all items from the first to the last will be selected. These two methods can be combined to make complex selections easy and efficiently.
Batch multiple selection
Click the dropdown menu Batches
Batch dropdown menu

We now desvribe the available options:

  • Project label… You edit the label of multiple projects by selecting Project label….
    Alternatively, click Edit in the menu bar and then select Set project label… from the dropdown menu:
    Batch dropdown menu edit

    Or right-click on one of the selected projects to access the management menu. Click the option Set project label…

    Batch right click label

    You can set the label of each project individually by double-clicking the actual label:

    Batch one label

    Or edit all labels at once, by typing the desired label and clicking the button Set all labels:

    Batch all labels 1
    Batch all labels 2
  • Project type… You can edit simultaneously the type of project of the selected batch of items. We refer the user to chapter ASAP Workflows for further information on the different types of projects and their characteristics.
    Batch project type
  • Project settings… You can establish common project settings for the selected batch. The parameters included in the settings widget will depend on the project type. See chapter ASAP Workflows for further information on the settings of each project type.
    Batch settings
    In the case of single-point project type, you can also set up the parameters required to compute the target electronic material properties from this widget:
    Batch settings single point
  • Calculator type… You can set up a common calculator for all the selected projects. ASAP implements the EMT calculator, the SIESTA calculator and TranSIESTA calculator. We refer the user to chapter Calculators for more information on ASAP Calculator, a GUI designed to select the computational engine and help the user to properly prepare the input file.
    Batch calculator type
  • Calculator parameters… You can set up common calculator parameters for the selected projects. See chapter Calculators for more information on calculator parameters.

    Batch calculator parameters
  • Run parameters… You can set up common run parameters (Program \(\&\) server and number of MPI processors) for the set of selected projects.

    Batch run parameters
    Press the Click to apply new parameters button and close the widget.
    To submit the set of jobs, open the corresponding Run widget for each project by clicking on the Run icon. In the Run widget, locate the Run button and click on it to start the project. See chapter The run widget of this manual for further information on the Run widget.
    Please note that simultaneous job submission of multiple projects will be available in a future ASAP release.
    Batch run button
    Batch run widget
  • Analyse… Select the set of projects that you want to analyse. Please be aware that they must be successfully completed.

    Batch menu analysis

    The Batch analysis widget shows a list of completed projects, providing essential information for each entry. Each row in the list includes the following details:

    • Project label: Indicates the label of the project.

    • Structure: Indicates the structure of the chemical composition.

    • Total energy: Specifies the total energy of the project, measured in units such as eV, meV, kJ/mol, cal/mol, Rydberg and Hartree.

    • HOMO: Represents the energy level of the Highest Occupied Molecular Orbital (HOMO) in the project, also measured in the energy units mentioned above.

    • LUMO: Represents the energy level of the Lowest Unoccupied Molecular Orbital (LUMO) in the project, again measured using the specified energy units.

    Batch analysis widget units
    To export the table of the different energies of the selected batch click the Export .csv… or Export .txt… buttons. These two formats are very useful to deal with large amounts of data displayed in table form. Additionally, the batch analysis widget enables you to clone the projects of the batch by clicking the Create new single-point projects button.
    Batch analysis widget export create
You can save and export multiple projects at once by selecting the desired projects and clicking File in the menu bar. Then, press the option Save as… to save the selected batch, or click Export… to export the selected projects to a directory of your preference.
Alternatively, you can use the following keyboard shortcuts:
  • Ctrl+Shift+S (Cmd+S for Mac users) to save the selected projects to a directory of your choice.

  • Ctrl+E (Cmd+E) to export the batch of selected projects to a directory of your choice.

Batch save as

See section Keyboard shortcuts in ASAP for further information on keyboard shortcuts available in ASAP.