smiths / caseStudies

Case studies of (manual) documentation for scientific computing software
3 stars 2 forks source link

SSP : Data constraints section does not contain any uncertainty values #46

Closed niazim3 closed 6 years ago

niazim3 commented 6 years ago

(Issue #27 )

In section 4.2.6 (i.e. Data Constraints), the use of values in the uncertainty column of the table is described, however, there are no values in the table itself.

Perhaps it can be removed completely?

Or is information missing from the SRS?

image

(https://github.com/smiths/caseStudies/blob/220c839436f38aaf2c87c4020d0ca23a278fa6c0/CaseStudies/ssp/Documentation%20Files/SRS_SSP.tex#L2961)

smiths commented 6 years ago

No, we shouldn't remove the information. We'll never remember to put it back in if we remove it now. Please enter 10\% as the uncertainty for everything. If in doubt, this is the value that engineers usually assume, since they know they can't really do much better than this is general.

niazim3 commented 6 years ago

This change has been implemented in Drasil already, the only difference being the format of the Typical Uncertainty (i.e. "10%" vs "0.1").

smiths commented 6 years ago

Can you please also make the change in the manual version. At some point we will stop maintaining the manual version, but we aren't to this point yet. Also, I prefer 10% to 0.1. If 0.1 is used, then the text needs to explain what it means (true-measured)/true <= 0.1.

niazim3 commented 6 years ago

Sorry @smiths, I didn't mention that the manual version has been implemented already (commit that references this issue before my comment).

As for 10% vs the note in Drasil, I'll look into it now.

smiths commented 6 years ago

Sounds good.

niazim3 commented 6 years ago
-- | UncertQ is a chunk which is an instance of UncertainQuantity. It takes a 
-- ConstrainedChunk and a Double (from 0 to 1) which represents a percentage of uncertainty
data UncertainChunk  = UCh { _conc :: ConstrainedChunk
                           , _unc' :: Maybe Double
                           }
makeLenses ''UncertainChunk

Currently, the uncertainty is stored as a value between 0 and 1 (which is why 0.1 is output at the moment). Since 10% is preferred to 0.1, working on updating the output to be in percent format in the following branch: displayingUncrtntyUpdate.