Thermosteam

Thermosteam: BioSTEAM's Premier Thermodynamic Engine - Published in JOSS (2020)

https://github.com/biosteamdevelopmentgroup/thermosteam

Science Score: 95.0%

This score indicates how likely this project is to be science-related based on various indicators:

○
CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
✓
DOI references
Found 6 DOI reference(s) in README and JOSS metadata
✓
Academic publication links
Links to: joss.theoj.org
✓
Committers with academic emails
1 of 7 committers (14.3%) from academic institutions
○
Institutional organization owner
✓
JOSS paper metadata
Published in Journal of Open Source Software

Keywords

chemical chemical-engineering equations-of-state liquid-liquid-equilibrium material-and-energy-balance mixture properties reaction thermodynamics vapor-liquid-equilibrium

Last synced: 6 months ago · JSON representation

Repository

BioSTEAM's Premier Thermodynamic Engine

Basic Info

Host: GitHub
Owner: BioSTEAMDevelopmentGroup
License: other
Language: Python
Default Branch: master
Homepage:
Size: 1.38 GB

Statistics

Stars: 70
Watchers: 3
Forks: 12
Open Issues: 2
Releases: 2

Topics

chemical chemical-engineering equations-of-state liquid-liquid-equilibrium material-and-energy-balance mixture properties reaction thermodynamics vapor-liquid-equilibrium

Created over 6 years ago · Last pushed 6 months ago

Metadata Files

Readme License Authors

README.rst

====================================================
ThermoSTEAM: BioSTEAM's Premier Thermodynamic Engine 
====================================================

.. image:: http://img.shields.io/pypi/v/thermosteam.svg?style=flat
   :target: https://pypi.python.org/pypi/thermosteam
   :alt: Version_status
.. image:: http://img.shields.io/badge/docs-latest-brightgreen.svg?style=flat
   :target: https://biosteam.readthedocs.io/en/latest/API/thermosteam/index.html
   :alt: Documentation
.. image:: https://img.shields.io/pypi/pyversions/thermosteam.svg
   :target: https://pypi.python.org/pypi/thermosteam
   :alt: Supported_versions
.. image:: http://img.shields.io/badge/license-UIUC-blue.svg?style=flat
   :target: https://github.com/BioSTEAMDevelopmentGroup/thermosteam/blob/master/LICENSE.txt
   :alt: license
.. image:: https://coveralls.io/repos/github/BioSTEAMDevelopmentGroup/thermosteam/badge.svg?branch=master
   :target: https://coveralls.io/github/BioSTEAMDevelopmentGroup/thermosteam?branch=master
   :alt: Coverage
.. image:: https://joss.theoj.org/papers/10.21105/joss.02814/status.svg
   :target: https://doi.org/10.21105/joss.02814

.. contents::

Workshops
---------
Join us on Friday, Jan 20, 9:15-10:15am CST, for a BioSTEAM workshop! 
Email biosteamdevelopmentgroup@gmail.com for details.

What is ThermoSTEAM?
--------------------

ThermoSTEAM is a standalone thermodynamic engine capable of estimating mixture 
properties, solving thermodynamic phase equilibria, and modeling stoichiometric 
reactions. ThermoSTEAM builds upon `chemicals `_, 
the chemical properties component of the Chemical Engineering Design Library, 
with a robust and flexible framework that facilitates the creation of property packages.  
`The Biorefinery Simulation and Techno-Economic Analysis Modules (BioSTEAM) `_ 
is dependent on ThermoSTEAM for the simulation of unit operations.

Installation
------------

Get the latest version of ThermoSTEAM from `PyPI `_.
If you have an installation of Python with pip, simple install it with::

    $ pip install thermosteam

To get the git version and install it, run::

    $ git clone --depth 100 git://github.com/BioSTEAMDevelopmentGroup/thermosteam
    $ cd thermosteam
    $ pip install .

We use the `depth` option to clone only the last 100 commits. Thermosteam has a 
long history, so cloning the whole repository (without using the depth option)
may take over 30 min.

If you would like to clone all branches, add the "--no-single-branch" flag as such::

    $ git clone --depth 100 --no-single-branch git://github.com/BioSTEAMDevelopmentGroup/thermosteam

Documentation
-------------

ThermoSTEAM's documentation is available on the web:

    https://biosteam.readthedocs.io/en/latest/API/thermosteam/index.html

Bug reports
-----------

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

    https://github.com/BioSTEAMDevelopmentGroup/thermosteam


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 ThermoSTEAM license, if it is convenient for you,
please cite ThermoSTEAM if used in your work. Please also consider contributing
any changes you make back, and benefit the community.


Citation
--------

To cite ThermoSTEAM in publications use::

    Cortes-Pena, Y., (2020). ThermoSTEAM: BioSTEAM's Premier Thermodynamic Engine. 
    Journal of Open Source Software, 5(56), 2814. doi.org/10.21105/joss.02814

Owner

Name: BioSTEAM Development Group
Login: BioSTEAMDevelopmentGroup
Kind: organization
Email: BioSTEAMDevelopmentGroup@gmail.com

Website: https://biosteam.readthedocs.io/en/latest/index.html
Repositories: 7
Profile: https://github.com/BioSTEAMDevelopmentGroup

Our mission is to create, deliver, and support open-source products that make the BioSTEAM software easy to use, deploy, and scale.

JOSS Publication

Thermosteam: BioSTEAM's Premier Thermodynamic Engine

Published

December 02, 2020

DOI

10.21105/joss.02814

Volume 5, Issue 56, Page 2814

Authors

Yoel Cortés-Peña

Department of Civil and Environmental Engineering, University of Illinois at Urbana-Champaign, DOE Center for Advanced Bioenergy and Bioproducts Innovation (CABBI)

Editor

Kyle Niemeyer

GitHub Events

Total

Issues event: 3
Watch event: 10
Issue comment event: 2
Push event: 70
Fork event: 1
Create event: 1

Last Year

Issues event: 3
Watch event: 10
Issue comment event: 2
Push event: 70
Fork event: 1
Create event: 1

Committers

Last synced: 10 months ago

All Time

Total Commits: 1,226
Total Committers: 7
Avg Commits per committer: 175.143
Development Distribution Score (DDS): 0.048

Past Year

Commits: 105
Committers: 2
Avg Commits per committer: 52.5
Development Distribution Score (DDS): 0.01

Top Committers

Name	Email	Commits
Yoel	y**s@g**m	1,167
cortespea	c**a@a**u	31
Yalin	z**i@g**m	15
Benjamin W. Portner	b**r@b**t	7
Francesco Witte	g**b@w**h	3
lkudli2	9****2	2
sarangbhagwat	5****t	1

Committer Domains (Top 20 + Academic)

witte.sh: 1 bauhaus-luftfahrt.net: 1 ad.engr.wisc.edu: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time

Total issues: 71
Total pull requests: 24
Average time to close issues: 27 days
Average time to close pull requests: 2 days
Total issue authors: 15
Total pull request authors: 5
Average comments per issue: 2.34
Average comments per pull request: 1.46
Merged pull requests: 21
Bot issues: 0
Bot pull requests: 1

Past Year

Issues: 1
Pull requests: 0
Average time to close issues: 1 day
Average time to close pull requests: N/A
Issue authors: 1
Pull request authors: 0
Average comments per issue: 2.0
Average comments per pull request: 0
Merged pull requests: 0
Bot issues: 0
Bot pull requests: 0

View more stats

Top Authors

Issue Authors

yalinli2 (23)
fwitte (10)
BenPortner (10)
yoelcortes (9)
dhkblaszyk (5)
sarangbhagwat (4)
nkawerau (2)
gaorkl (1)
wennanlong (1)
ioncubekh (1)
Ikegwuugo (1)
Ali-Nazarik (1)
wigging (1)
rjplevin (1)
joyxyz1994 (1)

Pull Request Authors

yoelcortes (13)
BenPortner (5)
yalinli2 (4)
fwitte (2)
dependabot[bot] (1)

Top Labels

Issue Labels

enhancement (9) bug (5) question (1) code overlap (1) good first issue (1) documentation (1)

Pull Request Labels

enhancement (1) documentation (1) dependencies (1)

Packages

Total packages: 1
Total downloads:
- pypi 1,322 last-month

Total dependent packages: 3
Total dependent repositories: 3
Total versions: 351
Total maintainers: 1

pypi.org: thermosteam

BioSTEAM's Premier Thermodynamic Engine

Homepage: https://github.com/BioSTEAMDevelopmentGroup/thermosteam
Documentation: https://thermosteam.readthedocs.io/
License: MIT
Latest release: 0.52.1
published 6 months ago

Versions: 351
Dependent Packages: 3
Dependent Repositories: 3
Downloads: 1,322 Last month

Rankings

Dependent packages count: 1.6%

Downloads: 7.6%

Average: 7.6%

Dependent repos count: 9.1%

Stargazers count: 9.3%

Forks count: 10.6%

Maintainers (1)

yoelcortes

Last synced: 6 months ago

Dependencies

requirements.txt pypi

IPython >=7.9.0
colorpalette >=0.3.1
flexsolve ==0.5.3
free_properties >=0.2.6
ipykernel *
matplotlib >=3.1.1
nbsphinx *
numba >=0.53.1
numpy >=1.18.1
openpyxl >=3.0.0
pandas >=0.25.2
pint >=0.9
pyglet *
scipy >=1.5
sphinx >=2.4.0
sphinx_rtd_theme *
thermo >=0.2.9
xlrd ==1.2.0

requirements_test.txt pypi

IPython >=7.9.0
biorefineries >=2.23.0
biosteam >=2.32.2
colorpalette >=0.3.3
coveralls *
flexsolve ==0.5.3
free_properties >=0.2.6
ipykernel *
matplotlib >=3.1.1
nbval *
numba >=0.53.1
numpy >=1.18.1
openpyxl >=3.0.0
pandas >=0.25.2
pint >=0.9
pyglet *
pytest-cov *
pyyaml *
scipy >=1.5
simpy *
thermo >=0.2.9
xlrd ==1.2.0

setup.py pypi

IPython >=7.9.0
colorpalette >=0.3.3
flexsolve >=0.5.3
free_properties >=0.3.4
matplotlib >=3.1.1
numba >=0.53.1
numpy >=1.18.1,<=1.21
openpyxl >=3.0.0
pandas >=0.25.2
pint >=0.9
pyglet *
scipy >=1.5
thermo >=0.2.9
xlrd >=1.2.0

.github/workflows/build.yml actions

actions/cache v2 composite
actions/checkout v2 composite
actions/setup-python v2 composite

Thermosteam

Science Score: 95.0%

Keywords

Repository

Basic Info

Statistics

Topics

Metadata Files

README.rst

Owner

JOSS Publication

Thermosteam: BioSTEAM's Premier Thermodynamic Engine

Authors

Editor

Tags

GitHub Events

Total

Last Year

Committers

All Time

Past Year

Top Committers

Committer Domains (Top 20 + Academic)

Issues and Pull Requests

All Time

Past Year

Top Authors

Issue Authors

Pull Request Authors

Top Labels

Issue Labels

Pull Request Labels

Packages

pypi.org: thermosteam

Rankings

Maintainers (1)

Dependencies