Skip to content

Commit

Permalink
Update Units docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
jeonggyukim committed Nov 2, 2024
1 parent 4392129 commit d5b650c
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions pyathena/util/units.py
Original file line number Diff line number Diff line change
Expand Up @@ -28,17 +28,17 @@ def __init__(self, kind='LV', muH=1.4271, units_dict=None):
Example
-------
# Athena-TIGRESS with classic cooling
>>> u = Units(kind='LV', muH=1.4271)
# Athena-TIGRESS with NCR cooling
>>> u = Units(kind='LV', muH=1.4)
# TIGRIS "ism" unit system or any other custom unit system
>>> u = Units(kind='LV', muH=1.4271) # Athena-TIGRESS with classic cooling
>>> u = Units(kind='LV', muH=1.4) # Athena-TIGRESS with NCR cooling
>>> units_dict = {'units_system': 'ism',
'mass_cgs': 4.91615563682836e+31,
'length_cgs': 3.085678e+18,
'time_cgs': 30856780000000,
'mean_mass_per_hydrogen': 2.34262e-24}
>>> u = Units('custom', units_dict=units_dict)
# TIGRIS "ism" unit system or any other custom unit system
"""
mH = (1.008*au.u).to('g')
# If code units, set [L]=[M]=[T]=1 and return.
Expand Down

0 comments on commit d5b650c

Please sign in to comment.