Machine-Learned Interatomic Potential eXploration
mlipx is a Python library designed for evaluating machine-learned interatomic
potentials (MLIPs). It offers a growing set of evaluation methods alongside
powerful visualization and comparison tools.
The goal of mlipx is to provide a common platform for MLIP evaluation and to
facilitate sharing results among researchers. This allows you to determine the
applicability of a specific MLIP to your research and compare it against others.
Installation
Install mlipx via pip:
pip install mlipx
Quickstart
This section provides a brief overview of the core features of mlipx. For more detailed instructions, visit the documentation.
Most recipes support different input formats, such as data file paths, SMILES strings, or Materials Project structure IDs.
Energy-Volume Curve
Compute an energy-volume curve using the mp-1143 structure from the Materials Project and MLIPs such as mace-mpa-0, sevennet, and orb-v2:
mlipx recipes ev --models mace-mpa-0,sevennet,orb-v2 --material-ids=mp-1143 --repro
mlipx compare --glob "*EnergyVolumeCurve"
Below is an example of the resulting comparison:
Structure Optimization
Compare the performance of different models in optimizing multiple molecular structures from SMILES representations:
mlipx recipes relax --models mace-mpa-0,sevennet,orb-v2 --smiles "CCO,C1=CC2=C(C=C1O)C(=CN2)CCN" --repro
mlipx compare --glob "*0_StructureOptimization"
mlipx compare --glob "*1_StructureOptimization"
Nudged Elastic Band (NEB)
Run and compare nudged elastic band (NEB) calculations for a given start and end structure:
mlipx recipes neb --models mace-mpa-0,sevennet,orb-v2 --datapath ../data/neb_end_p.xyz --repro
mlipx compare --glob "*NEBs"
Python API
You can also use all the recipes from the mlipx command-line interface
programmatically in Python.
import mlipx
# Initialize the project
project = mlipx.Project()
# Define an MLIP
mace_mp = mlipx.GenericASECalculator(
module="mace.calculators",
class_name="mace_mp",
device="auto",
kwargs={
"model": "medium",
},
)
# Use the MLIP in a structure optimization
with project:
data = mlipx.LoadDataFile(path="/your/data/file.xyz")
relax = mlipx.StructureOptimization(
data=data.frames,
data_id=-1,
model=mace_mp,
fmax=0.1
)
# Reproduce the project state
project.repro()
# Access the results
print(relax.frames)
# >>> [ase.Atoms(...), ...]
Metadata
Release files for mlipx 0.1.5
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| mlipx-0.1.5.tar.gz | 3.7 MB | Without provenance | Details for mlipx-0.1.5.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| mlipx-0.1.5-py3-none-any.whl | Python 3 | none | any | Details for mlipx-0.1.5-py3-none-any.whl |
Total release size: 3.8 MB
Release files / mlipx-0.1.5.tar.gz
| Download URL | mlipx-0.1.5.tar.gz |
|---|---|
| Size | 3.7 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
1a0dbe96a7d0b85f40a0ac8f5f8d9eb163e6e32983114f0030106c2f539f3895
|
|
BLAKE2b-256 checksum How to use checksums |
e4c11a8d477eeea567a8139bb46531f1a19456c2b8baab117ff3c811ec705aa4
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.7.12
|
Release files / mlipx-0.1.5-py3-none-any.whl
| Download URL | mlipx-0.1.5-py3-none-any.whl |
|---|---|
| Size | 73.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
bd07636c385ee36357255bd289e9bc27c3833ff6cc5f65bca29d87d5bccb9991
|
|
BLAKE2b-256 checksum How to use checksums |
b6adac2fba9cc24c4f18048c671e5ef7495bbf86eba0acc8450907f3d4e52dd9
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.7.12
|
Security for mlipx 0.1.5
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.