feos

(โ˜… 193)

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

  • .gitignore
  • Cargo.toml
  • CHANGELOG.md
  • CITATION.bib
  • docs-header.html
  • license-apache
  • license-mit
  • README.md

# Installation Guide

1. Get the code
git clone https://github.com/feos-org/feos

Downloads the entire project code from GitHub to your computer.

cd feos

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
Prerequisites
  • Python 3 Python is required to use pip.
pip install feos

Installs the package published on PyPI directly โ€” no need to clone the source.

pip install git+https://github.com/feos-org/feos

Installs the package published on PyPI directly โ€” no need to clone the source.

โœ… After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Python

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.
pip install feos

Installs the package published on PyPI directly โ€” no need to clone the source.

pip install git+https://github.com/feos-org/feos

Installs the package published on PyPI directly โ€” no need to clone the source.

โœ… If it runs without errors and prints output in the terminal, it worked.

Pulled directly from this repo's README.

4. Rust

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Rust (rustup) Installing via rustup also installs cargo.
cargo test --release

Type this command into your terminal and run it.

cargo test --release --features pcsaft

Type this command into your terminal and run it.

cargo test --release --features all_models

Type this command into your terminal and run it.

โœ… If cargo build finishes without errors, it worked. The executable is created under target/.

Pulled directly from this repo's README.

// repository documentation