Skip to main content

The Milky Way Plotting Library

Project description

mwplotlib

An extension to Matplotlib that plots the shape of the Milky Way.

Installation

pip install mwplotlib

Usage

Here is a simple example of how to use mwplotlib:

from mwplotlib import MilkyWay
import matplotlib.pyplot as plt

# Plot the Milky Way in polar coordinates (region-style)
plt.figure(figsize=(9, 9))
plt.MilkyWay.shape(plot_type="polar", style="region")

# Plot the Milky Way in polar coordinates (line-style)
plt.figure(figsize=(9, 9))
plt.MilkyWay.shape(plot_type="polar", style="line")

# Plot the Milky Way in Cartesian coordinates (region-style)
plt.figure(figsize=(9, 9))
plt.MilkyWay.shape(plot_type="cartesian", style="region")

# Plot the Milky Way in Cartesian coordinates (line-style)
plt.figure(figsize=(9, 9))
plt.MilkyWay.shape(plot_type="cartesian", style="line")

For more examples of usage, please refer to examples notebook. Those examples are also available on Google Colab:

Reference

The galaxy model and data used in this package is based on the following paper:

@ARTICLE{2023ApJ...947...54X,
       author = {{Xu}, Y. and {Hao}, C.~J. and {Liu}, D.~J. and {Lin}, Z.~H. and {Bian}, S.~B. and {Hou}, L.~G. and {Li}, J.~J. and {Li}, Y.~J.},
        title = "{What Does the Milky Way Look Like?}",
      journal = {\apj},
     keywords = {Galaxy structure, Milky Way Galaxy, Trigonometric parallax, 622, 1054, 1713},
         year = 2023,
        month = apr,
       volume = {947},
       number = {2},
          eid = {54},
        pages = {54},
          doi = {10.3847/1538-4357/acc45c},
       adsurl = {https://ui.adsabs.harvard.edu/abs/2023ApJ...947...54X},
      adsnote = {Provided by the SAO/NASA Astrophysics Data System}
}

Please BOTH cite the above paper AND acknowledge this package if you are using it in your research.

License

This package is licensed under the MIT license. See LICENSE for details.

Acknowledgement

We would like to thank the authors of the above paper for making their data publicly available, which made this package possible. We would also like to credit Prof. Ryan Trainor at Franklin and Marshall College for his guidance and support.

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

mwplotlib-1.1.3.tar.gz (21.0 kB view details)

Uploaded Source

Built Distribution

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

mwplotlib-1.1.3-py2.py3-none-any.whl (20.6 kB view details)

Uploaded Python 2Python 3

File details

Details for the file mwplotlib-1.1.3.tar.gz.

File metadata

  • Download URL: mwplotlib-1.1.3.tar.gz
  • Upload date:
  • Size: 21.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.8.10

File hashes

Hashes for mwplotlib-1.1.3.tar.gz
Algorithm Hash digest
SHA256 9db577ee6e31ac7aee53bebcfe72809a8aec6ed8b0417b186e1542e10a959e25
MD5 dc3cec2d83d197b10dff86e1604b093f
BLAKE2b-256 e6e01909719c3f868f970c1704f290a9766a552065ae37b99f347354db07b794

See more details on using hashes here.

File details

Details for the file mwplotlib-1.1.3-py2.py3-none-any.whl.

File metadata

  • Download URL: mwplotlib-1.1.3-py2.py3-none-any.whl
  • Upload date:
  • Size: 20.6 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.8.10

File hashes

Hashes for mwplotlib-1.1.3-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 5624cff9ae89e28b1e94cad6aac30b493d3e1261ac3102b59636b004c0ac7e9d
MD5 b053822dc1f603c44020c389d5894028
BLAKE2b-256 cfb36c3f37431919109cf405704977917ff1bd89d139df933f2e0a38724ba4b5

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