Metadata-Version: 2.5
Name: lh2poolx
Version: 0.1.0
Summary: Transparent liquid-hydrogen pool source terms for dispersion models
Project-URL: Source, https://github.com/lyullee/lh2poolx
Project-URL: Documentation, https://github.com/lyullee/lh2poolx#readme
Author: Ugwiyeon Lee
License: MIT License
        
        Copyright (c) 2026 Ugwiyeon Lee
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
License-File: LICENSE
Keywords: LH2,liquid hydrogen,pool evaporation,process safety,source term
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Scientific/Engineering
Requires-Python: >=3.10
Requires-Dist: coolprop>=6.5
Provides-Extra: test
Requires-Dist: pytest>=7; extra == 'test'
Description-Content-Type: text/markdown

# LH2PoolX

LH2PoolX calculates an **evidence-qualified, quasi-steady liquid-hydrogen
pool source term** for a declared time window.  It is an upstream input module
for dispersion models, not a dispersion model and not a general jet-impact or
pool-spreading solver.

## What it calculates

For a specified release rate, storage pressure, elapsed time, substrate and
ground-deposition fraction, LH2PoolX calculates:

1. isenthalpic flash fraction using CoolProp;
2. liquid mass reaching the ground;
3. heat-limited evaporation flux using a semi-infinite ground-conduction
   relation with an LH2 critical-heat-flux cap; and
4. the unconfined equilibrium pool area and evaporation rate.

`deposition_fraction` is deliberately explicit.  The package does **not**
predict impingement, splashing, droplet transport, drainage, barriers, or
transient pool spreading.  A confined result reports liquid accumulation and
must not be used as a steady source without a separate inventory model.

## Install

```bash
pip install lh2poolx
```

## Minimal use

```python
from lh2poolx import LH2Release, evaluate_pool_source

release = LH2Release(rate_kg_s=0.1055, storage_pressure_barg=1.0)
source = evaluate_pool_source(release, elapsed_s=300.0)
print(source.area_m2, source.evaporation_rate_kg_s)
```

## Evidence boundary

The concrete heat-transfer implementation is checked against the four
published PRESLHY E3.4 Concrete02 mass-loss windows.  That comparison is a
restricted substrate-and-condition check, not validation for other substrates
or for jet-to-ground deposition.  Literature supports the physical form of
the source chain; it does not turn unknown deposition into a fitted value.

## License

MIT.  Cite the accompanying software record when one is released, plus the
underlying experimental and heat-transfer sources used in an analysis.
