mwdust 1.6__cp314-cp314-macosx_11_0_arm64.whl

mwdust-1.6.dist-info/METADATA

@@ -0,0 +1,265 @@
+Metadata-Version: 2.4
+Name: mwdust
+Version: 1.6
+Summary: Dust in the Milky Way
+Home-page: https://github.com/jobovy/mwdust
+Author: Jo Bovy
+Author-email: bovy@astro.utoronto.ca
+License: New BSD
+Classifier: Development Status :: 6 - Mature
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: C
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Scientific/Engineering :: Astronomy
+Classifier: Topic :: Scientific/Engineering :: Physics
+License-File: LICENSE
+License-File: AUTHORS.txt
+Requires-Dist: numpy
+Requires-Dist: scipy
+Requires-Dist: matplotlib
+Requires-Dist: astropy
+Requires-Dist: h5py
+Requires-Dist: tqdm
+Requires-Dist: requests
+Requires-Dist: healpy
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: home-page
+Dynamic: license
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: summary
+
+mwdust
+======
+
+**Dust in 3D in the Milky Way**
+
+
+
+
+
+| 
+
+.. contents:: **Contents**
+    :depth: 3
+
+Installation
+-------------
+
+Install the latest released version using ``pip``:
+
+..  code-block::
+
+   pip install mwdust
+
+To install the latest development version, clone the repository and do
+
+..  code-block::
+
+   python setup.py install
+
+or 
+
+..  code-block::
+
+   python setup.py install --user
+
+Using custom implementations of necessary HEALPIx functions, basic 
+evaluation of extinction is available on all platforms (Linux, Mac OS,
+Windows) for all dust maps. However, some HEALPIx-based features like 
+plotting require ``healpy``, which is unavailable on Windows.
+Install on Linux/Mac OS for full functionality.
+
+Dust Data
+---------
+
+By default, dust maps are download when you use them for the first time. 
+If you define an environment variable ``DUST_DIR``, then all dust data
+downloaded by the code will be downloaded to this directory. If you do not
+set the ``DUST_DIR`` variable, then ``mwdust`` will download data to ``~/.mwdust``. 
+
+The code can download all of the necessary data at by running
+
+..  code-block:: python
+
+   from mwdust import download_all
+   download_all()
+
+Note that some of the maps are very large (multiple GB) and some of the downloads 
+are slow, so this may take a while.
+
+The data are put in subdirectories of a directory ``DUST_DIR`` or ``~/.mwdust``, with
+roughly the following lay-out::
+
+    $DUST_DIR/
+       combined15/
+          dust-map-3d.h5
+       combined19/
+          combine19.h5
+       green15/
+          dust-map-3d.h5
+       green17/
+          bayestar2017.h5
+       green19/
+          bayestar2019.h5
+       zucker25/
+      	  decaps_mean.h5
+          decaps_mean_and_samples.h5
+       maps/
+          SFD_dust_4096_ngp.fits
+          SFD_dust_4096_sgp.fits
+       marshall06/
+          ReadMe
+	       table1.dat
+       sale14/
+          Amap.dat
+          ReadMe
+
+The data for the Drimmel et al. (2003) map is installed in the code
+directory, because it is not very large.
+
+Usage
+------
+
+All of the maps can be initialized similar to
+
+..  code-block:: python
+
+   import mwdust
+   drimmel= mwdust.Drimmel03(filter='2MASS H')
+   combined= mwdust.Combined15(filter='2MASS H')
+   combined19= mwdust.Combined19(filter='2MASS H')
+   sfd= mwdust.SFD(filter='2MASS H')
+
+which sets up the Drimmel et al. (2003) map, the combined Bovy et
+al. (2016) map, an updated version of the combined map using the Green
+et al. (2019) Bayestar19 map, and the SFD map for the *H*-band
+filter. The maps can be evaluate for a given Galactic longitude *l*,
+Galactic latitude *b*, and an array (or scalar) of distances *D*
+
+..  code-block:: python
+
+   drimmel(60.,0.,3.) # inputs are (l,b,D)
+   array([ 0.38813341])
+   combined(30.,3.,numpy.array([1.,2.,3.,10.]))
+   array([ 0.22304147,  0.55687252,  0.86694602,  1.18779507])
+   # SFD is just the constant SFD extinction
+   sfd(30.,3.,numpy.array([1.,2.,3.]))
+   array([ 1.19977335,  1.19977335,  1.19977335])
+
+and they can be plotted as a function of distance at a given (l,b)
+
+..  code-block:: python
+
+   combined.plot(55.,0.5) # inputs are (l,b)
+
+(plot not shown). Maps that are derived from the ``HierarchicalHealpixMap.py`` class (currently all Green-type maps and
+the combined maps) can be vectorized to evaluate on array inputs of *l*, *b*, *D*
+
+..  code-block:: python
+
+   combined(numpy.array([30.,40.,50.,60.]),numpy.array([3.,4.,3.,6.]),numpy.array([1.,2.,3.,10.]))
+   array([0.22304147, 0.3780736 , 0.42528571, 0.22258065])
+
+They can also be plotted on the sky using a Mollweide projection at a given distance using
+
+..  code-block:: python
+
+   combined.plot_mollweide(5.) # input is distance in kpc
+
+Note that this requires ``healpy`` to be installed, so this does not work on Windows.
+
+Supported bandpasses
+---------------------
+
+Currently only a few filters are supported. 
+To obtain E(B-V), specify ``filter='E(B-V)'``.
+To check what bandpasses are supported on the ``sf10=True`` scale
+(these are all the bandpasses from Table 6 in `Schlafly & Finkbeiner
+2011 <http://adsabs.harvard.edu/abs/2011ApJ...737..103S>`__), do
+
+..  code-block:: python
+
+   from mwdust.util import extCurves  
+   extCurves.avebvsf.keys()
+
+which gives
+
+..  code-block:: python
+
+   ['Stromgren u',
+      'Stromgren v',
+      'ACS clear',
+      'CTIO R',
+      'CTIO V',
+      'CTIO U',
+      'CTIO I',
+      ...]
+
+To check the bandpasses that are supported on the old SFD scale (``sf10=False``), do
+
+..  code-block:: python
+
+   numpy.array(extCurves.avebv.keys())[True-numpy.isnan(extCurves.avebv.values())]
+
+which gives
+
+..  code-block:: python
+
+   array(['CTIO R', 'CTIO V', 'CTIO U', 'CTIO I', 'CTIO B', 'DSS-II i',
+      'DSS-II g', 'WISE-1', 'WISE-2', 'DSS-II r', 'UKIRT H', 'UKIRT J',
+      'UKIRT K', 'IRAC-1', 'IRAC-2', 'IRAC-3', 'IRAC-4', '2MASS H',
+      'SDSS r', 'SDSS u', 'SDSS z', 'SDSS g', 'SDSS i', '2MASS Ks',
+      '2MASS J'], dtype='|S14')
+
+
+If no filter is supplied, *E(B-V)* is returned on the SFD scale if the object is initialized
+with ``sf10=True`` (which tells the code to use re-scalings from
+`Schlafly & Finkbeiner 2011
+<http://adsabs.harvard.edu/abs/2011ApJ...737..103S>`__). ``sf10=True``
+is the default initialization for every map, so be careful in
+interpreting the raw *E(B-V)* that come out of the code when 
+not setting ``filter`` or when setting ``filter=None``. *Only use*
+``sf10=False`` *when you have an extinction map in true E(B-V)*, **not**
+*SFD E(B-V)*. No map currently included in this package is in this
+situation, so using ``sf10=False`` is never recommended.
+
+Acknowledging ``mwdust`` and its data
+---------------------------------------
+
+When making use of this code in a publication, please cite `Bovy et
+al. (2015a) <http://arxiv.org/abs/1509.06751>`__. Also cite the relevant papers for the dust
+map that you use:
+
+* **mwdust.SFD**: `Schlegel et al. (1998) <http://adsabs.harvard.edu/abs/1998ApJ...500..525S>`__
+
+* **mwdust.Drimmel03**: `Drimmel et al. (2003) <http://adsabs.harvard.edu/abs/2003A%26A...409..205D>`__
+
+* **mwdust.Marshall06**: `Marshall et al. (2006) <http://adsabs.harvard.edu/abs/2006A%26A...453..635M>`__
+
+* **mwdust.Sale14**: `Sale et al. (2014) <http://adsabs.harvard.edu/abs/2014MNRAS.443.2907S>`__
+
+* **mwdust.Green15**: `Green et al. (2015) <https://ui.adsabs.harvard.edu/abs/2015ApJ...810...25G>`__
+
+* **mwdust.Green17**: `Green et al. (2018) <https://ui.adsabs.harvard.edu/abs/2018MNRAS.478..651G>`__ (added by `@jan-rybizki <https://github.com/jan-rybizki>`__)
+
+* **mwdust.Green19**: `Green et al. (2019) <https://ui.adsabs.harvard.edu/abs/2019arXiv190502734G>`__ (added by `@jan-rybizki <https://github.com/jan-rybizki>`__)
+
+* **mwdust.Zucker25**: `Zucker et al. (2025) <https://ui.adsabs.harvard.edu/abs/2025arXiv250302657Z>`__
+
+* **mwdust.Combined15**: Combination of 
+  
+  * `Marshall et al. (2006) <http://adsabs.harvard.edu/abs/2006A%26A...453..635M>`__ (**mwdust.Marshall06**),
+  * `Green et al. (2015) <http://adsabs.harvard.edu/abs/2015arXiv150701005G>`__ (**mwdust.Green15**), and 
+  * `Drimmel et al. (2003) <http://adsabs.harvard.edu/abs/2003A%26A...409..205D>`__ (**mwdust.Drimmel03**); 
+  
+  see `Bovy et al. (2015a) <http://adsabs.harvard.edu/abs/2015arXiv150906751B>`__.
+
+* **mwdust.Combined19**: Similar to **mwdust.Combined15**, but using **mwdust.Green19** instead of **mwdust.Green15**; see `Bovy et al. (2015a) <http://adsabs.harvard.edu/abs/2015arXiv150906751B>`__ for details on the combination (added by `@jan-rybizki <https://github.com/jan-rybizki>`__)
+
+* **mwdust.Zero**: `Bovy et al. (2015b) <http://adsabs.harvard.edu/abs/2015arXiv150905796B>`__ :smirk:

mwdust-1.6.dist-info/RECORD

@@ -0,0 +1,33 @@
+sfd_c.cpython-314-darwin.so,sha256=s2w46pxr9uyunLHAZJIYo-21yIs9uvKpwuh7mP54eDY,108024
+healpix_c.cpython-314-darwin.so,sha256=Z1eQT62LBnjmfEdQLGfEpx6KsNZ3E749GhbV5F5SIgo,52688
+mwdust/Marshall06.py,sha256=YuwZ6t4Qq5PUbBS-xQ6hM8JtCALxlxL0OJRiJ6kjfUM,11169
+mwdust/DustMap3D.py,sha256=pOFUBcGHE7cMQgnWmbIEQgBtfTwRlwKUgK91F-nla5Q,3376
+mwdust/Green19.py,sha256=jIIyjV1L-r-tcrHLAexwryKza31WucWZoUqHYJeK9ag,3714
+mwdust/Green17.py,sha256=ycGNlrzfTcXB6pEre889FjyWrthPAxjuh_Yi-Z6wq-s,3761
+mwdust/SFD.py,sha256=ikaMJ2KU1KpOqaDI5TGBfc2j7PeI2BOjfwCcpzazlPs,2734
+mwdust/HierarchicalHealpixMap.py,sha256=iPngVe6z5p5hkkI1c1ne5MF4IF1ZQ4avUEqSM8MtqMI,10324
+mwdust/__init__.py,sha256=y_lzwtz3i9jQgx_jkzVhDckLm5nhu_Tr2M0U-9YdlVA,794
+mwdust/Combined19.py,sha256=H0qzRP2-HhfPT7ScaeDe_OrtR-YOF5qoeHP4E5iRLgA,2831
+mwdust/Zero.py,sha256=EbYTq739rlPi79lkoFgQus_EJZxY0laElAWxkcKEY1A,1949
+mwdust/Green15.py,sha256=daSzGojQw4QsGYUl7dfYF_FGU9NC7iqsVbdlqM4Mgvk,3685
+mwdust/Zucker25.py,sha256=wNT_f719-PV_DnU07uxubtoz5mBCQ0pXlJjh_qRvVXo,4500
+mwdust/Combined15.py,sha256=MsiS3sNe6kpgzY1WJYRwufeeTeaoKUyeVViDWDO6eoo,2819
+mwdust/Drimmel03.py,sha256=qVcXKrDELzf3btiCDU_LdPbGfohzYBkgB36C1l5Czjg,12166
+mwdust/Sale14.py,sha256=TbDYf-FdajMlyuDexF7PwFI8iJpft4MerjY92t9As7Q,9115
+mwdust/util/fortranfile.py,sha256=NYghSGLMBZnmiFYkelw0PZ6TPoMPNGprOXQp6-Pyv3g,8799
+mwdust/util/extCurves.py,sha256=1bO3-MYAxDEbz0t6jutrOO-6vPBVus4jpcibCxf8szQ,2102
+mwdust/util/download.py,sha256=6TzlCwYTAOmmAigKM4y83mjZWT_a-uAxU8gHdiMGvFI,1106
+mwdust/util/tools.py,sha256=F_86rb71azFw5JmE4S0QSxJX_HHXjRqs1BhVbHm3c4o,921
+mwdust/util/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+mwdust/util/combine_dustmaps19.py,sha256=ha3OPAWJpRgQgtUkCLDSf3OmY0sRs2E3wx2hbXHA3hg,9137
+mwdust/util/healpix.py,sha256=zjy-ToIOeln5mnHCv4Hh3ClYReqEMjPGc3aECRlSnCI,12759
+mwdust/util/read_SFD.py,sha256=_Gdn9NCFoTyqbyKx2VjA7KuiAt3oLRkmPjrmMAscP8o,4366
+mwdust/util/read_Drimmel.py,sha256=-rXQHvaozSWLwb9c_GGfjUSO6B58cHp8aDGK0i6aqCg,2487
+mwdust/util/extCurves/extinction.tbl,sha256=YxMdJ8MIryxcFktWOn7Sd_Ro3VOXxjs6j8cm0NY4J9A,4385
+mwdust/util/extCurves/apj398709t6_ascii.txt,sha256=WEE5Z93xpw5MErEbSpH7LEVyv1xkRe_o0Qbp5m3zliw,4228
+mwdust-1.6.dist-info/RECORD,,
+mwdust-1.6.dist-info/WHEEL,sha256=2Id6qreet5t4wZv58bZfijJ58qrc2xkw6OVvWfeqxV0,136
+mwdust-1.6.dist-info/top_level.txt,sha256=Np8Osh_Yamek_ExIk8NZPvP02xYOChGgGHHyth4l2GY,35
+mwdust-1.6.dist-info/METADATA,sha256=gUA21Ie0K3kASDeTaWnzWFJwPra6Bmjc0cTdklaELNc,8611
+mwdust-1.6.dist-info/licenses/LICENSE,sha256=-c8EkMS9umaZ5szXj3P1AtBCbq7saCaDWZDR2GsHFEE,1488
+mwdust-1.6.dist-info/licenses/AUTHORS.txt,sha256=9sv1C5aD1kGrUyto3icM1b4T6v3etsS4-ooHrTYSRfk,333

mwdust-1.6.dist-info/WHEEL

@@ -0,0 +1,6 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.9.0)
+Root-Is-Purelib: false
+Tag: cp314-cp314-macosx_11_0_arm64
+Generator: delocate 0.13.0
+

mwdust-1.6.dist-info/licenses/AUTHORS.txt

@@ -0,0 +1,8 @@
+Author:
+
+Jo Bovy <bovy@astro.utoronto.ca>
+
+Direct contributions to the code base:
+
+Henry Leung (Windows support for SFD; custom HEALPIx implementation allowing use on Windows; dust map downloads during use rather than installation; some dependency maintenance)
+Surhud More (fix SFD links in 122343153eca80dc2dae433ed46062e828fc90c1)

mwdust-1.6.dist-info/licenses/LICENSE

@@ -0,0 +1,27 @@
+Copyright (c) 2013-2015, Jo Bovy
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice, this
+  list of conditions and the following disclaimer in the documentation and/or
+  other materials provided with the distribution.
+
+* Neither the name of the {organization} nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

mwdust-1.6.dist-info/top_level.txt

@@ -0,0 +1,4 @@
+healpix_c
+mwdust
+mwdust/util
+sfd_c