Skip to content

Commit

Permalink
Updated code documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Tomas Stolker committed Feb 10, 2020
1 parent e5fa6b4 commit 484e15c
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 4 deletions.
2 changes: 1 addition & 1 deletion diskmap/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

__author__ = 'Tomas Stolker'
__license__ = 'MIT'
__version__ = '0.0.6'
__version__ = '0.0.7'
__maintainer__ = 'Tomas Stolker'
__email__ = '[email protected]'
__status__ = 'Development'
7 changes: 5 additions & 2 deletions diskmap/diskmap.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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))

Expand Down
2 changes: 1 addition & 1 deletion setup.py
100755 → 100644
Original file line number Diff line number Diff line change
Expand Up @@ -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',
Expand Down

0 comments on commit 484e15c

Please sign in to comment.