Skip to content

Commit

Permalink
joss edits
Browse files Browse the repository at this point in the history
  • Loading branch information
jmmshn committed Jan 11, 2024
1 parent a28b25a commit f1165b8
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 10 deletions.
16 changes: 8 additions & 8 deletions docs/source/content/defect-finder.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,10 @@
"source": [
"# Defect Finder\n",
"\n",
"As you introduced a defect into a crystalline system, all of the atoms in the system will be subject to displacements\n",
"As you introduce a defect into a crystalline system, all of the atoms in the system will be subject to displacements\n",
"during the atomic relaxation process. This can be especially problematic for native point defects, since the similar atoms in the simulation cell are technically fungible so split-vacancies and split-interstitials can be created with ill-defined positions.\n",
"The `DefectSiteFinder` can be used to identify the location of the defect in a simulation cell without any prior knowledge of the how the defect is created.\n",
"This is especially useful during database building since the location of the defect is now provence agnostic which means that the database requires less context information during the build process.\n",
"The `DefectSiteFinder` can be used to identify the location of the defect in a simulation cell without any prior knowledge of how the defect is created.\n",
"This is especially useful during database building since the location of the defect is now provenance agnostic which means that the database requires less context information during the build process.\n",
"\n",
"To use the `DefectSiteFinder`, simply instantiate the class and call the `find_defect_fpos` method with the defective and pristine structures as arguments. We show that the `DefectSiteFinder` can be used to identify the location of nitrogen vacancies in wz-GaN structure blow."
]
Expand Down Expand Up @@ -49,7 +49,7 @@
"id": "873288d3",
"metadata": {},
"source": [
"The last for `q=3` demonstrates that doing this in a smaller simulation cell with large distortions can be problematic so always double check your results.\n",
"The last structure (for `q=2`) demonstrates that doing this in a smaller simulation cell with large distortions can be problematic so always double-check your results.\n",
"\n",
"On a larger ZrO2 cell, the identified vacancy is shown\n",
"\n",
Expand All @@ -63,15 +63,15 @@
"source": [
"## How does it work?\n",
"\n",
"Structure matching procedure is as follows:\n",
"The steps of the structure analysis and comparison procedure are as follows:\n",
"\n",
"1. Caclulate the anonymized SOAP vector for each symmetry distinct site in the pristine structure.\n",
"1. Calculate the anonymized SOAP vector for each symmetry distinct site in the pristine structure.\n",
"2. Calculate the SOAP vector for each site in the defective structure.\n",
"3. For each site in the defective structure, find the closest match in the pristine structure using the cosine similarity of the SOAP vectors. This cosine similarity becomes a measure of how defective the site is (how different from a bulk site).\n",
"4. Rank the sites by the their defectiveness as defined above.\n",
"4. Rank the sites by their defectiveness as defined above.\n",
"5. Compute the periodic average of a subset of the most defective sites.\n",
"\n",
"So in a sense we are using SOAP to arrive at a distortion field for the defect structure and calculating the center of that distortion field. This is a fairly straight-forward approach, but it seems to work well in practice."
"So in a sense, we are using SOAP to arrive at a distortion field for the defect structure and calculating the center of that distortion field. This is a fairly straightforward approach, but it seems to work well in practice."
]
}
],
Expand Down
7 changes: 6 additions & 1 deletion docs/source/content/nonradiative.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@
"source": [
"### Potential energy surface\n",
"\n",
"The potential energy surface of the defect in a particular charge state is given by:\n",
"Under the harmonic approximation, the potential energy surface of the defect in a particular charge state is given by:\n",
"\n",
"$$\\frac{1}{2} \\omega^2 Q^2$$\n",
"\n",
Expand Down Expand Up @@ -260,6 +260,11 @@
}
],
"metadata": {
"kernelspec": {
"display_name": "mp",
"language": "python",
"name": "python3"
},
"language_info": {
"codemirror_mode": {
"name": "ipython",
Expand Down
2 changes: 1 addition & 1 deletion paper/paper.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ bibliography: paper.bib

Point defects can often determine the properties of semiconductor and optoelectronic materials.
Simulation of point defects is one of the most complex workflows in computational materials science, involving extensive pre- and post-processing of the structural and electronic structure data[@CGWalle_defects_RMP].
Multiple software packages exist to automate the simulation of point defects including work from [@Broberg2018], [@Kumagai2021], [@Huang2022,] [@Arrigoni2021Jul], [@Goyal2017Apr], and [@Smtg-Bham2023Dec ]however, there is a lack of a code that focuses on:
Multiple software packages exist to automate the simulation of point defects including work from [@Broberg2018], [@Kumagai2021], [@Huang2022], [@Arrigoni2021Jul], [@Goyal2017Apr], and [@Smtg-Bham2023Dec]however, there is a lack of a code that focuses on:

1. Integration but not insistence on standardized high-throughput workflow frameworks.
2. Building large, persistent databases of point defects that are extensible to new calculations over time.
Expand Down

0 comments on commit f1165b8

Please sign in to comment.