From 6e7faeba8fafc2dcfbef1ecacd44ac39a950d6a3 Mon Sep 17 00:00:00 2001 From: Kyle Westfall Date: Tue, 28 Mar 2023 09:47:52 -0700 Subject: [PATCH] doc update --- doc/include/gemini_gnirs_A.pypeit.rst | 2 +- doc/include/keck_deimos_A.pypeit.rst | 2 +- doc/include/keck_nires_A.pypeit.rst | 2 +- doc/include/shane_kast_blue_A.pypeit.rst | 2 +- doc/pypeit_par.rst | 60 ++++++++++++------------ 5 files changed, 34 insertions(+), 34 deletions(-) diff --git a/doc/include/gemini_gnirs_A.pypeit.rst b/doc/include/gemini_gnirs_A.pypeit.rst index e867ac8399..83cd424242 100644 --- a/doc/include/gemini_gnirs_A.pypeit.rst +++ b/doc/include/gemini_gnirs_A.pypeit.rst @@ -1,7 +1,7 @@ .. code-block:: console # Auto-generated PypeIt input file using PypeIt version: 1.12.2.dev137+g95b15695a - # UTC 2023-03-28T16:28:12.019 + # UTC 2023-03-28T16:44:36.466 # User-defined execution parameters [rdx] diff --git a/doc/include/keck_deimos_A.pypeit.rst b/doc/include/keck_deimos_A.pypeit.rst index eed6f494cd..62c20da3c8 100644 --- a/doc/include/keck_deimos_A.pypeit.rst +++ b/doc/include/keck_deimos_A.pypeit.rst @@ -1,7 +1,7 @@ .. code-block:: console # Auto-generated PypeIt input file using PypeIt version: 1.12.2.dev137+g95b15695a - # UTC 2023-03-28T16:28:11.454 + # UTC 2023-03-28T16:44:35.910 # User-defined execution parameters [rdx] diff --git a/doc/include/keck_nires_A.pypeit.rst b/doc/include/keck_nires_A.pypeit.rst index 5fb8e888fe..00c6544082 100644 --- a/doc/include/keck_nires_A.pypeit.rst +++ b/doc/include/keck_nires_A.pypeit.rst @@ -1,7 +1,7 @@ .. code-block:: console # Auto-generated PypeIt input file using PypeIt version: 1.12.2.dev137+g95b15695a - # UTC 2023-03-28T16:28:24.251 + # UTC 2023-03-28T16:44:48.443 # User-defined execution parameters [rdx] diff --git a/doc/include/shane_kast_blue_A.pypeit.rst b/doc/include/shane_kast_blue_A.pypeit.rst index f4e6f9444f..63591c1541 100644 --- a/doc/include/shane_kast_blue_A.pypeit.rst +++ b/doc/include/shane_kast_blue_A.pypeit.rst @@ -1,7 +1,7 @@ .. code-block:: console # Auto-generated PypeIt input file using PypeIt version: 1.12.2.dev137+g95b15695a - # UTC 2023-03-28T16:28:05.001 + # UTC 2023-03-28T16:44:29.544 # User-defined execution parameters [rdx] diff --git a/doc/pypeit_par.rst b/doc/pypeit_par.rst index 4e5d4b082e..f061119496 100644 --- a/doc/pypeit_par.rst +++ b/doc/pypeit_par.rst @@ -543,21 +543,21 @@ Collate1DPar Keywords Class Instantiation: :class:`~pypeit.par.pypeitpar.Collate1DPar` -========================= ========== ======= ============================================ ============================================================================================================================================================================================================================================================================================================================================================================================================== -Key Type Options Default Description -========================= ========== ======= ============================================ ============================================================================================================================================================================================================================================================================================================================================================================================================== -``dry_run`` bool .. False If set, the script will display the matching File and Object Ids but will not flux, coadd or archive. -``exclude_serendip`` bool .. False Whether to exclude SERENDIP objects from collating. -``exclude_slit_trace_bm`` list, str .. [] A list of slit trace bitmask bits that should be excluded. -``flux`` bool .. False If set, the script will flux calibrate using archived sensfuncs before coadding. -``ignore_flux`` bool .. False If set, the script will only coadd non-fluxed spectra even if flux data is present. Otherwise fluxed spectra are coadded if all spec1ds have been fluxed calibrated. -``match_using`` str .. ``ra/dec`` Determines how 1D spectra are matched as being the same object. Must be either 'pixel' or 'ra/dec'. -``outdir`` str .. ``/Users/westfall/Work/packages/pypeit/doc`` The path where all coadded output files and report files will be placed. -``refframe`` str .. .. Perform reference frame correction prior to coadding. Options are: observed, heliocentric, barycentric -``spec1d_outdir`` str .. .. The path where all modified spec1d files are placed. These are only created if flux calibration or refframe correction are asked for. -``tolerance`` str, float .. ``1.0`` The tolerance used when comparing the coordinates of objects. If two objects are within this distance from each other, they are considered the same object. If match_using is 'ra/dec' (the default) this is an angular distance. The defaults units are arcseconds but other units supported by astropy.coordinates.Angle can be used(e.g. '0.003d' or '0h1m30s'). If match_using is 'pixel' this is a float. -``wv_rms_thresh`` float .. .. If set, any objects with a wavelength RMS > this value are skipped, else all wavelength RMS values are accepted. -========================= ========== ======= ============================================ ============================================================================================================================================================================================================================================================================================================================================================================================================== +========================= ========== ======= ================================================= ============================================================================================================================================================================================================================================================================================================================================================================================================== +Key Type Options Default Description +========================= ========== ======= ================================================= ============================================================================================================================================================================================================================================================================================================================================================================================================== +``dry_run`` bool .. False If set, the script will display the matching File and Object Ids but will not flux, coadd or archive. +``exclude_serendip`` bool .. False Whether to exclude SERENDIP objects from collating. +``exclude_slit_trace_bm`` list, str .. [] A list of slit trace bitmask bits that should be excluded. +``flux`` bool .. False If set, the script will flux calibrate using archived sensfuncs before coadding. +``ignore_flux`` bool .. False If set, the script will only coadd non-fluxed spectra even if flux data is present. Otherwise fluxed spectra are coadded if all spec1ds have been fluxed calibrated. +``match_using`` str .. ``ra/dec`` Determines how 1D spectra are matched as being the same object. Must be either 'pixel' or 'ra/dec'. +``outdir`` str .. ``/Users/westfall/Work/packages/pypeit-test/doc`` The path where all coadded output files and report files will be placed. +``refframe`` str .. .. Perform reference frame correction prior to coadding. Options are: observed, heliocentric, barycentric +``spec1d_outdir`` str .. .. The path where all modified spec1d files are placed. These are only created if flux calibration or refframe correction are asked for. +``tolerance`` str, float .. ``1.0`` The tolerance used when comparing the coordinates of objects. If two objects are within this distance from each other, they are considered the same object. If match_using is 'ra/dec' (the default) this is an angular distance. The defaults units are arcseconds but other units supported by astropy.coordinates.Angle can be used(e.g. '0.003d' or '0h1m30s'). If match_using is 'pixel' this is a float. +``wv_rms_thresh`` float .. .. If set, any objects with a wavelength RMS > this value are skipped, else all wavelength RMS values are accepted. +========================= ========== ======= ================================================= ============================================================================================================================================================================================================================================================================================================================================================================================================== ---- @@ -608,21 +608,21 @@ ReduxPar Keywords Class Instantiation: :class:`~pypeit.par.pypeitpar.ReduxPar` -====================== ============== ======= ============================================ ================================================================================================================================================================================================================================================================================================================================================================ -Key Type Options Default Description -====================== ============== ======= ============================================ ================================================================================================================================================================================================================================================================================================================================================================ -``calwin`` int, float .. 0 The window of time in hours to search for calibration frames for a science frame -``detnum`` int, list .. .. Restrict reduction to a list of detector indices. In case of mosaic reduction (currently only available for Gemini/GMOS and Keck/DEIMOS) ``detnum`` should be a list of tuples of the detector indices that are mosaiced together. E.g., for Gemini/GMOS ``detnum`` would be ``[(1,2,3)]`` and for Keck/DEIMOS it would be ``[(1, 5), (2, 6), (3, 7), (4, 8)]`` -``ignore_bad_headers`` bool .. False Ignore bad headers (NOT recommended unless you know it is safe). -``maskIDs`` str, int, list .. .. Restrict reduction to a set of slitmask IDsExample syntax -- maskIDs = 818006,818015 This must be used with detnum (for now). -``qadir`` str .. ``QA`` Directory relative to calling directory to write quality assessment files. -``quicklook`` bool .. False Run a quick look reduction? This is usually good if you want to quickly reduce the data (usually at the telescope in real time) to get an initial estimate of the data quality. -``redux_path`` str .. ``/Users/westfall/Work/packages/pypeit/doc`` Path to folder for performing reductions. Default is the current working directory. -``scidir`` str .. ``Science`` Directory relative to calling directory to write science files. -``slitspatnum`` str, list .. .. Restrict reduction to a set of slit DET:SPAT values (closest slit is used). Example syntax -- slitspatnum = DET01:175,DET01:205 or MSC02:2234 If you are re-running the code, (i.e. modifying one slit) you *must* have the precise SPAT_ID index. -``sortroot`` str .. .. A filename given to output the details of the sorted files. If None, the default is the root name of the pypeit file. If off, no output is produced. -``spectrograph`` str .. .. Spectrograph that provided the data to be reduced. See :ref:`instruments` for valid options. -====================== ============== ======= ============================================ ================================================================================================================================================================================================================================================================================================================================================================ +====================== ============== ======= ================================================= ================================================================================================================================================================================================================================================================================================================================================================ +Key Type Options Default Description +====================== ============== ======= ================================================= ================================================================================================================================================================================================================================================================================================================================================================ +``calwin`` int, float .. 0 The window of time in hours to search for calibration frames for a science frame +``detnum`` int, list .. .. Restrict reduction to a list of detector indices. In case of mosaic reduction (currently only available for Gemini/GMOS and Keck/DEIMOS) ``detnum`` should be a list of tuples of the detector indices that are mosaiced together. E.g., for Gemini/GMOS ``detnum`` would be ``[(1,2,3)]`` and for Keck/DEIMOS it would be ``[(1, 5), (2, 6), (3, 7), (4, 8)]`` +``ignore_bad_headers`` bool .. False Ignore bad headers (NOT recommended unless you know it is safe). +``maskIDs`` str, int, list .. .. Restrict reduction to a set of slitmask IDsExample syntax -- maskIDs = 818006,818015 This must be used with detnum (for now). +``qadir`` str .. ``QA`` Directory relative to calling directory to write quality assessment files. +``quicklook`` bool .. False Run a quick look reduction? This is usually good if you want to quickly reduce the data (usually at the telescope in real time) to get an initial estimate of the data quality. +``redux_path`` str .. ``/Users/westfall/Work/packages/pypeit-test/doc`` Path to folder for performing reductions. Default is the current working directory. +``scidir`` str .. ``Science`` Directory relative to calling directory to write science files. +``slitspatnum`` str, list .. .. Restrict reduction to a set of slit DET:SPAT values (closest slit is used). Example syntax -- slitspatnum = DET01:175,DET01:205 or MSC02:2234 If you are re-running the code, (i.e. modifying one slit) you *must* have the precise SPAT_ID index. +``sortroot`` str .. .. A filename given to output the details of the sorted files. If None, the default is the root name of the pypeit file. If off, no output is produced. +``spectrograph`` str .. .. Spectrograph that provided the data to be reduced. See :ref:`instruments` for valid options. +====================== ============== ======= ================================================= ================================================================================================================================================================================================================================================================================================================================================================ ----