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

Expanded documentation on NED searches #25

Draft
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

gpdf
Copy link

@gpdf gpdf commented Jan 7, 2022

While fiddling with NED searches I thought I'd expand/clarify the documentation a bit. See what you think.

I think it would also be nice to ask the Firefly team to put a subheading at the top of the search tab itself, something like "Search the NASA Extragalactic Database (NED) at IPAC by coordinates", maybe? And a little NED icon? @xiuqin if you like that idea, we can make a FIREFLY- ticket for that.

@gpdf gpdf requested review from xiuqin and lrebull January 7, 2022 18:43
@lrebull
Copy link
Contributor

lrebull commented Jan 7, 2022

for this:

superpose NED search results on search results you've already obtained from other sources.

For all of these catalog searches, one could say that you can superpose these results onto search results you've already obtained from other sources. I'm not sure why NED alone would get that special phrase added. It does already say as part of the introductory matter that the catalogs are overlaid on the images.

The rest of it looks ok to me.

@gpdf
Copy link
Author

gpdf commented Jan 7, 2022

I'm not sure why NED alone would get that special phrase added.

That's a fair point. I was trying to obliquely address the "why search NED by proxy when you can have the real thing?" question. But perhaps this is obvious to anyone who has gotten this far in the application - would that be your take?

It does already say as part of the introductory matter that the catalogs are overlaid on the images

A user who gets here by deep link from the "(?)" icon will not have seen that material, though.

@lrebull
Copy link
Contributor

lrebull commented Jan 7, 2022

Yeah, it's hard to make it clear for people dropping in but not horrifically redundant for people reading the whole thing, and I'm not sure where to draw the line... though the line is probably somewhere before I have to remember to change something in all 5 places in the same file, for example. :) I was trying to minimize repetition by "The search results are then shown (and interacted with) in the same way as the other catalogs described here." But I do see that I don't have that for all the catalog searches, sigh!!

Maybe a section of the catalog 'chapter' called 'interacting with catalogs' (as opposed to loading catalogs, which most of the chapter is at the moment) that has an overview with pointers to plots, visualization, tables (including filters) -- all of which are other chapters. ??


<img src="img/nedcat.png" width="75%"><P>

This tab allows performing a cone search in the main NED object
catalog around specified coordinates.
Copy link

Choose a reason for hiding this comment

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

This tab allows performing a cone search in the NED objects directory

@@ -221,26 +220,39 @@ <h3><A name="nedcatalogs">NED Catalogs</A> -- Overlaying

By clicking on the blue "Catalogs" tab, you are by default dropped
into the interface for searching for catalogs at IRSA. However, you
can pick another tab, "NED", to search for and load a catalog from
NED.<P>
can pick another tab, "NED", to search for and load catalog data from
Copy link

Choose a reason for hiding this comment

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

... to search for and load objects data from ...

Copy link

@xiuqin xiuqin left a comment

Choose a reason for hiding this comment

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

Gregory and I slacked on consistency vs more information separately. We agree it need a wider discussion.
I have a separate change request on documents.

NED is not a catalog. I suggest we use "NED objects" when 'NED catalog" is used. Some phrases I found:
"NED Catalogs -- Overlaying catalogs obtained from NED"
"search for and load a catalog from NED"

@lrebull
Copy link
Contributor

lrebull commented Jan 7, 2022

OK. I will work on changing all instances of "catalog from NED" and add a section explicitly on "interacting with catalogs" early next week.

@lrebull
Copy link
Contributor

lrebull commented Jan 10, 2022

I changed (and propagated) all instances of "NED catalog" to "NED object" in the text and menus. Working on other stuff next.

lrebull pushed a commit that referenced this pull request Jan 10, 2022
lrebull pushed a commit that referenced this pull request Jan 10, 2022
lrebull pushed a commit that referenced this pull request Jan 10, 2022
@lrebull
Copy link
Contributor

lrebull commented Jan 10, 2022

OK, merged thoughts from Gregory and Xiuqin (and me) into the docs version now checked into master. I have also shot myself in the foot with git (again), and although the files are identical as per diff in my directories, git says they are different and cannot be merged properly between the firefly-help branch and the irsa-ui-help branch with the firefly directory. I need someone with more git-fu than me to help fix this.

@lrebull
Copy link
Contributor

lrebull commented Jan 10, 2022

( new version built here: https://master.irsakudev.ipac.caltech.edu/onlinehelp/ )

@xiuqin
Copy link

xiuqin commented Jan 12, 2022

Thank you for the update. The NED portion looks good to me.

@xiuqin xiuqin closed this Jan 12, 2022
@xiuqin xiuqin reopened this Jan 12, 2022
@lrebull
Copy link
Contributor

lrebull commented Jan 12, 2022

can we just close this without merging it? I've manually made all the changes.

@gpdf gpdf marked this pull request as draft January 12, 2022 21:35
@gpdf
Copy link
Author

gpdf commented Jan 12, 2022

Let me give the new version a read-through first.

Meanwhile I've marked this PR as "draft" so that it won't be possible to accidentally merge it with a stray click.

@gpdf
Copy link
Author

gpdf commented Jan 12, 2022

@lrebull I'm snowed under with SPHEREx and family things today, but I'll do it tomorrow.

@lrebull
Copy link
Contributor

lrebull commented Jan 29, 2022

ah, yes, here it says you wanted to look at what i'd done.

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.

3 participants