Skip to main content

The python distribution for the FALCON on-the-fly Machine Learning ab initio Molecular Dynamics code

Project description

FALCON

This work presents the FALCON (Fast Active Learning for Computational ab initio mOlecular dyNamics) calculator where the ML model is trained on-the-fly (OTF) and uses its own uncertainty estimation to decide whether an exact calculation is required.

Alt text

The FALCON calculator can be used with any machine learning model. A base class is provided in order to make different ML frameworks work together with FALCON. However, as standart the Gaussian Process Regression (GPR) and its sparsified versions (SparseGPR) as implemented in the AGOX framework by Hammer and co-workers is implemented as default ML models.

Authors

Noah Felis
Wilke Dononelli


Requirements

  • Python_ 3.8 or later
  • NumPy_ (base N-dimensional array package)
  • ase_ 3.23 (functions to determine atomic structures' geometries and quantum chemical calculators)
  • agox (Atomistic Global Optimization X)

Installation

FALCON can be installed by installing it using pip:

pip install falcon-md

Alternatively, you can clone the Git repository:

git clone https://github.com/thequantumchemist/falcon

and add ~/falcon_md to your $PYTHONPATH environment variable.


Tutorial

The tutorial directory of this repository contains three example scripts demonstrating how to use FALCON and introduce its main concepts:.

  1. Basic OTF molecular dynamics with a default ML model.
  2. Advanced OTF training with a customized Sparse Gaussian Process model.
  3. Postprocessing and analysis of simulation results.

A detailed explanation is given in the README.md in the tutorial directory.


Citation

When using FALCON, please cite:

Felis, N., Dononelli, W. (2025). FALCON: fast active learning for machine learning potentials in atomistic and ab initio molecular dynamics simulations. npj Comput. Mater., https://doi.org/10.1038/s41524-025-01897-8

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

falcon_md-1.3.0.tar.gz (38.9 kB view details)

Uploaded Source

Built Distribution

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

falcon_md-1.3.0-py3-none-any.whl (41.3 kB view details)

Uploaded Python 3

File details

Details for the file falcon_md-1.3.0.tar.gz.

File metadata

  • Download URL: falcon_md-1.3.0.tar.gz
  • Upload date:
  • Size: 38.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for falcon_md-1.3.0.tar.gz
Algorithm Hash digest
SHA256 515be1cfec116e5cb71b1aae94c8c70b0df3ec99de040acdff61820230a8f983
MD5 b4af8d5913cd1689548730cc5f80966a
BLAKE2b-256 dfac374908fde96a19f1e1c8a3e83c405eb5aada39a4ea0084d635ec35f2fcf2

See more details on using hashes here.

Provenance

The following attestation bundles were made for falcon_md-1.3.0.tar.gz:

Publisher: python-publish.yml on thequantumchemist/falcon

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

File details

Details for the file falcon_md-1.3.0-py3-none-any.whl.

File metadata

  • Download URL: falcon_md-1.3.0-py3-none-any.whl
  • Upload date:
  • Size: 41.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for falcon_md-1.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3a1c1edb906a4017bfb0e112f27ccc2d418df1356f7d468ad1a12713a22e3191
MD5 6410c4076ba9af571b5a961b3cdc837f
BLAKE2b-256 21f734145c04956dcb8b9e9ee79097d33afd075e2969849f1bf0c4d2a5d5d36f

See more details on using hashes here.

Provenance

The following attestation bundles were made for falcon_md-1.3.0-py3-none-any.whl:

Publisher: python-publish.yml on thequantumchemist/falcon

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