Metadata-Version: 2.1
Name: diskmap
Version: 0.0.2
Summary: Scattered light mapping of protoplanetary disks
Home-page: https://github.com/tomasstolker/diskmap
Author: Tomas Stolker
Author-email: tomas.stolker@phys.ethz.ch
License: MIT
Keywords: diskmap
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering :: Astronomy
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Description-Content-Type: text/x-rst
Requires-Dist: astropy
Requires-Dist: numpy
Requires-Dist: scipy

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

.. image:: https://badge.fury.io/py/diskmap.svg
    :target: https://badge.fury.io/py/diskmap

.. image:: https://img.shields.io/badge/Python-3.6%2C%203.7-yellow.svg?style=flat
    :target: https://pypi.python.org/pypi/diskmap

.. image:: https://img.shields.io/badge/MIT-blue.svg
    :target: https://github.com/tomasstolker/diskmap/blob/master/LICENSE

.. image:: http://img.shields.io/badge/arXiv-1609.09505-orange.svg?style=flat
    :target: https://arxiv.org/abs/1609.09505

Python tool for mapping the surface layer of protoplanetary disks in scattered light images. The disk surface is parameterized with a power law profile which is then used to calculate the projected radius and scattering angle at each pixel. From this, the deprojected image, the stellar irradiation corrected image, and the scattering phase function can be extracted.

Installation
------------

Installation from PyPI:

.. code-block:: console

    $ pip install diskmap

Installation from Github:

.. code-block:: console

    $ git clone git@github.com:tomasstolker/diskmap.git
    $ python setup.py install

Example
-------

.. code-block:: python

   >>> import diskmap

   >>> mapping = diskmap.DiskMap(fitsfile='image.fits',
                                 pixscale=1e-2,
                                 inclination=40.,
                                 pos_angle=70.,
                                 distance=100.)

   >>> mapping.map_disk(power_law=(0., 0.1, 1.15),
                        radius=(1., 500., 100))

   >>> mapping.deproject_disk(power_law=(0., 0.1, 1.15))

   >>> mapping.r2_scaling(r_max=200.)

   >>> mapping.total_intensity(pol_max=1.)

   >>> mapping.phase_function(radius=(50., 70.),
                              n_phase=30)

   >>> mapping.write_output(filename='diskmap')


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

Please cite `Stolker et al. (2016) <https://ui.adsabs.harvard.edu/abs/2016A%26A...596A..70S/abstract/>`_ whenever results from *diskmap* are used in a publication.

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

Contributions are welcome, please consider forking the repository and creating a pull request. Bug reports can be provided by creating an `issue <https://github.com/tomasstolker/diskmap/issues>`_ on the Github page.

License
-------

Copyright 2020 Tomas Stolker

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


