Skip to content

Commit

Permalink
updated README to add features
Browse files Browse the repository at this point in the history
  • Loading branch information
alinelena committed Mar 15, 2024
1 parent 93fd190 commit 6bae15e
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,27 @@

Tools for machine learnt interatomic potentials

## Features (this is in development not all things work yet)

- [x] Supports multiple MLIPs
- MACE
- M3GNET
- CHGNET
- [x] Single point calculations
- [ ] Geometry optimisation
- [ ] Molecular Dynamics:
- NVE
- NVT (Langevin(Eijnden/Ciccotti flavour) and Nosé-Hoover (Melchionna flavour))
- NPT (Nosé-Hoover (Melchiona flavour)
- [ ] Nudge Elastic Bands
- [ ] phonons (via vibroscopy)
- [ ] training ML potentials (MACE only planned)
- [ ] fine tunning MLIPs (MACE only planned)
- [ ] Rare events simulations, via PLUMED

the code relies heavily on ASE, unless somethign else is mentioned.


## Development

1. Install [poetry](https://python-poetry.org/docs/#installation)
Expand Down

0 comments on commit 6bae15e

Please sign in to comment.