Skip to main content

FeNNol: Force-field-enhanced Neural Network optimized library

Project description

PyPI - Version DOI:10.1063/5.0217688

FeNNol: Force-field-enhanced Neural Networks optimized library

FeNNol is a library for building, training and running neural network potentials for molecular simulations. It is based on the JAX library and is designed to be fast and flexible.

FeNNol's documentation is available here and the article describing the library at https://doi.org/10.1063/5.0217688

Active Learning tutorial in this Colab notebook

Installation

From PyPI

# CPU version
pip install fennol

# GPU version
pip install "fennol[cuda]"

Latest version from Github repo

You can start with a fresh environment, for example using venv:

python -m venv fennol
source fennol/bin/activate

The first step is to install jax (see details at: https://jax.readthedocs.io/en/latest/installation.html). For example, to install the latest version using pip:

# CPU version
pip install -U jax

# GPU version
pip install -U "jax[cuda12]"

Then, you can clone the repo and install FeNNol using pip:

git clone https://github.com/FeNNol-tools/FeNNol.git
cd FeNNol
pip install .

Optional dependencies

pip install --upgrade e3nn-jax
  • The provided training script requires pytorch (at least the cpu version) for dataloaders:
pip install torch --index-url https://download.pytorch.org/whl/cpu
  • For the Deep-HP interface, cffi and pycuda are required:
pip install cffi pycuda

Examples

To learn how to train a FeNNol model, you can check the examples in the examples/training directory. The README.md file in that directory contains instructions on how to train a model on the aspirin revMD17 dataset.

To learn how to run molecular dynamics simulations with FeNNol models, you can check the examples in the examples/md directory. The README.md file in that directory contains instructions on how to run simulations with the provided ANI-2x model.

Citation

Please cite this paper if you use the library.

T. Plé, O. Adjoua, L. Lagardère and J-P. Piquemal. FeNNol: an Efficient and Flexible Library for Building Force-field-enhanced Neural Network Potentials. J. Chem. Phys. 161, 042502 (2024)
@article{ple2024fennol,
    author = {Plé, Thomas and Adjoua, Olivier and Lagardère, Louis and Piquemal, Jean-Philip},
    title = {FeNNol: An efficient and flexible library for building force-field-enhanced neural network potentials},
    journal = {The Journal of Chemical Physics},
    volume = {161},
    number = {4},
    pages = {042502},
    year = {2024},
    month = {07},
    doi = {10.1063/5.0217688},
    url = {https://doi.org/10.1063/5.0217688},
}

License

This project is licensed under the terms of the GNU LGPLv3 license. See LICENSE for additional 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

fennol-2026.4.2.post1.tar.gz (10.3 MB view details)

Uploaded Source

Built Distribution

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

fennol-2026.4.2.post1-py3-none-any.whl (1.1 MB view details)

Uploaded Python 3

File details

Details for the file fennol-2026.4.2.post1.tar.gz.

File metadata

  • Download URL: fennol-2026.4.2.post1.tar.gz
  • Upload date:
  • Size: 10.3 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for fennol-2026.4.2.post1.tar.gz
Algorithm Hash digest
SHA256 f3b5f7b2f48e0abeeb4c3aef926b9b8395cd97a4e5bde3cc06022bc1b84c214e
MD5 28fdc10862079065781c794406e86435
BLAKE2b-256 488bc19df376f1b8815e3a28ed33320a96ffdc594eb7476976997b3864eb0ba5

See more details on using hashes here.

Provenance

The following attestation bundles were made for fennol-2026.4.2.post1.tar.gz:

Publisher: publish-to-pypi.yml on FeNNol-tools/FeNNol

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

File details

Details for the file fennol-2026.4.2.post1-py3-none-any.whl.

File metadata

File hashes

Hashes for fennol-2026.4.2.post1-py3-none-any.whl
Algorithm Hash digest
SHA256 c3f47781d03847607dca6792fbfaa2219da9dca8b47a51edebf078eb2bede860
MD5 e2c79c071cedf721754c0c416bb38630
BLAKE2b-256 f3df77368f3405f9e042076bdc9deea125c27eec3feb00400858e66bb98f21f6

See more details on using hashes here.

Provenance

The following attestation bundles were made for fennol-2026.4.2.post1-py3-none-any.whl:

Publisher: publish-to-pypi.yml on FeNNol-tools/FeNNol

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