Skip to content

Latest commit

 

History

History
94 lines (63 loc) · 2.58 KB

README.rst

File metadata and controls

94 lines (63 loc) · 2.58 KB

fpi

Version_status

Downloads

Build_status

license

Coverage

What is fpi?

fpi is open-source software for engineers and technicians working in the fields of chemical or mechanical engineering. It includes modules for various fluid-particle interaction calculations..

The fpi library depends on the SciPy library to provide numerical constants, interpolation, integration, and numerical solving functionality. fpi runs on all operating systems which support Python, is quick to install, and is free of charge. fpi is designed to be easy to use while still providing powerful functionality. If you need to perform some fpi calculations, give fpi a try.

Installation

Get the latest version of fpi from https://pypi.python.org/pypi/fpi/

If you have an installation of Python with pip, simple install it with:

$ pip install fpi

To get the git version, run:

$ git clone git://github.com/CalebBell/fpi.git

Documentation

fpi's documentation is available on the web:

https://fpi.readthedocs.org/en/latest/index.html

Latest source code

The latest development version of fpi's sources can be obtained at

https://github.com/CalebBell/fpi

Bug reports

To report bugs, please use the fpi's Bug Tracker at:

https://github.com/CalebBell/fpi/issues

License information

See LICENSE.txt for information on the terms & conditions for usage of this software, and a DISCLAIMER OF ALL WARRANTIES.

Although not required by the fpi license, if it is convenient for you, please cite fpi if used in your work. Please also consider contributing any changes you make back, such that they may be incorporated into the main library and all of us will benefit from them.

Citation

To cite fpi in publications use:

Caleb Bell (2016). fpi: Fluid-Particle Interaction component of Chemical Engineering Design Library (ChEDL)
https://github.com/CalebBell/fpi.