USACE / chart-docs

2 stars 0 forks source link

User Documentation: Tech Ref Consequences Engine #73

Open rnugent3 opened 4 months ago

rnugent3 commented 4 months ago

Any work taking place in characterizing consequences - calculations taking place in CHART - need to be documented here.

Further:

  1. Need to point to go-consequences technical reference manual, or write up the technical reference on the consequences engine here.
  2. Only need to point to where to get more information on how input data sets where developed, no need to describe that in detail here

I highly recommend including mathematical formulae and example calculations.

https://www.hec.usace.army.mil/confluence/display/CSTD/Consequences

rnugent3 commented 4 months ago

Critical Updates before SME Review

  1. Document the family of damage functions
  2. Remove public-facing content for features under development. You can save the content without publishing.
  3. Move risk stuff to risk calculation page
HenryGeorgist commented 4 months ago

WIP For 1. - added links to the damage function description table in go-consequences.

for 2. Understood - I am taking no action until others are consulted, I added that in based on requests from other team members.

for 3. I have asked for clarification from you in the comments on the confluence page.