Skip to main content

Summary

SE-PINN is a physics-informed neural network in PyTorch that solves the Schrödinger equation of quantum mechanics.

The model is constrained to predict quantum-mechanical states that respect the mathematical-physical properties of symmetry, normality, and orthogonality — all via (1) a custom loss function and (2) a custom architectural layer. In addition, the model learns not through supervised learning but through reinforcement learning (RL) via feedback from the Schrödinger equation itself.

SE-PINN was developed at Vanderbilt University in collaboration with Alexander Ahrens and under the supervision of Prof. Ipek Oguz (https://engineering.vanderbilt.edu/bio/?pid=ipek-oguz).


Demonstration

Figure 1 and Figure 2 are visualizations of the ground state (left) and the energy of the ground state (right) that are predicted by the model as it trains. The physical system of interest is the quantum harmonic oscillator, which is used to model diatomic molecules such as diatomic nitrogen, diatomic oxygen, and the hydrogen halides.

The enforcement of symmetry on the prediction of the ground state via a special architectural layer of the model — a "hub layer" — improves its convergence to the correct energy, as visualized in Figure 2.

Figure 1: SE-PINN without Enforcement of Symmetry
Figure 2: SE-PINN with Enforcement of Symmetry

Usage

(1) Install

pip install sepinn

(2) Import

from sepinn.wrappedpinn import WrappedPINN

model = WrappedPINN(...)

model.train(...)

Documentation

A Jupyter notebook is available for reference in the docs folder as well as through Google Colab and nbviewer.

Google Colab (Interactive):

https://colab.research.google.com/github/Tiger-Du/SE-PINN/blob/main/docs/quantum_harmonic_oscillator.ipynb

nbviewer (Non-interactive):

https://nbviewer.org/github/Tiger-Du/SE-PINN/blob/main/docs/quantum_harmonic_oscillator.ipynb


Citation

SE-PINN is citable via the BibTeX entry below.

@techreport{DuAhrensOguz2023,
  author={Du, Tiger and Ahrens, Alexander and Oguz, Ipek},
  institution={Vanderbilt University},
  title={Solving the Schrodinger Equation via Physics-Informed Machine Learning},
  year={2023}
}

License

SE-PINN is published under the GPL-3.0 license.

Release files for sepinn 1.0.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for sepinn 1.0.0
File Size Uploaded
sepinn-1.0.0.tar.gz 16.6 MB Details

Built distribution (wheel)

Table of built distributions (wheels) for sepinn 1.0.0
File Interpreter ABI Platform
sepinn-1.0.0-py2.py3-none-any.whl Python 2, Python 3 none any Details

Total release size: 16.6 MB

Release files / sepinn-1.0.0.tar.gz

Download URL sepinn-1.0.0.tar.gz
Size 16.6 MB
Tags Source
SHA-256 checksum
How to use checksums
4d06c8401ccc0fe62c21e10f20556dd9c953e1ae9423e7f0564b52401e1d3f3e
BLAKE2b-256 checksum
How to use checksums
88dcdf3ed8f4d80c0392f2d15b8beb2dd5dd35f8c5c333b3c2436d63e5d6e82c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.0.1 CPython/3.12.8

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Dec 12, 2024.

Transparency log

Release files / sepinn-1.0.0-py2.py3-none-any.whl

Download URL sepinn-1.0.0-py2.py3-none-any.whl
Size 19.1 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
de1d82b2183e7d6c15ce1162058ca03a0f802acb20497c3b23b71c8cd6319365
BLAKE2b-256 checksum
How to use checksums
7fabdeec1d4b2228acd06090f5d4c493607776b85a2a5ba71e2fe7723a987f39
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.0.1 CPython/3.12.8

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Dec 12, 2024.

Transparency log

Release history Release notifications | RSS feed

This release

1.0.0 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page