diff --git a/docs/conf.py b/docs/conf.py index c152ba00..e573cb85 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -121,11 +121,11 @@ # The name of the Pygments (syntax highlighting) style to use. pygments_style = "default" -intersphinx_mapping.update( # noqa - defined in star import - { - "poppy": ("http://poppy-optics.readthedocs.io/", None), - } -) +#intersphinx_mapping.update( # noqa - defined in star import +# { +# "poppy": ("http://poppy-optics.readthedocs.io/", None), +# } +#) # -- Options for HTML output ------------------------------------------------- diff --git a/docs/index.rst b/docs/index.rst index 605f18ba..d4717d3c 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -49,7 +49,7 @@ Contents installation.rst relnotes.rst usage.ipynb - psf_grids.rst + psf_grids.ipynb .. toctree:: :maxdepth: 1 diff --git a/webbpsf/webbpsf_core.py b/webbpsf/webbpsf_core.py index d2b7ea50..89caf856 100644 --- a/webbpsf/webbpsf_core.py +++ b/webbpsf/webbpsf_core.py @@ -74,8 +74,23 @@ class SpaceTelescopeInstrument(poppy.instrument.Instrument): The instrument constructors do not take any arguments. Instead, create an instrument object and then configure the `filter` or other attributes as desired. The most commonly accessed parameters are available as object attributes: `filter`, `image_mask`, `pupil_mask`, `pupilopd`. More advanced - configuration can be done by editing the :ref:`SpaceTelescopeInstrument.options` dictionary, either by + configuration can be done by editing the `options` dictionary attribute, either by passing options to ``__init__`` or by directly editing the dict afterwards. + + Attributes + ---------- + telescope : str + Name of selected telescope, JWST or Roman. + filter : str + Bandpass filter name + image_mask : str + Name of selected image plane mask, e.g. coronagraph mask or spectrograph slit + pupil_mask : str + Name of selected image plane mask, e.g. coronagraph mask or pupil stop + pupilopd : str + Filename for telescope pupil wavefront error Optical Path Difference data + options : dict + Dictionary for specifying additional specialized options, per each subclass and instance. """ telescope = 'Generic Space Telescope' @@ -704,8 +719,8 @@ def psf_grid( configuration is specified (1 per instrument, detector, and filter) User also has the option to save the grid as a fits.HDUlist object. - Use - --- + Examples + -------- nir = webbpsf.NIRCam() nir.filter = "F090W" list_of_grids = nir.psf_grid(all_detectors=True, num_psfs=4) @@ -762,16 +777,16 @@ def psf_grid( class JWInstrument(SpaceTelescopeInstrument): """Superclass for all JWST instruments - Notable attributes - ------------------ - - telescope : name of telescope - pupilopd : filename or FITS file object - - include_si_wfe : boolean (default: True) + Attributes + ---------- + telescope : str + name of telescope + pupilopd : file-like + filename or FITS file object for the pupil Optical Path Difference + include_si_wfe : boolean Should SI internal WFE be included in models? Requires the presence of ``si_zernikes_isim_cv3.fits`` in the - ``WEBBPSF_PATH``. + ``WEBBPSF_PATH``. Default = True. """ telescope = 'JWST'