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

Fitting the Light Curves documentation: Model calculation #18

Closed
gapp-c opened this issue Oct 7, 2023 · 2 comments
Closed

Fitting the Light Curves documentation: Model calculation #18

gapp-c opened this issue Oct 7, 2023 · 2 comments
Labels
documentation Improvements or additions to documentation duplicate This issue or pull request already exists

Comments

@gapp-c
Copy link
Contributor

gapp-c commented Oct 7, 2023

In the Fitting the Light Curves Documentation, the fit parameters corresponding to each model are given, but the exact meaning of many of the listed parameters is ambiguous since many of them are given in abbreviations only and without units. I think more descriptions of the fit parameters are needed. Also, for the models with analytical expressions (such as model_ramp), I think it'd be useful to state the equation of the model for clarification of the parameters' meanings.

@sebastian-zieba
Copy link
Owner

For sure. I'll definitely have the units in the next release. For the formulas, I currently link to the python code for each model where the user can check out how it's coded into PACMAN. Having a nice latex-formatted formula there for each model too would be cool for the future.
(duplication of Issue #11)

@sebastian-zieba sebastian-zieba added documentation Improvements or additions to documentation duplicate This issue or pull request already exists labels Oct 11, 2023
@sebastian-zieba
Copy link
Owner

The units and meaning of most parameters are now explained. The formulae can be checked out in the respective python files.

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 duplicate This issue or pull request already exists
Projects
None yet
Development

No branches or pull requests

2 participants