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

Rename variables to match paper #203

Open
philihp opened this issue Sep 30, 2021 · 3 comments
Open

Rename variables to match paper #203

philihp opened this issue Sep 30, 2021 · 3 comments
Labels
good first issue Good for newcomers

Comments

@philihp
Copy link
Owner

philihp commented Sep 30, 2021

  • Refactor and rename variables in the src/models/ such that they match the variables defined in the PDF. This will make the code easier to maintain and perhaps help others port to other languages.
  • e.g. sigSqToCiq should probably be some variation of qEta, since it's related to ηq defined on page 287, §3.1.1
  • The unit tests should protect you from making any catastrophic changes.
@mstofirova
Copy link

Hello, can I work on this?

@philihp
Copy link
Owner Author

philihp commented Oct 7, 2021

Go for it :)

Please ask questions if you get stuck on anything. I would suggest a different and separate PRs for each model, and perhaps another that renames config vars to be more in line with the paper. I would prefer multiple smaller, incremental PRs.

@philihp philihp changed the title Rename variables to Match PDF Rename variables to match paper Mar 1, 2022
@philihp
Copy link
Owner Author

philihp commented Mar 8, 2022

"EPSILON" should be "KAPPA"

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants