GalpyPotential

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

Bases: Model

Generic Galpy potential wrapper.

Allows use of any instantiated Galpy potential object for computing accelerations. Requires the Galpy package to be installed. Note: Parameter updates not currently supported.

Methods Summary

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

Compute the acceleration at given coordinates.

Methods Documentation

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

Compute the acceleration at given coordinates. Must be implemented by subclasses.

X (array_like):

X coordinates (kpc)

Y (array_like):

Y coordinates (kpc)

Z (array_like):

Z coordinates (kpc)

**kwargskwargs:

Additional keyword arguments specific to the model

Returns:

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