Skip to content
This repository was archived by the owner on Sep 14, 2022. It is now read-only.

More detailed README #21

Merged
prehner merged 6 commits into from
Jan 12, 2022
Merged

More detailed README #21

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
2d3275f
More detailed README
prehner Jan 12, 2022
b6cd8ec
update README
prehner Jan 12, 2022
ae08c7e
fix link
prehner Jan 12, 2022
343223c
Add text for parameter section
prehner Jan 12, 2022
83f9f0a
update Cargo.toml
prehner Jan 12, 2022
8c5d058
add CHANGELOG
prehner Jan 12, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
update README
  • Loading branch information
@prehner
prehner committed Jan 12, 2022
commit b6cd8ec634feddde8cc72819006ed004e20e1638
16 changes: 14 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,23 @@
# FeOs-PC-SAFT
# FeOs - PC-SAFT

[![crate](https://img.shields.io/crates/v/feos-pcsaft.svg)](https://crates.io/crates/feos-pcsaft)
[![documentation](https://docs.rs/feos-pcsaft/badge.svg)](https://docs.rs/feos-pcsaft)
[![documentation](https://img.shields.io/badge/docs-github--pages-blue)](https://feos-org.github.io/feos/)

Implementation of the PC(P)-SAFT equation of state[^gross2001][^gross2005][^gross2006] and Helmholtz energy functional[^sauer2016] in the FeOs framework.
Implementation of the PC(P)-SAFT equation of state[^gross2001][^gross2005][^gross2006] and corresponding Helmholtz energy functional[^sauer2016] within the FeOs project. This project contains a Rust implementation as well as bindings to Python.

## Usage in Python

If you want to use `feos-pcsaft` in Python, take a look at the [`feos`-repository](https://github.com/feos-org/feos). `feos` contains multiple equation of state implementations in a single, easy-to-use Python package.

## FeOs

> FeOs is a framework for equations of state and classical density function theory

You can learn more about the principles behind `FeOs` [here](https://feos-org.github.io/feos/).


## Parameters
[parameters](parameters/README.md)

[^gross2001]: [J. Gross and G. Sadowski (2001). *Industrial & Engineering Chemistry Research*, 40(4), 1244-1260.]([https:://](https://doi.org/10.1021/ie0003887))
Expand Down