physiokinematic package

Submodules

physiokinematic.distance_model module

physiokinematic.hii_region_model module

physiokinematic.loader module

loader.py Load HII region data from database.

Copyright(C) 2023-2025 by Trey V. Wenger; tvwenger@gmail.com Ryan Bakko This code is licensed under MIT license (see LICENSE for details)

physiokinematic.loader.loader(db)

Returns HII region data as a pandas DataFrame.

Inputs:
db :: string

Path to database file

Returns:
data :: pd.DataFrame

HII region data

physiokinematic.utils module

utils.py Utility functions.

Copyright(C) 2023-2025 by Trey V. Wenger; tvwenger@gmail.com Ryan Bakko This code is licensed under MIT license (see LICENSE for details)

physiokinematic.utils.distance(glong: float, glat: float, Rgal: float, R0: float = 8.166)

Return the distances at which a given line-of-sight crosses a given Galactocentric radius.

Parameters:
glongfloat

Galactic longitude (degrees)

glatfloat

Galactic latitude (degrees)

Rgalfloat

Galactocentric radius (kpc)

R0float, optional

Solar Galactocentric radius (kpc), by default __R0

Returns:
float, float

Near and far distances. Near distance is negative when not allowed. Both distances are nan if line of sight never crosses Rgal.

physiokinematic.utils.reid19_theta(R: float, R0: float = 8.166, a2: float = 0.977, a3: float = 1.623)

Calculate the Reid et al. (2019) circular rotation speed at a given Galactocentric radius.

Parameters:
Rfloat

Galactocentric radius (kpc)

R0float, optional

Solar Galactocentric radius (kpc), by default __R0

a2float, optional

Parameter that defines rotation curve, by default __a2

a3float, optional

Parameter that defines rotation curve, by default __a3

Returns:
float

Circular rotation speed (km/s)

physiokinematic.utils.reid19_vlsr(glong: float, glat: float, R: float, R0: float = 8.166, a2: float = 0.977, a3: float = 1.623, Usun: float = 10.449, Vsun: float = 12.092, Wsun: float = 7.729)

Calculate the Reid et al. (2019) rotation curve LSR velocity at a given position.

Parameters:
glongfloat

Galactic longitude (degrees)

glatfloat

Galactic latitude (degrees)

Rfloat

Galactocentric radius (kpc)

R0float, optional

Solar Galactocentric radius (kpc), by default __R0

a2float, optional

Parameter that defines rotation curve, by default __a2

a3float, optional

Parameter that defines rotation curve, by default __a3

Usunfloat, optional

Solar motion relative to the LSR (km/s), by default __Usun

Vsunfloat, optional

Solar motion relative to the LSR (km/s), by default __Vsun

Wsunfloat, optional

Solar motion relative to the LSR (km/s), by default __Wsun

Returns:
float

LSR velocity (km/s)

Module contents