Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Add Conda instructions
  • Loading branch information
AntObi authored Aug 7, 2024
1 parent 795e6e0 commit ab02a1f
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
[![codecov](https://codecov.io/gh/WMD-group/ElementEmbeddings/branch/main/graph/badge.svg?token=OCMIM5SHL0)](https://codecov.io/gh/WMD-group/ElementEmbeddings)
[![DOI](https://zenodo.org/badge/493285385.svg)](https://zenodo.org/badge/latestdoi/493285385)
[![PyPI](https://img.shields.io/pypi/v/ElementEmbeddings)](https://pypi.org/project/ElementEmbeddings/)
[![Conda](https://anaconda.org/conda-forge/elementembeddings/badges/version.svg)](https://anaconda.org/conda-forge/elementembeddings)
[![documentation](https://img.shields.io/badge/docs-mkdocs%20material-blue.svg?style=flat)](https://wmd-group.github.io/ElementEmbeddings/)
![python version](https://img.shields.io/pypi/pyversions/elementembeddings)

Expand Down Expand Up @@ -42,6 +43,12 @@ The latest stable release can be installed via pip using:
pip install ElementEmbeddings
```

Alternatively, ElementEmbeddings is available via conda through the conda-forge channel on Anaconda Cloud:

```bash
conda install -c conda-forge elementembeddings
```

For installing the development or documentation dependencies via pip:

```bash
Expand Down Expand Up @@ -185,4 +192,4 @@ The steps required to add a new representation scheme are:

[H. Park et al, "Mapping inorganic crystal chemical space" *Faraday Discuss.* (2024)](https://pubs.rsc.org/en/content/articlelanding/2024/fd/d4fd00063c)

[A. Onwuli et al, "Element similarity in high-dimensional materials representations" *Digital Discovery* **2**, 1558 (2023)](https://pubs.rsc.org/en/content/articlelanding/2023/dd/d3dd00121k)
[A. Onwuli et al, "Element similarity in high-dimensional materials representations" *Digital Discovery* **2**, 1558 (2023)](https://pubs.rsc.org/en/content/articlelanding/2023/dd/d3dd00121k)

0 comments on commit ab02a1f

Please sign in to comment.