Skip to content
Python Package to Interact with, Visualize, and Analyze the Wisconsin H-Alpha Mapper - Sky Survey
Python TeX Shell
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.ci
.github/ISSUE_TEMPLATE
astropy_helpers @ ca63040
docs
paper
whampy
.coveragerc
.gitignore
.gitmodules
.rtd-environment.yml
.travis.yml
LICENSE.rst
MANIFEST.in
README.rst
ah_bootstrap.py
appveyor.yml
readthedocs.yml
setup.cfg
setup.py

README.rst

Python Package to Interact with, Visualize, and Analyze the Wisconsin H-Alpha Mapper - Sky Survey

Powered by Astropy Badge https://travis-ci.com/Deech08/whampy.svg?branch=master https://coveralls.io/repos/github/Deech08/whampy/badge.svg?branch=master&service=github Documentation Status

The whampy package provides an easy way to load, view, and do science with the Wisconsin H-Alpha Mapper (WHAM) Sky Survey. It provides the following main features:

  • The ability to load the Sky Survey Data from the FITS table
  • The ability to quickly plot sections of the sky with beam maps
  • The ability to calculate moment maps and arithmetic using the data

Installation

You can install whampy using pip:

pip install whampy

To install the latest developer version of whampy you can type:

git clone https://github.com/Deech08/whampy.git
cd whampy
python setup.py install

You may need to add the --user option to the last line if you do not have root access. You can also install the latest developer version in a single line with pip:

pip install git+https://github.com/Deech08/whampy.git

Optional Dependencies

whampy contains some features that require additonal python packages that are included by default. If you would like to use some of these extra features, you will need to separately install those packages as well. These packages, with links to their documentation and installation instructions, are listed below.

The following two packages can be useful if working with the spectral-cube package along with whampy.

Quick Start

Here is a simple script demonstrating the modspectra package:

>>> from whampy.skySurvey import SkySurvey
>>> # Load the Survey
>>> survey = SkySurvey()
>>> # Compute Moments
>>> moment_0, err_0 = survey.moment(order = 0, return_sigma = True)
>>> moment_1, err_1 = survey.moment(order = 1, return_sigma = True)
>>> moment_2, err_2 = survey.moment(order = 2, return_sigma = True)

Full Documentation

Complete documentation of the package and its funcationality can be found at the link below: whampy Documentation

Contributing

Contributions, feedback, and bug reports are welcome from all users of whampy! If you discover a bug, or have a request for a new feature, please open an issue on this repository using one of the templates. If you would like to make a more direct contribution to the code, please submit a pull request to this repository. This package relies upon the work of the astropy team, and we also ask that all contributions follow the Astropy Community Code of Conduct.

License

This project is Copyright (c) DK (Dhanesh Krishnarao) and licensed under the terms of the BSD 3-Clause license. This package is based upon the Astropy package template which is licensed under the BSD 3-clause licence. See the licenses folder for more information.

You can’t perform that action at this time.