Tidy up the documentation.

zkbt / chromatic

Tools for visualizing spectrosopic light curves, with flux as a function of wavelength and time.

MIT License

14 stars 4 forks source link

Tidy up the documentation. #141

Closed zkbt closed 2 years ago

zkbt commented 2 years ago

A few things have come up recently that would be good to write down quick intros for in the documentation, at least before a big public release:

[x] explain how to retrieve the injected transit and systematics parameters, to provide a nice test case for anyone's multiwavelength fits
[x] add a page for general helper functions, for example things like bintogrid and bintoR, or the one2another colormap. It shouldn't be front and center, but I've suggested those functions to folks frequently enough that they should probably have their own page
[x] add a page for interacting with models, including getting the residuals, various plots and metrics, and more

zkbt commented 2 years ago

[x] We should add an example of @mone0982 's number_of_photons option for inject_noise.

zkbt commented 2 years ago

[x] We should the shortest possible example for someone to create rainbow from scratch, perhaps as a section on the existing "create from arrays" page.

zkbt commented 2 years ago

[x] Make sure the .help tables are up-to-date with all recent changes.

zkbt commented 2 years ago

[x] Add a tiny bit of description for some of the standard output formats (.rainbow.npy, .rainbow.fits, xarray_[...]) to make it easier for folks to read them without chromatic.

zkbt commented 2 years ago

Most of this has been accomplished in #155 , but there's still a few items remaining.

zkbt commented 2 years ago

The general helper functions are now described under "Related Tools" at https://zkbt.github.io/chromatic/.

zkbt commented 2 years ago

I'm closing this Issue for now. The job of getting the documentation right is going to be infinite, but let's call this list of actions done, and move on to more!