Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions .github/workflows/build-tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,14 +23,14 @@ jobs:

steps:
- name: Checkout repository and submodules
uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
with:
fetch-depth: 0
lfs: true
submodules: true

- name: Setup python 3
uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6.2.0
uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
with:
python-version: ${{ matrix.python-version }}

Expand Down Expand Up @@ -89,12 +89,12 @@ jobs:

steps:
- name: Checkout this repository
uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
with:
lfs: true

- name: Checkout actions repository
uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
with:
repository: mat3ra/actions
token: ${{ secrets.BOT_GITHUB_TOKEN }}
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/s3-deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,14 +18,14 @@ jobs:
AWS_SECRET_ACCESS_KEY: ${{ secrets.S3_SECRET_KEY }}
steps:
- name: Checkout
uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
with:
fetch-depth: 0
lfs: true
submodules: true

- name: Set python 3 version
uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6.2.0
uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
with:
python-version: "3.10"

Expand Down
3 changes: 0 additions & 3 deletions images/jobs-designer/header-jobs-designer.png

This file was deleted.

3 changes: 3 additions & 0 deletions images/jobs-designer/header-jobs-designer.webp
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 0 additions & 3 deletions images/jobs-designer/jobs-designer.png

This file was deleted.

3 changes: 3 additions & 0 deletions images/jobs-designer/jobs-designer.webp
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 0 additions & 3 deletions images/jobs-designer/select-job-dialog.png

This file was deleted.

3 changes: 3 additions & 0 deletions images/jobs-designer/select-parent-job-dialog.webp
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
48 changes: 36 additions & 12 deletions lang/en/docs/jobs-designer/actions-header-menu/select-parent.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,53 @@
# Select Parent Job

As introduced in the [header menu page](../header-menu.md#select-parent), a completed "Parent" Job can be selected and added to a Job being [designed]({{ reference_url }}/jobs/overview/) from scratch. This new Job can in this way be based upon the Parent, and thus re-utilize its final results for further computation. These results are therefore "recycled", with the aim of optimizing the performance and computational time of the child Job.
As introduced in the [header menu page](../header-menu.md#select-parent), a
completed "Parent" Job can be selected and added to a Job being
[designed]({{ reference_url }}/jobs/overview/) from scratch. This new Job can in
this way be based upon the Parent, and thus re-utilize its final results for
further computation. These results are therefore "recycled", with the aim of
optimizing the performance and computational time of the child Job.

In order to do so, the user should select the `Select Parent` option under the drop-down menu <i class="zmdi zmdi-more-vert zmdi-hc-border"></i> of the main [header bar](../header-menu.md) of Jobs Designer.
In order to do so, the user should select the "Select Parent" option under the
"Select Job Actions" drop-down menu of the main [header bar](../header-menu.md)
of Jobs Designer.

## "Select Job" Dialog
## "Select Parent" Dialog

The "Select Job" dialog is now displayed with the following appearance, which is based on [Jobs Explorer](../../jobs/ui/explorer.md) and thus supporting the corresponding [filter/search](../../entities-general/actions/search.md) functionality.
The "Select Parent" dialog is based on [Jobs Explorer](../../jobs/ui/explorer.md)
and thus supporting the corresponding [filter/search](
../../entities-general/actions/search.md) functionality.

![Select Job](../../images/jobs-designer/select-job-dialog.png "Select Job")
![Select Parent](../../images/jobs-designer/select-parent-job-dialog.webp "Select Parent")

!!! warning "Criteria for Parent Job selection"
Only Jobs that satisfy both of the following criteria are available for selection as "parents".

- The parent Job must be under either a "Finished" <span class="btn badge b-success border-50">F</span> or "Terminated" <span class="btn badge b-default border-50">T</span> [status]({{ reference_url }}/jobs/status/).
- The parent Job must have been executed on a [cluster]({{ resources_url }}/infrastructure/clusters/overview/) which is still available for use by the Account under consideration at the moment of the new Job creation.
Only Jobs that satisfy both of the following criteria are available for
selection as "parents".

- The parent Job must be under either a "Finished"
<span class="btn badge b-success border-50">F</span> or "Terminated"
<span class="btn badge b-default border-50">T</span>
[status]({{ reference_url }}/jobs/status/).
- The parent Job must have been executed on a
[cluster]({{ resources_url }}/infrastructure/clusters/overview/) which is
still available for use by the Account under consideration at the moment of
the new Job creation.

## Add Parent Job

**Only one** Job can be [selected](../../entities-general/actions/select.md) as "Parent". It can be prepended to the Job being currently designed by pressing the "Select Items" button <i class="zmdi zmdi-collection-plus zmdi-hc-border"></i> located under the [top-right actions toolbar](../../entities-general/ui/explorer.md#actions-toolbar).
**Only one** Job can be [selected](../../entities-general/actions/select.md) as
"Parent". It can be prepended to the Job being currently designed by pressing
the "Select Items" button <i class="zmdi zmdi-collection-plus zmdi-hc-border"></i>
located under the [top-right actions toolbar](
../../entities-general/ui/explorer.md#actions-toolbar).

This returns the view to the main [Jobs Designer](../overview.md) interface, where the name of the selected parent Job and of its container Project are now indicated directly below the main [header menu](../header-menu.md).
This returns the view to the main [Jobs Designer](../overview.md) interface,
where the name of the selected parent Job and of its container Project are now
indicated directly below the main [header menu](../header-menu.md).

## Animation

Here, we demonstrate how to prepend a parent total energy calculation, performed on the semiconductor GaAs, to a new band structure calculation being designed for the same material.
Here, we demonstrate how to prepend a parent total energy calculation, performed
on the semiconductor GaAs, to a new band structure calculation being designed
for the same material.

<img data-gifffer="/images/jobs-designer/add-parent-designer.gif">
69 changes: 54 additions & 15 deletions lang/en/docs/jobs-designer/header-menu.md
Original file line number Diff line number Diff line change
@@ -1,49 +1,88 @@
# Header Menu

The main header menu at the top of the [Jobs Designer](overview.md) interface is comprised of the following items enumerated below. Please refer to further explanations under the same number labels.
The main header menu at the top of the [Jobs Designer](overview.md) interface is
comprised of the following items enumerated below. Please refer to further
explanations under the same number labels.

![Header Menu](../images/jobs-designer/header-jobs-designer.png "Header Menu")
![Header Menu](../images/jobs-designer/header-jobs-designer.webp "Header Menu")

## 1. Job Name

The name of the Job being created is shown here and can be edited in-place.
The name of the Job being created is shown here and can be edited in-place.

### Project Name

The name of the Project container is also displayed in smaller characters directly underneath it, however unlike Jobs it **cannot** be modified following Project creation.
The name of the Project container is also displayed in smaller characters
directly underneath it, however unlike Jobs it **cannot** be modified following
Project creation.

## 2. Description

A **Description** of the Job is shown and can be edited in-place through the corresponding icon button <i class="zmdi zmdi-info-outline zmdi-hc-border"></i>. The reader is referred to [this page](../entities-general/actions/metadata.md#edit-description) for a full explanation of how to do this.
A **Description** of the Job is shown and can be edited in-place through the
corresponding toggle button. The reader is referred to [this page](
../entities-general/actions/metadata.md#edit-description) for a full explanation
of how to do this.

## 3. Actions

The second button <i class="zmdi zmdi-more-vert zmdi-hc-border"></i> towards the right of the header menu allows the user primarily to add new entities to the Job being created. The following options are available under the corresponding drop-down menu.
The "Select Job Actions" dropdown list on the header menubar allows the user to
apply actions to the Job being created. The following options are available
under the corresponding dropdown list.

### [Select Materials](actions-header-menu/select-materials.md)

**Multiple** [Materials]({{ reference_url }}/materials/overview/) can be selected from the account-owned [collection]({{ reference_url }}/accounts/collections/), and added to the Job under creation. This procedure is described separately [in this page](actions-header-menu/select-materials.md).
**Multiple** [Materials]({{ reference_url }}/materials/overview/) can be
selected from the account-owned
[collection]({{ reference_url }}/accounts/collections/), and added to the Job
under creation. This procedure is described separately [in this page](
actions-header-menu/select-materials.md).

### [Select Workflow](actions-header-menu/select-workflow.md)

A **single** [Workflow]({{ reference_url }}/workflows/overview/) can also be selected and added to the Job, for performing computations on **all** materials selected in the above step. If the user wishes to execute multiple computational tasks sequentially, he/she should consider the possibility of creating a sequence of [Subworkflows](../workflow-designer/subworkflow-editor/overview-tab.md) within the same Workflow instead.
A **single** [Workflow]({{ reference_url }}/workflows/overview/) can also be
selected and added to the Job, for performing computations on **all** materials
selected in the above step. If the user wishes to execute multiple computational
tasks sequentially, he/she should consider the possibility of creating a
sequence of [Subworkflows](
../workflow-designer/subworkflow-editor/overview-tab.md) within the same
Workflow instead.

Instructions on how to select Workflows from the account-owned collection and add them to the Job being designed can be found [here](actions-header-menu/select-workflow.md).
Instructions on how to select Workflows from the account-owned collection and
add them to the Job being designed can be found [here](
actions-header-menu/select-workflow.md).

### [Select Parent](actions-header-menu/select-parent.md)

This option is convenient when the Job being created is intended to be run on top of the results obtained from a previous "parent" Job. Some examples where such a scenario is plausible include the re-calculation of a property with slight modifications, or obtaining the same results but with a higher precision. In both cases, the same preliminary calculations performed in the preceding parent job can be re-utilized, thus saving computational time.
This option is convenient when the Job being created is intended to be run on
top of the results obtained from a previous "parent" Job. Some examples where
such a scenario is plausible include the re-calculation of a property with
slight modifications, or obtaining the same results but with a higher precision.
In both cases, the same preliminary calculations performed in the preceding
parent job can be re-utilized, thus saving computational time.

The action of selecting a parent job is explained in detail [here](actions-header-menu/select-parent.md).
The action of selecting a parent job is explained in detail [here](
actions-header-menu/select-parent.md).

### Submit

The `Submit` option is only present for the case of Jobs with a "Pre-submission" [status]({{ reference_url }}/jobs/status/), which have been opened in Designer directly from [Explorer](../jobs/ui/explorer.md). Pressing `Submit` first saves the Job to the account-owned collection, and then directly [submits](../jobs/actions/run.md) it for execution.
The `Submit` option is only present for the case of Jobs with a "Pre-submission"
[status]({{ reference_url }}/jobs/status/), which have been opened in Designer
directly from [Explorer](../jobs/ui/explorer.md). Pressing `Submit` first saves
the Job to the account-owned collection, and then directly [submits](
../jobs/actions/run.md) it for execution.

## 4. Save Job

The Job being currently designed can finally be saved, after all appropriate changes have been made, by clicking the "Save" button <i class="zmdi zmdi-check zmdi-hc-border"></i>.
The Job being currently designed can finally be saved, after all appropriate
changes have been made, by clicking the "Save" or "Save & Exit" button.

When multiple materials are selected, by default (unless the workflow is multi-material in nature) a single job will be created per **each** material. The name of the resulting Job will have the material formula appended to it when more than one material is selected during its design phase.
When multiple materials are selected, by default (unless the workflow is
multi-material in nature) a single job will be created per **each** material.
The name of the resulting Job will have the material formula appended to it when
more than one material is selected during its design phase.

Once the new Job has been saved, the view is returned to the corresponding [Project page](../jobs/ui/project-page.md). Here, the new Job is now listed as a top entry under [Jobs Explorer](../jobs/ui/explorer.md) and has a "Pre-submission" [status]({{ reference_url }}/jobs/status/), indicating its readiness to be [submitted for execution](../jobs/actions/run.md).
Once the new Job has been saved, the view is returned to the corresponding
[Project page](../jobs/ui/project-page.md). Here, the new Job is now listed as a
top entry under [Jobs Explorer](../jobs/ui/explorer.md) and has a
"Pre-submission" [status]({{ reference_url }}/jobs/status/), indicating its
readiness to be [submitted for execution](../jobs/actions/run.md).
Loading