Skip to content

Commit

Permalink
Updates based on comments.
Browse files Browse the repository at this point in the history
  • Loading branch information
hbrown-ST committed Oct 7, 2024
1 parent 39e5602 commit 3a61527
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 3 deletions.
5 changes: 3 additions & 2 deletions documentation/crds_users_guide/source/library_use.rst
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,8 @@ reference file paths:
context : The name of the pipeline context mapping which should be
used to define best reference lookup rules, or None. If
`context` is None, use the latest pipeline mapping.
`context` is None, use the latest pipeline mapping. For JWST,
this is the build context mapping.
str
Expand Down Expand Up @@ -147,7 +148,7 @@ reference type:
filling in appropriate reference type keywords.
Define best references using either .pmap `context` or the default
CRDS latest context if context=None.
CRDS context if context=None.
If `reftypes` is defined, assign bestrefs to only the listed
reftypes, otherwise assign all reftypes.
Expand Down
5 changes: 4 additions & 1 deletion documentation/crds_users_guide/source/web_services.rst
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,10 @@ when the cache is synchronized. Since this value is inapplicable if a pipeline
is run in "remote" mode computing best references on the CRDS Server, the
generally preferred value is from `get_default_context()` since it always
reflects the intended latest context regardless of the pipeline's CRDS
mode.
mode. For JWST, get_default_context() retrieves the "build" context associated
with the version of JWST pipeline calibration software installed locally,
which may or may not differ from the "latest" context.
This ensures compatibility between reference files and calibration software.

The actual default context for a pipeline can be obtained as follows:

Expand Down

0 comments on commit 3a61527

Please sign in to comment.