Skip to content

Commit 74069ac

Browse files
committed
update: add headers
1 parent 9242fe6 commit 74069ac

File tree

1 file changed

+66
-23
lines changed

1 file changed

+66
-23
lines changed

other/materials_designer/specific_examples/run_bandgap_workflow.ipynb

Lines changed: 66 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -9,44 +9,68 @@
99
"\n",
1010
"## Process Overview\n",
1111
"### 1. Set up the environment and parameters.\n",
12-
"### 2. Load the target material.\n",
13-
"### 3. Import workflow builder and related analyzers.\n",
14-
"### 4. Analyze material to get parameters for the workflow configuration.\n",
15-
"### 5. Create the workflow configuration.\n",
16-
"### 6. Create a job with material and workflow configuration.\n",
17-
"### 7. Log in to get the API token\n",
18-
"### 8. Submit the job to the server.\n",
19-
"### 9. Monitor the job status and retrieve results."
12+
"### 1. Log in to get the API token\n",
13+
"### 1. Load the target material.\n",
14+
"### 1. Import workflow builder and related analyzers.\n",
15+
"### 1. Analyze material to get parameters for the workflow configuration.\n",
16+
"### 1. Create the workflow configuration.\n",
17+
"### 1. Create a job with material and workflow configuration.\n",
18+
"### 1. Submit the job to the server.\n",
19+
"### 1. Monitor the job status and retrieve results."
2020
],
2121
"id": "ed24b225263ae3c3"
2222
},
2323
{
24+
"metadata": {},
25+
"cell_type": "markdown",
26+
"source": "## 1. Set up the environment and parameters",
27+
"id": "598da5f8c4f507ec"
28+
},
29+
{
30+
"metadata": {},
31+
"cell_type": "markdown",
32+
"source": "## 2. Log in to get the API token",
33+
"id": "51105b005c535ca"
34+
},
35+
{
36+
"metadata": {},
2437
"cell_type": "code",
25-
"id": "initial_id",
38+
"source": [
39+
"from mat3ra.api import ApiClient\n",
40+
"# Log in to get the API token\n",
41+
"auth_config = await ApiClient().login()"
42+
],
43+
"id": "23626cb27f6e7206",
44+
"outputs": [],
45+
"execution_count": null
46+
},
47+
{
48+
"metadata": {},
49+
"cell_type": "markdown",
50+
"source": "## 3. Load the target material",
51+
"id": "ba816c64f28f6a3d"
52+
},
53+
{
2654
"metadata": {
2755
"collapsed": true
2856
},
57+
"cell_type": "code",
58+
"outputs": [],
59+
"execution_count": null,
2960
"source": [
3061
"from utils.visualize import visualize_materials as visualize\n",
3162
"from utils.jupyterlite import load_material_from_folder\n",
3263
"\n",
3364
"material = load_material_from_folder(\"/uploads\", \"MoS2_twisted_interface_60_degrees.json\")\n",
3465
"visualize(material)"
3566
],
36-
"outputs": [],
37-
"execution_count": null
67+
"id": "initial_id"
3868
},
3969
{
4070
"metadata": {},
41-
"cell_type": "code",
42-
"source": [
43-
"from mat3ra.api import ApiClient\n",
44-
"# Log in to get the API token\n",
45-
"auth_config = await ApiClient().login()"
46-
],
47-
"id": "23626cb27f6e7206",
48-
"outputs": [],
49-
"execution_count": null
71+
"cell_type": "markdown",
72+
"source": "## 4. Import workflow builder and related analyzers",
73+
"id": "f8d7e25a7c9cc2e"
5074
},
5175
{
5276
"metadata": {},
@@ -69,23 +93,36 @@
6993
],
7094
"id": "5ead702c417eff62"
7195
},
96+
{
97+
"metadata": {},
98+
"cell_type": "markdown",
99+
"source": "## 5. Create workflow",
100+
"id": "9bdd00f870caaeeb"
101+
},
72102
{
73103
"metadata": {},
74104
"cell_type": "code",
75105
"outputs": [],
76106
"execution_count": null,
77107
"source": [
78-
"from mat3ra.wode.workflow.vasp import create_vasp_workflow\n",
108+
"from mat3ra.wode.workflow.vasp.band_structure import create_band_structure_workflow\n",
79109
"\n",
80-
"band_gap_workflow = create_vasp_workflow(\n",
110+
"band_gap_workflow = create_band_structure_workflow(\n",
81111
" material=material,\n",
82112
" kpoints=kpoints,\n",
83113
" cutoff=cutoff,\n",
84114
" smearing=smearing,\n",
85-
" number_of_bands=number_of_bands)"
115+
" number_of_bands=number_of_bands\n",
116+
")"
86117
],
87118
"id": "68d43f6c797f2fc4"
88119
},
120+
{
121+
"metadata": {},
122+
"cell_type": "markdown",
123+
"source": "## 6. Create the job configuration",
124+
"id": "1f15e054ddb9a08c"
125+
},
89126
{
90127
"metadata": {},
91128
"cell_type": "code",
@@ -101,6 +138,12 @@
101138
],
102139
"id": "60e880dc581dafe1"
103140
},
141+
{
142+
"metadata": {},
143+
"cell_type": "markdown",
144+
"source": "## 7. Submit the job and monitor the status",
145+
"id": "8d5740e099512107"
146+
},
104147
{
105148
"metadata": {},
106149
"cell_type": "code",

0 commit comments

Comments
 (0)