prose icon indicating copy to clipboard operation
prose copied to clipboard

More documentation on `Fluxes`

Open lgrcia opened this issue 2 years ago • 2 comments

Amazing review @szunigaf, thanks!

Here are some documentation issues that needs to be addressed ASAP:

  • [x] Update the photometry tutorials to avoid reusing the *calibration sequence
  • [x] Update the photometry tutorials on how measurements are extracted in GetFluxes
  • [x] Update the photometry to show how prose 2.0.0 diagnostic plots can be reproduced (waiting for a detailed issue about that @szunigaf)
  • [ ] On top of the Fluxes docstring, give more context on the shape of fluxes and how it translates on other attributes (like weights.
  • [ ] On top of the Fluxes docstring, add a note about inplace vs. return methods
  • [ ] Extensively document docstrings of Fluxes.autodiff, specify what attributes it changes and that it calls set_aperture...
  • [ ] Documentation of Fluxes.flux is very bad
  • [ ] Badly displayed documentation for Fluxes.fluxes, keep it simple and add more details in Fluxes main docstring

lgrcia avatar Apr 28 '23 09:04 lgrcia

Some features that I miss from prose 2 are the one included in the obs object like:

Comparison stars and Systematics. Screenshot 2023-04-28 at 14 20 16

Or the summary, specially the obs.plot_radial_psf part (lower left corner). Screenshot 2023-04-28 at 14 23 37

Last but not least, the ref.plot_psf_model(). Screenshot 2023-04-28 at 14 24 50

szunigaf avatar Apr 28 '23 12:04 szunigaf

The first comparisons and explanatory measurements plot are now described in the exoplanet transit tutorial (part of #116)

lgrcia avatar Jul 18 '23 11:07 lgrcia