
Welcome to CoolProp 
===================

CoolProp is a thermophysical property database and wrappers for a selection of programming environments. 
It offers similar functionality to REFPROP, but CoolProp is open-source and free. 
It was originally developed by Ian Bell, at the time a post-doc at the University of Liege, in Liege, Belgium.

* CoolProp has flexible licensing terms: Commercial - ok! Academic? - ok! |ghlicense|

* For Python, get the latest release via ``pip install coolprop`` |pypidownloads| |pypiversion| 

* ... other binaries are available from `SourceForge <http://sourceforge.net/projects/coolprop/files>`_  |sfdownloads| |ghversion|

* There is also a bleeding edge nightly build of the `development version <http://sourceforge.net/projects/coolprop/files/CoolProp/nightly>`_ .

* The documentation is available for the `latest release <http://www.coolprop.org>`_ and the `development version <http://www.coolprop.org/dev>`_  

* For any kind of question regarding CoolProp and its usage, you can ask the `CoolProp Discussions <https://github.com/CoolProp/CoolProp/discussions>`_

* ... you might also find answers in our `FAQ <https://github.com/CoolProp/CoolProp/blob/master/FAQ.md>`_ 

* If you found a bug or have an issue that requires the developers to become active, please file an issue in our `issue tracker <https://github.com/CoolProp/CoolProp/issues>`_ 

* `Contributions <https://github.com/CoolProp/CoolProp/blob/master/.github/CONTRIBUTING.md>`_ to this project are welcomed and encouraged!  If you wish to `contribute <https://github.com/CoolProp/CoolProp/blob/master/.github/CONTRIBUTING.md>`_ bug fixes, patches, or new features, wrappers, or material properties, please submit a Pull Request with your code.

* If you are new to Git and Github, please see the `CoolProp Wiki <https://github.com/CoolProp/CoolProp/wiki>`_ for guidance on becoming a contributor to the project.

* Accelerate development of things you really need implemented by posting at `Bountysource <https://www.bountysource.com/teams/coolprop>`_ 

* Check Travis CI for build failures |travisbuilds| and have a look at the coverity stats |coveritystatus|

.. 
   Downloads and other stats
   -------------------------
   
   ===============  ==============================
   Binary release:  |sfdownloads| |ghversion| 
   PyPI release:    |pypidownloads| |pypiversion|
   ===============  ==============================




.. |ghversion| image:: https://img.shields.io/github/release/CoolProp/CoolProp.svg?label=SF-binaries
    :alt: CoolProp version tag

.. |sfdownloads| image:: https://img.shields.io/sourceforge/dm/CoolProp.svg?label=SF-downloads
    :target: http://sourceforge.net/projects/coolprop/files
    :alt: sourceforge downloads

.. |pypidownloads| image:: https://img.shields.io/pypi/dm/CoolProp.svg?label=PyPI-downloads
    :target: http://pypi.python.org/pypi/CoolProp/
    :alt: PyPI downloads

.. |pypiversion| image:: https://img.shields.io/pypi/v/coolprop.svg?label=PyPI-binaries
    :target: http://pypi.python.org/pypi/CoolProp/
    :alt: PyPI version

.. |ghlicense| image:: https://img.shields.io/github/license/CoolProp/CoolProp.svg
    :target: https://github.com/CoolProp/CoolProp/blob/master/LICENSE
    :alt: license

.. |travisbuilds| image:: https://travis-ci.org/CoolProp/CoolProp.svg?branch=master
    :target: https://travis-ci.org/CoolProp/CoolProp
    :alt: Travis CI builds

.. |coveritystatus| image:: https://scan.coverity.com/projects/4375/badge.svg
    :target: https://scan.coverity.com/projects/coolprop
    :alt: Coverity Scan Build Status

.. 
   image:: https://www.bountysource.com/badge/team?team_id=14160&style=raised
    
.. |bounties| image:: https://img.shields.io/bountysource/team/coolprop/activity.svg
   :alt: Post a bounty at https://www.bountysource.com/teams/coolprop
   :target: https://www.bountysource.com/teams/coolprop?utm_source=CoolProp&utm_medium=shield&utm_campaign=raised

.. 
   image:: https://badges.gitter.im/Join%20Chat.svg
   :alt: Join the chat at https://gitter.im/CoolProp/CoolProp
   :target: https://gitter.im/CoolProp/CoolProp?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
