peebee.models Module

Peebee contains many different potential models, which can be used to either generate acceleration data, or can be fit to existing acceleration data. A variety of models are incorporated here, and are added as they become relevant. If you do not see a specific potential you are interested in, you can reach out and ask that it be added to a future version of peebee.

Classes

AnharmonicDisk([neg_alpha2])	Anharmonic disk model with polynomial vertical expansion.
CompositeModel([models])
CoxGomezSpiralArm(**kwargs)	Cox & Gomez (2002) spiral arm potential model.
Cross(**kwargs)	Cross model for Galactic dynamics.
DamourTaylorPotential(**kwargs)	Damour-Taylor numerical potential model.
ExponentialDisk(**kwargs)	Exponential disk model (NOT a double exponential disk!).
GalaPotential(pot, **kwargs)	Wrapper for Gala potential objects.
GalpyPotential(pot, **kwargs)	Generic Galpy potential wrapper.
Hernquist(**kwargs)	Hernquist spherical mass profile.
IsothermalDisk(**kwargs)	Isothermal disk model with constant velocity dispersion.
IsothermalDiskBeta(**kwargs)	Isothermal disk with beta parameter for rotation curve slope.
LocalExpansion([neg_dadr, neg_dadphi])	Local expansion model with acceleration gradients.
MiyamotoNagaiDisk([only_vertical])
Model()	Base class for gravitational potential models.
NFW(**kwargs)	Navarro-Frenk-White (NFW) dark matter halo profile.
OffsetMiyamotoNagaiDisk(**kwargs)	Miyamoto-Nagai disk with vertical offset.
OortExpansion([vert_only])	Oort expansion (alpha) model with flexible vertical and radial components.
Plummer(**kwargs)	Plummer sphere mass distribution.
PointMass(**kwargs)	Point mass gravitational source.
RadialDensityOscillation(**kwargs)	Radial density oscillation model.
SinusoidalDisk(**kwargs)	Sinusoidal disk model with oscillatory vertical structure.
SphericalFlatRC(**kwargs)	Spherical potential with flat rotation curve.
Uniform3DAccel(**kwargs)	Uniform 3D acceleration model.
UniformAlos(**kwargs)	Uniform line-of-sight acceleration model.