Replace ModelContainer with ModelLibrary

CHANGES.rst

@@ -23,6 +23,8 @@ general
 
 - replace usages of ``copy_arrays`` with ``memmap`` [#1316]
 
+- Replace ModelContainer with ModelLibrary [#1241]
+
 source_catalog
 --------------
 - Add PSF photometry capability. [#1243]

docs/roman/data_products/product_types.rst

@@ -69,13 +69,13 @@ the user is running the pipeline. The input for each optional step is the output
 +===================================================+=================+==============================+==================+=====================+=======================================+
 |                                                   |                 | asn                          |                  |                     |                                       |
 +---------------------------------------------------+-----------------+------------------------------+------------------+---------------------+---------------------------------------+
-| :ref:`flux <flux_step>`                           | asn             | flux (opt)                   | ModelContainer   | MJy/sr              | A list of _cal files                  |
+| :ref:`flux <flux_step>`                           | asn             | flux (opt)                   | ModelLibrary     | MJy/sr              | A list of _cal files                  |
 +---------------------------------------------------+-----------------+------------------------------+------------------+---------------------+---------------------------------------+
-| :ref:`sky_match <skymatch_step>`                  | asn             | skymatch (opt)               | ModelContainer   | MJy/sr              | A list of _cal files                  |
+| :ref:`sky_match <skymatch_step>`                  | asn             | skymatch (opt)               | ModelLibrary     | MJy/sr              | A list of _cal files                  |
 +---------------------------------------------------+-----------------+------------------------------+------------------+---------------------+---------------------------------------+
-| :ref:`outlier_detection <outlier_detection_step>` |                 | outlier_detection_step (opt) | ModelContainer   | MJy/sr              | A list of _cal files                  |
+| :ref:`outlier_detection <outlier_detection_step>` |                 | outlier_detection_step (opt) | ModelLibrary     | MJy/sr              | A list of _cal files                  |
 +---------------------------------------------------+-----------------+------------------------------+------------------+---------------------+---------------------------------------+
-| :ref:`resample <resample_step>`                   |                 | resamplestep (opt)           | ModelContainer   | MJy/sr              | A list of _cal files                  |
+| :ref:`resample <resample_step>`                   |                 | resamplestep (opt)           | ModelLibrary     | MJy/sr              | A list of _cal files                  |
 +---------------------------------------------------+-----------------+------------------------------+------------------+---------------------+---------------------------------------+
 |                                                   |                 | i2d                          | MosaicModel      | MJy/sr              | A 2D resampled image                  |
 +---------------------------------------------------+-----------------+------------------------------+------------------+---------------------+---------------------------------------+

docs/roman/datamodels/index.rst

@@ -6,4 +6,4 @@
    models.rst
    metadata.rst
    datamodels_asdf.rst
-   container.rst
+   library.rst

docs/roman/datamodels/library.rst

@@ -0,0 +1,9 @@
+.. _library:
+
+==============
+ModelLibrary
+==============
+
+.. automodule:: romancal.datamodels.library
+   :members:
+   :undoc-members:

docs/roman/flux/main.rst

@@ -12,7 +12,7 @@ The ``flux`` step can take:
 
   * a single 2D input image (in the format of either a string with the full
     path and filename of an ASDF file or a Roman
-    Datamodel/:py:class:`~romancal.datamodels.container.ModelContainer`);
+    Datamodel/:py:class:`~romancal.datamodels.library.ModelLibrary`);
   * an association table (in JSON format).
 
 

docs/roman/outlier_detection/outlier_detection.rst

@@ -48,7 +48,7 @@ Specifically, this routine performs the following operations:
      resampling.
    * Resampled images will be written out to disk with suffix `_outlier_i2d` by default.
    * **If resampling is turned off** through the use of the ``resample_data`` parameter,
-     a copy of the unrectified input images (as a ModelContainer)
+     a copy of the unrectified input images (as a ModelLibrary)
      will be used for subsequent processing.
 
 #. Create a median image from all grouped observation mosaics.
@@ -115,7 +115,7 @@ The outlier detection algorithm can end up using massive amounts of memory
 depending on the number of inputs, the size of each input, and the size of the
 final output product.  Specifically,
 
-#. The input :py:class:`~romancal.datamodels.ModelContainer` all input exposures would
+#. The input :py:class:`~romancal.datamodels.ModelLibrary` all input exposures would
    have been kept open in memory to make processing more efficient.
 
 #. The initial resample step creates an output product for EACH input that is the
@@ -137,9 +137,9 @@ with the use of the ``in_memory`` parameter.  The full impact of this parameter
 during processing includes:
 
 #. The ``save_open`` parameter gets set to `False`
-   when opening the input :py:class:`~romancal.datamodels.container.ModelContainer`
+   when opening the input :py:class:`~romancal.datamodels.library.ModelLibrary`
    object. This forces all input models in the input
-   :py:class:`~romancal.datamodels.container.ModelContainer` to get written out to disk.
+   :py:class:`~romancal.datamodels.library.ModelLibrary` to get written out to disk.
    It then uses the filename of the input model during subsequent processing.
 
 #. The ``in_memory`` parameter gets passed to the :py:class:`~romancal.resample.ResampleStep`

docs/roman/outlier_detection/outlier_detection_step.rst

@@ -11,7 +11,7 @@ and described in :ref:`outlier-detection-imaging`.
 .. note::
     Whether the data are being provided in an `association file`_ or as a list of ASDF filenames,
     they must always be wrapped with a
-    :py:class:`~romancal.datamodels.container.ModelContainer`, which will handle and
+    :py:class:`~romancal.datamodels.library.ModelLibrary`, which will handle and
     read in the input properly.
 
 .. _association file: https://jwst-pipeline.readthedocs.io/en/latest/jwst/associations/asn_from_list.html

docs/roman/outlier_detection/outlier_examples.rst

@@ -1,7 +1,7 @@
 Examples
 ========
 Whether the data are contained in a list of ASDF files or provided as an ASN file, the
-`ModelContainer` class must be used to properly handle the data that will be used in
+`ModelLibrary` class must be used to properly handle the data that will be used in
 the outlier detection step.
 
 1. To run the outlier detection step (with the default parameters) on a list of 2 ASDF
@@ -10,9 +10,9 @@ the outlier detection step.
         .. code-block:: python
 
                 from romancal.outlier_detection import OutlierDetectionStep
-                from romancal.datamodels import ModelContainer
-                # read the file list into a ModelContainer object
-                mc = ModelContainer(["img_1.asdf", "img_2.asdf"])
+                from romancal.datamodels import ModelLibrary
+                # read the file list into a ModelLibrary object
+                mc = ModelLibrary(["img_1.asdf", "img_2.asdf"])
                 step = OutlierDetectionStep()
                 step.process(mc)
 
@@ -52,9 +52,9 @@ the outlier detection step.
         .. code-block:: python
 
                 from romancal.outlier_detection import OutlierDetectionStep
-                from romancal.datamodels import ModelContainer
-                # read the file list into a ModelContainer object
-                mc = ModelContainer("asn_sample.json")
+                from romancal.datamodels import ModelLibrary
+                # read the file list into a ModelLibrary object
+                mc = ModelLibrary("asn_sample.json")
                 step = OutlierDetectionStep()
                 step.process(mc)
 

docs/roman/resample/main.rst

@@ -14,7 +14,7 @@ The ``resample`` step can take:
 
   * a single 2D input image (in the format of either a string with the full
     path and filename of an ASDF file or a Roman
-    Datamodel/:py:class:`~romancal.datamodels.container.ModelContainer`);
+    Datamodel/:py:class:`~romancal.datamodels.library.ModelLibrary`);
   * an association table (in JSON format).
 
 The parameters for the drizzle operation itself are set by

docs/roman/tweakreg/README.rst

@@ -33,7 +33,7 @@ models to the custom catalog file name, the ``tweakreg_step`` also supports two
 other ways of supplying custom source catalogs to the step:
 
 1. Adding ``tweakreg_catalog`` attribute to the ``members`` of the input ASN
-   table - see `~roman.datamodels.ModelContainer` for more details.
+   table - see `~roman.datamodels.ModelLibrary` for more details.
    Catalog file names are relative to ASN file path.
 
 2. Providing a simple two-column text file, specified via step's parameter

docs/roman/tweakreg/tweakreg_examples.rst

@@ -14,7 +14,7 @@ or a Roman datamodel `ImageModel`.
         .. note::
             If the input is a single Roman ``DataModel``,
             either ``step.call([img])`` or ``step.call(img)`` will work. For multiple elements as input,
-            they must be passed in as either a list or a ModelContainer.
+            they must be passed in as either a list or a ModelLibrary.
 
 #. To run TweakReg in a Python session on an association file with the default parameters:
 

pyproject.toml

@@ -30,7 +30,8 @@ dependencies = [
     "scipy >=1.11",
     "stcal>=1.7.0",
     # "stcal @ git+https://github.com/spacetelescope/stcal.git@main",
-    "stpipe >=0.5.0",
+    #"stpipe >=0.5.0",
+    "stpipe @ git+https://github.com/spacetelescope/stpipe.git@main",
     "tweakwcs >=0.8.6",
     "spherical-geometry >= 1.2.22",
     "stsci.imagestats >= 1.6.3",

romancal/datamodels/__init__.py

@@ -1,3 +1,3 @@
-from .container import ModelContainer
+from .library import ModelLibrary
 
-__all__ = ["ModelContainer"]
+__all__ = ["ModelLibrary"]