Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve slightly the examples of LumiWorks. Also fix typos. #304

Merged
merged 30 commits into from
Nov 21, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
30 commits
Select commit Hold shift + click to select a range
babdb63
Insert one sentence to explain why conda install --file ./requirement…
gonzex Jul 26, 2018
8c9465d
Merge trunk/develop into gonzex/develop
gonzex Jul 26, 2018
779c4d9
More explanations in the README.rst .
gonzex Jul 26, 2018
9223fb9
Fix typos. Specify how to get a PMG_MAPI_KEY.
gonzex Jul 27, 2018
18d42aa
Several minor modifs
gonzex Jul 27, 2018
2678754
Minor modif, slightly more accurate wording.
gonzex Jul 27, 2018
d9e6073
Transfer the section explaining how to install conda from the abituto…
gonzex Jul 31, 2018
956af80
Improve the previous commit
gonzex Jul 31, 2018
39534d9
And now ...
gonzex Jul 31, 2018
086213b
Next trial
gonzex Jul 31, 2018
def3b92
Now should work
gonzex Jul 31, 2018
e150a43
Complete README.rst with information coming from abitutorials. Also i…
gonzex Jul 31, 2018
778913e
Fix formatting problems.
gonzex Jul 31, 2018
2caf520
More formatting fixes.
gonzex Jul 31, 2018
d040c88
Continue to work on the README.rst, minor modifs.
gonzex Jul 31, 2018
4691ab8
Fix links
gonzex Jul 31, 2018
c5294d1
Commas
gonzex Jul 31, 2018
2d24064
Minor correction
gonzex Jul 31, 2018
261103a
Previous modif did not work
gonzex Jul 31, 2018
4eb87ba
Fixes
gonzex Jul 31, 2018
633e2d5
Unify the environment name, now abienv everywhere (instead of possibl…
gonzex Jul 31, 2018
e2fe56b
Final modifs of README.rst
gonzex Jul 31, 2018
aa9e212
Merge trunk/develop into develop
gonzex Jul 31, 2018
42c2152
Merge trunk/develop' into develop
gonzex Aug 1, 2018
b7e1f9f
Fix missing :: in README.rst , causing unformatted apprearance on git…
gonzex Aug 1, 2018
18b646c
Remove the managers dir, and update the associated doc.
gonzex Aug 1, 2018
6bcfb5c
Write explicitly Setyawan and Curtarolo 2010
gonzex Aug 2, 2018
39e1321
Merge trunk/develop into develop
gonzex Mar 15, 2020
826bd67
Merge remote-tracking branch 'remotes/trunk/develop' into develop
gmatteo Nov 20, 2024
ab72a8b
Improve slightly the examples of LumiWorks. Also fix a typo.
gmatteo Nov 20, 2024
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
2 changes: 1 addition & 1 deletion abipy/examples/flows/run_gs_vs_kpts.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#!/usr/bin/env python
r"""
Convergence studiy with different k-meshes
Convergence study with different k-meshes
==========================================

In this example,
Expand Down
18 changes: 9 additions & 9 deletions abipy/examples/flows/run_lumi_Eu_doped_SLA.py
Original file line number Diff line number Diff line change
@@ -1,22 +1,22 @@
#!/usr/bin/env python
r"""
Delta SCF constrained occupation method calculation, to determine luminescent properties.
=========================================================================================
Delta SCF calculation: luminescence of an Eu-doped phosphor
===========================================================

This example shows how to compute the luminescent properties of Eu doped phosphor.
It uses a 36 atoms cell of SrLiAl3N4. Two non-equivalent Sr sites are availabe for Eu, resulting
This example shows how to compute the luminescent properties of an Eu-doped phosphor.
It uses a 36 atoms cell of SrLiAl3N4. Two non-equivalent Sr sites are available for Eu, resulting
in two independent LumiWork. The creation of the supercells is done with make_doped_supercell().

Steps, for each structure:
1) Relaxation in the ground state
2) Relaxation in the excited state, starting from the relaxed ground state. Created at run-time
1) Relaxation in the ground state.
2) Relaxation in the excited state, starting from the relaxed ground state. Created at run-time.
3) Scf computation in the relaxed/unrelaxed ground/excited state (4 computations).

Even if we use minimal settings, the workflow takes around one hour to run on one core.
Filepaths of the 6 runs are stored in outdata/lumi.json of each work
A quick post-processing is automatically done at the end of a LumiWork
Filepaths of the 6 runs are stored in outdata/lumi.json of each work.
A quick post-processing is automatically done at the end of a LumiWork,
and stored in outdata/Delta_SCF.json of each work, with relevant luminescent properties
(ZPL energy, Stoke Shift, \Delta Q,...), see abipy/lumi/delta_scf.py
(ZPL energy, Stoke Shift, \Delta Q,...), see abipy/lumi/delta_scf.py .
"""

import sys
Expand Down
8 changes: 4 additions & 4 deletions abipy/examples/flows/run_lumi_NV_center.py
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
#!/usr/bin/env python
r"""
Delta SCF constrained occupation method calculation, to determine luminescent properties.
Delta SCF calculation: luminescence of the NV- center in diamond.
=========================================================================================

This example shows how to compute the luminescent properties of the NV- center in diamond.
It uses a 64 atoms supercell, where one C atom was replaced by one N atom and one vacancy was created.
It uses a 64-atom supercell, where one C atom was replaced by one N atom and one vacancy was created.
See Fig.3 of https://doi.org/10.1103/PhysRevB.104.045303 for the setting of electron occupation
in the ground/excited state.
Steps:
1) Relaxation in the ground state
2) Relaxation in the excited state, starting from the relaxed ground state. Created at run-time
1) Relaxation in the ground state.
2) Relaxation in the excited state, starting from the relaxed ground state. Created at run-time.
3) Scf computation in the relaxed/unrelaxed ground/excited state (4 computations).

Even if we use minimal settings, the workflow takes a few minutes to run on one core.
Expand Down
6 changes: 3 additions & 3 deletions abipy/scripts/abistruct.py
Original file line number Diff line number Diff line change
Expand Up @@ -60,8 +60,8 @@ def get_epilog() -> str:
abistruct.py abisanitize FILE => Read structure from FILE, call abisanitize, compare structures
and save "abisanitized" structure to file.
abistruct.py conventional FILE => Read structure from FILE, generate conventional structure
following doi:10.1016/j.commatsci.2010.05.010
abistruct.py proto FILE => Read structure from FILE, find possible crystallographic prototypes
following Setyawan, W., & Curtarolo, S. (2010) doi:10.1016/j.commatsci.2010.05.010
abistruct.py proto FILE => Read structure from FILE, find possible crystallographic prototypes:
in the AFLOW library of crystallographic prototypes.
See http://doi.org/10.1016/j.commatsci.2017.01.017

Expand Down Expand Up @@ -290,7 +290,7 @@ def add_format_arg(parser, default, option=True, formats=None):
# Subparser for conventional.
p_conventional = subparsers.add_parser('conventional', parents=[copts_parser, path_selector, spgopt_parser, savefile_parser],
help="Gives a structure with a conventional cell according to certain standards. "
"The standards are defined in doi:10.1016/j.commatsci.2010.05.010")
"The standards are defined in Setyawan, W., & Curtarolo, S. (2010) doi:10.1016/j.commatsci.2010.05.010")

# Subparser for proto.
p_proto = subparsers.add_parser('proto', parents=[copts_parser, path_selector],
Expand Down
Loading