-
Notifications
You must be signed in to change notification settings - Fork 63
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #951 from spacetelescope/webbpsf_to_stpsf
WebbPSF to STPSF
- Loading branch information
Showing
8 changed files
with
32 additions
and
354 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
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
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,113 +1,2 @@ | ||
| Documentation for WebbPSF | ||
| =============================== | ||
|
|
||
| WebbPSF is a Python package that computes simulated point spread functions (PSFs) for NASA's James Webb Space Telescope (JWST) and Nancy Grace Roman Space Telescope. WebbPSF transforms models of telescope and instrument optical state into PSFs, taking into account detector pixel scales, rotations, filter profiles, and point source spectra. It is rather a tool for transforming optical path difference (OPD) maps, created with observatory systems engineering models, into the resulting PSFs as observed with JWST's or Roman's instruments. | ||
|
|
||
| .. figure:: ./fig_instrument_comparison.png | ||
| :scale: 45 % | ||
| :align: center | ||
| :alt: Sample PSFs for JWST's instruments. | ||
|
|
||
| Sample PSFs for JWST's instrument suite, all on the same angular scale and display stretch. | ||
|
|
||
| .. figure:: ./roman_figures/webbpsf-roman_page_header.png | ||
| :scale: 70 % | ||
| :align: center | ||
| :alt: Sample PSFs for the filters in the Roman WFI. | ||
|
|
||
| Sample PSFs for the filters in the Roman WFI on SCA01. Note that | ||
| the prism and grism PSFs shown here are monochromatic. | ||
|
|
||
|
|
||
| **Contributors:** | ||
| WebbPSF has been developed by Marshall Perrin, Marcio Meléndez, Shannon Osborne, Robel Geda, Brad Sappington, Charles-Philippe Lajoie, Joseph Long, Justin Otor, Jarron Leisenring, Neil Zimmerman, Keira Brooks, and Anand Sivaramakrishnan, with contributions from Alden Jurling, Lauren Chambers, Ewan Douglas, and `others <https://github.com/spacetelescope/webbpsf/graphs/contributors>`_. | ||
|
|
||
| Getting Started with WebbPSF | ||
| ---------------------------- | ||
|
|
||
| See `Using WebbPSF <usage.html>`_. | ||
|
|
||
| .. admonition:: Quickstart Jupyter Notebook | ||
|
|
||
| This documentation is complemented by an `Jupyter Notebook format quickstart tutorial <http://nbviewer.jupyter.org/github/spacetelescope/webbpsf/blob/stable/notebooks/WebbPSF_tutorial.ipynb>`_. Downloading and running that notebook is a great way to get started using WebbPSF. | ||
|
|
||
|
|
||
| .. admonition:: Getting Help | ||
|
|
||
| For help using or installing webbpsf, you can contact the STScI JWST Help Desk at jwsthelp.stsci.edu, category WebbPSF/JWST Telescope. | ||
|
|
||
|
|
||
| :ref:`What's new in the latest release? <whatsnew>` | ||
|
|
||
| Contents | ||
| -------- | ||
|
|
||
| .. toctree:: | ||
| :maxdepth: 1 | ||
| :caption: Getting Started | ||
|
|
||
| intro.rst | ||
| installation.rst | ||
| relnotes.rst | ||
| usage.ipynb | ||
| psf_grids.ipynb | ||
|
|
||
| .. toctree:: | ||
| :maxdepth: 1 | ||
| :caption: Modeling JWST PSFs | ||
|
|
||
| jwst.rst | ||
| more_examples.rst | ||
| jwst_measured_opds.ipynb | ||
| jwst_detector_effects.ipynb | ||
| jwst_matching_psfs_to_data.ipynb | ||
| jwst_ifu_datacubes.ipynb | ||
| jwst_large_psf.ipynb | ||
| jwst_optical_budgets.ipynb | ||
| jwst_psf_subtraction.ipynb | ||
| jwst_wavefront_deltas.ipynb | ||
| less_common_usage.rst | ||
|
|
||
| .. toctree:: | ||
| :maxdepth: 1 | ||
| :caption: Modeling Roman PSFs | ||
|
|
||
| roman.rst | ||
|
|
||
| .. toctree:: | ||
| :maxdepth: 1 | ||
| :caption: Package Documentation | ||
|
|
||
| api_reference.rst | ||
| help.rst | ||
| sampling.rst | ||
| fft_optimization.rst | ||
| poppy.rst | ||
|
|
||
| .. toctree:: | ||
| :maxdepth: 1 | ||
| :caption: Developer Reference | ||
|
|
||
| available_opds.rst | ||
| field_dependence/multifield_documentation.ipynb | ||
| references.rst | ||
| release.rst | ||
|
|
||
|
|
||
| .. admonition:: How to cite WebbPSF | ||
|
|
||
| In addition to this documentation, WebbPSF is described in the following references. Users of WebbPSF are encouraged to cite one of these. | ||
|
|
||
| * Perrin et al. 2014, `"Updated point spread function simulations for JWST with WebbPSF" <http://adsabs.harvard.edu/abs/2014SPIE.9143E..3XP>`_, Proc. SPIE. 9143, | ||
| * Perrin et al. 2012, `"Simulating point spread functions for the James Webb Space Telescope with WebbPSF", <http://adsabs.harvard.edu/abs/2012SPIE.8442E..3DP>`_ Proc SPIE 8842, and | ||
| * Perrin 2011, `Improved PSF Simulations for JWST: Methods, Algorithms, and Validation <Improved_PSFs_for_Webb.pdf>`_, JWST Technical report JWST-STScI-002469. | ||
|
|
||
| In particular, the 2012 SPIE paper gives a broad overview, the 2014 SPIE paper presents comparisons to instrument cryotest data, and the Technical Report document describes in more detail the relevant optical physics, explains design decisions and motivation for WebbPSF's architecture, and presents extensive validation tests demonstrating consistency between WebbPSF and other PSF simulation packages used throughout the JWST project. | ||
|
|
||
|
|
||
| * :ref:`genindex` | ||
| * :ref:`search` | ||
|
|
||
| **Mailing List** | ||
|
|
||
| If you would like to receive email announcements of future versions, please contact Marshall Perrin, or visit `maillist.stsci.edu <https://maillist.stsci.edu/scripts/wa.exe?SUBED1=webbpsf-users&A=1>` to subscribe yourself to the "[email protected]" list. | ||
| .. meta:: | ||
| :http-equiv=Refresh: 0; url='https://stpsf.readthedocs.io/en/latest/' |
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
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
Oops, something went wrong.