Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

HLA-1190: New installation instructions and small text changes #1727

Merged
merged 13 commits into from
Feb 5, 2024

Conversation

s-goldman
Copy link
Collaborator

@s-goldman s-goldman commented Jan 29, 2024

Resolves HLA-1190

This PR updates the installation instructions and makes several changes related to the recent readthedocs restructuring.

Checklist for maintainers

  • added entry in CHANGELOG.rst within the relevant release section
  • updated or added relevant tests
  • updated relevant documentation
  • added relevant milestone
  • added relevant label(s)
  • ran regression tests, post a link to the Jenkins job below.
    How to run regression tests on a PR

Jenkins test

Copy link

codecov bot commented Jan 30, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (1941e07) 31.14% compared to head (1e8a7e1) 31.14%.

❗ Current head 1e8a7e1 differs from pull request most recent head a3a5a6c. Consider uploading reports for the commit a3a5a6c to get more accurate results

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #1727   +/-   ##
=======================================
  Coverage   31.14%   31.14%           
=======================================
  Files         159      159           
  Lines       35102    35102           
=======================================
  Hits        10933    10933           
  Misses      24169    24169           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@s-goldman s-goldman changed the title Small text changes, updated links to notebook tutorials HLA-1190: New installation instructions and small text changes Jan 31, 2024
Copy link
Collaborator

@mdlpstsci mdlpstsci left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Most of these changes look fine, but there needs to be some rewording as I noted in a comment. I will write up a few sentences momentarily.

@mdlpstsci
Copy link
Collaborator

mdlpstsci commented Jan 31, 2024

@s-goldman
You should feel VERY free to rework what I have said here. I just wanted to clarify that Drizzlepac produces three types of products, and they are all now generated during pipeline processing. This comment is for the drizzlepac_api discussion.

Drizzlepac has evolved over time from not only being
responsible for creating the calibration pipeline
drizzled products (i.e., ipppssoot_dr[c|z].fits),
but also to being responsible for the generation of
the two types of Hubble Advanced Products (HAP). The
HAP products are Single Visit Mosaics (SVMs) and
Multiple Visit Mosaics (MVMs) and the creation of
these products has been incorporated into the
calibration pipeline processing. SVM and MVM
drizzled products are distingushed from pipeline
drizzled counterparts and each other through their
filenames, as well as internal contents.

SVM: hst_<propid>_<obsetid>_<instr>_<detector>_<filter>_<ipppssoo>_dr[c|z].fits)
MVM: hst_skycell_p<PPPP>x<XX>y<YY>_<instr>_<detector>_<filter>_<label>_dr[c|z].fits)

where PPPP = 4-digit projection cell number
XX, YY = 2-digit sky cell numbers

runastrodriz.py is the module to control operation of AstroDrizzle to
remove distortion and combine HST images.

runsinglehap.py is the module which controls the single visit mosaic
processing.

runmultihap.py is the module which controls the single visit mosaic
processing.

You can discuss "AstroDrizzle" as being a fundamental module which is the basis for all of the above code.

@s-goldman
Copy link
Collaborator Author

@s-goldman You should feel VERY free to rework what I have said here. I just wanted to clarify that Drizzlepac produces three types of products, and they are all now generated during pipeline processing. This comment is for the drizzlepac_api discussion.

Drizzlepac has evolved over time from not only being responsible for creating the calibration pipeline drizzled products (i.e., _dr[c|z].fits), but also to being responsible for the generation of the two types of Hubble Advanced Products (HAP). The HAP products are Single Visit Mosaics (SVMs) and Multiple Visit Mosaics (MVMs) and the creation of these products has been incorporated into the calibration pipeline processing. SVM and MVM drizzled products are distingushed from pipeline drizzled counterparts and each other through their filenames, as well as internal contents.

SVM: hst_<propid>_<obsetid>_<instr>_<detector>_<filter>_<ipppssoo>_dr[c|z].fits)
MVM: hst_skycell_p<PPPP>x<XX>y<YY>_<instr>_<detector>_<filter>_<label>_dr[c|z].fits)

where PPPP = 4-digit projection cell number XX, YY = 2-digit sky cell numbers

runastrodriz.py is the module to control operation of astrodrizzle to remove distortion and combine HST images.

runsinglehap.py is the module which controls the single visit mosaic processing.

runmultihap.py is the module which controls the single visit mosaic processing.

You can discuss "AstroDrizzle" as being a fundamental module which is the basis for all of the above code.

I also just got a reply from Jenn on the driz_updates slack channel that we should remove the stuff about HAP and move it to the HAP API (which also needs an intro) and I think she is right.

If it sounds good to you, I will use this for the HAP API intro and create another drizzlepac interface intro just for runastrodriz.

Copy link
Collaborator

@mdlpstsci mdlpstsci left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

After our discussion I am willing to approve this PR even though I do not think the SVM and MVM discussion should fall under the MAST category. These are calibration pipeline produced products and deserve the same level of discussion given to the use of "drizzlepac (runastrodriz)". Having said this, I think is fine to wait until the documentation is further fleshed out and to read all the docs for a high-level view. In any case, kudos on your patience and thoroughness!

@s-goldman s-goldman merged commit 1dc0416 into spacetelescope:master Feb 5, 2024
15 of 18 checks passed
mdlpstsci pushed a commit to mdlpstsci/drizzlepac that referenced this pull request Feb 21, 2024
…telescope#1727)

Co-authored-by: codesee-maps[bot] <86324825+codesee-maps[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants