Merge pull request #11 from bsipocz/MAINT_reformatting

Author: bsipocz

documentation/index.md

@@ -2,11 +2,15 @@
 
 
 ## Document Purpose and Scope
-The purpose of this document is to facilitate science with SPHEREx data by providing users with an overview of the SPHEREx data that are available at the NASA/IPAC Infrared Science Archive (IRSA) at Caltech, as well as instructions for accessing and downloading these data. We also provide tips for exploring the data and getting help with any questions you may have. This User Guide will evolve as the SPHEREx project delivers new data products and tools to IRSA to make available to the public.
+The purpose of this document is to facilitate science with SPHEREx data by providing users with an overview of the SPHEREx data that are available at the NASA/IPAC Infrared Science Archive (IRSA) at Caltech, as well as instructions for accessing and downloading these data.
+We also provide tips for exploring the data and getting help with any questions you may have.
+This User Guide will evolve as the SPHEREx project delivers new data products and tools to IRSA to make available to the public.
 
 ## SPHEREx Overview
 
-SPHEREx is a NASA Astrophysics Medium Explorer mission that launched in March 2025. During its planned two-year mission, SPHEREx will obtain 0.75-5 micron spectroscopy over the entire sky, with deeper data in the SPHEREx Deep Fields. SPHEREx data will be used to:
+SPHEREx is a NASA Astrophysics Medium Explorer mission that launched in March 2025.
+During its planned two-year mission, SPHEREx will obtain 0.75-5 micron spectroscopy over the entire sky, with deeper data in the SPHEREx Deep Fields.
+SPHEREx data will be used to:
 
 * **constrain the physics of inflation** by measuring its imprints on the three-dimensional large-scale distribution of matter,
 * **trace the history of galactic light production** through a deep multi-band measurement of large-scale clustering,
@@ -23,4 +27,4 @@ More information is available in the "Mission Overview" section of the SPHEREx E
 
 [SPHEREx project website](https://spherex.caltech.edu/)
 
-[SPHEREx Explanatory Supplement](https://irsa.ipac.caltech.edu/data/SPHEREx/docs/SPHEREx_Expsupp_QR_v1.0.pdf)
+[SPHEREx Explanatory Supplement](https://irsa.ipac.caltech.edu/data/SPHEREx/docs/SPHEREx_Expsupp_QR.pdf)

documentation/spherex_data_access.md

@@ -1,6 +1,8 @@
 # SPHEREx Data Access
 
-IRSA serves SPHEREx data on premises at IPAC. IRSA provides layered access to these data to support a variety of use cases and users. These layers include:
+IRSA serves SPHEREx data on premises at IPAC.
+IRSA provides layered access to these data to support a variety of use cases and users.
+These layers include:
 
 * **Browsable Directories:** SPHEREx on-premises data products are laid out in directories that can be navigated with standard web browsers.
 * **Application Program Interfaces:** IRSA provides SPHEREx data access APIs that are compliant with International Virtual Observatory Alliance (IVOA) standards.
@@ -10,7 +12,8 @@ IRSA serves SPHEREx data on premises at IPAC. IRSA provides layered access to th
 Each of these data access layers is described in greater detail in the subsections below.
 
 ## Browsable Directories
-SPHEREx data products are laid out in directories that can be navigated with standard web browsers. This is convenient for users to get a quick sense of the types of data products that are available, to quickly download some examples by clicking through the directory tree, and to script bulk downloads using wget or curl.
+SPHEREx data products are laid out in directories that can be navigated with standard web browsers.
+This is convenient for users to get a quick sense of the types of data products that are available, to quickly download some examples by clicking through the directory tree, and to script bulk downloads using wget or curl.
 
 The root of the SPHEREx data quick release data directories is:
 https://irsa.ipac.caltech.edu/ibe/data/spherex/qr
@@ -27,28 +30,38 @@ The public data products are organized into subdirectories based on the followin
 * **Read Noise Parameters:** `readnoise_pars/base-[Processing Date]/[Detector]/`
 * **Spectral WCS:** `spectral_wcs/base-[Processing Date]/[Detector]/`
 
-The content of each subdirectory is described in greater detail in the Data Products section of this user guide and in the [SPHEREx Explanatory Supplement](https://irsa.ipac.caltech.edu/data/SPHEREx/docs/SPHEREx_Expsupp_QR_v1.0.pdf).
+The content of each subdirectory is described in greater detail in the Data Products section of this user guide and in the [SPHEREx Explanatory Supplement](https://irsa.ipac.caltech.edu/data/SPHEREx/docs/SPHEREx_Expsupp_QR.pdf).
 
 
 ## Application Program Interfaces (APIs)
 
-IRSA provides API access to SPHEREx Spectral Images through version 2 of the VO Simple Image Access (SIA2) protocol. SIA2 allows users to query for a list of images that satisfy constraints based on position(s) on the sky, band, time, ID, and instrument. The list returned by the service includes data access URLs, which can be used to retrieve some or all of the images in the list using wget or curl. A brief summary of SIA2 for accessing SPHEREx data for IRSA is given below. Additional [documentation on IRSA’s SIA2 service](https://irsa.ipac.caltech.edu/ibe/sia.html) can be found on the IRSA website:
+IRSA provides API access to SPHEREx Spectral Images through version 2 of the VO Simple Image Access (SIA2) protocol.
+SIA2 allows users to query for a list of images that satisfy constraints based on position(s) on the sky, band, time, ID, and instrument.
+The list returned by the service includes data access URLs, which can be used to retrieve some or all of the images in the list using wget or curl.
+A brief summary of SIA2 for accessing SPHEREx data for IRSA is given below.
+Additional [documentation on IRSA’s SIA2 service](https://irsa.ipac.caltech.edu/ibe/sia.html) can be found on the IRSA website:
 
-Note: SPHEREx data are ingested on a weekly basis. Due to the nature of the ingestion process, new SPHEREx data will first be available in the browsable directories and in the SPHEREx Data Explorer GUI. Availability via SIA2 and Python libraries like Astroquery and PyVO will lag on the order of a day.
+:::{note}
+SPHEREx data are ingested on a weekly basis.
+Due to the nature of the ingestion process, new SPHEREx data will first be available in the browsable directories and in the SPHEREx Data Explorer GUI.
+Availability via SIA2 and Python libraries like Astroquery and PyVO will lag on the order of a day.
+:::
 
 IRSA's generric SIA2 endpoint is:
 
 `https://irsa.ipac.caltech.edu/SIA?`
 
-Users must add a `COLLECTION` parameter to this endpoint to specify which dataset to search.  There are three SPHEREx-related SIA2 collections:
+Users must add a `COLLECTION` parameter to this endpoint to specify which dataset to search.
+ There are three SPHEREx-related SIA2 collections:
 
 * SPHEREx Quick Release Spectral Image MEFs that are part of the SPHEREx **Wide Survey** can be accessed with: `COLLECTION=spherex_qr`
 
 * SPHEREx Quick Release Spectral Image MEFs that are part of the SPHEREx **Deep Survey** can be accessed with: `COLLECTION=spherex_qr_deep`
 
 * SPHEREx Quick Release **Calibration files** can be accessed with: `COLLECTION=spherex_qr_cal`
 
-You can use `wget` or `curl` to submit SIA2 queries from the command line. For example:
+You can use `wget` or `curl` to submit SIA2 queries from the command line.
+For example:
 
 * `wget -O example1.html "https://irsatest.ipac.caltech.edu/SIA?COLLECTION=spherex_qr&POS=circle+127.69444+-39.17760+0.01&RESPONSEFORMAT=HTML"`
 
@@ -58,10 +71,13 @@ See the next section to learn how to use Python wrappers around IRSA’s SIA2 se
 
 If you would like to take advantage of IRSA’s SIA2 service for querying SPHEREx images, but prefer to use Python rather than the command line, you may be interested in using one of two Python libraries:
 
-*	**PyVO**  -- This module lets you find and retrieve astronomical data available from archives that support standard IVOA protocols.
-*	**Astroquery**  -- This module provides access to IRSA's public astrophysics data from projects such as SPHEREx, Euclid, Spitzer, WISE/NEOWISE, SOFIA, IRTF, 2MASS, Herschel, IRAS, and ZTF.
+[PyVO](https://github.com/astropy/pyvo)
+ : This module lets you find and retrieve astronomical data available from archives that support standard IVOA protocols.
 
-Examples of data queries using both of these libraries can be found in [IRSA’s Python Notebook Tutorial Repository](https://caltech-ipac.github.io/irsa-tutorials/):
+[Astroquery](https://github.com/astropy/astroquery)
+ : This module provides access to IRSA's public astrophysics data from projects such as SPHEREx, Euclid, Spitzer, WISE/NEOWISE, SOFIA, IRTF, 2MASS, Herschel, IRAS, and ZTF.
+
+Examples of data queries using both of these libraries can be found in [IRSA’s Python Notebook Tutorial Repository](https://caltech-ipac.github.io/irsa-tutorials/).
 
 ## SPHEREx Data Explorer Web Application