Skip to content

Commit

Permalink
Merge branch 'main' into feat/test_dgl_versions
Browse files Browse the repository at this point in the history
  • Loading branch information
mikemhenry authored Apr 30, 2024
2 parents f350dbf + 093de91 commit 27e3ad4
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 @@ -7,7 +7,28 @@ Standalone charge assignment from Espaloma framework. https://doi.org/10.1039/D2

## Installation

### conda-forge

We recomend installing `espaloma_charge` via conda-forge:

```bash
$ mamba create -n espaloma -c conda-forge espaloma_charge
```

If you plan on using [`openff-toolkit`](https://github.com/openforcefield/openff-toolkit), then install that as well when creating your `espaloma_charge` environment for optimal dependency solving:

```bash
$ mamba create -n espaloma -c conda-forge espaloma_charge openff-toolkit
```

### pypi

We also have `espaloma_charge` on pypi, but the `dgl` dependency must be installed first.

```bash
# First create a conda env with mamba, conda, or micromamba
$ mamba create -n espaloma -c conda-forge dgl==1.1.2 pip python
$ mamba activate espaloma
$ pip install espaloma_charge
```

Expand Down

0 comments on commit 27e3ad4

Please sign in to comment.