From 832ee84e42530ef231b2699f613dab9e03f1feee Mon Sep 17 00:00:00 2001 From: Kyle Westfall Date: Thu, 5 Sep 2024 17:06:45 -0700 Subject: [PATCH] doc update --- doc/dev/hiresconfig.rst | 4 ++-- doc/dev/hiresframes.rst | 2 +- doc/spectrographs/keck_hires.rst | 4 ++-- pypeit/core/flexure.py | 21 ++++++++++++--------- 4 files changed, 17 insertions(+), 14 deletions(-) diff --git a/doc/dev/hiresconfig.rst b/doc/dev/hiresconfig.rst index 52ad731b4b..38d07f705c 100644 --- a/doc/dev/hiresconfig.rst +++ b/doc/dev/hiresconfig.rst @@ -28,7 +28,7 @@ by the :ref:`pypeit_setup` script, which sorts the frames and writes a HIRES configuration identification ---------------------------------- +---------------------------------- The HIRES instrument configurations are determined by the function :func:`pypeit.metadata.PypeItMetaData.unique_configurations`, @@ -62,7 +62,7 @@ to the relevant unique configuration ("setup"), by assigning a setup identifier values of the specific unique configuration. HIRES calibration groups ------------------------ +------------------------ PypeIt uses the concept of a "calibration group" to define a complete set of calibration frames (e.g., arcs, flats) and the science frames to which these calibration diff --git a/doc/dev/hiresframes.rst b/doc/dev/hiresframes.rst index 0d0dad6f41..d303081a9a 100644 --- a/doc/dev/hiresframes.rst +++ b/doc/dev/hiresframes.rst @@ -24,7 +24,7 @@ The general procedure used to assign frames a given type is described here: :ref:`frame_types`. HIRES frame typing ------------------ +------------------ The primary typing of HIRES frames is performed by :func:`pypeit.spectrographs.keck_hires.KECKHIRESSpectrograph.check_frame_type`. diff --git a/doc/spectrographs/keck_hires.rst b/doc/spectrographs/keck_hires.rst index 34ff1dd6fd..f1628da181 100644 --- a/doc/spectrographs/keck_hires.rst +++ b/doc/spectrographs/keck_hires.rst @@ -7,10 +7,10 @@ Overview This file summarizes several instrument specific settings that are related to the Keck/HIRES spectrograph. Currently, PypeIt only supports the reduction of the post detector upgrade HIRES data (around August 2004). -Information on the frame typing and instrument configuration can be found in ref:`hiresframes` and :ref:`hiresconfig`. +Information on the frame typing and instrument configuration can be found in ref:`hiresframes` and :ref:`hires_config`. Default Settings -++++++++++++++++ +---------------- See :ref:`instr_par-keck_hires` for a list of modifications to the default settings. *You do not have to add these changes to your PypeIt reduction file!* This is just a list of diff --git a/pypeit/core/flexure.py b/pypeit/core/flexure.py index a36e581ec4..d4a816993f 100644 --- a/pypeit/core/flexure.py +++ b/pypeit/core/flexure.py @@ -1398,23 +1398,26 @@ def sky_em_residuals(wave:np.ndarray, flux:np.ndarray, def flexure_diagnostic(file, file_type='spec2d', flexure_type='spec', chk_version=False): """ Print the spectral or spatial flexure of a spec2d or spec1d file + Args: file (:obj:`str`, `Path`_): Filename of the spec2d or spec1d file to check file_type (:obj:`str`, optional): - Type of the file to check. Options are 'spec2d' or 'spec1d'. Default is 'spec2d'. + Type of the file to check. Options are 'spec2d' or 'spec1d'. Default + is 'spec2d'. flexure_type (:obj:`str`, optional): - Type of flexure to check. Options are 'spec' or 'spat'. Default is 'spec'. + Type of flexure to check. Options are 'spec' or 'spat'. Default is + 'spec'. chk_version (:obj:`bool`, optional): - If True, raise an error if the datamodel version or type check failed. - If False, throw a warning only. Default is False. + If True, raise an error if the datamodel version or type check + failed. If False, throw a warning only. Default is False. Returns: - :obj:`astropy.table.Table` or :obj:`float`: - - If file_type is 'spec2d' and flexure_type is 'spec', return a table with the spectral flexure - - If file_type is 'spec2d' and flexure_type is 'spat', return the spatial flexure - - If file_type is 'spec1d', return a table with the spectral flexure - + :obj:`astropy.table.Table`, :obj:`float`: If file_type is 'spec2d' and + flexure_type is 'spec', return a table with the spectral flexure. If + file_type is 'spec2d' and flexure_type is 'spat', return the spatial + flexure. If file_type is 'spec1d', return a table with the spectral + flexure. """ # value to return