Skip to content

Commit

Permalink
added installation from source
Browse files Browse the repository at this point in the history
  • Loading branch information
@bowen-bd
bowen-bd committed Oct 9, 2023
1 parent 20ebc58 commit 030d897
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,14 @@ Pretrained CHGNet achieves SOTA performance on materials stability prediction fr
pip install chgnet
```

if pypi installation fails, you can try installation from source:

```sh
git clone https://github.com/CederGroupHub/chgnet.git
cd chgnet
pip install -e .
```

## Docs

View [API docs](https://cedergrouphub.github.io/chgnet/api).
Expand Down

2 comments on commit 030d897

@KarimElgammal
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can also recommend installation via: pip install git+https://github.com/CederGroupHub/chgnet.git

@bowen-bd
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@KarimElgammal Good suggestion, I'll update this later

Please sign in to comment.