Metadata-Version: 2.1
Name: ase_extension
Version: 0.3.0
Requires-Dist: ase
Requires-Dist: numpy
License-File: LICENSE
Requires-Python: >=3.7
Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM

# ase_extension

Extension to ASE(atomistic simulation environment), written in Rust and Python.

## Features

- `ase_extension.constraints.LogFermiWallPotential`: Constrain atoms in sphere with logfermi potential
- `ase_extension.geometry.RMSD`: Minimum RMSD between molecules and its gradient
- `ase_extension.neighborlist.neighbor_list`: Drop-in replacement for `ase.neighborlist.neighbor_list`.

Note that `LogFermiWallPotential` and  `RMSD` does not support PBC yet.

## Installation


### With pypi

pip install ase_extension

### From source 

Install `maturin` first, and do:
```bash
pip install git+https://github.com/mjhong0708/ase_extension
```

## User guide

See [wiki](https://github.com/mjhong0708/ase_extension/wiki).


## Features to add

- [ ] Molecule packer for MD (like packmol, but supports PBC)

