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

Need better documentation for the meaning of some of the parameters #318

Open
emilydriano opened this issue Apr 4, 2024 · 1 comment · May be fixed by #324
Open

Need better documentation for the meaning of some of the parameters #318

emilydriano opened this issue Apr 4, 2024 · 1 comment · May be fixed by #324
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@emilydriano
Copy link
Collaborator

Per feedback from Aasli as an FPsim user, it's unclear what some of the model's scalar parameters are/how they should be parameterized. Example is the param 'high_parity_nonuse'; an explanation/comment next to the parameter in each location file (and possibly calibration file where it's used as a free param) would suffice.

@MObrien-IDM MObrien-IDM self-assigned this Apr 17, 2024
@MObrien-IDM
Copy link
Contributor

I'm starting to work on new documentation and will address this. Thank you!

@MObrien-IDM MObrien-IDM added the documentation Improvements or additions to documentation label Apr 17, 2024
@MObrien-IDM MObrien-IDM linked a pull request Apr 17, 2024 that will close this issue
14 tasks
@MObrien-IDM MObrien-IDM linked a pull request Apr 17, 2024 that will close this issue
14 tasks
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

Successfully merging a pull request may close this issue.

2 participants