astronat on import

This is the documentation for the top-level of astronat, ie, what happens on import.

Subpackages

• Constants (astronat.constants)
• Units (astronat.units)
• sc (astronat.sc)

Reference/API

astronat Package

The astronat Package.

Welcome to astronat, for astrophysics concomitant codes. There are modules for astronomical functions, improving astropy units and quantity-enabled functions, and much more.

Routine Listings

help

astronat help function. Online search or offline overview.

online_help

Search the online astronat documentation for the given query.

References

Utilipy [R9ca964349c90-1], Astropy [R9ca964349c90-2]

R9ca964349c90-1

nstarman. (2020, March 23). nstarman/utilipy: astropy_template (Version astropy_template). Zenodo. http://doi.org/10.5281/zenodo.3724822

R9ca964349c90-2

Astropy Collaboration et al., 2018, AJ, 156, 123.

Examples

help

To do a specific search of astronat’s docs, use the online_help function. If you don’t have a specific query, that’s fine too, astronat will open the general search page.

As an example, here we query RTD for the documentation on LogFile.

>>> import astronat
>>> astronat.online_help(query="distance_modulus") 

The same can be accomplished with the general help function.

>>> import astronat
>>> astronat.help(query="distance_modulus", online=True) 

Functions

help([query, online])	astronat help function.
online_help([query])	Search the online documentation for the given query.
reload_config()	Reload astronat configuration.