Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

More documentation on Fluxes #75

Open
3 of 8 tasks
lgrcia opened this issue Apr 28, 2023 · 2 comments
Open
3 of 8 tasks

More documentation on Fluxes #75

lgrcia opened this issue Apr 28, 2023 · 2 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed priority

Comments

@lgrcia
Copy link
Owner

lgrcia commented Apr 28, 2023

Amazing review @szunigaf, thanks!

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

  • Update the photometry tutorials to avoid reusing the *calibration sequence
  • Update the photometry tutorials on how measurements are extracted in GetFluxes
  • 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 lgrcia added enhancement New feature or request documentation Improvements or additions to documentation labels Apr 28, 2023
@szunigaf
Copy link

szunigaf commented Apr 28, 2023

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

@lgrcia lgrcia added priority help wanted Extra attention is needed good first issue Good for newcomers labels May 26, 2023
@lgrcia lgrcia pinned this issue Jul 18, 2023
@lgrcia
Copy link
Owner Author

lgrcia commented Jul 18, 2023

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed priority
Projects
None yet
Development

No branches or pull requests

2 participants