Skip to content

Commit 096b298

Browse files
committed
update readme
1 parent 9206b6c commit 096b298

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,19 @@
11
# FeOs - A Framework for Equations of State and Classical Density Functional Theory
22

3-
[![crate](https://img.shields.io/crates/v/feos.svg)](https://crates.io/crates/feos)
4-
[![documentation](https://docs.rs/feos/badge.svg)](https://docs.rs/feos)
5-
[![documentation](https://img.shields.io/badge/docs-github--pages-blue)](https://feos-org.github.io/feos/)
6-
[![repository](https://img.shields.io/pypi/v/feos)](https://pypi.org/project/feos/)
3+
[![crate](https://img.shields.io/crates/v/feos?logo=rust)](https://crates.io/crates/feos)
4+
[![documentation](https://img.shields.io/docsrs/feos?logo=rust)](https://docs.rs/feos)
5+
[![repository](https://img.shields.io/pypi/v/feos?logo=python)](https://pypi.org/project/feos/)
6+
[![documentation](https://img.shields.io/badge/docs-github--pages-blue?logo=python)](https://feos-org.github.io/feos/)
77
[![FeOs Publication](https://img.shields.io/badge/DOI-10.1021/acs.iecr.2c04561-passing)](https://pubs.acs.org/doi/10.1021/acs.iecr.2c04561)
88

99
The `FeOs` package provides Rust implementations of different equation of state and Helmholtz energy functional models and corresponding Python bindings.
1010

1111
```python
12-
from feos import EquationOfState, State
13-
from feos.parameters import PureRecord, Identifier, Parameters
12+
import feos
1413

1514
# PC-SAFT parameters for methanol (Gross and Sadowski 2002)
16-
record = PureRecord(
17-
Identifier(name="methanol"),
15+
record = feos.PureRecord(
16+
feos.Identifier(name="methanol"),
1817
molarweight=32.04,
1918
m=1.5255,
2019
sigma=3.23,
@@ -26,11 +25,11 @@ record = PureRecord(
2625
)
2726

2827
# Build an equation of state
29-
parameters = Parameters.new_pure(record)
30-
eos = EquationOfState.pcsaft(parameters)
28+
parameters = feos.Parameters.new_pure(record)
29+
eos = feos.EquationOfState.pcsaft(parameters)
3130

3231
# Define thermodynamic conditions
33-
critical_point = State.critical_point(eos)
32+
critical_point = feos.State.critical_point(eos)
3433

3534
# Compute properties
3635
p = critical_point.pressure()
@@ -122,6 +121,7 @@ To compile the code you need the Rust compiler and `maturin` installed.
122121
To install the package directly into the active environment (virtualenv or conda), use
123122

124123
```
124+
cd py-feos
125125
maturin develop --release
126126
```
127127

@@ -130,7 +130,7 @@ which uses the `python` and `all_models` feature as specified in the `pyproject.
130130
Alternatively, you can specify the models or features that you want to include in the python package explicitly, e.g.
131131

132132
```
133-
maturin develop --release --features "python pcsaft dft"
133+
maturin develop --release --features "pcsaft dft"
134134
```
135135

136136
for the PC-SAFT equation of state and Helmholtz energy functional.

0 commit comments

Comments
 (0)