search

gwnrtools / nr-catalog-tools

A unified interface to various catalogs of Numerical Relativity simulations of compact binary mergers.
https://github.com/gwnrtools/nr-catalog-tools
GNU General Public License v3.0
1 stars 5 forks source link

Retire legacy code in `nrcatalogtools/legacy.py` #5

Closed prayush closed 1 year ago

prayush commented 1 year ago

The code currently in nrcatalogtools/legacy.py was written to use waveform data from NR simulations, rotate and combine them appropriately to get observable GW polarizations. However, all of this functionality is now being derived from the sxs package which is more complete and computationally efficient than the implementation here. So we need to retire all the code in this file in order to avoid any confusion to users.

adivijaykumar commented 1 year ago

@prayush I can confirm that everything in the file not under the waveform class can be safely removed. I think the waveform class can also be removed, if we think that mismatch and the norms do not fit in neatly into this package. Otherwise, I think it would be better to these functionalities under utils.py (or some other subpackage...).

prayush commented 1 year ago

Sounds good @adivijaykumar , do you want to remove all but the waveform class?

In the waveform class itself, the get_td_waveform* methods have counterparts in WaveformModes, get_mismatch is empty, and get_mode is also in WaveformModes already, so perhaps remove them as well. I suggest moving the get_l2_norm to WaveformModes as well OR to utils.py, this is up to you. But do check this method for overlap.