hyram

Name	hyram JSON
Version	6.1 JSON
	download
home_page	None
Summary	Hydrogen Plus Other Alternative Fuels Risk Assessment Models Python Package
upload_time	2025-09-15 18:08:57
maintainer	Michael C. Devin, Brian D. Ehrhart, Ethan S. Hecht, Benjamin R. Liu, Cianan Sims
docs_url	None
author	Erin E. Carrier, Michael C. Devin, Brian D. Ehrhart, Isaac W. Ekoto, Katrina M. Groth, Ethan S. Hecht, Benjamin R. Liu, Alice Muna, John T. Reynolds, Benjamin B. Schroeder, Cianan Sims, Greg Walkup
requires_python	>=3.9
license	None
keywords	hydrogen methane propane flame plume jet overpressure quantitative risk assessment risk
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # 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": null,
    "name": "hyram",
    "maintainer": "Michael C. Devin, Brian D. Ehrhart, Ethan S. Hecht, Benjamin R. Liu, Cianan Sims",
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": null,
    "keywords": "hydrogen, methane, propane, flame, plume, jet, overpressure, quantitative risk assessment, risk",
    "author": "Erin E. Carrier, Michael C. Devin, Brian D. Ehrhart, Isaac W. Ekoto, Katrina M. Groth, Ethan S. Hecht, Benjamin R. Liu, Alice Muna, John T. Reynolds, Benjamin B. Schroeder, Cianan Sims, Greg Walkup",
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/2a/66/2e0c5b1d288e3b36224a06260e9f9fd49ad35569473197f6e4cfac631969/hyram-6.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": null,
    "summary": "Hydrogen Plus Other Alternative Fuels Risk Assessment Models Python Package",
    "version": "6.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": null,
            "digests": {
                "blake2b_256": "e1a8b7268114860f7d8cb855cd53a1467442d80a72fede7a2465b6f85d5ad883",
                "md5": "ac725e321aa0ae1540eb7afcc72dd623",
                "sha256": "823838bea388f3a5778469a2cc8ae1cb77d4893b7bb2993c563c4c507bcae576"
            },
            "downloads": -1,
            "filename": "hyram-6.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "ac725e321aa0ae1540eb7afcc72dd623",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 149686,
            "upload_time": "2025-09-15T18:08:55",
            "upload_time_iso_8601": "2025-09-15T18:08:55.549404Z",
            "url": "https://files.pythonhosted.org/packages/e1/a8/b7268114860f7d8cb855cd53a1467442d80a72fede7a2465b6f85d5ad883/hyram-6.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "2a662e0c5b1d288e3b36224a06260e9f9fd49ad35569473197f6e4cfac631969",
                "md5": "77caa1601d2674aab212c66171fd87c5",
                "sha256": "80ec93279763319082e9709c62cbe8b821e222fb1f915215254a385bd0e37423"
            },
            "downloads": -1,
            "filename": "hyram-6.1.tar.gz",
            "has_sig": false,
            "md5_digest": "77caa1601d2674aab212c66171fd87c5",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 320558,
            "upload_time": "2025-09-15T18:08:57",
            "upload_time_iso_8601": "2025-09-15T18:08:57.044744Z",
            "url": "https://files.pythonhosted.org/packages/2a/66/2e0c5b1d288e3b36224a06260e9f9fd49ad35569473197f6e4cfac631969/hyram-6.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-09-15 18:08:57",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "sandialabs",
    "github_project": "hyram",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "hyram"
}