Skip to main content

SEAMM xnn Plug-in

GitHub pull requests Build Status Code Coverage Code Quality Documentation Status PyPi VERSION

A SEAMM plug-in providing machine-learned force fields (MLFFs) trained with xnn as model chemistries, run as MDI engines.

Features

  • Advertises every xnn checkpoint found in the directories listed in xnn.ini to the Model Chemistry step as xnn:MLFF@<model>.

  • Launches xnn mdi – the checkpoint served as a resident MDI engine – for any step that drives a model chemistry over MDI: Energy (single points for many structures), LAMMPS (MD with the MLFF as the QM engine), Dimer Builder, Normal Mode Sampling.

  • Molecular and periodic systems (energy, forces and stress); runs on the CPU or a GPU (device in xnn.ini).

  • There is no xnn step to place in a flowchart: the models are used through Model Chemistry + Energy (or LAMMPS).

Note: xnn is published on PyPI under the name xnns; the import name and the xnn command are unchanged.

Acknowledgements

This package was created with the molssi-seamm/cookiecutter-seamm-plugin tool, which is based on the excellent Cookiecutter.

Developed by the Molecular Sciences Software Institute (MolSSI), which receives funding from the National Science Foundation under award CHE-2136142.

History

2026.9.19 (2026-09-19)

  • Model directories in xnn.ini may be given as personal:<subdir> (~/.seamm.d/data/Forcefields/<subdir>) or local:<subdir> (~/SEAMM/data/Forcefields/<subdir>), the same convention as the Forcefield step; the default is personal:xnn then local:xnn, a personal model shadowing a machine one of the same name. Each model’s source (e.g. personal:xnn/water.pt) is reported to the Model Chemistry step.

  • Installs xnn from PyPI as xnns; documents the Apple mps constraints.

2026.9.18 (2026-09-18)

  • Initial release. Provides xnn machine-learned force fields as xnn:MLFF@<model> model chemistries (checkpoints discovered from the directories in xnn.ini) and launches xnn mdi as the MDI engine for the Energy, LAMMPS and other MDI-driving steps. Includes xnn-step-installer for the seamm-xnn conda environment.

  • Plug-in created using the SEAMM plug-in cookiecutter.

Metadata

Release files for xnn-step 2026.9.19

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

Source distribution (sdist)

Source distribution for xnn-step 2026.9.19
File Size Uploaded
xnn_step-2026.9.19.tar.gz 314.5 kB Details

Built distribution (wheel)

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

Total release size: 337.3 kB

Release files / xnn_step-2026.9.19.tar.gz

Download URL xnn_step-2026.9.19.tar.gz
Size 314.5 kB
Tags Source
SHA-256 checksum
How to use checksums
dfeca1d6d84c9f48e032bc5fad1a8a92da162cab4318339c7256f1ca92cee1f0
BLAKE2b-256 checksum
How to use checksums
d2f7fa10930cdc005129c72a5af027b1a32c7b7274dcbf8d2573419cb726e758
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.14

Release files / xnn_step-2026.9.19-py2.py3-none-any.whl

Download URL xnn_step-2026.9.19-py2.py3-none-any.whl
Size 22.8 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
ef4885885832b5e7423fbd4c6316de31628831fe9e8599b1fad8d393c6c2c619
BLAKE2b-256 checksum
How to use checksums
143c7b50fa860bffbffffdc704ae1e23ad38c79302c06786231e458ba0a8fc2e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.14

Release history Release notifications | RSS feed

This release

2026.9.19 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