Skip to content

Commit b02b4e2

Browse files
authored
Update installation section in the documentation (#130)
1 parent 4d9de46 commit b02b4e2

File tree

1 file changed

+12
-5
lines changed

1 file changed

+12
-5
lines changed

docs/installation.md

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,20 +17,27 @@ pip install git+https://github.com/feos-org/feos
1717
1818
````{tab-item} Rust
1919
In Rust, the `feos-dft` crate and each equation of state or DFT functional is a separate, optional module behind a feature flag.
20-
To use {math}`\text{FeO}_\text{s}` with all models (including Python bindings), use the `all` feature:
20+
To use {math}`\text{FeO}_\text{s}` with all models (including Python bindings), use the `all_models` feature:
2121
2222
```toml
2323
[dependencies]
24-
feos = { version="0.2", features = ["all"] }
25-
quantity = "0.5"
24+
feos-core = "0.4"
25+
feos = { version="0.4", features = ["all_models"] }
26+
quantity = "0.6"
2627
```
2728
29+
To access the generic implementations for properties and phase equilibria, the `feos-core` crate is also included as dependency. Finally, {math}`\text{FeO}_\text{s}` makes extensive use of SI units provided by the `quantity` crate.
30+
2831
In the following example we use only the PC-SAFT equation of state and Helmholtz energy functionals (without Python bindings):
2932
3033
```toml
3134
[dependencies]
32-
feos = { version="0.2", features = ["dft", "pcsaft"] }
33-
quantity = "0.5"
35+
feos-core = "0.4"
36+
feos-dft = "0.4"
37+
feos = { version="0.4", features = ["dft", "pcsaft"] }
38+
quantity = "0.6"
3439
```
40+
41+
To access generic DFT functionalities like interfaces and adsorption isotherms, the `feos-dft` crate is added to the dependencies.
3542
````
3643
`````

0 commit comments

Comments
 (0)