Deep suggestions added

spacetelescope · Jan 22, 2024 · 513c3e6 · 513c3e6
1 parent ee07106
commit 513c3e6
Show file tree

Hide file tree

Showing 11 changed files with 22 additions and 23 deletions.
diff --git a/doc/source/drizzlepac_api.rst b/doc/source/drizzlepac_api.rst
@@ -1,4 +1,4 @@
-Drizzlepac Interface
+DrizzlePac Interface
 ====================
 .. _drizzlepac_api:
 
@@ -20,5 +20,4 @@ Index
 -----
 
 * :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
+* :ref:`modindex`
diff --git a/doc/source/getting_started/citing_drizzlepac.rst b/doc/source/getting_started/citing_drizzlepac.rst
@@ -1,4 +1,4 @@
-Citing Drizzlepac
+Citing DrizzlePac
 -----------------
 
 For the design of AstroDrizzle and the enhancements to the FITS format it has introduced, please reference:

diff --git a/doc/source/getting_started/drizzlepac_resources.rst b/doc/source/getting_started/drizzlepac_resources.rst
@@ -2,13 +2,13 @@ Drizzlepac Resources
 ====================
 .. _drizzlepac_resources:
 
-Summary: *Coming soon!*
+Summary: Here we provide a list of DrizzlePac related pages for users, including links to the main DrizzlePac webpage and handbook, example workflow notebooks, and resources for troubleshooting issues that may arise. If your issues are not covered or you have additional questions, please contact the HST Help Desk at the link below.
 
 .. toctree:: 
     :maxdepth: 2
 
-    Drizzlepac Handbook <https://www.stsci.edu/scientific-community/software/drizzlepac.html>
+    DrizzlePac Handbook <https://www.stsci.edu/scientific-community/software/drizzlepac.html>
     Notebook Tutorials <https://github.com/spacetelescope/notebooks/tree/master/notebooks/DrizzlePac>
     Troubleshooting <https://hst-docs.stsci.edu/drizzpac/chapter-7-data-quality-checks-and-trouble-shooting-problems>
-    HST Helpdesk <https://stsci.service-now.com/hst>
+    HST Help Desk <https://stsci.service-now.com/hst>
     Software Repository <https://github.com/spacetelescope/drizzlepac>
diff --git a/doc/source/getting_started/installation.rst b/doc/source/getting_started/installation.rst
@@ -18,7 +18,7 @@ Clone this repository
     cd drizzlepac
 
 
-Build the documentation
+Build the Documentation
 =======================
 
 *Note:* If you intend to use ``drizzlepac``'s embedded help feature from within
@@ -32,7 +32,7 @@ this step.
     make html
 
 
-Install drizzlepac
+Install DrizzlePac
 ==================
 
 .. code-block:: shell

diff --git a/doc/source/index.rst b/doc/source/index.rst
@@ -6,11 +6,11 @@
 .. tocdepth: 2
 
 ==========
-Drizzlepac
+DrizzlePac
 ==========
 .. _drizzlepac:
 
-DrizzlePac is a set of software tools maintained by the Space Telescope Science Institute (STScI) that is designed to align and combine astronomical images obtained with the Hubble Space Telescope. DrizzlePac includes core features such as AstroDrizzle, Tweakreg, and the Hubble Archival Program (HAP) data processing pipeline that creates Single Visit and Multi Visit Mosaics (SVMs and MVMs). This readthedocs provides resources for users to run DrizzlePac in order to create custom image mosaics, and documents the procedures used to produce the MAST SVM and MVM data products. Please see the Getting Started guide and DrizzlePac website for additional information.
+DrizzlePac is a set of software tools maintained by the Space Telescope Science Institute (STScI) that is designed to align and combine astronomical images obtained with the Hubble Space Telescope. DrizzlePac includes core features such as AstroDrizzle, Tweakreg, and the Hubble Archival Program (HAP) data processing pipeline that creates Single-Visit and Multi-Visit Mosaics (SVMs and MVMs). This readthedocs provides resources for users to run DrizzlePac in order to create custom image mosaics, and documents the procedures used to produce the MAST SVM and MVM data products. Please see the Getting Started guide and DrizzlePac website for additional information.
 
 .. toctree:: 
     :maxdepth: 2

diff --git a/doc/source/mast_data_products.rst b/doc/source/mast_data_products.rst
@@ -1,4 +1,4 @@
-Mast Data Products
+MAST Data Products
 ==================
 .. _mast_data_products:
 

diff --git a/doc/source/mast_data_products/astrometry.rst b/doc/source/mast_data_products/astrometry.rst
@@ -1,7 +1,7 @@
 .. _astrometry:
 
 =========================
-Astrometry and headerlets
+Astrometry and Headerlets
 =========================
 
 The astrometry for any given observation relies upon accurate pointing information from the telescope.   However, HST has evolved over time since it was put into orbit, with the focus changing over time as the telescope desorbs.  The instruments have also changed positions over time relative to the FGS guides, and the coordinates for the guide stars were orginally determined using ground-based information.  All this has limited the calculation of the pointing of any given observation on the sky (absolute astrometry) to no better than 1-2 arc-seconds.
@@ -20,7 +20,7 @@ Pipeline Astrometric Calibration
 
 `Pipeline Astrometric Calibraion <https://hst-docs.stsci.edu/drizzpac/chapter-4-astrometric-information-in-the-header/4-5-absolute-astrometry>`_
 
-WCS solutions
+WCS Solutions
 =============
 
 All calibrated HST products delivered by the Barbara A. Mikulski Archive for Space Telescopes (MAST) contain the best available WCS solutions available at the time the data was last processed.  Unfortunately, only 1 WCS can be used at a time to transform the position in the image to an undistorted position on the sky.  The FITS Standard, however, describes how multiple WCS solutions can be defined for an image in `FITS Paper I (Greisen, E. W., and Calabretta, M. R., Astronomy & Astrophysics, 395, 1061-1075, 2002) <http://adsabs.harvard.edu/cgi-bin/nph-bib_query?bibcode=2002A%26A...395.1061G&db_key=AST&high=3db47576cf06933>`_.
@@ -290,12 +290,12 @@ the sample ACS/WFC exposure after writing it out to a file would then be::
     6       IMAGE       SIPWCS                1                  8
     7       IMAGE       SIPWCS                2                  8
 
-Detailed Description of headerlet
+Detailed Description of Headerlets
 ----------------------------------
-The full details on the headerlet, it's required set of keywords, and how the distortion models get described in the headerlet can be found in the `Technical Report on headerlets <https://stwcs.readthedocs.io/en/latest/headerlet_tsr/source/index.html>`_.
+The full details on the headerlet, it's required set of keywords, and how the distortion models get described in the headerlet can be found in the `Technical Report on Headerlets <https://stwcs.readthedocs.io/en/latest/headerlet_tsr/source/index.html>`_.
 
-Code Interface to headerlets
------------------------------
+Code Interface to Headerlets
+----------------------------
 The `STWCS package <https://stwcs.readthedocs.io/en/latest/>`_ provides the code used to work with headerlets and WCS solutions.
 
 

diff --git a/doc/source/mast_data_products/catalog_generation.rst b/doc/source/mast_data_products/catalog_generation.rst
@@ -148,7 +148,7 @@ parameter values in the <instrument>_<detector>_catalog_generation_all.json file
 configuration settings is to first utilize `~drizzlepac.haputils.generate_custom_svm_mvm_param_file` to generate a
 custom parameter .json file. This parameter file, which is written to the user's current working directory by default,
 contains all default pipeline parameters and allows users to adjust any/or all of these parameters as they wish without
-overwriting the hard-coded default values stored in /drizzlepac/pars/hap_pars/svm_parameters/. To run the single visit
+overwriting the hard-coded default values stored in /drizzlepac/pars/hap_pars/svm_parameters/. To run the single-visit
 mosaic pipeline using the custom parameter file, users simply need to specify the name of the file with the '-c'
 optional command-line argument when using `~drizzlepac.runsinglehap` or the 'input_custom_pars_file' optional input
 argument when executing ``run_hap_processing()`` in `~drizzlepac.hapsequencer` from Python or from another python script.

diff --git a/doc/source/mast_data_products/hap_introduction.rst b/doc/source/mast_data_products/hap_introduction.rst
@@ -14,7 +14,7 @@ Three levels of products are available as part of this release:
   * Filter level products are produced from all exposures in a visit with a common filter.
   * Total level products combine all exposures from a visit for a specific detector and are intended as a detection image for producing catalogs.
 
-The **HAP Single Visit Mosaics (SVMs)** differ from the standard HST drizzled data products, which are aligned filter-by-filter to Gaia.  SVM data products, on the other hand, are all drizzled onto the same north-up pixel grid and may have improved relative alignment across filters within a given visit, enabling easy comparison of the images through multiple filters or for images to be combined to create color mosaics. When possible, sources in the images have been aligned directly to the Gaia source catalog to improve the WCS of the images. SVM data products with both relative alignment (by filter) and absolute alignment to Gaia will contain the string 'FIT_SVM_GAIA' in the 'WCSNAME' keyword in the science extension of the image header. More discussion on HAP alignment, may be found on the webpage `Improvements in HST Astrometry <https://outerspace.stsci.edu/pages/viewpage.action?spaceKey=HAdP&title=Improvements+in+HST+Astrometry>`_.
+The **HAP Single-Visit Mosaics (SVMs)** differ from the standard HST drizzled data products, which are aligned filter-by-filter to Gaia.  SVM data products, on the other hand, are all drizzled onto the same north-up pixel grid and may have improved relative alignment across filters within a given visit, enabling easy comparison of the images through multiple filters or for images to be combined to create color mosaics. When possible, sources in the images have been aligned directly to the Gaia source catalog to improve the WCS of the images. SVM data products with both relative alignment (by filter) and absolute alignment to Gaia will contain the string 'FIT_SVM_GAIA' in the 'WCSNAME' keyword in the science extension of the image header. More discussion on HAP alignment, may be found on the webpage `Improvements in HST Astrometry <https://outerspace.stsci.edu/pages/viewpage.action?spaceKey=HAdP&title=Improvements+in+HST+Astrometry>`_.
 
 Combining data across visits to create mosaics for every observed location on the sky gets performed using
 **HAP Multi-Visit Mosaic (MVM)** processing.
diff --git a/doc/source/mast_data_products/svm_processing.rst b/doc/source/mast_data_products/svm_processing.rst
@@ -41,7 +41,7 @@ in this description can be found in the :ref:`hap-glossary`.
 .. _svm_naming_convention:
 
 =====================
-Single Visit Products
+Single-Visit Products
 =====================
 All files processed as part of a single visit get renamed from the standard
 pipeline filenames into something which describes the data more clearly.  The
@@ -58,7 +58,7 @@ components:
   * **dr[cz].fits** : suffix for drizzled products
   * **fl[ct].fits** : suffix for pipeline-calibrated files
   * **hlet.fits** : suffix for headerlet files containing the WCS solution used to create the final drizzle products/mosaics
-  * **<ipppss>_trl.txt** : single visit processing log files
+  * **<ipppss>_trl.txt** : single-visit processing log files
   * **point-cat.ecsv** : suffix for point (aperture) photometric catalog products
   * **segment-cat.ecsv** : suffix for segment photometric catalog products
 

diff --git a/doc/source/user_reprocessing.rst b/doc/source/user_reprocessing.rst
@@ -2,7 +2,7 @@ User Data Reprocessing
 ======================
 .. _user_reprocessing:
 
-Recommended drizzle parameters to your specific data
+Here we provide resources (including Jupyter Notebooks) to aid users in the reprocessing of their data to best suit their individual science cases.
 
 
 .. toctree::