Skip to content

Commit

Permalink
Merge pull request #10 from HPQC-LABS/documentation-improvements
Browse files Browse the repository at this point in the history
Add missing installation steps in the README.md
  • Loading branch information
fishjojo authored Mar 10, 2023
2 parents 994c00b + a337516 commit 5128e15
Showing 1 changed file with 20 additions and 5 deletions.
25 changes: 20 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,21 +8,35 @@ PySCF with Auto-differentiation
Installation
------------

* To install the latest release, use the following command:
---
* To install the latest release, use the following commands:
```
# install cmake
pip install cmake
# install OpenMP runtime used with clang
# On Linux:
sudo apt update
sudo apt install libomp-dev
# On OSX:
brew install libomp
# install pyscf
pip install 'pyscf @ git+https://github.com/fishjojo/pyscf.git@ad#egg=pyscf',
pip install 'pyscf-properties @ git+https://github.com/fishjojo/properties.git@ad',
pip install 'pyscf @ git+https://github.com/fishjojo/pyscf.git@ad#egg=pyscf'
pip install 'pyscf-properties @ git+https://github.com/fishjojo/properties.git@ad'
# install pyscfad
pip install pyscfad
```

* To install the development version, use the following command instead:
* To install the development version of pyscfad, use the following command instead:
```
pip install git+https://github.com/fishjojo/pyscfad.git
```
---

* Install dependencies manually
* To Install from source and install dependencies manually
```
pip install numpy scipy h5py
pip install jax jaxlib jaxopt
Expand All @@ -36,6 +50,7 @@ cd build; cmake ..; make
export PYTHONPATH=$HOME/pyscf:$PYTHONPATH
```

---
* Running pyscfad inside a docker container:
```
docker pull fishjojo/pyscfad:latest
Expand Down

0 comments on commit 5128e15

Please sign in to comment.