diff --git a/docs/_file_suffixes.rst b/docs/_file_suffixes.rst index f06421b4..f3fac557 100644 --- a/docs/_file_suffixes.rst +++ b/docs/_file_suffixes.rst @@ -25,4 +25,33 @@ There are two scenarios where this can happen: ================ ========= ======================================== -Assuming the two targets in `sci_file.fits` are extracted we'll end up with \ No newline at end of file +Assuming the two targets in `sci_file.fits` are extracted and they are approximately at the position +400 and 600 (pixels in spatial axis), after extraction we'll end up with: + +.. code-block:: bash + + esci_file_target_1.fits + esci_file_target_2.fits + elamp_001_390-410.fits + elamp_001_590-610.fits + elamp_002_390-410.fits + elamp_002_590-610.fits + + +The default prefix for extraction is ``e`` and does not have an underscore to separate it from the +file name. + +After wavelength calibration, since there are two suitable lamps and due to the fact that the +pipeline does not combine solutions, it will save two wavelength calibrated files with each one +solved by the respective lamp. Then: + +.. code-block:: bash + + wesci_file_target_1_ws_1.fits + wesci_file_target_1_ws_2.fits + wesci_file_target_2_ws_1.fits + wesci_file_target_2_ws_2.fits + welamp_001_390-410.fits + welamp_001_590-610.fits + welamp_002_390-410.fits + welamp_002_590-610.fits diff --git a/docs/conf.py b/docs/conf.py index a53eb39a..0bbc8496 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -39,7 +39,7 @@ 'sphinx.ext.autodoc', 'sphinx.ext.mathjax', 'sphinx.ext.intersphinx', - 'sphinxcontrib.napoleon'] + 'sphinx.ext.napoleon'] intersphinx_mapping = { @@ -81,7 +81,7 @@ # # This is also used if you do content translation via gettext catalogs. # Usually you set "language" from the command line for these cases. -language = None +language = 'en' # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. diff --git a/goodman_pipeline/core/core.py b/goodman_pipeline/core/core.py index 61c8ae35..d6caf652 100644 --- a/goodman_pipeline/core/core.py +++ b/goodman_pipeline/core/core.py @@ -1149,7 +1149,7 @@ def extraction(ccd, def extract_fractional_pixel(ccd, target_trace, target_fwhm, extraction_width, background_spacing=3): - """Performs an spectrum extraction using fractional pixels. + """Performs a spectrum extraction using fractional pixels. Args: ccd (CCDData) Instance of :class:`~astropy.nddata.CCDData` that