Skip to content

Commit c312c37

Browse files
committed
update readme.md
1 parent 477b3f7 commit c312c37

File tree

2 files changed

+8
-3
lines changed

2 files changed

+8
-3
lines changed

dftd3/src/damping_param_usage.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ If your task is to retrive damping parameters of some specific xc-functionals, y
44

55
In this crate, you may have three ways to define customized parameters:
66

7-
- By `DFTD3***DampingParam` struct. In this way, all parameters (include optional parameters with default value) must be provided. For example of B3-Zero:
7+
- By `DFTD3***DampingParam` struct. In this way, all parameters (include optional parameters with default value) must be provided. For example of D3-Zero:
88

99
```rust
1010
# use dftd3::prelude::*;
@@ -21,7 +21,7 @@ In this crate, you may have three ways to define customized parameters:
2121
// this will give param: DFTD3Param
2222
```
2323

24-
- By `DFTD3***DampingParamBuilder` struct. In this way, optional parameters can be omitted. For example of B3-Zero:
24+
- By `DFTD3***DampingParamBuilder` struct. In this way, optional parameters can be omitted. For example of D3-Zero:
2525

2626
```rust
2727
# use dftd3::prelude::*;
@@ -34,7 +34,7 @@ In this crate, you may have three ways to define customized parameters:
3434
// this will give param: DFTD3Param
3535
```
3636

37-
- By `DFTD3Param` utility. In this way, all parameters must be provided. For example of B3-Zero:
37+
- By `DFTD3Param` utility. In this way, all parameters must be provided. For example of D3-Zero:
3838

3939
```rust
4040
# use dftd3::prelude::*;

readme.md

+5
Original file line numberDiff line numberDiff line change
@@ -123,6 +123,11 @@ If you have not compiled `s-dftd3` library, you may try out cargo feature `build
123123
### Cargo features of `dftd3-src`
124124

125125
- **`build_from_source`**: This will use CMake and meson, and pull code from github to first perform build for simple-dftd3. Though this option can be developer-friendly (you do not need to perform any other configurations to make program compile and run by cargo), `build_from_source` does not provide customized compilation.
126+
127+
CMake configurable variables (can be defined as environment variables):
128+
- `DFTD3_SRC`: git repository source directory or URL;
129+
- `DFTD3_VER`: version of DFT-D4 (default v1.2.1);
130+
126131
- **`static`**: This will link static libary instead of dynamic one. Please note that 1. static linking may require additional Fortran and OpenMP linking, which is not provided in this crate; 2. staticly linking LGPL-3.0 license may require your project to be GPL-3.0.
127132

128133
## License

0 commit comments

Comments
 (0)