Skip to main content

Pythonic electronic structure theory.

Project description

eminus logo

eminus

Version License Python Coverage Chat DOI

eminus is a pythonic electronic structure theory code. It implements plane wave density functional theory (DFT) with self-interaction correction (SIC) functionalities. The goal is to create a simple code that is easy to read and easy to extend while using minimal dependencies. It is built upon the DFT++ pragmas proposed by Tomas Arias et al. that aim to let programming languages and theory coincide. This can be shown by, e.g., solving the Poisson equation. In the operator notation of DFT++ the equation reads

$$ \phi(\boldsymbol r) = -4\pi\mathcal L^{-1}\mathcal O\mathcal J n(\boldsymbol r). $$

The corresponding Python code (implying that the operators have been implemented properly) reads

def get_phi(atoms, n):
    return -4 * np.pi * atoms.Linv(atoms.O(atoms.J(n)))

Installation

The package and all necessary dependencies can be installed with

pip install eminus

More information about installing eminus can be found here.

Documentation

To learn more about the features, usage, or implementation of eminus, take a look inside the documentation.

Citation

A supplementary paper is available on SoftwareX. The following BibTeX key can be used

@Article{Schulze2025,
  author  = {Schulze, Wanja Timm and Schwalbe, Sebastian and Trepte, Kai and Gr\"afe, Stefanie},
  title   = {{eminus} --- Pythonic electronic structure theory},
  year    = {2025},
  doi     = {10.1016/j.softx.2025.102035},
  issn    = {2352-7110},
  journal = {SoftwareX},
  pages   = {102035},
  volume  = {29},
}

To cite a specific version one can select and cite it with Zenodo.

License

This project is licensed under the Apache 2.0 License. See the license page for more details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

eminus-3.2.1.tar.gz (1.9 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

eminus-3.2.1-py3-none-any.whl (261.8 kB view details)

Uploaded Python 3

File details

Details for the file eminus-3.2.1.tar.gz.

File metadata

  • Download URL: eminus-3.2.1.tar.gz
  • Upload date:
  • Size: 1.9 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.2.0 CPython/3.14.0

File hashes

Hashes for eminus-3.2.1.tar.gz
Algorithm Hash digest
SHA256 07cf7c4e8c376150e09925d3f3e1d5ad31996ce09ccc625e2a79bfea87d1a28c
MD5 ecb9318f10256ecc668c33d1f8b6ae6c
BLAKE2b-256 0160f7bdca63038fde02cbf93ce021c134b29014eadb16e7757af8f4c5ada1be

See more details on using hashes here.

Provenance

The following attestation bundles were made for eminus-3.2.1.tar.gz:

Publisher: .gitlab-ci.yml on wangenau/eminus

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file eminus-3.2.1-py3-none-any.whl.

File metadata

  • Download URL: eminus-3.2.1-py3-none-any.whl
  • Upload date:
  • Size: 261.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.2.0 CPython/3.14.0

File hashes

Hashes for eminus-3.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 1a3de1b7cd790435f1b66e83281630cab9a47ba1d9e4381a1d32c2355569d80b
MD5 3c963b529d4bf60f897129489ecec2d7
BLAKE2b-256 6bcbdb8e3dcf2ac7d5883f98e838012f3c2d7ec9bfc4f5fd640c941fd11b8b01

See more details on using hashes here.

Provenance

The following attestation bundles were made for eminus-3.2.1-py3-none-any.whl:

Publisher: .gitlab-ci.yml on wangenau/eminus

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page