Data

Tools

Indexes

Applications

Experiments

Open Source Science

whampy

whampy: Python Package to Interact with, Visualize, and Analyze the Wisconsin H-Alpha Mapper - Sky Survey - Published in JOSS (2019)

https://github.com/deech08/whampy

Science Score: 93.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ✓
    DOI references
    Found 4 DOI reference(s) in README and JOSS metadata
  • ✓
    Academic publication links
    Links to: joss.theoj.org
  • ○
    Committers with academic emails
  • ○
    Institutional organization owner
  • ✓
    JOSS paper metadata
    Published in Journal of Open Source Software
Last synced: 6 months ago · JSON representation

Repository

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

Basic Info
  • Host: GitHub
  • Owner: Deech08
  • License: bsd-3-clause
  • Language: Python
  • Default Branch: master
  • Homepage:
  • Size: 89.5 MB
Statistics
  • Stars: 7
  • Watchers: 3
  • Forks: 1
  • Open Issues: 2
  • Releases: 7
Created over 7 years ago · Last pushed over 1 year ago
Metadata Files
Readme License

README.rst 

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

.. image:: https://joss.theoj.org/papers/10.21105/joss.01940/status.svg
   :target: https://doi.org/10.21105/joss.01940

.. image:: http://img.shields.io/badge/powered%20by-AstroPy-orange.svg?style=flat
    :target: http://www.astropy.org
    :alt: Powered by Astropy Badge

.. image:: https://github.com/Deech08/whampy/actions/workflows/tests.yml/badge.svg
   :target: https://github.com/Deech08/whampy/actions/workflows/tests.yml

.. image:: https://coveralls.io/repos/github/Deech08/whampy/badge.svg?branch=master&service=github
	:target: https://coveralls.io/github/Deech08/whampy?branch=master&service=github

.. image:: https://readthedocs.org/projects/whampy/badge/?version=latest
	:target: https://whampy.readthedocs.io/en/latest/?badge=latest
	:alt: 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.

* `cartopy `_
* `spectral cube `_

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

* `pyregion `_
* `Regions `_


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.

Owner

  • Name: Dhanesh (DK) Krishnarao
  • Login: Deech08
  • Kind: user

JOSS Publication

whampy: Python Package to Interact with, Visualize, and Analyze the Wisconsin H-Alpha Mapper - Sky Survey
Published
December 24, 2019
DOI
Volume 4, Issue 44, Page 1940
Authors
Dhanesh Krishnarao ORCID
Department of Astronomy, University of Wisconsin-Madison
Editor
Juanjo Bazán ORCID
Tags
astronomy interstellar medium emission lines position-position-velocity kinematics
View PDF Review Thread Software Archive

GitHub Events

Total
  • Issues event: 2
Last Year
  • Issues event: 2

Committers

Last synced: 7 months ago

All Time
  • Total Commits: 130
  • Total Committers: 3
  • Avg Commits per committer: 43.333
  • Development Distribution Score (DDS): 0.323
Past Year
  • Commits: 0
  • Committers: 0
  • Avg Commits per committer: 0.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
DK d****o@i****m 88
Dhanesh (DK) Krishnarao 3****8 41
Pey Lian Lim 2****m 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 18
  • Total pull requests: 1
  • Average time to close issues: about 2 months
  • Average time to close pull requests: 2 months
  • Total issue authors: 4
  • Total pull request authors: 1
  • Average comments per issue: 1.94
  • Average comments per pull request: 0.0
  • Merged pull requests: 1
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 2
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 2
  • Pull request authors: 0
  • Average comments per issue: 0.0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • HeloiseS (11)
  • Gabriel-p (4)
  • pllim (2)
  • ashill (1)
Pull Request Authors
  • pllim (1)
Top Labels
Issue Labels
bug (8) enhancement (2)
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 9 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 1
  • Total versions: 15
  • Total maintainers: 1
pypi.org: whampy

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

  • Versions: 15
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 9 Last month
Rankings
Dependent packages count: 10.0%
Stargazers count: 20.3%
Dependent repos count: 21.7%
Forks count: 22.6%
Average: 24.8%
Downloads: 49.5%
Maintainers (1)
Deech08
Last synced: 6 months ago

Dependencies

setup.py pypi
  • astropy *
  • s.strip *
.github/workflows/tests.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v3 composite