RAD-229: Clean up the documentation after all the RAD updates.

changes/745.doc.rst

@@ -0,0 +1 @@
+Update the RAD docs to reflect all the changes within RAD recently.

docs/helper.rst

@@ -15,7 +15,7 @@ using the command:
 
 .. code:: bash
 
-    python scripts/rad.py
+    python scripts/rad_helper.py
 
 .. note::
 

docs/index.rst

@@ -24,10 +24,10 @@ The following are listings of all the schemas provided by this package for ASDF.
   :maxdepth: 1
 
   schemas.rst
-  source_catalogs.rst
   reference_files.rst
   manifests.rst
   ground_tests.rst
+  ssc.rst
 
 Developer Resources
 ===================

docs/manifests.rst

@@ -8,4 +8,5 @@ The ``tag`` manifests:
 .. asdf-autoschemas::
     :standard_prefix: manifests
 
-    datamodels-1.0
+    datamodels-1.5.0
+    static-1.1.0

docs/reference_files.rst

@@ -8,25 +8,25 @@ Schemas used in Nancy Grace Roman Space Telescope Reference Files:
 .. asdf-autoschemas::
     :standard_prefix: schemas/reference_files
 
-    abvegaoffset-1.0.0
-    apcorr-1.0.0
-    dark-1.0.0
-    distortion-1.0.0
-    epsf-1.0.0
-    flat-1.0.0
-    gain-1.0.0
-    inverselinearity-1.0.0
-    ipc-1.0.0
-    linearity-1.0.0
-    mask-1.0.0
-    matable-1.0.0
-    pixelarea-1.0.0
-    readnoise-1.0.0
-    ref_common-1.0.0
-    ref_exposure_type-1.0.0
-    ref_optical_element-1.0.0
-    refpix-1.0.0
-    saturation-1.0.0
-    skycells-1.0.0
-    superbias-1.0.0
-    wfi_img_photom-1.0.0
+    abvegaoffset-1.2.0
+    apcorr-1.2.0
+    dark-1.4.0
+    distortion-1.3.0
+    epsf-1.3.0
+    flat-1.3.0
+    gain-1.2.0
+    inverselinearity-1.2.0
+    ipc-1.3.0
+    linearity-1.2.0
+    mask-1.2.0
+    matable-1.2.0
+    pixelarea-1.3.0
+    readnoise-1.3.0
+    ref_common-1.2.0
+    ref_exposure_type-1.3.0
+    ref_optical_element-1.3.0
+    refpix-1.2.0
+    saturation-1.2.0
+    skycells-1.1.0
+    superbias-1.2.0
+    wfi_img_photom-1.3.0

docs/schemas.rst

@@ -12,89 +12,99 @@ Level 1 (uncalibrated) schema
 
 .. asdf-autoschemas::
 
-  wfi_science_raw-1.1.0
+  wfi_science_raw-1.4.0
 
 Level 2 (calibrated exposure) schema
 ------------------------------------
 
 .. asdf-autoschemas::
 
-   wfi_image-1.1.0
-   wfi_wcs-1.0.0
+   wfi_image-1.4.0
+   wfi_wcs-1.3.0
 
 Level 3 (resampled mosaic) schema
 ---------------------------------
 
 .. asdf-autoschemas::
 
-  wfi_mosaic-1.1.0
+  wfi_mosaic-1.4.0
 
 Level 4 (ancillary) schemas
 ---------------------------
 
 .. asdf-autoschemas::
 
-  image_source_catalog-1.3.0
-  forced_image_source_catalog-1.0.0
-  segmentation_map-1.1.0
-  mosaic_source_catalog-1.3.0
-  forced_mosaic_source_catalog-1.0.0
-  mosaic_segmentation_map-1.1.0
-  multiband_source_catalog-1.0.0
+  image_source_catalog-1.4.0
+  forced_image_source_catalog-1.1.0
+  segmentation_map-1.4.0
+  mosaic_source_catalog-1.4.0
+  forced_mosaic_source_catalog-1.1.0
+  mosaic_segmentation_map-1.4.0
+  multiband_source_catalog-1.1.0
+  multiband_segmentation_map-1.0.0
 
 
-Tags
+Meta
 ----
 
 .. asdf-autoschemas::
 
-    associations-1.0.0
-    basic-1.0.0
-    cal_logs-1.0.0
-    common-1.1.0
-    coordinates-1.0.0
-    ephemeris-1.1.0
-    exposure_type-1.0.0
-    exposure-1.1.0
-    guidestar-1.1.0
-    guidewindow_modes-1.0.0
-    guidewindow-1.1.0
-    individual_image_meta-1.0.0
-    l1_detector_guidewindow-1.0.0
-    l1_face_guidewindow-1.0.0
-    l2_cal_step-1.1.0
-    l3_cal_step-1.1.0
-    mosaic_associations-1.0.0
-    mosaic_basic-1.0.0
-    mosaic_wcsinfo-1.0.0
-    msos_stack-1.1.0
-    observation-1.0.0
-    outlier_detection-1.0.0
-    photometry-1.0.0
-    pointing-1.0.0
-    program-1.1.0
-    rad_schema-1.0.0
-    ramp_fit_output-1.1.0
-    ramp-1.1.0
-    rcs-1.0.0
-    ref_file-1.1.0
-    resample-1.0.0
-    sky_background-1.0.0
-    statistics-1.0.0
-    source_catalog-1.0.0
-    velocity_aberration-1.0.0
-    visit-1.1.0
-    wcsinfo-1.1.0
-    wfi_detector-1.0.0
-    wfi_mode-1.0.0
-    wfi_optical_element-1.0.0
-    tagged_scalars/file_date-1.0.0
-    tagged_scalars/calibration_software_name-1.0.0
-    tagged_scalars/calibration_software_version-1.0.0
-    tagged_scalars/filename-1.0.0
-    tagged_scalars/model_type-1.0.0
-    tagged_scalars/origin-1.0.0
-    tagged_scalars/prd_version-1.0.0
-    tagged_scalars/product_type-1.0.0
-    tagged_scalars/sdf_software_version-1.0.0
-    tagged_scalars/telescope-1.0.0
+  meta/basic-1.0.0
+  meta/cal_logs-1.0.0
+  meta/calibration_software_name-1.0.0
+  meta/calibration_software_version-1.0.0
+  meta/catalog_image-1.0.0
+  meta/common-1.0.0
+  meta/coordinates-1.0.0
+  meta/ephemeris-1.0.0
+  meta/exposure-1.0.0
+  meta/file_date-1.0.0
+  meta/filename-1.0.0
+  meta/guidestar-1.0.0
+  meta/individual_image_meta-1.0.0
+  meta/l2_cal_step-1.0.0
+  meta/l2_catalog_common-1.0.0
+  meta/l3_cal_step-1.0.0
+  meta/l3_catalog_common-1.0.0
+  meta/l3_common-1.0.0
+  meta/l3_resample-1.0.0
+  meta/l3_wcsinfo-1.0.0
+  meta/model_type-1.0.0
+  meta/observation-1.0.0
+  meta/origin-1.0.0
+  meta/outlier_detection-1.0.0
+  meta/photometry-1.0.0
+  meta/pointing-1.0.0
+  meta/prd_version-1.0.0
+  meta/product_type-1.0.0
+  meta/program-1.0.0
+  meta/rcs-1.0.0
+  meta/ref_file-1.0.0
+  meta/sdf_software_version-1.0.0
+  meta/sky_background-1.0.0
+  meta/source_catalog-1.0.0
+  meta/telescope-1.0.0
+  meta/velocity_aberration-1.0.0
+  meta/visit-1.0.0
+  meta/wcsinfo-1.0.0
+  meta/wfi_mode-1.0.0
+
+Enums
+-----
+.. asdf-autoschemas::
+
+  enums/cal_step_flag-1.0.0
+  enums/exposure_type-1.0.0
+  enums/guidewindow_modes-1.0.0
+  enums/wfi_detector-1.0.0
+  enums/wfi_optical_element-1.0.0
+
+Tables
+------
+
+.. asdf-autoschemas::
+
+  tables/forced_catalog_table-1.0.0
+  tables/multiband_catalog_table-1.0.0
+  tables/prompt_catalog_table-1.0.0
+  tables/source_catalog_columns-1.0.0

docs/ssc.rst

@@ -0,0 +1,7 @@
+.. _ssc_schemas:
+
+SSC Schemas
+===========
+SSC schemas are located in the `resources/schemas/SSC` directory of the package.
+These schemas are not true ASDF schemas so they are not registered with ASDF by default.
+For more information on these schemas contact the Archive and/or SSC teams.

docs/versioning.rst

@@ -60,10 +60,12 @@ for the resources. This directory is organized into two subdirectories:
 
 While ``src/rad/resources`` is where the resources are located for the ASDF extension,
 not all of the resources are directly located in this directory. Instead, the *latest*
-version of any resource (schema or manifest) is instead located within the ``latest``
-directory in the top level of the RAD repository. These files are linked to from
-the ``src/rad/resources`` directory. Note that the path relative to the ``latest``
-directory is the same as the path to the respective symlink relative to the ``src/rad/resources``.
+version of any schema is instead located within the ``latest`` directory in the top
+level of the RAD repository, while the *latest* version of any manifest is located within
+the ``latest/manifests`` directory. These files are linked to from the ``src/rad/resources``
+directory. Note that the path relative to the ``latest`` directory for schemas (``latest/manifests``
+for manifests) is the same as the path to the respective symlink relative to the ``src/rad/resources/schemas`` for schemas
+(``src/rad/resources/manifests`` for manifests).
 
 The naming conventions for resources follows two different patterns:
 
@@ -91,6 +93,15 @@ The naming conventions for resources follows two different patterns:
 Workflow for Updating a Resource Version
 ----------------------------------------
 
+.. note::
+
+   We strongly recommend using the :ref:`RAD Helper Tool's <rad_helper>` Bump function
+   to update the version of a given resource. In addition, the tool will also tell you
+   if you need to bump the version of a resource when you attempt to edit it.
+
+   The tool will take care of updating all the references to the new version number within
+   the ``latest``.
+
 To update the version of a given resource the following steps should be taken:
 
 1. Determine the new version number to be used for the resource following the