Getting Started¶

This section will provide some starting points for using the library.

For installation instructions, see Installation.

Hydro¶

This module contains the tools for hydrodynamical simulations. See below for some basic usage examples.

One-dimensional hydrodynamical simulations.

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 Hydro for more information.

This module contains the tools for radiative transfer simulations. See below for some basic usage examples.

Loading models:

import hesmapy.base as hp
model = hp.load_rt_lightcurve("examples/rt/rt_lightcurve.json")

Get the data from a model as a pd.DataFrame:

df = model.get_data()

Plot a model:

model.plot(show_plot=True)

Loading models:

import hesmapy.base as hp
model = hp.load_rt_spectrum("examples/rt/rt_spectrum.json")

Get the data from a model as a list of pd.DataFrame (one for each timestep):

dfs = 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 RT for more information.

(Not yet implemented)