dustmaps

dustmaps: A Python interface for maps of interstellar dust - Published in JOSS (2018)

https://github.com/gregreen/dustmaps

Science Score: 95.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 7 DOI reference(s) in README and JOSS metadata
  • Academic publication links
    Links to: joss.theoj.org, zenodo.org
  • Committers with academic emails
    2 of 12 committers (16.7%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
    Published in Journal of Open Source Software

Keywords from Contributors

astronomy astrophysics

Scientific Fields

Mathematics Computer Science - 84% confidence
Last synced: 4 months ago · JSON representation

Repository

A uniform interface for a number of 2D and 3D maps of interstellar dust reddening/extinction.

Basic Info
  • Host: GitHub
  • Owner: gregreen
  • License: other
  • Language: Python
  • Default Branch: master
  • Size: 2.08 MB
Statistics
  • Stars: 74
  • Watchers: 7
  • Forks: 25
  • Open Issues: 10
  • Releases: 14
Created over 9 years ago · Last pushed 10 months ago
Metadata Files
Readme License

README.md

DOI DOI

dustmaps

The dustmaps package provides a uniform interface for dealing with a number of 2D and 3D maps of interstellar dust reddening/extinction.

Supported Dust Maps

The currently supported dust maps are:

  1. Burstein & Heiles (1982; BH'82)
  2. Chen et al. (2014)
  3. Green, Schlafly, Finkbeiner et al. (2015,2018,2019; Bayestar)
  4. Marshall et al. (2006)
  5. Planck Collaboration (2013)
  6. Planck Collaboration (2016; GNILC)
  7. Sale et al. (2014; IPHAS)
  8. Schlegel, Finkbeiner & Davis (1998; SFD'98)
  9. Lenz, Hensley & Doré (2017)
  10. Peek & Graves (2010)
  11. Leike & Enßlin (2019)
  12. Leike, Glatzle & Enßlin (2020)
  13. Edenhofer et al. (2023)
  14. Chiang (2023; CSFD)
  15. Zucker, Saydjari, & Speagle et al. (2025; DECaPS)

To request addition of another dust map in this package, file an issue on GitHub, or submit a pull request.

Installation

Download the repository from GitHub and then run:

python setup.py install --large-data-dir=/path/where/you/want/large/data/files/stored

Alternatively, you can use the Python package manager pip:

pip install dustmaps

Getting the Data

To fetch the data for the SFD dust map, run:

python setup.py fetch --map-name=sfd

You can download the other dust maps by changing "sfd" to "csfd", "planck", "planckGNILC", "bayestar", "iphas", "marshall", "chen2014", "lenz2017", "pg2010", "leikeensslin2019", "leike2020", "edenhofer2023", "bh", or "decaps".

Alternatively, if you have used pip to install dustmaps, then you can configure the data directory and download the data by opening up a python interpreter and running:

>>> from dustmaps.config import config
>>> config['data_dir'] = '/path/where/you/want/large/data/files/stored'
>>>
>>> import dustmaps.sfd
>>> dustmaps.sfd.fetch()
>>>
>>> import dustmaps.csfd
>>> dustmaps.csfd.fetch()
>>>
>>> import dustmaps.planck
>>> dustmaps.planck.fetch()
>>>
>>> import dustmaps.planck
>>> dustmaps.planck.fetch(which='GNILC')
>>>
>>> import dustmaps.bayestar
>>> dustmaps.bayestar.fetch()
>>>
>>> import dustmaps.iphas
>>> dustmaps.iphas.fetch()
>>>
>>> import dustmaps.marshall
>>> dustmaps.marshall.fetch()
>>>
>>> import dustmaps.chen2014
>>> dustmaps.chen2014.fetch()
>>>
>>> import dustmaps.lenz2017
>>> dustmaps.lenz2017.fetch()
>>>
>>> import dustmaps.pg2010
>>> dustmaps.pg2010.fetch()
>>>
>>> import dustmaps.leike_ensslin_2019
>>> dustmaps.leike_ensslin_2019.fetch()
>>>
>>> import dustmaps.leike2020
>>> dustmaps.leike2020.fetch()
>>>
>>> import dustmaps.edenhofer2023
>>> dustmaps.edenhofer2023.fetch()
>>>
>>> import dustmaps.decaps
>>> dustmaps.decaps.fetch()

Querying the Maps

Maps are queried using astropy.coordinates.SkyCoord objects. This means that any coordinate system supported by astropy can be used as input. For example, we can query SFD'98 as follows:

>>> from dustmaps.sfd import SFDQuery
>>> from astropy.coordinates import SkyCoord
>>>
>>> sfd = SFDQuery()
>>>
>>> c = SkyCoord(
        '05h00m00.00000s',
        '+30d00m00.0000s',
        frame='icrs')
>>> print sfd(c)
0.483961

Above, we have used the ICRS coordinate system (the inputs are RA and Dec). We can use other coordinate systems, such as Galactic coordinates, and we can provide coordinate arrays. The following example uses both features:

>>> c = SkyCoord(
        [75.00000000, 130.00000000],
        [-89.00000000, 10.00000000],
        frame='galactic',
        unit='deg')
>>> print sfd(c)
[ 0.0146584   0.97695869]

Documentation

Read the full documentation at http://dustmaps.readthedocs.io/en/latest/.

Citation

If you make use of this software in a publication, please cite Green (2018) in The Journal of Open Source Software:

@ARTICLE{2018JOSS....3..695M,
       author = {{Green}, {Gregory M.}},
        title = "{dustmaps: A Python interface for maps of interstellar dust}",
      journal = {The Journal of Open Source Software},
         year = "2018",
        month = "Jun",
       volume = {3},
       number = {26},
        pages = {695},
          doi = {10.21105/joss.00695},
       adsurl = {https://ui.adsabs.harvard.edu/abs/2018JOSS....3..695M},
      adsnote = {Provided by the SAO/NASA Astrophysics Data System}
}

Development

Development of dustmaps takes place on GitHub, at https://github.com/gregreen/dustmaps. Any bugs, feature requests, pull requests, or other issues can be filed there. Contributions to the software are welcome.

Owner

  • Name: Gregory Green
  • Login: gregreen
  • Kind: user
  • Location: Heidelberg, Germany
  • Company: Max Planck Institute for Astronomy

Sofia Kovalevskaya Group Leader at the Max Planck Institute for Astronomy. Former postdoc at KIPAC, Stanford. PhD in Astronomy and Astrophysics from Harvard.

JOSS Publication

dustmaps: A Python interface for maps of interstellar dust
Published
June 27, 2018
Volume 3, Issue 26, Page 695
Authors
Gregory M. Green ORCID
Porat Fellow, Stanford/KIPAC
Editor
Arfon Smith ORCID
Tags
astronomy interstellar medium interstellar reddening interstellar extinction

GitHub Events

Total
  • Create event: 1
  • Release event: 1
  • Issues event: 4
  • Watch event: 11
  • Issue comment event: 7
  • Push event: 11
  • Pull request review comment event: 2
  • Pull request review event: 2
  • Pull request event: 8
  • Fork event: 3
Last Year
  • Create event: 1
  • Release event: 1
  • Issues event: 4
  • Watch event: 11
  • Issue comment event: 7
  • Push event: 11
  • Pull request review comment event: 2
  • Pull request review event: 2
  • Pull request event: 8
  • Fork event: 3

Committers

Last synced: 5 months ago

All Time
  • Total Commits: 287
  • Total Committers: 12
  • Avg Commits per committer: 23.917
  • Development Distribution Score (DDS): 0.178
Past Year
  • Commits: 31
  • Committers: 6
  • Avg Commits per committer: 5.167
  • Development Distribution Score (DDS): 0.452
Top Committers
Name Email Commits
Gregory M. Green g****n@g****m 236
Gordian Edenhofer g****r@g****m 20
Catherine Zucker Catherine Zucker c****r@C****l 17
Simon Krughoff k****f@l****g 4
Konstantin Malanchev h****t@g****m 2
Catherine Zucker c****r@g****m 2
conornally 3****y 1
andrew-saydjari s****i@g****u 1
Rui-Zhi Li (李睿智) 6****e 1
Leo Singer l****r@l****g 1
Daniel m****l@d****g 1
Arfon Smith a****n 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 4 months ago

All Time
  • Total issues: 41
  • Total pull requests: 25
  • Average time to close issues: about 2 months
  • Average time to close pull requests: about 2 months
  • Total issue authors: 30
  • Total pull request authors: 16
  • Average comments per issue: 2.44
  • Average comments per pull request: 1.08
  • Merged pull requests: 16
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 2
  • Pull requests: 8
  • Average time to close issues: 2 months
  • Average time to close pull requests: 29 days
  • Issue authors: 2
  • Pull request authors: 4
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.88
  • Merged pull requests: 5
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • gregreen (5)
  • MilesCranmer (3)
  • harenk (3)
  • Ompha (2)
  • andersdot (2)
  • SimonKrughoff (2)
  • acscott (1)
  • christinahedges (1)
  • jameshegarty1 (1)
  • eblur (1)
  • hombit (1)
  • Edenhofer (1)
  • sonithls (1)
  • DavidMoiseNataf (1)
  • ahlamaq (1)
Pull Request Authors
  • hombit (3)
  • andrew-saydjari (3)
  • catherinezucker (3)
  • Edenhofer (2)
  • lpsinger (2)
  • SimonKrughoff (2)
  • Astro-Lee (2)
  • leeskelvin (2)
  • conornally (1)
  • DanielLenz (1)
  • AlecThomson (1)
  • jan-rybizki (1)
  • j-faria (1)
  • arfon (1)
  • danhey (1)
Top Labels
Issue Labels
bug (8) enhancement (6) Python 3.x (4) help wanted (3) new map request (1) releases (1) question (1) documentation (1)
Pull Request Labels
enhancement (2)

Packages

  • Total packages: 2
  • Total downloads:
    • pypi 4,769 last-month
  • Total docker downloads: 3,884
  • Total dependent packages: 13
    (may contain duplicates)
  • Total dependent repositories: 42
    (may contain duplicates)
  • Total versions: 33
  • Total maintainers: 1
pypi.org: dustmaps

Uniform interface for multiple dust reddening maps.

  • Versions: 24
  • Dependent Packages: 10
  • Dependent Repositories: 42
  • Downloads: 4,769 Last month
  • Docker Downloads: 3,884
Rankings
Docker downloads count: 1.6%
Dependent repos count: 2.3%
Dependent packages count: 3.3%
Downloads: 3.9%
Average: 4.8%
Forks count: 8.8%
Stargazers count: 9.2%
Maintainers (1)
Last synced: 4 months ago
conda-forge.org: dustmaps
  • Versions: 9
  • Dependent Packages: 3
  • Dependent Repositories: 0
Rankings
Dependent packages count: 15.6%
Average: 30.9%
Dependent repos count: 34.0%
Forks count: 36.1%
Stargazers count: 37.7%
Last synced: 4 months ago

Dependencies

docs/requirements.txt pypi
  • Sphinx >=1.4.6
  • argparse >=1.2.1
  • nose >=1.3.7
  • progressbar2 >=3.30.2
  • six >=1.10.0
  • sphinx-autobuild >=0.6.0
  • sphinxcontrib-napoleon >=0.5.3
  • sphinxcontrib-programoutput >=0.8
setup.py pypi
  • astropy *
  • h5py *
  • healpy *
  • numpy *
  • progressbar2 *
  • requests *
  • scipy *
  • six *