outs1der / minbar

Tools and software for building, accessing and analysing the Multi-INstrument Burst ARchive (MINBAR)
GNU General Public License v3.0
8 stars 0 forks source link

Missing minbar_sources.fits file #26

Closed yveskini closed 1 year ago

yveskini commented 1 year ago

In order for the mb.create_distance_correction() method to work correctly as demonstrated in the Example Usage, the file minbar_sources.fits is essential. I'd like to suggest a slight modification to the Getting Started section as follows:

Change this:

"Copy the MINBAR table files minbar.txt and minbar-obs.txt into the data directory, or softlink to the locations"

To something like this :

"Copy the MINBAR table files minbar.txt, minbar-obs.txt, and minbar_sources.fits (rename the downloaded minbar_sources_vXX.fit to minbar_sources.fits) into the data directory, or softlink them to the respective locations."

This updated instruction should help ensure that users have all the necessary files in place for the functionality of mb.create_distance_correction().

outs1der commented 1 year ago

Thanks – have updated the README.md as suggested