# ms_thermo
This is a small package from Cerfacs dedicated to multispecies thermodynamics operations.
*It is available on [PyPI](https://pypi.org/project/ms-thermo/),
documentation is on [readtthedocs](https://ms-thermo.readthedocs.io/en/latest/), sources are mirrored on [gitlab.com](https://gitlab.com/cerfacs/ms_thermo)*
## Installation
Install from Python Package index:
```shell
pip install ms_thermo
```
## Features
### Command line tools
Once the package is installed, you have access in your terminal to a CLI from the command `ms_thermo`:
```bash
Usage: ms_thermo [OPTIONS] COMMAND [ARGS]...
--------------- MS-THERMO --------------------
You are now using the Command line interface of MS-Thermo, a Python3
helper for reactive multispecies computation, created at CERFACS
(https://cerfacs.fr).
This is a python package currently installed in your python environement.
See the full documentation at : https://ms-
thermo.readthedocs.io/en/latest/.
Options:
--help Show this message and exit.
Commands:
fresh-gas (Deprecated) Renamed as kero-prim2cons
gasout Apply GASOUT actions to a mixture.
hp-equil HP equilibrium using Cantera.
kero-prim2cons Primitive to conservative variable conversion...
kero-tadia Adiabatic flame temperature for a kerosene-air...
tadia (Deprecated) Renamed as kero-tadia
yk-from-phi Mass fractions of a fuel-air mixture.
```
Details on the commands are available in the [documentation](https://ms-thermo.readthedocs.io/en/latest/explanations/cli.html#command-line-tools).
### The `State` class
The `State` class describes the full thermodynamic state of a gas mixture.
As an example, the following script creates an initial mixture of fresh gases, then changes a subset of the field into hot gases.
```
>>> from ms_thermo.state import State
>>> case = State()
>>> print(case)
Current primitive state of the mixture
| Most Common | Min | Max
----------------------------------------------------
rho| 1.17192e+00 | 1.172e+00 | 1.172e+00
energy| 2.16038e+05 | 2.160e+05 | 2.160e+05
temperature| 3.00000e+02 | 3.000e+02 | 3.000e+02
pressure| 1.01325e+05 | 1.013e+05 | 1.013e+05
Y_O2| 2.32500e-01 | 2.325e-01 | 2.325e-01
Y_N2| 7.67500e-01 | 7.675e-01 | 7.675e-01
>>> case.temperature = 1200
>>> print(case)
Current primitive state of the mixture
| Most Common | Min | Max
----------------------------------------------------
rho| 2.92980e-01 | 2.930e-01 | 2.930e-01
energy| 9.41143e+05 | 9.411e+05 | 9.411e+05
temperature| 1.20000e+03 | 1.200e+03 | 1.200e+03
pressure| 1.01325e+05 | 1.013e+05 | 1.013e+05
Y_O2| 2.32500e-01 | 2.325e-01 | 2.325e-01
Y_N2| 7.67500e-01 | 7.675e-01 | 7.675e-01
```
Additional details on the commands are provided in the [documentation](https://ms-thermo.readthedocs.io/en/latest/explanations/state.html#).
Raw data
{
"_id": null,
"home_page": "https://gitlab.com/cerfacs/ms_thermo",
"name": "ms-thermo",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "MS THERMO API",
"author": "CoopTeam-CERFACS",
"author_email": "coop@cerfacs.com",
"download_url": "https://files.pythonhosted.org/packages/86/ec/2a2620a6b256ca9a88e0cfd25e1f73da4fc20ddb0934ac42c1b5c8485176/ms_thermo-0.3.9.tar.gz",
"platform": null,
"description": "# ms_thermo\n\n\n\nThis is a small package from Cerfacs dedicated to multispecies thermodynamics operations.\n\n*It is available on [PyPI](https://pypi.org/project/ms-thermo/),\ndocumentation is on [readtthedocs](https://ms-thermo.readthedocs.io/en/latest/), sources are mirrored on [gitlab.com](https://gitlab.com/cerfacs/ms_thermo)*\n\n## Installation\n\nInstall from Python Package index:\n\n```shell\npip install ms_thermo\n```\n\n## Features\n\n### Command line tools\n\nOnce the package is installed, you have access in your terminal to a CLI from the command `ms_thermo`:\n\n```bash\nUsage: ms_thermo [OPTIONS] COMMAND [ARGS]...\n\n --------------- MS-THERMO --------------------\n\n You are now using the Command line interface of MS-Thermo, a Python3\n helper for reactive multispecies computation, created at CERFACS\n (https://cerfacs.fr).\n\n This is a python package currently installed in your python environement.\n See the full documentation at : https://ms-\n thermo.readthedocs.io/en/latest/.\n\nOptions:\n --help Show this message and exit.\n\nCommands:\n fresh-gas (Deprecated) Renamed as kero-prim2cons\n gasout Apply GASOUT actions to a mixture.\n hp-equil HP equilibrium using Cantera.\n kero-prim2cons Primitive to conservative variable conversion...\n kero-tadia Adiabatic flame temperature for a kerosene-air...\n tadia (Deprecated) Renamed as kero-tadia\n yk-from-phi Mass fractions of a fuel-air mixture.\n```\n\nDetails on the commands are available in the [documentation](https://ms-thermo.readthedocs.io/en/latest/explanations/cli.html#command-line-tools).\n\n### The `State` class\n\nThe `State` class describes the full thermodynamic state of a gas mixture.\nAs an example, the following script creates an initial mixture of fresh gases, then changes a subset of the field into hot gases.\n\n```\n>>> from ms_thermo.state import State\n>>> case = State()\n>>> print(case)\n\nCurrent primitive state of the mixture\n\n\t\t | Most Common | Min | Max\n----------------------------------------------------\n rho| 1.17192e+00 | 1.172e+00 | 1.172e+00\n energy| 2.16038e+05 | 2.160e+05 | 2.160e+05\n temperature| 3.00000e+02 | 3.000e+02 | 3.000e+02\n pressure| 1.01325e+05 | 1.013e+05 | 1.013e+05\n Y_O2| 2.32500e-01 | 2.325e-01 | 2.325e-01\n Y_N2| 7.67500e-01 | 7.675e-01 | 7.675e-01\n\n>>> case.temperature = 1200\n>>> print(case)\n\nCurrent primitive state of the mixture\n\t\t\t \t| Most Common | Min | Max\n----------------------------------------------------\n rho| 2.92980e-01 | 2.930e-01 | 2.930e-01\n energy| 9.41143e+05 | 9.411e+05 | 9.411e+05\n temperature| 1.20000e+03 | 1.200e+03 | 1.200e+03\n pressure| 1.01325e+05 | 1.013e+05 | 1.013e+05\n Y_O2| 2.32500e-01 | 2.325e-01 | 2.325e-01\n Y_N2| 7.67500e-01 | 7.675e-01 | 7.675e-01\n```\n\nAdditional details on the commands are provided in the [documentation](https://ms-thermo.readthedocs.io/en/latest/explanations/state.html#).\n",
"bugtrack_url": null,
"license": "",
"summary": "Utilities to work on 2D and 3D structured grids",
"version": "0.3.9",
"project_urls": {
"Bug Tracker": "https://gitlab.com/cerfacs/ms_thermo/-/issues",
"Documentation": "https://ms_thermo.readthedocs.io/en/latest/",
"Homepage": "https://gitlab.com/cerfacs/ms_thermo"
},
"split_keywords": [
"ms",
"thermo",
"api"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "bbfd23de8cf70ccaaefcf94029233e7f33012c29faa7c89cb55aa1cdb8095c2f",
"md5": "cddba4b38d75f01716ba8667bfdad913",
"sha256": "2d0de4316de8420fc0535c1669aa1ba670c98e2a4e09fc3df75e0c106ef46ea6"
},
"downloads": -1,
"filename": "ms_thermo-0.3.9-py3-none-any.whl",
"has_sig": false,
"md5_digest": "cddba4b38d75f01716ba8667bfdad913",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 165616,
"upload_time": "2024-02-13T12:19:35",
"upload_time_iso_8601": "2024-02-13T12:19:35.499809Z",
"url": "https://files.pythonhosted.org/packages/bb/fd/23de8cf70ccaaefcf94029233e7f33012c29faa7c89cb55aa1cdb8095c2f/ms_thermo-0.3.9-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "86ec2a2620a6b256ca9a88e0cfd25e1f73da4fc20ddb0934ac42c1b5c8485176",
"md5": "d634535178d44df143c100cb5ff98bac",
"sha256": "41b1c0c6de2969c215994e53956e1c7f6ff2df8a4cd63e5cab0818852db858c0"
},
"downloads": -1,
"filename": "ms_thermo-0.3.9.tar.gz",
"has_sig": false,
"md5_digest": "d634535178d44df143c100cb5ff98bac",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 164472,
"upload_time": "2024-02-13T12:19:37",
"upload_time_iso_8601": "2024-02-13T12:19:37.795461Z",
"url": "https://files.pythonhosted.org/packages/86/ec/2a2620a6b256ca9a88e0cfd25e1f73da4fc20ddb0934ac42c1b5c8485176/ms_thermo-0.3.9.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-13 12:19:37",
"github": false,
"gitlab": true,
"bitbucket": false,
"codeberg": false,
"gitlab_user": "cerfacs",
"gitlab_project": "ms_thermo",
"lcname": "ms-thermo"
}
JSON