# helmeos
[![codecov](https://codecov.io/github/msbc/helmeos/graph/badge.svg?token=9C1XFJO2SQ)](https://codecov.io/github/msbc/helmeos)
[![License](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/license/mit)
A Python implementation/port of [Frank Timmes' Helmholtz EoS](http://cococubed.com/code_pages/eos.shtml).
This package provides a simple interface to the Helmholtz EoS for a wide range of temperatures and densities. The Helmholtz EoS is a tabulated equation of state for stellar matter, which is based on the Helmholtz free energy. The Helmholtz free energy is a function of temperature, density, and composition, and is used to calculate the pressure, internal energy, and entropy of a gas. This package does not provide a way to calculate the interpolation tables, but it does provide a way to read the tables and interpolate the values.
## References
- [Timmes, F. X., & Arnett, D. 1999, ApJS, 125, 277](https://ui.adsabs.harvard.edu/abs/1999ApJS..125..277T/abstract)
- [Timmes, F. X., & Douglas, S. 2000, ApJS, 126, 501](https://ui.adsabs.harvard.edu/abs/2000ApJS..126..501T/abstract)
## Prerequisites
Python packages:
- numpy
- matplotlib (optional, for plotting)
This is only tested on Python3.
## Installation
This package is available on PyPI, so you can install it using pip:
```pip install helmeos```
This package is also available on conda-forge, so you can install it using conda:
```conda install -c conda-forge helmeos```
## Example
See [example.py](helmeos/example.py) for example code.
Raw data
{
"_id": null,
"home_page": null,
"name": "helmeos",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": "\"Matthew S. B. Coleman\" <msbc@princeton.edu>",
"keywords": "equation of state, helmeos, eos, thermodynamics, astrophysics, astronomy, physics",
"author": null,
"author_email": "\"Matthew S. B. Coleman\" <msbc@princeton.edu>",
"download_url": "https://files.pythonhosted.org/packages/b3/6f/3decbcad5df16b25ffb5bc56bfa8704b973c2cbe527af17e096ffa6f1eea/helmeos-1.0.0.tar.gz",
"platform": null,
"description": "# helmeos\n\n[![codecov](https://codecov.io/github/msbc/helmeos/graph/badge.svg?token=9C1XFJO2SQ)](https://codecov.io/github/msbc/helmeos)\n[![License](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/license/mit)\n\nA Python implementation/port of [Frank Timmes' Helmholtz EoS](http://cococubed.com/code_pages/eos.shtml).\n\nThis package provides a simple interface to the Helmholtz EoS for a wide range of temperatures and densities. The Helmholtz EoS is a tabulated equation of state for stellar matter, which is based on the Helmholtz free energy. The Helmholtz free energy is a function of temperature, density, and composition, and is used to calculate the pressure, internal energy, and entropy of a gas. This package does not provide a way to calculate the interpolation tables, but it does provide a way to read the tables and interpolate the values.\n\n## References\n\n- [Timmes, F. X., & Arnett, D. 1999, ApJS, 125, 277](https://ui.adsabs.harvard.edu/abs/1999ApJS..125..277T/abstract)\n- [Timmes, F. X., & Douglas, S. 2000, ApJS, 126, 501](https://ui.adsabs.harvard.edu/abs/2000ApJS..126..501T/abstract)\n\n## Prerequisites\n\nPython packages:\n\n- numpy\n- matplotlib (optional, for plotting)\n\nThis is only tested on Python3.\n\n## Installation\n\nThis package is available on PyPI, so you can install it using pip:\n```pip install helmeos```\n\nThis package is also available on conda-forge, so you can install it using conda:\n```conda install -c conda-forge helmeos```\n\n## Example\n\nSee [example.py](helmeos/example.py) for example code.\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "A Python implementation/port of Frank Timmes' Helmholtz EoS.",
"version": "1.0.0",
"project_urls": {
"Repository": "https://github.com/msbc/helmeos"
},
"split_keywords": [
"equation of state",
" helmeos",
" eos",
" thermodynamics",
" astrophysics",
" astronomy",
" physics"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "aa310c2299e9a30aab9577d9c0c83d19927b33201e683130eca58399fb1c3625",
"md5": "8863d5854bde539b7de56efe35ab5109",
"sha256": "ed7ee3f9872895c4d2382dc9ac895b81ee0ca8eaa59927ab9c64e42f8da357b5"
},
"downloads": -1,
"filename": "helmeos-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8863d5854bde539b7de56efe35ab5109",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 13983,
"upload_time": "2024-12-02T01:04:22",
"upload_time_iso_8601": "2024-12-02T01:04:22.603047Z",
"url": "https://files.pythonhosted.org/packages/aa/31/0c2299e9a30aab9577d9c0c83d19927b33201e683130eca58399fb1c3625/helmeos-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b36f3decbcad5df16b25ffb5bc56bfa8704b973c2cbe527af17e096ffa6f1eea",
"md5": "c5be0871c5c34371f2d38f6167ee3fd1",
"sha256": "1a024df55d0e6d6dfc69b394fbb3576d6e07012b265344380d7303b68cb07ab6"
},
"downloads": -1,
"filename": "helmeos-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "c5be0871c5c34371f2d38f6167ee3fd1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 16941,
"upload_time": "2024-12-02T01:04:24",
"upload_time_iso_8601": "2024-12-02T01:04:24.880936Z",
"url": "https://files.pythonhosted.org/packages/b3/6f/3decbcad5df16b25ffb5bc56bfa8704b973c2cbe527af17e096ffa6f1eea/helmeos-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-02 01:04:24",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "msbc",
"github_project": "helmeos",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "numpy",
"specs": [
[
">=",
"1.0.0"
]
]
}
],
"tox": true,
"lcname": "helmeos"
}