Add QA Product Specs for v16.0.0

README.md

@@ -3,13 +3,13 @@ Quality Assurance software for NISAR
 
 For the upcoming [NISAR mission](https://nisar.jpl.nasa.gov/),
 eight types of L1/L2 data products will be generated.
-This Quality Assurance (QA) software is designed to look at the data products
-produced one at a time. For each product, the QA code can:
+This Quality Assurance (QA) software is designed to look at the data granules
+produced one at a time. For each granule, the QA code can:
 - Verify the metadata matches the product spec
 - Generate metrics, a PDF report, and a summary CSV describing the quality
-of the product
-- Run CalTools processes on RSLC products
-- Produce a browse image PNG with sidecar KML file for that product
+of the granule
+- Run CalTools processes on RSLC granules
+- Produce a browse image PNG with sidecar KML file for that granule
 
 # Minimum PreRequisites:
 See `environment.yaml` for required packages.
@@ -115,7 +115,7 @@ SKIP=flake8,black git commit -m "foo"  # temporarily disable flake8 and black
 Because the QA code is uniquely written for each product type, each product
 also has a unique runconfig yaml file template and default settings.
 
-The runconfig is where a user specifies the filepath to the input NISAR product,
+The runconfig is where a user specifies the filepath to the input NISAR granule,
 which workflows to run, what units to use for a given metric, and so forth.
 
 To get a product's example runconfig file that has been populated with
@@ -134,11 +134,11 @@ nisarqa dumpconfig gcov
 
 ## Expected Outputs
 
-For each NISAR product, if all workflows are requested via the `workflows`
+For each NISAR granule, if all workflows are requested via the `workflows`
 parameter in the runconfig, the QA code will generate six output files
 and store them in the directory specified by `qa_output_dir` in the runconfig:
 
-1) `BROWSE.png` - RGB browse image for the input NISAR product
+1) `BROWSE.png` - RGB browse image for the input NISAR granule
 2) `BROWSE.kml` - geolocation information for `BROWSE.png`
 3) `REPORT.pdf` - graphical summary PDF containing histograms,
                   low-res images of the input datasets, etc.

docs/README.md

@@ -0,0 +1,46 @@
+# Introduction
+
+This documentation is for the NASA SDS Product Specification for NISAR 
+Level-1 and Level-2 Quality Assurance Products, which will be produced 
+using the `nisarqa` repository.
+
+
+# Quick Links to the QA Product Specification Markdown Files
+
+1) [Introduction and Overview](product_specs/01_intro_and_overview.md)
+2) [Summary CSV File](product_specs/02_summary_csv.md)
+3) [Browse Image PNG and KML](product_specs/03_browse_png_kml.md)
+4) [Graphical Summary PDF](product_specs/04_report_pdf.md)
+    - [RSLC, GSLC, GCOV (Single-Input Products)](product_specs/04a_single_input_products.md)
+    - [Caltools (RSLC, GSLC)](product_specs/04b_caltools.md)
+    - [RIFG, RUNW, GUNW, ROFF, GOFF](product_specs/04c_insar_products.md)
+5) [Statistical Summary QA HDF5](product_specs/05_stats_h5.md)
+    - [RSLC QA HDF5 Specs](product_specs/05a_rslc_qa_hdf5_spec.md)
+    - [GSLC QA HDF5 Specs](product_specs/05b_gslc_qa_hdf5_spec.md)
+    - [GCOV QA HDF5 Specs](product_specs/05c_gcov_qa_hdf5_spec.md)
+    - [RIFG QA HDF5 Specs](product_specs/05d_rifg_qa_hdf5_spec.md)
+    - [RUNW QA HDF5 Specs](product_specs/05e_runw_qa_hdf5_spec.md)
+    - [GUNW QA HDF5 Specs](product_specs/05f_gunw_qa_hdf5_spec.md)
+    - [ROFF QA HDF5 Specs](product_specs/05g_roff_qa_hdf5_spec.md)
+    - [GOFF QA HDF5 Specs](product_specs/05h_goff_qa_hdf5_spec.md)
+
+# Maintainer Documentation
+
+This documentation is written as a series of Markdown files, 
+which will have two primary venues for viewing: the public `nisarqa` 
+GitHub repository, and the NISAR Product Specification document 
+which is signed and released publicly.
+
+## Instructions to Update the Product Spec Markdown Files
+
+Please follow the [Process to Update the QA Product Spec Markdown Files](helpers/process_to_update_the_markdown_files.md)
+
+Of note, this links to the:
+* [Style Guide for the QA Product Spec Markdown](helpers/style_guide_for_writing_markdown_specs.md)
+* [Tips for Compressing Images for the repo](helpers/image_compression_tips.md)
+
+
+## Instructions to Build the QA Product Specification DOCX
+
+Please follow the [Process to Build the DOCX QA Product Specs](helpers/process_to_build_the_docx.md)
+