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

Document flux functions #106

Open
ErwanQuintin opened this issue Jan 10, 2024 · 2 comments
Open

Document flux functions #106

ErwanQuintin opened this issue Jan 10, 2024 · 2 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@ErwanQuintin
Copy link
Collaborator

Document the model.abc.photon_flux and model.abc.energy_flux functions, showing how to use them (and how to apply parameters to the loaded SpectralModel object)

@ErwanQuintin ErwanQuintin added the documentation Improvements or additions to documentation label Jan 10, 2024
@renecotyfanboy
Copy link
Owner

renecotyfanboy commented Jan 10, 2024

I'll also add wrappers so that you can enter floats both as parameters and energy limits. Add better integration too

  • Document the photon flux and energy flux
  • Integrate between more than 2 energies
  • Ensure the functions can admit float arguments
  • Add unit tests

@ErwanQuintin
Copy link
Collaborator Author

Emphasize the fact that it's a single trapezoid integration, and using it to compute fluxes in a large band requires to sum over several smaller bins

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
Projects
None yet
Development

No branches or pull requests

2 participants