CurveFit documentation - #56
Open
alirezazolanvari wants to merge 9 commits into
Open
alirezazolanvari wants to merge 9 commits into
alirezazolanvari wants to merge 9 commits into
Conversation
alirezazolanvari
added
the
documentation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## dev #56 +/- ##
=======================================
Coverage 99.03% 99.03%
=======================================
Files 10 10
Lines 309 309
Branches 33 33
=======================================
Hits 306 306
Misses 2 2
Partials 1 1 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
Up to standards ✅🟢 Issues
|
alirezazolanvari
marked this pull request as ready for review
September 8, 2026 17:17
sepandhaghighi
requested changes
Sep 13, 2026
| ### Known Parameters | ||
| If you know the value of a parameter, give it in the `known_parameters` argument. Use the parameter names in the table above. `CurveFit` keeps these values constant and calculates only the other parameters. | ||
|
|
||
| ⚠️ All the parameters of a model cannot always be calculated from a release profile. Some models use a group of parameters only as one product or one ratio. Many different combinations of these parameters give the same value for this group. Thus, the fit has no unique solution, and the calculated values can be different from the true physical values. To prevent this problem, give at least **two** parameters of each group in the `known_parameters` argument. Two of the models have such a group: |
Member
There was a problem hiding this comment.
To prevent this problem, ... contains two spaces
sepandhaghighi
requested changes
Sep 13, 2026
|
|
||
| You can fit all the models above. This table gives the name and the parameters of each model: | ||
|
|
||
| | Model | `model_name` | Parameters | |
Member
There was a problem hiding this comment.
I notice a potential redundancy and recommend deleting the first column.
sepandhaghighi
requested changes
Sep 14, 2026
sepandhaghighi
left a comment
sepandhaghighi
left a comment
Member
There was a problem hiding this comment.
Please update CHANGELOG.md
|
|
||
| You can fit all the models above. This table gives the name and the parameters of each model: | ||
|
|
||
| | `model_name` | Parameters | |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What does this implement/fix? Explain your changes.
CurveFitclass inREADME.md.