original source: km7i 10.8.3 Data Dictionary
note: this is under revision for hri07e - but not for irap08c (above km7i refe.)
- new versions of the keycode contents for km6's are under test at:
- net:cname (non-numeric example)
- (numeric example)
10.6 Key Codes
Key Codes are an essential part of the (future) ability to enable machine accessible data storage and management for engineering projects. They have a two part identification - namely - Discipline and KeyCode which only needs to be unique with that discipline. The user should be very aware that symbols and acronyms get reused again and again in different contexts - especially if they are hand written algebraic equations - which is still where most analysts start.
eg: me:q in Mechanical Engineering indicates nominal mass flow whereas q in Chemical Engineering usually is used for heat flow. Therefore chem:q is a very different animal than me:q - although the local calculations for both will only use q. Once posted into a Data Sheet for use by other however - the prefix is essential. (The units may help - except for dimensionless parameters.)
- Discipline: Examples: ACCounting, Industrial Engineering, Mechanical Engineering, etc.
- KeyCode: This would be the name used in software code or as a named variable in a spreadsheet
example: SG
- Label: This is the normal title used in a formal report.
example: Specific Gravity
- Symbol: The normally used Greek or algabric format used in hand calculations should be identified.
example: ρ (rho)
- Units: The normal Imperial and SI units should be indicated.
example: lbs/ft^3 kg/m^3 (is not SG - is SW - specific weight)
- Range: The minimum, typical and maximum values for the data. A distribution curve may also apply and should be identified in known.
example: 0 - 1 - 20 gm/cm^3
- Abstract: This is a short definition of the keycode is and how it is used; and how it was derived if known. It should include the algebraic symbolic form for the equation if possible. (Please do not use source code format unless there is good reason to do so.)
- Related Keycodes: Keycodes which are prerequisites or co-requisites for this item should be identified.
eg: ME:SW, ME:SV
- References: The sources for the derivation and abstract should be linked, stated here.
eg: [1] http://en.wikipedia.org/wiki/Specific_gravity
- Editor: The person who is responsible for the accuracy and quality of the entry should be identified.
- Procedure: If there is a formal procedure or software available for calculating this element it should be identified here.
- Tutorial: If there is a tutorial available is should be linked here.
eg: http://www.khanacademy.org/video/mass-and-weight-clarification?playlist=Physics