wobble icon indicating copy to clipboard operation
wobble copied to clipboard

Example for Generic Dataset

Open bjfultn opened this issue 5 years ago • 2 comments

Is it feasible to create an example of setting up the appropriate hd5 dataset with a more generic set of input spectra files? This might be as simple as documenting the make_data.write_data function in great detail in a tutorial on the RTD page. Some specific questions I have are after briefly looking through the make_data.py script.

  • What data is actually needed from the HARPS files (without having to look up what the HARPS header keywords mean)?
  • Are there any pieces of the data that are optional?

bjfultn avatar Feb 25 '19 21:02 bjfultn

For the moment I've added a long docstring to make_data.write_data to specify what things are & which ones are optional. Not an ideal solution but hopefully it helps!

megbedell avatar Feb 26 '19 16:02 megbedell

This is a great help, thanks! If you could add the documentation for that function into the API docs on the RTD page then I think we can close or greatly lower the priority of this issue. Maybe move that function into wobble.utils or wobble.data?

bjfultn avatar Feb 26 '19 19:02 bjfultn