Skip to content

Commit

Permalink
Fix setup script and install guide
Browse files Browse the repository at this point in the history
  • Loading branch information
AllanChain committed Jun 5, 2024
1 parent cdc0fc0 commit 75f131c
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 6 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,15 @@ and [PyQMC](https://github.com/WagnerGroup/pyqmc).

DeepSolid can be installed via the supplied setup.py file.
```shell
pip3 install -e.
# Install with CPU only
pip3 install -e . -f https://storage.googleapis.com/jax-releases/jax_releases.html
# or with GPU
pip3 install -e . -f https://storage.googleapis.com/jax-releases/jax_cuda_releases.html
```

Python 3.9 is recommended.
If GPU is available, we recommend you to install jax and jaxlib with cuda 11.4+.
Our experiments were carried out with jax==0.2.26 and jaxlib==0.1.75.
Our experiments were carried out with `jax==0.2.26` and `jaxlib==0.1.75.`

## Usage

Expand Down
3 changes: 2 additions & 1 deletion bin/deepsolid
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
#! /usr/bin/env python3
# Copyright (c) ByteDance, Inc. and its affiliates.
# All rights reserved.
#
Expand Down Expand Up @@ -34,4 +35,4 @@ def main(_):


if __name__ == '__main__':
app.run(main)
app.run(main)
6 changes: 3 additions & 3 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,13 @@
'attrs',
"dataclasses",
"networkx",
"scipy",
"scipy==1.9.3",
"numpy",
"ordered-set",
"typing",
"chex==0.1.5",
"jax",
"jaxlib",
"jax==0.2.26",
"jaxlib==0.1.75",
"pandas",
"ml_collections",
"pyscf",
Expand Down

0 comments on commit 75f131c

Please sign in to comment.