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

pin Python in RTD environment #1687

Merged
merged 4 commits into from
Nov 9, 2023

Conversation

zacharyburnett
Copy link
Collaborator

This PR pins Python to 3.11 in the RTD build environment, to attempt to resolve build errors with the docs

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

@codecov
Copy link

codecov bot commented Oct 27, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

see 126 files with indirect coverage changes

📢 Thoughts on this report? Let us know!

@s-goldman
Copy link
Collaborator

@zacharyburnett Is this ready for review?

@zacharyburnett
Copy link
Collaborator Author

@zacharyburnett Is this ready for review?

Yes it should be, there is just a single warning that I'm unsure about:

/Users/zburnett/projects/drizzlepac/drizzlepac/haputils/poller_utils.py:docstring of drizzlepac.haputils.poller_utils.interpret_obset_input:38: WARNING: Literal block expected; none found.

@s-goldman
Copy link
Collaborator

@zacharyburnett Is this ready for review?

Yes it should be, there is just a single warning that I'm unsure about:

/Users/zburnett/projects/drizzlepac/drizzlepac/haputils/poller_utils.py:docstring of drizzlepac.haputils.poller_utils.interpret_obset_input:38: WARNING: Literal block expected; none found.

That doesn't seem related. I'll try to fix that in another PR.

@zacharyburnett zacharyburnett marked this pull request as ready for review November 9, 2023 16:03
@zacharyburnett zacharyburnett requested review from mdlpstsci and a team as code owners November 9, 2023 16:03
@s-goldman
Copy link
Collaborator

I think we just need to indent the numbered lines. Changing the docstring to the following should work:

`"""

Parameters
-----------
results : str or list
    Input poller file name or Python list of dataset names to be processed as a single visit.
    Dataset names have to be either the filename of a singleton (non-associated exposure) or the
    name of an ASN file (e.g., jabc01010_asn.fits).

log_level : int
    The desired level of verboseness in the log statements displayed on the screen and written to the
    .log file.

Returns
-------
obset_dict : dict
    Dictionary of obset objects

tdp_list : list
    list of total detection products

Notes
-------
Interpret the database query for a given obset to prepare the returned
values for use in generating the names of all the expected output products.

Input will have formated rows of one of the following three options::

    1) Full poller file
        ib4606c5q_flc.fits,11665,B46,06,1.0,F555W,UVIS,/foo/bar/ib4606c5q_flc.fits
    
    2) Simpler poller file (list); other info taken from file header keywords
        ib4606c5q_flc.fits
    
    3) For updating the WFPC2 SVM aperture keyword using the poller file; it
        is important that there are no spaces within the poller aperture keyword(s)
        ib4606c5q_flc.fits, PC1-FIX;F160BN15

Full poller files contain filename, proposal_id, program_id, obset_id, exptime, filters, detector, pathname.

The output dict will have format (as needed by further code for creating the product filenames) of::

    obs_info_dict["single exposure product 00": {"info": '11665 06 wfc3 uvis empty_aperture ib4606c5q f555w drc',
                                                 "files": ['ib4606c5q_flc.fits']}
    .
    .
    .
    obs_info_dict["single exposure product 08": {"info": '11665 06 wfc3 ir empty_aperture ib4606clq f110w drz',
                                                 "files": ['ib4606clq_flt.fits']}

    obs_info_dict["filter product 00": {"info": '11665 06 wfc3 uvis empty_aperture ib4606c5q f555w drc',
                                        "files": ['ib4606c5q_flc.fits', 'ib4606c6q_flc.fits']},
    .
    .
    .
    obs_info_dict["filter product 01": {"info": '11665 06 wfc3 ir empty_aperture ib4606cmq f160w drz',
                                        "files": ['ib4606cmq_flt.fits', 'ib4606crq_flt.fits']},


    obs_info_dict["total detection product 00": {"info": '11665 06 wfc3 uvis empty_aperture ib4606c5q f555w drc',
                                                 "files": ['ib4606c5q_flc.fits', 'ib4606c6q_flc.fits']}
    .
    .
    .
    obs_info_dict["total detection product 01": {"info": '11665 06 wfc3 ir empty_aperture ib4606cmq f160w drz',
                                                 "files": ['ib4606cmq_flt.fits', 'ib4606crq_flt.fits']}

The aperture keyword, which has a default value of 'empty_aperture' is filled in the case of WFPC2 observations,
and the use of the two-column format.

"""`

@zacharyburnett
Copy link
Collaborator Author

zacharyburnett commented Nov 9, 2023

I put the code examples in their own blocks and that seemed to fix it, see https://drizzlepac--1687.org.readthedocs.build/en/1687/reference/runsinglehap.html#drizzlepac.haputils.poller_utils.interpret_obset_input

We could alternatively put the whole list in a code block like you suggested, let me know

@s-goldman
Copy link
Collaborator

That sounds good

@s-goldman s-goldman self-requested a review November 9, 2023 19:29
@zacharyburnett zacharyburnett merged commit 6154040 into spacetelescope:master Nov 9, 2023
13 of 14 checks passed
@zacharyburnett zacharyburnett deleted the docs/py311 branch November 9, 2023 19:47
mdlpstsci pushed a commit to mdlpstsci/drizzlepac that referenced this pull request Nov 13, 2023
@mdlpstsci mdlpstsci mentioned this pull request Nov 13, 2023
6 tasks
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