# HyRAM+ Python Package
The Hydrogen Plus Other Alternative Fuels Risk Assessment Models (HyRAM+) Python package contains modules for the calculation of physical release and risk for alternative fuels.
## Installation
To install [HyRAM+ from the Python Package Index](https://pypi.org/project/hyram/), use the command:
```
pip install hyram
```
More instructions on installing Python packages with `pip` can be found [here](https://packaging.python.org/en/latest/tutorials/installing-packages/).
To install [HyRAM+ from Conda-Forge](https://anaconda.org/conda-forge/hyram), use the command:
```
conda install -c conda-forge hyram
```
More instructions on installing Python packages with `conda` can be found [here](https://docs.anaconda.com/anacondaorg/user-guide/howto/#use-packages).
## Usage
The HyRAM+ package can be utilized after installation using a standard Python import:
```python
import hyram
```
Specific models can be accessed within the HyRAM+ package.
The main calculations for the physics models can be accessed using `hyram.phys.api`.
This includes models such as:
* `create_fluid`
* `compute_mass_flow`
* `compute_tank_mass_param`
* `compute_thermo_param`
* `compute_equivalent_tnt_mass`
* `analyze_jet_plume`
* `analyze_accumulation`
* `jet_flame_analysis`
* `compute_overpressure`
The following are the main model objects that can be accessed using `hyram.phys`:
* `Fluid`
* `Orifice`
* `Jet`
* `Flame`
* `Source`
* `Enclosure`
* `Vent`
* `IndoorRelease`
* `BST_method`
* `TNT_method`
* `Bauwens_method`
* `FuelProperties`
The main risk calculations are located in `hyram.qra.analysis.conduct_analysis`.
More information about the specific models and the inputs/outputs for each one can be found in the specific modules themselves.
## Documentation
The models and equations used in the HyRAM+ Python package are described in the Technical Reference Manual, located on the [HyRAM+ website](https://hyram.sandia.gov).
## Development/Modifications
To make changes to the source code, either for a specific need or to contribute to HyRAM+, please follow the instructions in the [CONTRIBUTING](https://github.com/sandialabs/hyram/blob/master/CONTRIBUTING.md) file for the HyRAM+ Python package.
Raw data
{
"_id": null,
"home_page": "",
"name": "hyram",
"maintainer": "",
"docs_url": null,
"requires_python": "<3.11,>3.6",
"maintainer_email": "",
"keywords": "hydrogen,methane,propane,flame,plume,jet,overpressure,quantitative risk assessment,risk",
"author": "Brian D. Ehrhart, Cianan Sims, Ethan S. Hecht, Benjamin B. Schroeder, Benjamin R. Liu, Katrina M. Groth, John T. Reynolds, Gregory W. Walkup",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/04/f6/aff211bd76fb9a85ffcc4344852660b15786697a5f6d8291f1593170221b/hyram-5.1.1.tar.gz",
"platform": null,
"description": "# HyRAM+ Python Package\r\n\r\nThe Hydrogen Plus Other Alternative Fuels Risk Assessment Models (HyRAM+) Python package contains modules for the calculation of physical release and risk for alternative fuels.\r\n\r\n\r\n## Installation\r\n\r\nTo install [HyRAM+ from the Python Package Index](https://pypi.org/project/hyram/), use the command:\r\n\r\n```\r\npip install hyram\r\n```\r\n\r\nMore instructions on installing Python packages with `pip` can be found [here](https://packaging.python.org/en/latest/tutorials/installing-packages/).\r\n\r\nTo install [HyRAM+ from Conda-Forge](https://anaconda.org/conda-forge/hyram), use the command:\r\n\r\n```\r\nconda install -c conda-forge hyram\r\n```\r\n\r\nMore instructions on installing Python packages with `conda` can be found [here](https://docs.anaconda.com/anacondaorg/user-guide/howto/#use-packages).\r\n\r\n\r\n## Usage\r\n\r\nThe HyRAM+ package can be utilized after installation using a standard Python import:\r\n```python\r\nimport hyram\r\n```\r\n\r\nSpecific models can be accessed within the HyRAM+ package.\r\nThe main calculations for the physics models can be accessed using `hyram.phys.api`.\r\nThis includes models such as:\r\n* `create_fluid`\r\n* `compute_mass_flow`\r\n* `compute_tank_mass_param`\r\n* `compute_thermo_param`\r\n* `compute_equivalent_tnt_mass`\r\n* `analyze_jet_plume`\r\n* `analyze_accumulation`\r\n* `jet_flame_analysis`\r\n* `compute_overpressure`\r\n\r\nThe following are the main model objects that can be accessed using `hyram.phys`:\r\n* `Fluid`\r\n* `Orifice`\r\n* `Jet`\r\n* `Flame`\r\n* `Source`\r\n* `Enclosure`\r\n* `Vent`\r\n* `IndoorRelease`\r\n* `BST_method`\r\n* `TNT_method`\r\n* `Bauwens_method`\r\n* `FuelProperties`\r\n\r\nThe main risk calculations are located in `hyram.qra.analysis.conduct_analysis`.\r\n\r\nMore information about the specific models and the inputs/outputs for each one can be found in the specific modules themselves.\r\n\r\n\r\n## Documentation\r\n\r\nThe models and equations used in the HyRAM+ Python package are described in the Technical Reference Manual, located on the [HyRAM+ website](https://hyram.sandia.gov).\r\n\r\n\r\n## Development/Modifications\r\n\r\nTo make changes to the source code, either for a specific need or to contribute to HyRAM+, please follow the instructions in the [CONTRIBUTING](https://github.com/sandialabs/hyram/blob/master/CONTRIBUTING.md) file for the HyRAM+ Python package.\r\n",
"bugtrack_url": null,
"license": "GPL-3.0-only",
"summary": "Hydrogen Plus Other Alternative Fuels Risk Assessment Models Python Package",
"version": "5.1.1",
"project_urls": {
"homepage": "https://hyram.sandia.gov/",
"repository": "https://github.com/sandialabs/hyram"
},
"split_keywords": [
"hydrogen",
"methane",
"propane",
"flame",
"plume",
"jet",
"overpressure",
"quantitative risk assessment",
"risk"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "141f046e7881f3b195221777990609e52bf895c0645e38fc8ea87b82bfd7ca6d",
"md5": "acba66a51ad43aaa1747aa983f9351b5",
"sha256": "a3cc41ae655bf4dd309c6c35e76dfc72df33fc43cc4fb65d2f16b2b3b11dadfe"
},
"downloads": -1,
"filename": "hyram-5.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "acba66a51ad43aaa1747aa983f9351b5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.11,>3.6",
"size": 139574,
"upload_time": "2024-02-12T21:45:37",
"upload_time_iso_8601": "2024-02-12T21:45:37.873151Z",
"url": "https://files.pythonhosted.org/packages/14/1f/046e7881f3b195221777990609e52bf895c0645e38fc8ea87b82bfd7ca6d/hyram-5.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "04f6aff211bd76fb9a85ffcc4344852660b15786697a5f6d8291f1593170221b",
"md5": "2aa37b62de6a264a1fb72c316c3e4aa2",
"sha256": "2865f9acb3d6a5eaa549f48f2b50db16e680c5a714bcad51bf4117da10a1e215"
},
"downloads": -1,
"filename": "hyram-5.1.1.tar.gz",
"has_sig": false,
"md5_digest": "2aa37b62de6a264a1fb72c316c3e4aa2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.11,>3.6",
"size": 296071,
"upload_time": "2024-02-12T21:45:39",
"upload_time_iso_8601": "2024-02-12T21:45:39.330312Z",
"url": "https://files.pythonhosted.org/packages/04/f6/aff211bd76fb9a85ffcc4344852660b15786697a5f6d8291f1593170221b/hyram-5.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-12 21:45:39",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "sandialabs",
"github_project": "hyram",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "hyram"
}
JSON
