Skip to content

Commit

Permalink
doc formatting and doc string updates
Browse files Browse the repository at this point in the history
  • Loading branch information
mperrin committed Sep 10, 2024
1 parent a40258a commit c6ec0ad
Show file tree
Hide file tree
Showing 3 changed files with 32 additions and 17 deletions.
10 changes: 5 additions & 5 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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 -------------------------------------------------
Expand Down
2 changes: 1 addition & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ Contents
installation.rst
relnotes.rst
usage.ipynb
psf_grids.rst
psf_grids.ipynb

.. toctree::
:maxdepth: 1
Expand Down
37 changes: 26 additions & 11 deletions webbpsf/webbpsf_core.py
Original file line number Diff line number Diff line change
Expand Up @@ -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'
Expand Down Expand Up @@ -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)
Expand Down Expand Up @@ -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'
Expand Down

0 comments on commit c6ec0ad

Please sign in to comment.