HESMA file format reader and writer
Project description
Hesmapy
HESMA Python - Tools for reading HESMA models
Documentation
Full documentation can be found here.
Installation
Currently, the package is only available through pip
.
pip install hesmapy
In case you want to build the documentation, you'll need to install the optional dependencies as well.
See pyproject.toml
for a list of needed packages (mostly sphinx
related packages)
Contents
hesmapy
contains three main modules, one for each of the main HESMA categories (Hydro, RT, Tracer).
It provides utilties to read and write files in the standardised HESMA file formats, as well as
some utilities such as plotting. These utilities are mostly intended for use by HESMA itself and
might be rather limited in their functionality.
Hydro
Hydro1D
This module contains the tools for one-dimensional hydro models. See below for some basic usage examples.
Loading models:
import hesmapy.base as hp
model = hp.load_hydro_1d("examples/hydro/hydro_1d.json")
Get the data from a model as a pd.DataFrame
:
df = model.get_data()
Plot a model:
model.plot(show_plot=True)
Model files can be written by providing either a pd.DataFrame
, dict
or several np.ndarray
.
See the documentation for more details.
RT
(Not yet implemented)
Tracer
(Not yet implemented)
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for hesmapy-23.12.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ecc33770761c88294e1493617568d7bc433e5d7537217ffcbcae1858b56e6201 |
|
MD5 | 159429638dd1dcc889873b71d91ca70b |
|
BLAKE2b-256 | 2d5ccbedaf2a4a9c7c4c973360b2b11654d4c53b6da76cf83939ad5704657d39 |