Skip to main content

An all-sky 3D dust map based on Gaia and LAMOST.

Project description

dustmaps3d

🌌 An all-sky 3D dust extinction map based on Gaia and LAMOST

📄 Wang et al. (2025), An all-sky 3D dust map based on Gaia and LAMOST
📌 DOI: 10.12149/101620

📦 A Python package for easy access to the 3D dust map
📌 DOI: 10.12149/101619


📦 Installation

Install via pip:

pip install dustmaps3d

Note: Installing the package does not include the data file.
The ~350 MB model data will be automatically downloaded from GitHub on first use.
⚠️ If you experience network issues when downloading from GitHub,
you can manually download the data from NADC:
🔗 https://nadc.china-vo.org/res/r101619/


🚀 Usage

from dustmaps3d import dustmaps3d

l = [120.0]
b = [30.0]
d = [1.5]

EBV, dust, sigma, max_d = dustmaps3d(l, b, d)

print(f"EBV: {EBV[0]:.4f} [mag]")
print(f"Dust: {dust[0]:.4f} [mag/kpc]")
print(f"Sigma: {sigma[0]:.4f} [mag]")
print(f"Max distance: {max_d.iloc[0]:.4f} kpc")

Batch example with FITS:

import numpy as np
from astropy.io import fits
from astropy.table import Table
from dustmaps3d import dustmaps3d

data = Table.read('input.fits')
l = data['l'].astype(float)
b = data['b'].astype(float)
d = data['distance'].astype(float)

EBV, dust, sigma, max_d = dustmaps3d(l, b, d, n_process = 4)
# n_process: Optional parameter to specify number of threads; default is single-threaded. For example, set to 4 to use 4 threads for faster computation.

data['EBV_3d'] = EBV
data['dust'] = dust
data['sigma'] = sigma
data['max_distance'] = max_d

data.write('output.fits', overwrite=True)

🧠 Function Description

dustmaps3d(l, b, d, n_process=None)

Estimates 3D dust extinction and related quantities for given galactic coordinates and distances.

Input Type Description Unit
l np.ndarray Galactic longitude degrees
b np.ndarray Galactic latitude degrees
d np.ndarray Distance kpc
n_process int, optional Number of processes for parallel computing

Returns:

Output Type Description Unit
EBV np.ndarray E(B–V) extinction mag
dust np.ndarray Dust density (d(EBV)/dx) mag/kpc
sigma np.ndarray Estimated uncertainty in E(B–V) mag
max_d np.ndarray Maximum reliable distance kpc

If d contains NaN, it will be automatically replaced by the maximum reliable distance along that line of sight (max_d).

If the input d exceeds max_d, it indicates the point lies beyond the model's reliable range. The returned values in this case are extrapolated and not guaranteed to be accurate.


⚡ Performance

  • Fully vectorized and optimized with NumPy
  • Supports multiprocessing with n_process argument
  • On a modern personal computer, evaluating 100 million stars takes only ~60 seconds

📂 Data Version

This version uses data_v2.1.parquet, released under v2.1


📜 Citation

If you use this model or the Python package, please cite both:

  • Wang, T. (2025), An all-sky 3D dust map based on Gaia and LAMOST. DOI: 10.12149/101620
  • dustmaps3d: A Python package for easy access to the 3D dust map. DOI: 10.12149/101619

🛠️ License

This project is open-source and distributed under the MIT License.


📫 Contact

If you have any questions, suggestions, or encounter issues using this package,
please feel free to contact the authors via GitHub issues or email.

🔗 GitHub Repository

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

dustmaps3d-2.1.5.tar.gz (5.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

dustmaps3d-2.1.5-py3-none-any.whl (6.2 kB view details)

Uploaded Python 3

File details

Details for the file dustmaps3d-2.1.5.tar.gz.

File metadata

  • Download URL: dustmaps3d-2.1.5.tar.gz
  • Upload date:
  • Size: 5.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.3

File hashes

Hashes for dustmaps3d-2.1.5.tar.gz
Algorithm Hash digest
SHA256 2170334ebb0a67064a6bd74ab2788dee90651e1d6b032a7e725fddc232175caf
MD5 d8a90c9ae829de5038ccd354f13bf484
BLAKE2b-256 da976fbd1479ca83d4e5657dffea865b5d0031d948e8bff8f3cc8a015cbfae8c

See more details on using hashes here.

File details

Details for the file dustmaps3d-2.1.5-py3-none-any.whl.

File metadata

  • Download URL: dustmaps3d-2.1.5-py3-none-any.whl
  • Upload date:
  • Size: 6.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.3

File hashes

Hashes for dustmaps3d-2.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 1499e2a06469a8b6e51fd93658fb8432af0f427f18884dc3de380546ef9cbe4e
MD5 7f5a3a8d002e0201209c18ff0d2f5d0f
BLAKE2b-256 47253b25a87ae339c8ce5e2ab3f2efddd284a351a85c2f2d66af15ce371cff26

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page