search

megbedell / wobble

precise data-driven RV fitting, now with tellurics!
https://wobble.readthedocs.io
MIT License
39 stars 16 forks source link

Example for Generic Dataset #54

Open bjfultn opened 5 years ago

bjfultn commented 5 years ago

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.

megbedell commented 5 years ago

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!

bjfultn commented 5 years ago

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?