From 484e15cf654807f27ed7d11cb1cc49e73a2ed919 Mon Sep 17 00:00:00 2001 From: Tomas Stolker Date: Mon, 10 Feb 2020 10:04:59 +0100 Subject: [PATCH] Updated code documentation --- diskmap/__init__.py | 2 +- diskmap/diskmap.py | 7 +++++-- setup.py | 2 +- 3 files changed, 7 insertions(+), 4 deletions(-) mode change 100755 => 100644 setup.py diff --git a/diskmap/__init__.py b/diskmap/__init__.py index d4f6d0f..9200c2e 100644 --- a/diskmap/__init__.py +++ b/diskmap/__init__.py @@ -2,7 +2,7 @@ __author__ = 'Tomas Stolker' __license__ = 'MIT' -__version__ = '0.0.6' +__version__ = '0.0.7' __maintainer__ = 'Tomas Stolker' __email__ = 'tomas.stolker@phys.ethz.ch' __status__ = 'Development' diff --git a/diskmap/diskmap.py b/diskmap/diskmap.py index 799ee7e..57f1e09 100644 --- a/diskmap/diskmap.py +++ b/diskmap/diskmap.py @@ -81,7 +81,9 @@ def map_disk(self, ---------- power_law : tuple(float, float, float) The argument for the power-law function, provided as (a, b, c) with - f(x) = a + b*x^c, with ``a`` and ``b`` in au. + f(x) = a + b*x^c, with ``a`` and ``b`` in au. Set all values to zero for the mapping + and deprojection of a geometrically flat disk, in which case only the inclination is + used for the deprojection. radius : tuple(float, float, int) Radius points that are sampled, provided as (r_in, r_out, n_r), with ``r_in`` and ``r_out`` in au. The outer radius should be set large enough such that a radius is @@ -335,7 +337,8 @@ def deproject_disk(self): fit_im = griddata(image_xy, im_disk, grid) except ValueError: raise ValueError('The radius sampling should cover the complete field of view of the ' - 'image. Try increasing the outer \'radius\' value in \'map_disk\'.') + 'image. Try increasing the outer \'radius\' value in \'map_disk\' ' + 'and have a look at the \'_radius.fits\' output to check for NaNs.') self.im_deproj = np.zeros((self.npix, self.npix)) diff --git a/setup.py b/setup.py old mode 100755 new mode 100644 index 907bb46..9dae6d1 --- a/setup.py +++ b/setup.py @@ -12,7 +12,7 @@ setup( name='diskmap', - version='0.0.6', + version='0.0.7', description='Scattered light mapping of protoplanetary disks', long_description=open('README.rst').read(), long_description_content_type='text/x-rst',