Skip to content

Commit 6171930

Browse files
committed
DOC: Fix Step ref in devel_io_design
1 parent f36be9e commit 6171930

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

docs/jwst/stpipe/devel_io_design.rst

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -34,19 +34,19 @@ API Summary
3434
Classes, Methods, Functions
3535
---------------------------
3636

37-
* :meth:`stpipe.step.Step.open_model`: Open a ``DataModel``
37+
* :meth:`stpipe.Step.open_model`: Open a ``DataModel``
3838
* ``Step.load_as_level2_asn()``: Open a list or file as Level2 association
3939
* ``Step.load_as_level3_asn()``: Open a list or file as Level3 association
40-
* :meth:`stpipe.step.Step.make_input_path`: Create a file name to
40+
* :meth:`stpipe.Step.make_input_path`: Create a file name to
4141
be used as input
42-
* :meth:`stpipe.step.Step.save_model`: Save a ``DataModel`` immediately
43-
* :attr:`stpipe.step.Step.make_output_path`: Create a file name
42+
* :meth:`stpipe.Step.save_model`: Save a ``DataModel`` immediately
43+
* :attr:`stpipe.Step.make_output_path`: Create a file name
4444
to be used as output
4545

4646
Design
4747
======
4848

49-
The :class:`~stpipe.step.Step` architecture is designed such that
49+
The :class:`~stpipe.Step` architecture is designed such that
5050
a ``Step``'s intended sole responsibility is to perform the calculation
5151
required. Any input/output operations are handled by the surrounding
5252
``Step`` architecture. This is to help facilitate the use of ``Step``'s
@@ -69,7 +69,7 @@ best practices.
6969
To facilitate this design, a basic ``Step`` is suggested to have the
7070
following structure::
7171

72-
class MyStep(stpipe.step.Step):
72+
class MyStep(stpipe.Step):
7373

7474
spec = '' # Desired configuration parameters
7575

@@ -128,12 +128,12 @@ is expected to accept other object types as well.
128128
A ``Step``'s primary argument is expected to be either a string containing
129129
the file path to a data file, or a JWST
130130
:class:`~jwst.datamodels.JwstDataModel` object. The method
131-
:meth:`~stpipe.step.Step.open_model` handles either type of
131+
:meth:`~stpipe.Step.open_model` handles either type of
132132
input, returning a ``DataModel`` from the specified file or a shallow
133133
copy of the ``DataModel`` that was originally passed to it. A typical
134134
pattern for handling input arguments is::
135135

136-
class MyStep(stpipe.step.Step):
136+
class MyStep(stpipe.Step):
137137

138138
def process(self, input_argument):
139139

@@ -143,19 +143,19 @@ pattern for handling input arguments is::
143143
``input_argument`` can either be a string containing a path to a data
144144
file, such as FITS file, or a ``DataModel`` directly.
145145

146-
:meth:`~stpipe.step.Step.open_model` handles ``Step``-specific
146+
:meth:`~stpipe.Step.open_model` handles ``Step``-specific
147147
issues, such ensuring consistency of input directory handling.
148148

149149
If some other file type is to be opened, the lower level method
150-
:meth:`~stpipe.step.Step.make_input_path` can be used to specify
150+
:meth:`~stpipe.Step.make_input_path` can be used to specify
151151
the input directory location.
152152

153153
Input and Associations
154154
----------------------
155155

156156
Many of the JWST calibration steps and pipelines expect an
157157
:ref:`Association <associations>` file as input. When opened with
158-
:meth:`~stpipe.step.Step.open_model`, a
158+
:meth:`~stpipe.Step.open_model`, a
159159
:class:`~jwst.datamodels.container.ModelContainer` is returned. ``ModelContainer``
160160
is a list-like object where each element is the
161161
``DataModel`` of each member of the association. The ``asn_table`` attribute is
@@ -303,7 +303,7 @@ as their primary input. In general, the association defines what the
303303
output basename should be. A typical pattern used to handle
304304
associations is::
305305

306-
class MyStep(stpipe.step.Step):
306+
class MyStep(stpipe.Step):
307307

308308
spec = '' # Desired configuration parameters
309309

@@ -349,7 +349,7 @@ Save That Model: Step.save_model
349349
````````````````````````````````
350350

351351
If a ``Step`` needs to save a ``DataModel`` before the step completes, use
352-
of :meth:`stpipe.step.Step.save_model` is the recommended over
352+
of :meth:`stpipe.Step.save_model` is the recommended over
353353
directly calling :meth:`jwst.datamodels.JwstDataModel.save`.
354354
``Step.save_model`` uses the ``Step`` framework and hence will honor the
355355
following:
@@ -374,14 +374,14 @@ results that would have a different suffix::
374374

375375
self.save_model(intermediate_result_datamodel, suffix='intermediate')
376376

377-
See :meth:`stpipe.step.Step.save_model` for further information.
377+
See :meth:`stpipe.Step.save_model` for further information.
378378

379379
Make That Filename: Step.make_output_path
380380
`````````````````````````````````````````
381381

382382
For the situations when a filename is needed to be constructed before
383383
saving, either to know what the filename will be or for data that is
384-
not a ``DataModel``, use :meth:`stpipe.step.Step.make_output_path`. By default, calling
384+
not a ``DataModel``, use :meth:`stpipe.Step.make_output_path`. By default, calling
385385
``make_output_path`` without any arguments will return what the default
386386
output file name will be::
387387

0 commit comments

Comments
 (0)