Skip to content

Commit dc9b344

Browse files
committed
update readme for new installation options.
1 parent 6fe8261 commit dc9b344

File tree

2 files changed

+17
-2
lines changed

2 files changed

+17
-2
lines changed

README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@
2121
Installing **DeePTB** is straightforward. We recommend using a virtual environment for dependency management.
2222

2323
### Requirements
24+
- Cmake 3.17 or later.
2425
- Python 3.8 or later.
2526
- Torch 1.13.0 or later ([PyTorch Installation](https://pytorch.org/get-started/locally)).
2627
- ifermi (optional, for 3D fermi-surface plotting).
@@ -45,6 +46,20 @@ Installing **DeePTB** is straightforward. We recommend using a virtual environme
4546
pip install .
4647
```
4748

49+
### Install optical response module
50+
1. Ensure you have the intel MKL library installed.
51+
52+
2. Clone the repository:
53+
```bash
54+
git clone https://github.com/deepmodeling/DeePTB.git
55+
```
56+
3. Navigate to the root directory and install DeePTB:
57+
```bash
58+
cd DeePTB
59+
BUILD_FORTRAN=ON USE_INTEL=ON USE_OPENMP=ON pip install .
60+
```
61+
Note: by default, the optical response module is not installed. To install it, you need to set the `BUILD_FORTRAN=ON` flag. The `USE_INTEL=ON` flag is used to enable the Intel MKL library, and the `USE_OPENMP=ON` flag is used to enable OpenMP parallelization. Both `USE_INTEL` and `USE_OPENMP` are `ON` by default.
62+
4863
## Usage
4964
For a comprehensive guide and usage tutorials, visit [our documentation website](https://deeptb.readthedocs.io/en/latest/).
5065

pyproject.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -69,8 +69,8 @@ provider = "scikit_build_core.metadata.setuptools_scm"
6969
[tool.scikit-build.cmake.define]
7070
CMAKE_POSITION_INDEPENDENT_CODE = "ON"
7171
BUILD_FORTRAN = {env="BUILD_FORTRAN", default="OFF"}
72-
USE_OPENMP = {env="USE_OPENMP", default="OFF"}
73-
USE_INTEL = {env="USE_INTEL", default="OFF"}
72+
USE_OPENMP = {env="USE_OPENMP", default="ON"}
73+
USE_INTEL = {env="USE_INTEL", default="ON"}
7474
# FORTRAN_COMPILER = {env="FORTRAN_COMPILER", default=""}
7575
CMAKE_C_COMPILER = "icx"
7676
CMAKE_Fortran_COMPILER = "ifx"

0 commit comments

Comments
 (0)