utilipy on import¶
This is the documentation for the top-level of utilipy, ie, what happens on import.
Reference/API¶
utilipy Package¶
The utilipy Package.
Welcome to utilipy, a collection of useful python codes. This is a centralized repository for non project-specific code. There are modules for making advanced decorators, interfacing with IPython environments, miscellaneous astronomical functions, data utilities, making fitting libraries inter-operable, improving astropy units and quantity-enabled functions, and much more.
Routine Listings¶
helputilipyhelp function. Online search or offline overview.online_helpSearch the online
utilipydocumentation for the given query.wrapsoverrides the default
functools.wraps, adding signature and docstring features.LogFileClass for basic logger that can both print and record to a file.
ObjDictExpanded dictionary with better slicing and attribute-style access. Use sparingly. Intended for rapid prototyping since it is NOT a high performance object.
References¶
Zenodo [R661196aee72d-1], Astropy [R661196aee72d-2]
- R661196aee72d-1
nstarman. (2020, March 23). nstarman/astroPHD: astropy_template (Version astropy_template). Zenodo. http://doi.org/10.5281/zenodo.3724822
- R661196aee72d-2
Astropy Collaboration et al., 2018, AJ, 156, 123.
Examples¶
help¶
To do a specific search of utilipy’s docs, use the online_help function.
If you don’t have a specific query, that’s fine too,
utilipy will open the general search page.
As an example, here we query RTD for the documentation on LogFile.
>>> import utilipy
>>> utilipy.online_help(query="LogFile")
The same can be accomplished with the general help function.
>>> import utilipy
>>> utilipy.help(query="LogFile", online=True)
Functions¶
|
Improved implementation of |
|
|
|
Search the online |
Classes¶
|
Class for basic logger that can both print and record to a file. |
|
Dictionary-like object intended to store information. |