Skip to main content

Atomistic Learned Potential Package in JAX

Project description

apax: Atomistic learned Potentials in JAX!

Read the Docs DOI DOI License: MIT Discord

apax[^1][^2] is a high-performance, extendable package for training of and inference with atomistic neural networks. It implements the Gaussian Moment Neural Network model [^3][^4]. It is based on JAX and uses JaxMD as a molecular dynamics engine.

Installation

Apax is available on PyPI with a CPU version of JAX.

pip install apax

If you want to enable GPU support (only on Linux), please run

pip install "apax[cuda]"

For more detailed instructions, please refer to the documentation.

Usage

Your first apax Model

In order to train a model, you need to run

apax train config.yaml

We offer some input file templates to get new users started as quickly as possible. Simply run the following commands and add the appropriate entries in the marked fields

apax template train # use --full for a template with all input options

Please refer to the documentation for a detailed explanation of all parameters. The documentation can convenienty be accessed by running apax docs.

Molecular Dynamics

There are two ways in which apax models can be used for molecular dynamics out of the box. High performance NVT simulations using JaxMD can be started with the CLI by running

apax md config.yaml md_config.yaml

A template command for MD input files is provided as well.

The second way is to use the ASE calculator provided in apax.md.

Input File Auto-Completion

use the following command to generate JSON schemata for training and MD configuration files:

apax schema

If you are using VSCode, you can utilize them to lint and autocomplete your input files. The command creates the 2 schemata and adds them to the projects .vscode/settings.json

Authors

  • Moritz René Schäfer
  • Nico Segreto

Under the supervion of Johannes Kästner

Contributing

We are happy to receive your issues and pull requests!

Do not hesitate to contact any of the authors above if you have any further questions.

Acknowledgements

The creation of Apax was supported by the Deutsche Forschungsgemeinschaft (DFG, German Research Foundation) in the framework of the priority program SPP 2363, “Utilization and Development of Machine Learning for Molecular Applications - Molecular Machine Learning” Project No. 497249646 and the Ministry of Science, Research and the Arts Baden-Württemberg in the Artificial Intelligence Software Academy (AISA). Further funding though the DFG under Germany's Excellence Strategy - EXC 2075 - 390740016 and the Stuttgart Center for Simulation Science (SimTech) was provided.

References

[^1]: Moritz René Schäfer, Nico Segreto, Fabian Zills, Christian Holm, Johannes Kästner, Apax: A Flexible and Performant Framework For The Development of Machine-Learned Interatomic Potentials, J. Chem. Inf. Model. 65, 8066-8078 (2025) [^2]: 10.5281/zenodo.10040711 [^3]: V. Zaverkin and J. Kästner, “Gaussian Moments as Physically Inspired Molecular Descriptors for Accurate and Scalable Machine Learning Potentials,” J. Chem. Theory Comput. 16, 5410–5421 (2020). [^4]: V. Zaverkin, D. Holzmüller, I. Steinwart, and J. Kästner, “Fast and Sample-Efficient Interatomic Neural Network Potentials for Molecules and Materials Based on Gaussian Moments,” J. Chem. Theory Comput. 17, 6658–6670 (2021).

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

apax-0.14.0.tar.gz (664.4 kB view details)

Uploaded Source

Built Distribution

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

apax-0.14.0-py3-none-any.whl (176.3 kB view details)

Uploaded Python 3

File details

Details for the file apax-0.14.0.tar.gz.

File metadata

  • Download URL: apax-0.14.0.tar.gz
  • Upload date:
  • Size: 664.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.10.11 {"installer":{"name":"uv","version":"0.10.11","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for apax-0.14.0.tar.gz
Algorithm Hash digest
SHA256 382805333c049d427702ad7cf47ed0dff28b81b476097917407a7967addb5003
MD5 336b02026267301b5a8ecc7dbd5d0e03
BLAKE2b-256 93f293358c8131e27bfa8ba7931e856af8ffef537ea2dc714555cb61f076b243

See more details on using hashes here.

File details

Details for the file apax-0.14.0-py3-none-any.whl.

File metadata

  • Download URL: apax-0.14.0-py3-none-any.whl
  • Upload date:
  • Size: 176.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.10.11 {"installer":{"name":"uv","version":"0.10.11","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for apax-0.14.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a72d7c69be5ac959fd07a2f902f16d8364b9c5540ad7f04509947d6a1ec2debc
MD5 b2cbf36a44cf7ca73726950dfaa5a6e9
BLAKE2b-256 edd1d6678d40fa12f5336e223706a136f6a8866c13e3e883c66e4f6217a6764a

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