Skip to main content

Nanobind bindings to the eOn C++ client (Matter, Parameters, Potential, Jobs, NEB, RGPOT)

Project description

pyeonclient

In-process eOn client for Python. First-class algorithm objects on Matter (not a workdir wrapper).

Class / function Role
Matter Geometry + PEF (ASE Atoms analogue)
ImprovedDimer / Dimer / Lanczos / Davidson Min-mode
MinModeSaddleSearch Single-ended saddle search
NudgedElasticBand NEB band (list[Matter])
Hessian / get_prefactors Vibrational analysis / HTST
make_job + Job.run Full JobType factory (workdir jobs)

Docs: Python API

Install

pip install pyeonclient
pip install 'pyeonclient[ase]'           # Matter ↔ ASE geometry helpers
pip install 'pyeonclient[models]'        # optional Pydantic DimerSpec / NebSpec
# uv: uv pip install 'pyeonclient[models]'
# Core Dimer/NEB work without pydantic; C++ + light Python still enforce
# accelerant="gp" only with method="improved".

Example (dimer → saddle)

import numpy as np
import pyeonclient as pyec

params = pyec.Parameters()
params.potential = pyec.PotType.LJ
pot = pyec.make_potential(params.potential, params)
matter = pyec.Matter(pot, params)
# ... set positions / cell / numbers ...

matter.relax()
mode0 = np.random.default_rng(0).normal(size=matter.positions.shape)
dimer = pyec.ImprovedDimer(matter, params, pot)
dimer.compute(matter, mode0)

ss = pyec.MinModeSaddleSearch(
    matter, dimer.eigenvector, matter.potential_energy, params, pot
)
status = ss.run()
print(pyec.saddle_status_message(status), ss.eigenvalue)

NEB

path = [pyec.from_ase(img, pot, params) for img in images]
neb = pyec.NudgedElasticBand(path, params, pot)
neb.compute()
path = list(neb.path_images())

Build

meson setup build -Dwith_pyeonclient=true
meson compile -C build
pytest tests/test_pyeonclient_eigenmode.py tests/test_pyeonclient_neb.py -v

Project details


Download files

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

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

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

pyeonclient-0.3.2-cp312-abi3-manylinux_2_28_x86_64.whl (5.9 MB view details)

Uploaded CPython 3.12+manylinux: glibc 2.28+ x86-64

File details

Details for the file pyeonclient-0.3.2-cp312-abi3-manylinux_2_28_x86_64.whl.

File metadata

File hashes

Hashes for pyeonclient-0.3.2-cp312-abi3-manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 a6db2a7f914775973362884d56114be82eca22c6fca12e7974e72b160ea73e34
MD5 35dc26526873c39548e5f46356813fb4
BLAKE2b-256 89b9f39d59abce112a448223295828d42f3c1c200b85670a49b00ef52ed6f3d6

See more details on using hashes here.

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