Skip to content

Commit

Permalink
Merge branch 'master' of github.com:lrcfmd/ElMD
Browse files Browse the repository at this point in the history
  • Loading branch information
SurgeArrester committed Mar 15, 2024
2 parents 6daebb6 + 477b1eb commit ab6dc38
Showing 1 changed file with 9 additions and 3 deletions.
12 changes: 9 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ This repository provides the reference implementations as described in our paper

If you wish to compute this metric between lots of compositions, the ElM2D high-performance library may be more useful and can be found at www.github.com/lrcfmd/ElM2D.

We reccomend installation via pip
We recommend installation via pip

```
pip install ElMD
Expand Down Expand Up @@ -172,10 +172,16 @@ A feature vector of length 8076 can be generated by concatenating the weighted m
> x = ElMD("NaCl").full_feature_vector()
```

## Documentation
When using 1D unpooled elemental vectors, these may be mapped to the associated chemical formula using the `vec_to_formula` method:

Complete documentation may be found at www.elmd.io/api
```python
x = ElMD("CaTiO3")
y = ElMD("NaCl")

print(x.pretty_formula)
print(x.vec_to_formula(x.feature_vector)) # Same as above
print(y.vec_to_formula(x.feature_vector)) # Same as above
```

## Citing

Expand Down

0 comments on commit ab6dc38

Please sign in to comment.