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-35482] Add support for generating the HiPS list #42

Merged
merged 3 commits into from Aug 5, 2022
Merged

Conversation

rra
Copy link
Member

@rra rra commented Aug 4, 2022

The HiPS list accumulates the properties files for all of the HiPS
data sets for a given deployment of the Rubin Science Platform,
with the addition of the URL (which varies by environment and thus
cannot be encoded in the properties file of the individual HiPS
data set). Serve that list by getting the individual properties
files of each data set, assembling, and then caching the list.

Including this in datalinker may look like an odd choice, since it's
unrelated to the DataLink standard. But, viewed more broadly, the
function of datalinker is to provide registries, catalogs, and
redirects to other services in the deployment, and HiPS is another
example of that type of service. The HiPS data sets themselves will
be served directly from GCS in the future, and GCS won't be able to
serve the dynamic HiPS list directly, so we need some small web
application to do so. Including this in datalinker seems better
than writing a separate application solely for that purpose.

rra added 2 commits August 3, 2022 18:25
The HiPS list accumulates the properties files for all of the HiPS
data sets for a given deployment of the Rubin Science Platform,
with the addition of the URL (which varies by environment and thus
cannot be encoded in the properties file of the individual HiPS
data set).  Serve that list by getting the individual properties
files of each data set, assembling, and then caching the list.

Including this in datalinker may look like an odd choice, since it's
unrelated to the DataLink standard.  But, viewed more broadly, the
function of datalinker is to provide registries, catalogs, and
redirects to other services in the deployment, and HiPS is another
example of that type of service.  The HiPS data sets themselves will
be served directly from GCS in the future, and GCS won't be able to
serve the dynamic HiPS list directly, so we need some small web
application to do so.  Including this in datalinker seems better
than writing a separate application solely for that purpose.
This is now on PyPI, so we can avoid Git dependencies and re-enable
dependency hash pinning.
@gpdf
Copy link
Contributor

gpdf commented Aug 4, 2022

When this is ready for review (I see it's still a draft), could you attach a sample of the HiPS list file output to the PR? Thanks!

@rra
Copy link
Member Author

rra commented Aug 4, 2022

My recollection from previous discussion was that it was okay to expose the HiPS list without requiring authentication, so I have done that and you can see a preview of the output at https://data-int.lsst.cloud/api/hips/list.

@rra rra marked this pull request as ready for review August 4, 2022 02:30
@rra rra requested review from cbanek and gpdf August 4, 2022 02:30
@rra
Copy link
Member Author

rra commented Aug 4, 2022

Adding @gpdf to the review list to check that the output is as expected, and Christine as the code reviewer.

Copy link
Contributor

@gpdf gpdf left a comment

Choose a reason for hiding this comment

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

Examined the output. Verified that the hips_service_url values are appropriate to the specific instance. Verified that it's not behind authorization.

Not tested with Firefly's HiPS-list access yet - that will require a deployment action. Do you want that test done before closing the ticket? We could do it during co-work today?

@rra
Copy link
Member Author

rra commented Aug 4, 2022

A Firefly test would be great but I don't think it's a blocker for merging this. If it uncovers problems, we can always fix it later. But if you feel like testing that today and have the free time I wouldn't say no!

Copy link
Contributor

@cbanek cbanek left a comment

Choose a reason for hiding this comment

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

We should make a service called shakira to host the hips list

safir

# lsst.daf.butler is not yet on PyPI
git+https://github.com/lsst/daf_butler.git@main#lsst-daf-butler
Copy link
Contributor

Choose a reason for hiding this comment

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

woot.

Copy link
Contributor

@cbanek cbanek left a comment

Choose a reason for hiding this comment

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

Just kidding ;) looks great

@rra rra merged commit ee945fd into main Aug 5, 2022
@rra rra deleted the tickets/DM-35482 branch August 5, 2022 15:41
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

3 participants