Skip to content

Commit

Permalink
doc update
Browse files Browse the repository at this point in the history
  • Loading branch information
@kbwestfall
kbwestfall committed Aug 28, 2024
1 parent 08a2798 commit 01aed2e
Show file tree
Hide file tree
Showing 12 changed files with 91 additions and 28 deletions.
8 changes: 8 additions & 0 deletions doc/api/pypeit.scripts.chk_flexure.rst
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
pypeit.scripts.chk\_flexure module
==================================

.. automodule:: pypeit.scripts.chk_flexure
:members:
:private-members:
:undoc-members:
:show-inheritance:
1 change: 1 addition & 0 deletions doc/api/pypeit.scripts.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ Submodules
pypeit.scripts.chk_alignments
pypeit.scripts.chk_edges
pypeit.scripts.chk_flats
pypeit.scripts.chk_flexure
pypeit.scripts.chk_for_calibs
pypeit.scripts.chk_noise_1dspec
pypeit.scripts.chk_noise_2dspec
Expand Down
18 changes: 18 additions & 0 deletions doc/help/pypeit_chk_flexure.rst
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
.. code-block:: console
$ pypeit_chk_flexure -h
usage: pypeit_chk_flexure [-h] (--spec | --spat) [--try_old]
input_file [input_file ...]
Print QA on flexure to the screen
positional arguments:
input_file One or more PypeIt spec2d or spec1d file
options:
-h, --help show this help message and exit
--spec Check the spectral flexure (default: False)
--spat Check the spatial flexure (default: False)
--try_old Attempt to load old datamodel versions. A crash may ensue..
(default: False)
16 changes: 13 additions & 3 deletions doc/help/pypeit_sensfunc.rst
View file
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
.. code-block:: console
$ pypeit_sensfunc -h
usage: pypeit_sensfunc [-h] [--algorithm {UVIS,IR}] [--multi MULTI] [-o OUTFILE]
[-s SENS_FILE] [-f FLATFILE] [--debug]
[--par_outfile PAR_OUTFILE] [-v VERBOSITY]
usage: pypeit_sensfunc [-h] [--extr {OPT,BOX}] [--algorithm {UVIS,IR}]
[--multi MULTI] [-o OUTFILE] [-s SENS_FILE] [-f FLATFILE]
[--debug] [--par_outfile PAR_OUTFILE] [-v VERBOSITY]
spec1dfile
Compute a sensitivity function
Expand All @@ -14,6 +14,16 @@
options:
-h, --help show this help message and exit
--extr {OPT,BOX} Override the default extraction method used for
computing the sensitivity function. Note that it is not
possible to set --extr and simultaneously use a .sens
file with the --sens_file option. If you are using a
.sens file, set the algorithm there via:
[sensfunc]
extr = BOX
The extraction options are: OPT or BOX
--algorithm {UVIS,IR}
Override the default algorithm for computing the
sensitivity function. Note that it is not possible to
Expand Down
2 changes: 1 addition & 1 deletion doc/help/run_pypeit.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
usage: run_pypeit [-h] [-v VERBOSITY] [-r REDUX_PATH] [-m] [-s] [-o] [-c]
pypeit_file
## [1;37;42mPypeIt : The Python Spectroscopic Data Reduction Pipeline v1.16.1.dev109+g885cb1823[0m
## [1;37;42mPypeIt : The Python Spectroscopic Data Reduction Pipeline v1.16.1.dev336+gdf3013372.d20240827[0m
##
## Available spectrographs include:
## bok_bc, gemini_flamingos1, gemini_flamingos2, gemini_gmos_north_e2v,
Expand Down
1 change: 1 addition & 0 deletions doc/include/class_datamodel_sensfunc.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ Attribute Type Array Type Description
``airmass`` float Airmass of the observation
``algorithm`` str Algorithm used for the sensitivity calculation.
``exptime`` float Exposure time
``extr`` str Extraction method used for the standard star (OPT or BOX)
``pypeline`` str PypeIt pipeline reduction path
``sens`` `astropy.table.table.Table`_ Table with the sensitivity function
``spec1df`` str PypeIt spec1D file used to for sensitivity function
Expand Down
10 changes: 5 additions & 5 deletions doc/include/dependencies_table.rst
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
======================= =========================================================================================================================================================================================================================================================================================================================================================
Python Version ``>=3.10,<3.13``
Required for users ``IPython>=7.10.0``, ``PyERFA>=2.0.0``, ``PyYAML>=5.1``, ``astropy>=6.0``, ``bottleneck``, ``configobj>=5.0.6``, ``extension-helpers>=0.1``, ``fast-histogram>=0.11``, ``ginga>=5.1.0``, ``linetools>=0.3.1``, ``matplotlib>=3.7``, ``numpy>=1.23``, ``packaging>=0.19``, ``pygithub``, ``pyqt6``, ``qtpy>=2.0.1``, ``scikit-learn>=1.0``, ``scipy>=1.7``
Required for developers ``coverage``, ``docutils<0.21``, ``psutil``, ``pygit2``, ``pytest-astropy``, ``pytest-cov``, ``pytest-qt``, ``pytest>=6.0.0``, ``scikit-image``, ``specutils>=1.13``, ``sphinx-automodapi``, ``sphinx>=1.6,<8``, ``sphinx_rtd_theme==2.0.0``, ``tox``
======================= =========================================================================================================================================================================================================================================================================================================================================================
======================= =======================================================================================================================================================================================================================================================================================================================================================================
Python Version ``>=3.10,<3.13``
Required for users ``IPython>=7.10.0``, ``PyERFA>=2.0.0``, ``PyYAML>=5.1``, ``astropy>=6.0``, ``bottleneck``, ``configobj>=5.0.6``, ``extension-helpers>=0.1``, ``fast-histogram>=0.11``, ``ginga>=5.1.0``, ``linetools>=0.3.1``, ``matplotlib>=3.7``, ``numpy>=1.23,<2.0.0``, ``packaging>=0.19``, ``pygithub``, ``pyqt6<=6.7.0``, ``qtpy>=2.0.1``, ``scikit-learn>=1.0``, ``scipy>=1.7``
Required for developers ``coverage``, ``docutils<0.21``, ``psutil``, ``pygit2``, ``pytest-astropy``, ``pytest-cov``, ``pytest-qt``, ``pytest>=6.0.0``, ``scikit-image``, ``specutils>=1.13``, ``sphinx-automodapi``, ``sphinx>=1.6,<8``, ``sphinx_rtd_theme==2.0.0``, ``tox``
======================= =======================================================================================================================================================================================================================================================================================================================================================================
6 changes: 3 additions & 3 deletions doc/include/inst_detector_table.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -85,9 +85,9 @@ Instrument Det specaxis specflip spatflip namp gain
``vlt_fors2`` 1 1 False False 1 0.7 2.9 2.1 -1.0e+10 200000.0 0.8000 0.1260
... 2 1 False False 1 0.7 3.15 1.4 -1.0e+10 200000.0 0.8000 0.1260
``vlt_sinfoni`` 1 0 True False 1 2.42 7.0 540.0 -1.0e+10 1000000000.0 1.0000 0.0125
``vlt_xshooter_nir`` 1 1 False False 1 2.12 8.0 0.0 -1.0e+10 200000.0 0.8600 0.1970
``vlt_xshooter_uvb`` 1 0 True True 1 1.61 2.6 0.0 -1.0e+10 65000.0 0.8600 0.1610
``vlt_xshooter_vis`` 1 0 False False 1 0.595 3.1 0.0 -1.0e+10 65535.0 0.8600 0.1600
``vlt_xshooter_nir`` 1 1 False False 1 2.29 8.0 72.0 -1.0e+10 200000.0 0.8600 0.2450
``vlt_xshooter_uvb`` 1 0 True True 1 ``None`` ``None`` 0.0 -1.0e+10 65000.0 0.8600 0.1640
``vlt_xshooter_vis`` 1 0 False False 1 ``None`` ``None`` 0.0 -1.0e+10 65535.0 0.8600 0.1540
``wht_isis_blue`` 1 0 False False 1 1.2 5.0 0.0 -1.0e+10 65535.0 0.7600 0.2000
``wht_isis_red`` 1 0 False False 1 0.98 4.0 0.0 -1.0e+10 65535.0 0.7600 0.2200
============================ === ======== ======== ======== ======== ========================== ====================== ======== ======== ============ ========= ==========
Loading

0 comments on commit 01aed2e

Please sign in to comment.