-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #14 from materialdigital/readme
Update readme
- Loading branch information
Showing
6 changed files
with
3 additions
and
17 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,14 +1,2 @@ | ||
# Quantum Espresso Workflow | ||
The structure optimization of an Aluminium bulk structure followed by the calculation of the bulk modulus by computing the energy for different volumes is implemented in three different workflow frameworks, [Aiida](https://aiida.net), [jobflow](https://materialsproject.github.io/jobflow/) and [pyiron_base](https://pyiron.org). | ||
|
||
Test it on: [](https://mybinder.org/v2/gh/materialdigital/ADIS2023/HEAD) | ||
|
||
## Explanation | ||
* `adis_tools` - quantum espresso parser independent of the workflow frameworks. | ||
* `aiida_qe_basic` - simple Aiida interface. | ||
* `espresso/pseudo/Al.pbe-n-kjpaw_psl.1.0.0.UPF` - This is the pseudo potential for qunatum espresso. By placing it in `~/espresso/pseudo`, it is automatically detected by quantum espresso. | ||
* `aiida.ipynb` - workflow implemented in [Aiida](https://aiida.net) | ||
* `environment.yml` - Conda environment to define the dependencies. | ||
* `jobflow.ipynb` - workflow implemented in [jobflow](https://materialsproject.github.io/jobflow/) | ||
* `postBuild` - script to install `aiida_qe_basic` in the mybinder environment. | ||
* `pyiron_base.ipynb` - workflow implemented in [pyiron_base](https://pyiron.org) | ||
# ADIS 2023 | ||
As part of the [Ab initio Description of Iron and Steel (ADIS2023): Digitalization and Workflows workshop](https://www.mpie.de/4902385/adis2023) the developers of the workflow frameworks [Aiida](https://aiida.net), [jobflow](https://materialsproject.github.io/jobflow/), [pyiron](https://pyiron.org) and [simstack](https://simstack.readthedocs.io) met and discussded their frameworks. During these discussions it became clear that while the naming and the extend of the implementation of certain components differ, there were also large number of similarities. To enable a more direct comparison of the different frameworks, the same workflow was implemented in all four workflow frameworks. These implementations are shared in this [repository](https://github.com/materialdigital/ADIS2023) and are rendered as a [jupyter book website](https://materialdigital.github.io/ADIS2023). The examples can even be executed directly in the web browser using [mybinder](https://mybinder.org/v2/gh/materialdigital/ADIS2023/HEAD). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,6 @@ | ||
title: ADIS2023 | ||
author: pyiron | ||
logo: logo_dark.png | ||
logo: images/adislogo.png | ||
|
||
execute: | ||
execute_notebooks : off | ||
|
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.