Energistics Unit of Measure Usage Guide
Total Page:16
File Type:pdf, Size:1020Kb
Energistics Unit of Measure Usage Guide Version 1.0 A set of resources that defines a standard unit of Energistics measure (UOM) dictionary to promote consistent Unit of usage, data exchange, and unit conversion. The Measure set includes the base Energistics Unit of Measure Dictionary and related documentation Standard for creating, implementing, and maintaining a UOM dictionary that is patterned after the Energistics dictionary. Version 1.0 Abstract This document outlines best practices for creating, implementing and maintaining a UOM dictionary that is patterned after the Energistics Unit of Measure Dictionary. Prepared by Energistics Date published June 2014 Document type Usage Guide Keywords: standards, energy, data, information, process, units of measure Energistics Unit of Measure Usage Guide Document Information DOCUMENT VERSION 1.0 DATE June 2014 Language US English Acknowledgements Energistics wishes to thank its member community, the Professional Petroleum Data Management (PPDM™) Association, and the Society of Exploration Geophysicists (SEG) for their contributions to this standard. Usage, Intellectual Property Rights, and Copyright This document was developed using the Energistics Standards Procedures. These procedures help implement Energistics’ requirements for consensus building and openness. Questions concerning the meaning of the contents of this document or comments about the standards procedures may be sent to Energistics at [email protected] . The material described in this document was developed by and is the intellectual property of Energistics. Energistics develops material for open, public use so that the material is accessible and can be of maximum value to everyone. Use of the material in this document is governed by the Energistics Intellectual Property Policy document and the Product Licensing Agreement, both of which can be found on the Energistics website, http://www.energistics.org/legal-policies . All Energistics published materials are freely available for public comment and use. Anyone may copy and share the materials but must always acknowledge Energistics as the source. No one may restrict use or dissemination of Energistics materials in any way. Trademarks Energistics®, Epicentre™, WITSML™, PRODML™, RESQML™, Upstream Standards. Bottom Line Results.®, The Energy Standards Resource Centre™ and their logos are trademarks or registered trademarks of Energistics in the United States. Access, receipt, and/or use of these documents and all Energistics materials are generally available to the public and are specifically governed by the Energistics Product Licensing Agreement (http://www.energistics.org/product-license-agreement ). Other company, product, or service names may be trademarks or service marks of others. V1.0/June 2014 2 Energistics Unit of Measure Usage Guide Amendment History Version Date Comment By 1.0 June 2014 First publication of the standard and document. Energistics V1.0/June 2014 3 Energistics Unit of Measure Usage Guide Table of Contents 1 Introduction ...................................................................................................... 5 1.1 Audience, Purpose and Scope ................................................................................. 5 1.2 Resource Set ............................................................................................................ 5 1.2.1 Additional Resources ..................................................................................... 6 1.3 Sources for UOM Standard ...................................................................................... 6 2 Key Concepts ................................................................................................... 7 2.1 Unit Dimension ......................................................................................................... 7 2.2 Quantity Class .......................................................................................................... 8 2.2.1 Guidelines for Specifying a Quantity Class .................................................... 9 2.3 Aliases ...................................................................................................................... 9 3 Special Considerations .................................................................................. 11 3.1 Ratios...................................................................................................................... 11 3.2 Point Temperature versus Temperature Interval ................................................... 11 3.3 Conditions of Measurement ................................................................................... 11 3.3.1 Gauge and Absolute Pressure ..................................................................... 11 3.3.2 Brake Horsepower ....................................................................................... 12 3.3.3 Standard Temperature and Pressure .......................................................... 12 3.3.4 Reservoir and Stock Tank Barrel ................................................................. 14 4 Mapping .......................................................................................................... 15 4.1 Conversion Factors ................................................................................................ 15 4.2 Mapping State ........................................................................................................ 15 4.3 Year ........................................................................................................................ 15 5 Extending a Unit Dictionary ........................................................................... 17 5.1 Creating a New Unit ............................................................................................... 17 5.1.1 Creating a New Atom ................................................................................... 17 5.1.2 Creating a Prefixed Atom ............................................................................. 18 5.1.3 Creating New Derived Symbols ................................................................... 18 5.1.4 Assigning a Category ................................................................................... 19 5.2 Deriving Conversion Data ...................................................................................... 19 5.2.1 Conversion Formulas ................................................................................... 20 5.2.2 Deriving Conversion Information for a Unit Expression ............................... 20 5.2.3 Exact Conversions ....................................................................................... 21 5.3 Validation Tests ...................................................................................................... 21 5.3.1 XSD Schema ................................................................................................ 22 5.3.2 Unit Dimension Set ...................................................................................... 22 5.3.3 Quantity Class Set ....................................................................................... 22 5.3.4 Unit Set ........................................................................................................ 23 5.3.5 Conversion Reference ................................................................................. 23 5.3.6 Class Integer Code (Energistics only) .......................................................... 23 5.3.7 Unit Integer Code (Energistics only) ............................................................ 23 V1.0/June 2014 4 Energistics Unit of Measure Usage Guide 1 Introduction Accurate use, exchange, and conversion of units of measure (UOM) in upstream oil and gas software are crucial. Errors in units of measure can cause serious problems for the accuracy and integrity of earth and reservoir models and the decisions that are based on those models. The Energistics Unit of Measure Standard (the UOM Standard ) represents the collaborative work of Energistics, its member community, the Professional Petroleum Data Management (PPDM™) Association, and the Society of Exploration Geophysicists (SEG) to update previous standards and best practices for use of units of measure used in the upstream oil and gas industry. (For a list of previous standards and specifications included, see Section 1.3 (page 6).) The goal of the UOM Standard is to provide the necessary components and guidelines to improve accuracy and consistency of implementation, usage, exchange, and conversion of units of measure related to all upstream activities. 1.1 Audience, Purpose and Scope This document is intended for IT professionals (e.g., software developers, information architects) who want to implement and maintain in their software a units of measure dictionary patterned after the Energistics Unit of Measure Dictionary , the key component of the UOM Standard . Software that implements Energistics data- exchange standards (e.g., WITSML, PRODML or RESQML) MUST implement the UOM Standard . Implementation of the UOM Standard also includes: • Conformance to the Energistics Unit Symbol Grammar Specification. • Optional, but strongly recommended use of Energistics quantity classes and unit dimensions, vital information that adds usage context to what would otherwise be a bunch of symbols. 1.2 Resource Set All resources that comprise the Energistics Unit of Measure Standard can be downloaded from the Energistics website