forked from spacetelescope/webbpsf
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update README, revise module docstring
Since the module docstring is used in the rendered HTML docs, it serves a different role from the README.
- Loading branch information
1 parent
ab2d118
commit 9ad6c33
Showing
2 changed files
with
21 additions
and
27 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters