Metadata-Version: 2.1
Name: diskmap
Version: 0.3.0
Summary: Scattered light mapping of protoplanetary disks
Author-email: Tomas Stolker <stolker@strw.leidenuniv.nl>
License: MIT License
Project-URL: Documentation, https://diskmap.readthedocs.io
Project-URL: Repository, https://github.com/tomasstolker/diskmap
Project-URL: Issues, https://github.com/tomasstolker/diskmap/issues
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: License :: OSI Approved :: MIT License
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering :: Astronomy
Requires-Python: <3.13,>=3.10
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: astropy
Requires-Dist: numpy
Requires-Dist: scipy
Requires-Dist: typeguard

*diskmap*
=========

.. container::

    |PyPI Status| |Python Versions| |CI Status| |Docs Status| |Code Coverage| |Code Quality| |License|

*diskmap* is a tool for scattered light mapping of protoplanetary disks. The disk surface is parameterized with a power law profile or read from an input file. The projected radius and scattering angle are then calculated at each pixel. From this, a 3D deprojected image and a stellar irradiation corrected image are computed. Also a polarized scattering phase function is extracted and an total intensity phase function is estimated.

Documentation
-------------

Documentation can be found at `http://diskmap.readthedocs.io <http://diskmap.readthedocs.io>`_. There is a `notebook tutorial <https://diskmap.readthedocs.io/en/latest/tutorial.html>`_ that demonstrates the usage.

Attribution
-----------

Please cite `Stolker et al. (2016b) <https://ui.adsabs.harvard.edu/abs/2016A%26A...596A..70S>`_ whenever results from *diskmap* are used in a publication (see `arXiv <https://arxiv.org/abs/1609.09505>`_, `ADS <https://ui.adsabs.harvard.edu/abs/2016A%26A...596A..70S>`_, `BibTeX <https://ui.adsabs.harvard.edu/abs/2016A%26A...596A..70S/exportcitation>`_).

Contributing
------------

Contributions are welcome so please consider `forking <https://help.github.com/en/articles/fork-a-repo>`_ the repository and creating a `pull request <https://github.com/tomasstolker/diskmap/pulls>`_. Bug reports and feature requests can be provided by creating an `issue <https://github.com/tomasstolker/diskmap/issues>`_ on the Github page.

License
-------

Copyright 2020-2023 Tomas Stolker

*diskmap* is distributed under the MIT License. See the LICENSE file for the terms and conditions.

.. |PyPI Status| image:: https://img.shields.io/pypi/v/diskmap
   :target: https://pypi.python.org/pypi/diskmap

.. |Python Versions| image:: https://img.shields.io/pypi/pyversions/diskmap
   :target: https://pypi.python.org/pypi/diskmap

.. |CI Status| image:: https://github.com/tomasstolker/diskmap/actions/workflows/main.yml/badge.svg
   :target: https://github.com/tomasstolker/diskmap/actions

.. |Docs Status| image:: https://img.shields.io/readthedocs/diskmap
   :target: http://diskmap.readthedocs.io

.. |Code Coverage| image:: https://codecov.io/gh/tomasstolker/diskmap/branch/main/graph/badge.svg?token=LSSCPMJ5JH
   :target: https://codecov.io/gh/tomasstolker/diskmap

.. |Code Quality| image:: https://img.shields.io/codefactor/grade/github/tomasstolker/diskmap
   :target: https://www.codefactor.io/repository/github/tomasstolker/diskmap

.. |License| image:: https://img.shields.io/github/license/tomasstolker/diskmap
   :target: https://github.com/tomasstolker/diskmap/blob/main/LICENSE
