dft_pib_code

Interactive Jupyter Notebooks for learning the fundamentals of Density-Functional Theory (DFT)

https://github.com/tjz21/dft_pib_code

Science Score: 67.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 11 DOI reference(s) in README
  • Academic publication links
  • Committers with academic emails
    1 of 2 committers (50.0%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (14.4%) to scientific vocabulary

Keywords

chemistry computational-chemistry density-functional-theory dft educational jupyter jupyter-notebook python quantum-chemistry tutorial
Last synced: 4 months ago · JSON representation ·

Repository

Interactive Jupyter Notebooks for learning the fundamentals of Density-Functional Theory (DFT)

Basic Info
  • Host: GitHub
  • Owner: tjz21
  • License: mit
  • Language: Jupyter Notebook
  • Default Branch: main
  • Homepage:
  • Size: 58.1 MB
Statistics
  • Stars: 70
  • Watchers: 4
  • Forks: 11
  • Open Issues: 0
  • Releases: 4
Topics
chemistry computational-chemistry density-functional-theory dft educational jupyter jupyter-notebook python quantum-chemistry tutorial
Created over 2 years ago · Last pushed 7 months ago
Metadata Files
Readme License Citation

README.md

Opening the Density-Functional Theory Black Box


'It is nice to know that the computer understands the problem. But I would like to understand it too.'

- Eugene Wigner


Documentation Status Python 3.10 License: MIT Latest Release ChemRxiv DOI:<10.1021/acs.jchemed.3c00535>

This repository contains three Google Colab notebooks that are designed to facilitate understanding of Density-Functional Theory (DFT) through interactive visualizations. Our motivation for developing this software stems from the knowledge deficiency that is often produced from using DFT as a black box in commercial software. By applying DFT to the familiar particle in a box model system employing a real-space grid basis, we hope to have reduced DFT to its fundamental essence fit for pedagogy. Brief instructions for executing the code are provided at the beginning of each notebook and a problem sheet for getting started is attached. The notebooks can be accessed without any installation through Google Colab by simply clicking on the links and signing in with a Google account (offline alternative is provided here). Python programming knowledge is not required, and docs are hosted through ReadTheDocs.


Notebook 1–Particle in a 3D Box

In this notebook, we’ll consider the particle in a three-dimensional box system treated in any undergraduate physical chemistry textbook. High-quality energy level diagrams and isosurface renderings of the wavefunction can be generated from user-specified box lengths. Depicted here is the 321 state of an anthracene-like box of dimensions 16 x 8 x 3 Bohr.

Click here to open the notebook in Google Colab:


Open In Colab






Notebook 2–PAH Frontier Orbitals

Next, we’ll look at a real chemical system in the form of polycyclic aromatic hydrocarbons (PAHs). We can perform Hartree-Fock/STO-3G calculations to find the shapes and energies of their frontier molecular orbitals, which can make for interesting comparisons with the analogous results from Notebook 1.

Open In Colab



Notebook 3–Density-Functional Theory

Finally, we’ll reconsider the system from Notebook 1, but now we’ll turn on electron-electron interaction through the Kohn-Sham potential. We’ll consider each term of the single-particle Hamiltonian and put everything together into a self-consistent field (SCF) DFT calculation. We can then analyze the how the density and eigeneneriges change as a function of SCF iteration number. LDA and PBE are the available exchange-correlation functionals.

Full theory notebook:

Open In Colab


Abbreviated notebook with the DFT calculator and analysis tools:

Open In Colab



Citation

If you would like to cite this work, please refer to the following publication (BibTeX):

Hirschi, J. S.; Bashirova, D.; Zuehlsdorff, T. J. Opening the Density Functional Theory Black Box: A Collection of Pedagogic Jupyter Notebooks. J. Chem. Educ. 2023, 100 (11), 4496-4503. https://doi.org/10.1021/acs.jchemed.3c00535

Owner

  • Login: tjz21
  • Kind: user

Citation (CITATION.cff)

cff-version: 1.2.0
title: Opening the Density Functional Theory Black Box
type: software
authors:
  - given-names: Jacob S.
    family-names: Hirschi
    affiliation: Oregon State University
    email: hirschij@oregonstate.edu
    orcid: 'https://orcid.org/0009-0004-3327-8671'
  - given-names: Dayana
    family-names: Bashirova
    affiliation: Oregon State University
    orcid: 'https://orcid.org/0009-0006-2283-717X'
  - given-names: Tim J.
    family-names: Zuehsldorff
    affiliation: Oregon State University
    orcid: 'https://orcid.org/0000-0002-6960-756X'
identifiers:
  - type: doi
    value: 10.1021/acs.jchemed.3c00535
repository-code: 'https://github.com/tjz21/DFT_PIB_Code'
abstract: >-
  Interactive Jupyter Notebooks for learning the
  fundamentals of Density-Functional Theory (DFT).
keywords:
  - quantum chemistry
  - density-functional theory
  - computational chemistry
  - open educational resource
  - electronic structure
license: MIT
date-released: '2023-10-16'
preferred-citation:
  authors:
  - given-names: Jacob S.
    family-names: Hirschi
    affiliation: Oregon State University
    email: hirschij@oregonstate.edu
    orcid: 'https://orcid.org/0009-0004-3327-8671'
  - given-names: Dayana
    family-names: Bashirova
    affiliation: Oregon State University
    orcid: 'https://orcid.org/0009-0006-2283-717X'
  - given-names: Tim J.
    family-names: Zuehsldorff
    affiliation: Oregon State University
    orcid: 'https://orcid.org/0000-0002-6960-756X'
  date-published: 2023-10-16
  doi: 10.1021/acs.jchemed.3c00535
  issue: 11
  journal: Journal of Chemical Education
  publisher:
    name: American Chemical Society
  start: 4496
  title: "Opening the Density Functional Theory Black 
    Box: A Collection of Pedagogic Jupyter Notebooks"
  type: article
  url: "https://pubs.acs.org/doi/10.1021/acs.jchemed.3c00535"
  volume: 100
title: "Opening the Density Functional Theory Black 
  Box: A Collection of Pedagogic Jupyter Notebooks"

GitHub Events

Total
  • Watch event: 13
  • Push event: 7
  • Fork event: 1
Last Year
  • Watch event: 13
  • Push event: 7
  • Fork event: 1

Committers

Last synced: almost 2 years ago

All Time
  • Total Commits: 138
  • Total Committers: 2
  • Avg Commits per committer: 69.0
  • Development Distribution Score (DDS): 0.116
Past Year
  • Commits: 138
  • Committers: 2
  • Avg Commits per committer: 69.0
  • Development Distribution Score (DDS): 0.116
Top Committers
Name Email Commits
Jacob Hirschi 1****7 122
Jacob Hirschi h****j@o****u 16
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: almost 2 years ago

All Time
  • Total issues: 0
  • Total pull requests: 1
  • Average time to close issues: N/A
  • Average time to close pull requests: 6 minutes
  • Total issue authors: 0
  • Total pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 0.0
  • Merged pull requests: 1
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 1
  • Average time to close issues: N/A
  • Average time to close pull requests: 6 minutes
  • Issue authors: 0
  • Pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 0.0
  • Merged pull requests: 1
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
Pull Request Authors
  • LinusP217 (1)
Top Labels
Issue Labels
Pull Request Labels