GalaPotential

class peebee.models.GalaPotential(pot, **kwargs)

Bases: Model

Wrapper for Gala potential objects.

Allows use of any instantiated Gala potential object within the peebee modeling framework. Requires the Gala package to be installed.

Methods Summary

accel(x, y, z, **kwargs)	Compute acceleration using Gala potential.
density(x, y, z, **kwargs)	Compute mass density using Gala potential
set_params(params[, ignore_name_check])	Set all model parameters from a dictionary.
update_params(params)	Update a subset of model parameters by name.

Methods Documentation

accel(x, y, z, **kwargs)

Compute acceleration using Gala potential.

X (array_like):

X coordinates (kpc)

Y (array_like):

Y coordinates (kpc)

Z (array_like):

Z coordinates (kpc)

**kwargskwargs:

Additional keyword arguments

Returns:

acceleration (tuple) - Three-component acceleration (ax, ay, az) in mm/s/yr

density(x, y, z, **kwargs)

Compute mass density using Gala potential

X (array_like):

X coordinates (kpc)

Y (array_like):

Y coordinates (kpc)

Z (array_like):

Z coordinates (kpc)

**kwargskwargs:

Additional keyword arguments

Returns:

density (array_like) - Density in Msun/kpc^3

set_params(params, ignore_name_check=False)

Set all model parameters from a dictionary.

Params (dict):

Dictionary of parameter names and values

Ignore_name_check (bool, optional):

Skip parameter name validation. Default is False.

Returns:

None

update_params(params)

Update a subset of model parameters by name.

Params (dict):

Dictionary of parameter names and values to update

Returns:

None