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

DM-21939: Create Gen 3 AP Pipeline #55

Merged
merged 11 commits into from Jun 23, 2020
Merged

DM-21939: Create Gen 3 AP Pipeline #55

merged 11 commits into from Jun 23, 2020

Conversation

kfindeisen
Copy link
Member

@kfindeisen kfindeisen commented Jun 9, 2020

This PR makes some code changes to conform to lsst/ap_association#86, and adds a pipeline config file to the repository (we may later want to move it to pipe_tasks, but I think doing so at this point would be confusing). For readability, I've put the documentation in different commits from the changes they document.

I've moved the old documentation to "Gen 2" files and created a modified "Gen 3" copy under the original filenames. GitHub displays this as an in-place change; I'm not sure whether it will be easier to review the changes that way, or as a completely new document.

This commit converts the input schema to the catalog-based format
needed in Gen 3.
This commit gives the document titles a "(Gen 2)" flag in their
title, and renames their files and anchors to avoid conflicts with
Gen 3 versions of the same document.
@kfindeisen kfindeisen requested a review from mrawls June 9, 2020 18:43
Copy link
Collaborator

@mrawls mrawls left a comment

Choose a reason for hiding this comment

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

Please see individual comments/suggestions for the docs, but for the most part this looks good.

doc/lsst.ap.pipe/apdb.rst Show resolved Hide resolved
doc/lsst.ap.pipe/getting-started-gen2.rst Outdated Show resolved Hide resolved
doc/lsst.ap.pipe/getting-started-gen2.rst Outdated Show resolved Hide resolved
doc/lsst.ap.pipe/getting-started-gen2.rst Outdated Show resolved Hide resolved
doc/lsst.ap.pipe/getting-started-gen2.rst Outdated Show resolved Hide resolved
doc/lsst.ap.pipe/pipeline-tutorial.rst Outdated Show resolved Hide resolved
doc/lsst.ap.pipe/pipeline-tutorial.rst Outdated Show resolved Hide resolved
doc/lsst.ap.pipe/pipeline-tutorial.rst Outdated Show resolved Hide resolved
doc/lsst.ap.pipe/pipeline-tutorial.rst Outdated Show resolved Hide resolved
doc/lsst.ap.pipe/pipeline-tutorial.rst Outdated Show resolved Hide resolved
The tutorials referred to old ways of handling data,
particularly defects.
This is a direct translation of the pipeline structure, configuration
defaults, and configuration validation.
@kfindeisen
Copy link
Member Author

I think I've addressed everything. I also added context paragraphs to the two "getting started" tutorials on cc7e875, if you'd like to take a look.

doc/lsst.ap.pipe/index.rst Outdated Show resolved Hide resolved
Of course, to inspect this data with the Butler, you don't need to know
where it lives on disk. You should instead instantiate a Butler within python
in the ``processed`` directory and access the data products that way.
contains_no_user_servicable_files/
Copy link
Collaborator

Choose a reason for hiding this comment

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

Ha! Is this really how it works? I couldn't open a calexp or a diffim output by ap_pipe with, e.g., ds9 if I wanted to?

Copy link
Member Author

Choose a reason for hiding this comment

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

They're still regular files (for now?), but their organization is more complicated than in Gen 2 and my impression is that Gen 3 is less tolerant of user hacking than Gen 2 was. So I'm disinclined to create the kind of detailed directory tree you had in the original guide (also, as we saw with the collection names, it's very subject to change ATM).

An anchor with this name is likely to appear in another package, such
as ``pipe_base``.
@mrawls
Copy link
Collaborator

mrawls commented Jun 23, 2020

Thanks for going through all these docs in such detail! All looks good now.

@kfindeisen kfindeisen merged commit 4a18b42 into master Jun 23, 2020
@kfindeisen kfindeisen deleted the tickets/DM-21939 branch June 23, 2020 22:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants