https://github.com/calebbell/fpi
Fluid-particle Interaction component of Chemical Engineering Design Library (ChEDL)
https://github.com/calebbell/fpi
Last synced: 8 months ago
JSON representation
Fluid-particle Interaction component of Chemical Engineering Design Library (ChEDL)
- Host: GitHub
- URL: https://github.com/calebbell/fpi
- Owner: CalebBell
- License: gpl-3.0
- Created: 2016-04-04T02:46:58.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2016-08-06T17:11:13.000Z (almost 10 years ago)
- Last Synced: 2025-05-05T21:16:47.100Z (about 1 year ago)
- Language: Python
- Size: 33.2 KB
- Stars: 25
- Watchers: 2
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.rst
- License: LICENSE.txt
Awesome Lists containing this project
README
===
fpi
===
.. image:: http://img.shields.io/pypi/v/fpi.svg?style=flat
:target: https://pypi.python.org/pypi/fpi
:alt: Version_status
.. image:: http://img.shields.io/pypi/dm/fpi.svg?style=flat
:target: https://pypi.python.org/pypi/fpi
:alt: Downloads
.. image:: http://img.shields.io/travis/CalebBell/fpi/master.svg?style=flat
:target: https://travis-ci.org/CalebBell/fpi
:alt: Build_status
.. image:: http://img.shields.io/badge/license-GPL3-blue.svg?style=flat
:target: https://github.com/CalebBell/fpi/blob/master/LICENSE.txt
:alt: license
.. image:: https://img.shields.io/coveralls/CalebBell/fpi.svg
:target: https://coveralls.io/github/CalebBell/fpi
:alt: Coverage
.. contents::
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.