This is a pre-release version of the documentation for WebbPSF version 0.3, which is not quite out yet. There are likely to be references to functionality not yet in the released code. Proceed at your own discretion!
WebbPSF is a Python package that computes simulated PSFs for the JWST instruments, taking into account detector pixel scales, rotations, filter profiles, and point source spectra. It is not a full optical model of JWST, but rather a tool for transforming optical path difference (OPD) maps, created with some other tool, into the resulting PSFs as observed with JWST’s instruments.
What this software does:
What this software does NOT do:
The WebbPSF software system includes two Python packages: a lower-level optical propagation library (POPPY) plus an implementation of the JWST instruments using that library (WebbPSF). This documentation explains the programming interfaces and graphical user interface, and provides usage examples for each.
In addition to this documentation, WebbPSF is described in Perrin et al. 2012, “Simulating point spread functions for the James Webb Space Telescope with WebbPSF”, Proc SPIE 8842, and in Perrin 2011, Improved PSF Simulations for JWST: Methods, Algorithms, and Validation , JWST Technical report JWST-STScI-002469. In particular, the SPIE paper gives a broad overview, while 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.
Users of WebbPSF are encouraged to cite one of those references.
The current version of WebbPSF is version 0.2.8, released Nov 7, 2011. If you would like to receive email announcements of future versions, please contact Marshall Perrin, or send an email to “email@example.com” containing the message “subscribe”.
This documentation is for a prerelease version of WebbPSF, eventually to be 0.3.0