search

manodeep / Corrfunc

⚡️⚡️⚡️Blazing fast correlation functions on the CPU.
https://corrfunc.readthedocs.io
MIT License
163 stars 50 forks source link

Consider changing "mock catalog" terminology #195

Closed lgarrison closed 4 years ago

lgarrison commented 4 years ago

We have two categories of estimators: those that operate on "simulations" (cartesian coordinates) and those that operate on "mock catalogs" (RA/DEC). But the latter is certainly not restricted to mock catalogs—it works just as well on real data! So perhaps we should change the terminology in the documentation to avoid confusion on this point.

Some ideas: instead of "mock catalogs", how about "RA/DEC catalogs" or "sky-coordinate catalogs"? @manodeep, other ideas?

Or, we could keep the "mock catalogs" nomenclature but clarify this point in prominent places in the documentation.

manodeep commented 4 years ago

@lgarrison Another option could be "On-sky co-ordinates" and highlight that those can be real galaxies as well as mocks.

manodeep commented 4 years ago

@lgarrison You were clearly prescient. We should somehow highlight that the "mocks" routines are aimed for observed galaxies! If the simulated galaxies have been projected to on-sky positions, then the "mocks" routines will also work for such 'mock' galaxies...

For starters, should we add a bold line in the top of the README?

manodeep commented 4 years ago

This is the only remaining issue earmarked for 2.3.2. Renaming the directories and the files consistently is a bit of undertaking, so should we start with updating the README and the docs?

lgarrison commented 4 years ago

Yeah, I agree it may not be worth updating all the files and function names. Clarifying the readme will get us most of the way there.

On Wed, Dec 18, 2019 at 2:29 PM Manodeep Sinha notifications@github.com wrote:

This is the only remaining issue earmarked for 2.3.2. Renaming the directories and the files consistently is a bit of undertaking, so should we start with updating the README and the docs?

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/manodeep/Corrfunc/issues/195?email_source=notifications&email_token=ABLA7S4LA7IJSKGZOAY5PQLQZJ2ZLA5CNFSM4IWUW7J2YY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOEHHGZ4Y#issuecomment-567176435, or unsubscribe https://github.com/notifications/unsubscribe-auth/ABLA7S5LRP7TSS5FA67OCNTQZJ2ZLANCNFSM4IWUW7JQ .

-- Lehman Garrison lgarrison@flatironinstitute.org Flatiron Research Fellow, Cosmology X Data Science Group Center for Computational Astrophysics, Flatiron Institute lgarrison.github.io

manodeep commented 4 years ago

Fixed by #205