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

Add rationale information to constraints #3197

Open
2 tasks
samm82 opened this issue Dec 23, 2022 · 1 comment
Open
2 tasks

Add rationale information to constraints #3197

samm82 opened this issue Dec 23, 2022 · 1 comment
Labels
design Related to the current design of Drasil (not artifacts). enhancement

Comments

@samm82
Copy link
Collaborator

samm82 commented Dec 23, 2022

As mentioned in #1491, #3091, and #3187, we should have a way to add rationale information to constraints. This could be a source, a derivation, or potentially something else.

Not all constraints would have a rationale, so we would need a way to accommodate that. My immediate thought is to use Maybe, but I know we are trying to avoid that (#2677).

TODO

  • Add the ability to store rationale information to ConstraintE (or create a new data type that allows for this?)
  • Display constraint rationale, if applicable, beneath the relevant table (Input/Output Data Constraints).
@samm82 samm82 added enhancement design Related to the current design of Drasil (not artifacts). labels Dec 23, 2022
@smiths
Copy link
Collaborator

smiths commented Jan 5, 2023

Although it isn't part of this issue, we should make sure that the rationale information can also be added to assumptions. Actually the rationale will be added "outside" the assumption to justify that we can invoke that assumption. For instance, in projectile we assume constant acceleration. That is a mathematical assumption that the physics equations depend on. If we want to use these equations to solve a particular problem, we need to be able to justify that we have constant acceleration. That is, we need to be able to provide a rationale for invoking the assumption. In the case of projectile motion we can use the constant acceleration assumption because the acceleration varies very little by height. (We could quantify this if needed.)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
design Related to the current design of Drasil (not artifacts). enhancement
Projects
None yet
Development

No branches or pull requests

2 participants