Skip to content

[WIP] QDET demo #1327

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

Open
wants to merge 23 commits into
base: master
Choose a base branch
from
Open

[WIP] QDET demo #1327

wants to merge 23 commits into from

Conversation

soranjh
Copy link
Contributor

@soranjh soranjh commented Mar 14, 2025

Before submitting

Please complete the following checklist when submitting a PR:

  • Ensure that your tutorial executes correctly, and conforms to the
    guidelines specified in the README.

  • Remember to do a grammar check of the content you include.

  • All tutorials conform to
    PEP8 standards.
    To auto format files, simply pip install black, and then
    run black -l 100 path/to/file.py.

When all the above are checked, delete everything above the dashed
line and fill in the pull request template.


Title:

Summary:

Relevant references:

Possible Drawbacks:

Related GitHub Issues:


If you are writing a demonstration, please answer these questions to facilitate the marketing process.

  • GOALS — Why are we working on this now?

    Eg. Promote a new PL feature or show a PL implementation of a recent paper.

  • AUDIENCE — Who is this for?

    Eg. Chemistry researchers, PL educators, beginners in quantum computing.

  • KEYWORDS — What words should be included in the marketing post?

  • Which of the following types of documentation is most similar to your file?
    (more details here)

  • Tutorial
  • Demo
  • How-to

Copy link

👋 Hey, looks like you've updated some demos!

🐘 Don't forget to update the dateOfLastModification in the associated metadata files so your changes are reflected in Glass Onion (search and recommendations).

Please hide this comment once the field(s) are updated. Thanks!

@soranjh soranjh marked this pull request as ready for review April 28, 2025 18:41
The core idea behind embedding methods is to partition the system and treat the strongly correlated
subsystem accurately, using high-level quantum mechanical methods, while approximating the effects
of the surrounding environment in a way that retains computational efficiency. In this demo, we show
how to implement the quantum defect embedding theory (QDET). The method has been successfully
Copy link
Contributor Author

@soranjh soranjh Apr 28, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add a reference.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add a reference.

Reference HERE

subsystem accurately, using high-level quantum mechanical methods, while approximating the effects
of the surrounding environment in a way that retains computational efficiency. In this demo, we show
how to implement the quantum defect embedding theory (QDET). The method has been successfully
applied to study defects in CaO and to calculate excitations of the negatively charged NV center in diamond.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add a reference.

# Implementation
# --------------
# We implement QDET to compute the excitation energies of a negatively charged nitrogen-vacancy
# defect in diamond [].
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add a reference.

# ^^^^^^^^^^^^^^^^^^^^^
# Once we have obtained the meanfield description, we can identify our impurity by finding
# the states that are localized in real space. We can identify these localized states using the
# localization factor defined as []:
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add a reference.

@@ -0,0 +1,47 @@
{
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please update the metadata file.

Copy link

github-actions bot commented May 1, 2025

Thank you for opening this pull request.

You can find the built site at this link.

Deployment Info:

  • Pull Request ID: 1327
  • Deployment SHA: b42e5c31250a6868e676cff40d3f55d92fa18fc9
    (The Deployment SHA refers to the latest commit hash the docs were built from)

Note: It may take several minutes for updates to this pull request to be reflected on the deployed site.

r"""Quantum Defect Embedding Theory (QDET)
=========================================
Efficient simulation of complex quantum systems remains a significant challenge in chemistry and
physics. These simulations often require computationally intractable methods for a complete
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps you can be more direct here.
For example: "Performing more reliable simulations of advanced materials and molecules remain a significant challenge in quantum chemistry due to the prohibitive cost of wave function methods."

feature a strongly correlated region, which requires accurate quantum treatment, embedded within a
larger environment that could be properly treated with cheaper approximations. Examples of such
systems include point defects in materials [#Galli]_, active site of catalysts [#SJRLee]_, surface phenomenon such
as adsorption [#Gagliardi]_ and many more. Embedding theories serve as powerful tools for effectively
Copy link
Contributor

@agran2018 agran2018 May 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider removing the last sentence. Perhaps it is the good place to point out that "Embedding methods serve as powerful tools to accurately capture electronic correlations in the active region while accounting for the screening effects of the environment."

larger environment that could be properly treated with cheaper approximations. Examples of such
systems include point defects in materials [#Galli]_, active site of catalysts [#SJRLee]_, surface phenomenon such
as adsorption [#Gagliardi]_ and many more. Embedding theories serve as powerful tools for effectively
addressing such problems.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

see comment above.

addressing such problems.

The core idea behind embedding methods is to partition the system and treat the strongly correlated
subsystem accurately, using high-level quantum mechanical methods, while approximating the effects
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
subsystem accurately, using high-level quantum mechanical methods, while approximating the effects
subsystem accurately, using wavefunction-based methods, while approximating the effects

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not necessarily the case, for example, SEET and DMFT use Green's function based methods and then there are density based embeddings where different functionals of DFT are used. Here, since we are talking about embedding in general, we don't want to specify wavefunction-based method here.


The core idea behind embedding methods is to partition the system and treat the strongly correlated
subsystem accurately, using high-level quantum mechanical methods, while approximating the effects
of the surrounding environment in a way that retains computational efficiency. In this demo, we show
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
of the surrounding environment in a way that retains computational efficiency. In this demo, we show
of the surrounding environment using mean field approximations to retain the computational efficiency. In this demo, we show

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We don't always treat the environment in a mean-field way, some embedding theories use some form of correction on top of mean-field, fox example, QDET uses GW, DMFT can use GW and DFT both, while SEET uses GF2 or GW.

#############################################
# Theory
# ------
# The core idea in QDET is to construct an effective Hamiltonian that describes the impurity
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
# The core idea in QDET is to construct an effective Hamiltonian that describes the impurity
# The QDET method allows us to construct an effective Hamiltonian that describes the impurity

# L_n = \int_{V \in \ohm} d^3 r |\Psi_n^{KS}(r)|^2
#
# where $V$ is the identified volume including the impurity within the supercell volume $\ohm$.
# We will use the WEST program to compute the localization factor. This requires creating another
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please, add WEST references. See here

# $W_0^R$, results from screening the bare Coulomb potential, $v$, with the reduced polarizability,
# $P_0^R = P - P_{imp}$, where $P$ is the system's polarizability and $P_{imp}$ is the impurity's
# polarizability. However, this definition of the effective interaction, $v_{eff}$, introduces
# double counting of electrostatic and exchange-correlation effects for the impurity: once via
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Check the wording above Diksha as per our discussion. I think this might flow better if you define the two-body term, then you define the one-body term and explain the motivation to correct it to avoid double counting the contribution of the active electrons to the Hartree and XC energy.

# exact removal of double counting corrections at GW level of theory, thus removing the
# approximation present in the initial DFT based formulation. This formulation also helps capture
# the response properties and provides access to excited state properties. Another major advantage
# of QDET is the ease with which it can be used with quantum computers in a hybrid framework.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You may want to add the reference to our paper on V_B in hBN.
https://journals.aps.org/pra/abstract/10.1103/PhysRevA.110.032606

Copy link
Contributor

@agran2018 agran2018 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you @ddhawan11, very nice tutorial! I have left some comments and suggestions.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants