diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index 4bf1659..88824e3 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -1,4 +1,4 @@ -name: documentation +name: FuelLib-Docs on: workflow_dispatch: diff --git a/README.md b/README.md index 825c8c4..6aaf632 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,11 @@ # FuelLib +[![Language: C++17](https://img.shields.io/badge/language-Python-blue)](https://isocpp.org/) +[![DOI Badge](https://img.shields.io/badge/DOI-10.11578/dc.20250317.1-blue)](https://doi.org/10.11578/dc.20250317.1) + +![CI](https://github.com/NatLabRockies/FuelLib/workflows/FuelLib-CI/badge.svg) +![Documentation](https://github.com/NatLabRockies/FuelLib/workflows/FuelLib-Docs/badge.svg) + +# Overview FuelLib (SWR-25-26) utilizes the tables and functions of the Group Contribution Method (GCM) as proposed by [Constantinou and Gani (1994)](https://doi.org/10.1002/aic.690401011) and [Constantinou, Gani and O'Connel (1995)](https://doi.org/10.1016/0378-3812(94)02593-P), with additional physical properties discussed in [Govindaraju & Ihme (2016)](https://doi.org/10.1016/j.ijheatmasstransfer.2016.06.079). The code is based on Pavan B. Govindaraju's [Matlab implementation](https://github.com/gpavanb-old/GroupContribution) of the GCM, and has been expanded to include additional thermodynamic properties and mixture properties. The fuel library contains gas chromatography (GC x GC) data for a variety of fuels ranging from simple single component fuels to complex jet fuels. The GC x GC data for POSF jet fuels comes from [Edwards (2020)](https://apps.dtic.mil/sti/pdfs/AD1093317.pdf). ## Citing this Work