Skip to content

Latest commit

 

History

History
61 lines (39 loc) · 2.92 KB

File metadata and controls

61 lines (39 loc) · 2.92 KB

FeOs - A Framework for Equations of State and Classical Density Functional Theory

documentation repository

The FeOs package conveniently provides bindings to the Rust implementations of different equation of state and Helmholtz energy functional models in a single Python package.

Models

The following models are currently published as part of the FeOs framework

name description eos dft
feos-pcsaft perturbed-chain (polar) statistical associating fluid theory 🗸 🗸
feos-gc-pcsaft (heterosegmented) group contribution PC-SAFT 🗸 🗸

The list is being expanded continuously. Currently under development are implementations of ePC-SAFT and equations of state/Helmholtz energy functionals for model fluids like LJ and Mie fluids.

Other public repositories that implement models within the FeOs framework, but are currently not part of the feos Python package, are

name description eos dft
feos-fused-chains heterosegmented fused-sphere chain functional 🗸

Installation

FeOs can be installed via pip and runs on Windows, Linux and macOS:

pip install feos

Building from source

To compile the code you need the Rust compiler (rustc >= 1.53) and maturin installed. To install the package directly into the active environment, use

maturin develop --release

To build wheels, use

maturin build --release --out dist --no-sdist

Documentation

For a documentation of the Python API, Python examples, and a guide to the underlying Rust framework check out the documentation.

Developers

This software is currently maintained by members of the groups of

Contributing

FeOs grew from the need to maintain a common codebase used within the scientific work done in our groups. We share the code publicly as a platform to publish our own research but also encourage other researchers and developers to contribute their own models or implementations of existing equations of state.

If you want to contribute to FeOs, there are several ways to go: improving the documentation and helping with language issues, testing the code on your systems to find bugs, adding new models or algorithms, or providing feature requests. Feel free to message us if you have questions or open an issue in this or the model-specific repositories to discuss improvements.