Skip to content

Algorithm Documentations #2183

@rmroot

Description

@rmroot

Create algorithm documentations in markdown files for the calculations/ directory. All of the content in the calculations directory should be documented. Put the documentation in a new directory "algorithm-documentation" within calculations/.

Make sure the structure of the documentation is logical using separate markdown files where appropriate.

Add a home page for the documentation that provides descriptions and links to the different files.

The documentation should be focused more on engineering math and less on coding related content. Exhaustive detail is desired for the math.

For analysis-calculations:

  • The math is calculated at the group monthly level and rolled up to an annual level
  • Than groups are rolled up to a facility
  • Finally facilities are rolled up to an account

An engineer/end user should be able to go to this documentation and understand how the math works within VERIFI without knowing how VERIFI works. Give detailed descriptions where necessary.

Metadata

Metadata

Labels

documentationImprovements or additions to documentation

Type

No type

Projects

Status

In Progress

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions