Skip to content

Google docstrings #19

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mattyowl merged 5 commits into from
May 27, 2026
Merged

Google docstrings #19

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
2d062c2
Convert all docstrings from epydoc to Google style
mattyowl May 26, 2026
bd394b8
Fix Sphinx autodoc failure when C extension is not compiled
mattyowl May 26, 2026
ea8cdf5
Add Sphinx cross-reference links throughout docstrings
mattyowl May 27, 2026
46e7135
Add module links in docs index and astStats to API reference
mattyowl May 27, 2026
1bc7c50
Format inline URLs as named hyperlinks in README
mattyowl May 27, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 14 additions & 13 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,21 +11,22 @@

**astLib** is divided into several modules:

* astCalc (general calculations, e.g. luminosity distance etc.)
* astCoords (coordinate conversions etc.)
* astImages (clip sections from .fits etc.)
* astPlots (provides a flexible image plot class, e.g. plot image with catalogue objects overlaid)
* astSED (calculate colours, magnitudes from stellar population models or spectral templates, fit photometric observations using stellar population models etc.)
* astStats (statistics, e.g. biweight location/scale estimators etc.)
* astWCS (routines for using FITS World Coordinate System information)
* :mod:`astLib.astCalc` (general calculations, e.g. luminosity distance etc.)
* :mod:`astLib.astCoords` (coordinate conversions etc.)
* :mod:`astLib.astImages` (clip sections from .fits etc.)
* :mod:`astLib.astPlots` (provides a flexible image plot class, e.g. plot image with catalogue objects overlaid)
* :mod:`astLib.astSED` (calculate colours, magnitudes from stellar population models or spectral templates, fit photometric observations using stellar population models etc.)
* :mod:`astLib.astStats` (statistics, e.g. biweight location/scale estimators etc.)
* :mod:`astLib.astWCS` (routines for using FITS World Coordinate System information)

The astWCS module is a higher level interface to PyWCSTools, a simple SWIG (http://www.swig.org) wrapping
of some of the routines from WCSTools by Jessica Mink (http://tdc-www.harvard.edu/software/wcstools/). It is
The astWCS module is a higher level interface to PyWCSTools, a simple `SWIG <http://www.swig.org>`_ wrapping
of some of the routines from `WCSTools <http://tdc-www.harvard.edu/software/wcstools/>`_ by Jessica Mink. It is
used by some routines in astCoords, astImages and astPlots.

The goal of **astLib** was to provide features useful to astronomers that are not included in the scipy
(http://scipy.org), numpy (http://numpy.scipy.org) or matplotlib (http://matplotlib.sourceforge.net) modules
on which astLib depends. For a far more extensive set of Python astronomy modules, see astropy
(http://www.astropy.org/).
The goal of **astLib** was to provide features useful to astronomers that are not included in the
`scipy <http://scipy.org>`_, `numpy <http://numpy.scipy.org>`_ or
`matplotlib <http://matplotlib.sourceforge.net>`_ modules
on which astLib depends. For a far more extensive set of Python astronomy modules, see
`astropy <http://www.astropy.org/>`_.

Some scripts using **astLib** can be found in the examples/ folder provided with the source code distribution.
Loading
Loading