Skip to content

Commit

Permalink
Update README, revise module docstring
Browse files Browse the repository at this point in the history
Since the module docstring is used in the rendered HTML docs, it
serves a different role from the README.
  • Loading branch information
joseph-long committed Dec 10, 2014
1 parent ab2d118 commit 9ad6c33
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 27 deletions.
24 changes: 15 additions & 9 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,14 +1,20 @@
webbpsf
=======
WebbPSF: Simulated Point Spread Functions for the James Webb Space Telescope
----------------------------------------------------------------------------

WebbPSF is a simple tool for simulating point spread functions for the
James Webb Space Telescope, inspired by TinyTim for Hubble.
WebbPSF produces simulated PSFs for the James Webb Space Telescope, NASA's next
flagship infrared space telescope. WebbPSF can simulate images for any of the
four science instruments plus the fine guidance sensor, including both direct
imaging and coronagraphic modes.

It provides a relatively user-friendly interface for diffractive point spread
function modeling for JWST in the Fraunhofer domain based on precomputed telescope models.
Documentation can be found at http://www.stsci.edu/jwst/software/webbpsf
Developed by Marshall Perrin and contributors at STScI, 2010-2015.

Developed by Marshall Perrin at STScI, 2010-2013.
Documentation can be found online at https://pythonhosted.org/webbpsf/

These packages have been developed on Python 2.7 but not yet tested for Python 3 compatibility.
WebbPSF requires a large amount of input data for its simulations, including
optical path difference (OPD) maps, filter transmission curves, and coronagraph
Lyot mask shapes. These data files are not included in this source distribution.

Please see the main WebbPSF web page, linked above, to download the required
data files.

This is an `Astropy <http://astropy.org/>`_ affiliated package.
24 changes: 6 additions & 18 deletions webbpsf/__init__.py
Original file line number Diff line number Diff line change
@@ -1,22 +1,14 @@
# Licensed under a 3-clause BSD style license - see LICENSE.rst
"""
WebbPSF: Simulated Point Spread Functions for the James Webb Space Telescope
-------------------------------------------------------------------------------
----------------------------------------------------------------------------
WebbPSf produces simulated PSFs for the James Webb Space Telescope, NASA's next flagship
infrared space telescope. WebbPSF can simulate images for any of the four science instruments plus the
fine guidance sensor, including both direct imaging and coronagraphic modes.
WebbPSF produces simulated PSFs for the James Webb Space Telescope, NASA's next
flagship infrared space telescope. WebbPSF can simulate images for any of the
four science instruments plus the fine guidance sensor, including both direct
imaging and coronagraphic modes.
Developed by Marshall Perrin at STScI, 2010-2012.
Documentation can be found online at http://www.stsci.edu/jwst/software/webbpsf/
WebbPSF requires a large amount of input data for its simulations, including optical path difference (OPD) maps,
filter transmission curves, and coronagraph Lyot mask shapes. These data files are not included in this
source distribution available from PYPI. Please see the main WebbPSF web page, linked above, to download
the required data tar file.
This is an Astropy affiliated package.
Developed by Marshall Perrin and contributors at STScI, 2010-2015.
"""

# Affiliated packages may add whatever they like to this file, but
Expand Down Expand Up @@ -144,7 +136,3 @@ def gui(preferred='wx'):
#raise ImportError("ttk GUI for webbpsf not available")
else:
raise NotImplementedError("Neither TK nor WX GUI libraries are available. Cannot start GUI.")




0 comments on commit 9ad6c33

Please sign in to comment.