diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000000000000000000000000000000000000..00ce19eeec62741fcb717b14a447e284bc570980 --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,12 @@ +############################################################################### +# Copyright (c) 2019 - Consortium of the joint research EMPIR project 17IND02 # +# (title: SmartCom) and Physikalisch-Technische Bundesanstalt (PTB), alle # +# Rechte vorbehalten - all rights reserved. # +# # +# Contact: smartcom@ptb.de # +############################################################################### + + The XML scheme "SI_Format.xsd" version 1.3.0 (DOI: 10.5281/zenodo.3366902) is + provided attributed to the CC-BY-ND 4.0 license. Please, refer to + https://creativecommons.org/licenses/by-nd/4.0/legalcode + for the full license. \ No newline at end of file diff --git a/README.md b/README.md index 74dc88f9bb92a1d659d040d4cb18cb4eecec47ce..b2c67eb3532e51bf76ac75df78fc595cb7258692 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,22 @@ +# Publication note + +Version 1.3.0 of the D-SI reference implementation in XML is published at + +[Zenodo Repository DOI 10.5281/zenodo.3366902](https://zenodo.org/record/3366902#.XabORWbgpaQ) + +The machine-readable version of SI_Format.xsd is available at + +[Digital-SI (D-SI) XML - machine-readable provision of v1.3.0 XML scheme](https://www.ptb.de/si/v1.3.0/SI_Format.xsd) + +[Digital-SI (D-SI) XML - machine-readable provision of latest XML schemes](https://www.ptb.de/si/SI_Format.xsd) + + + # XSD Schema files and instance examples for the XML implementation of the Digital System of Units (D-SI) data model. -**SI\_Format.xsd Version 1.3.0 (status: ready for publication)** +**SI_Format.xsd Version 1.3.0 (status: ready for publication)** - complete real and complex - real constants diff --git a/SI_Format.xsd b/SI_Format.xsd index 3ce9e998eb999957a476f2053894505f60d51b29..bebdd5ec01ed0df825a413343828751ea7dadc09 100644 --- a/SI_Format.xsd +++ b/SI_Format.xsd @@ -4,35 +4,50 @@ xmlns:si="https://ptb.de/si" elementFormDefault="qualified"> - <!-- disclaimer --> <xs:annotation> <xs:documentation xml:lang="en"> - XML-schema implementation of the unified SmartCom meta data format for the exchange of measurement data - in digital ICT applications. - </xs:documentation> - <xs:documentation xml:lang="en"> - THIS SCHEMA IS A PROTOTYPE FOR THE INTERNAL USE IN EMPIR 17IND02 SMARTCOM PROJECT. - ANY DISTRIBUTION REQUIRES THE PERMISSION BY THE SMARTCOM CONSORTIUM (smartcom@ptb.de). - </xs:documentation> - <xs:documentation xml:lang="en"> - Authors: All contributing SmartCom JRP partners (https://www.ptb.de/empir2018/smartcom/home/) - Contact: smartcom@ptb.de - Version: 1.3.0 - Date: 2019-08-16 - DOI: (not assigned) + Copyright (c) 2019 - EMPIR project 17IND02 (title: SmartCom) consortium and Physikalisch-Technische Bundesanstalt (PTB), + alle Rechte vorbehalten - all rights reserved. This XML scheme is provided attributed to the CC-BY-ND 4.0 license. + Please, refer to https://creativecommons.org/licenses/by-nd/4.0/legalcode for the full license. + </xs:documentation> + <xs:documentation xml:lang="en"> + This XML scheme implements the Digital-SI (D-SI) data model for a transmission of metrological data in digital + applications. + AUTHORS + Physikalisch-Technische Bundesanstalt (DE): Daniel Hutzschenreuter, Frank Härtig, Thomas Wiedenhöfer, + Siegfried Gustav Hackel, Alexander Scheibner, Wiebke Heeren; + National Physical Laboratory (UK): Ian Smith, Clifford Brown + CONTACT + smartcom@ptb.de + WEBPAGE + https://www.ptb.de/empir2018/smartcom/home/ + VERSION + 1.3.0 + DATE + 2019-10-16 + DOI: + 10.5281/zenodo.3366902 + </xs:documentation> + <xs:documentation xml:lang="en"> + DISCLAIMER: + This XML scheme was developed by the EMPIR project 17IND02 (title: SmartCom) consortium under the lead of + Physikalisch-Technische Bundesanstalt (PTB). The XML scheme is made available “as is“ + free of cost at your own risk. Members of the EMPIR project 17IND02 (SmartCom) consortium and the Physikalisch-Technische + Bundesanstalt assume no responsibility whatsoever for its use by other parties, and makes no guarantees, expressed or + implied, about its quality, reliability, safety, suitability or any other characteristic. As far as legally permitted, + the members of the EMPIR project 17IND02 (SmartCom) consortium and the Physikalisch-Technische Bundesanstalt refuse + any liability for any direct, indirect or consequential damage arising in connection with the use of this XML scheme. </xs:documentation> - <xs:documentation xml:lang="en"> - Acknowledgment - The development of the unified meta data format for the exchange of measurement data in ICT applications and - its implementation using XML is made as part of the research project EMPIR 17IND02 (title: SmartCom). - This project (17IND02) has received funding from the EMPIR programme co-financed by the Participating States and + <xs:documentation xml:lang="en"> + ACKNOWLEDGEMENT: + The development of the XML scheme is part of the research project EMPIR 17IND02 (title: SmartCom). + This project (17IND02) has received funding from the EMPIR programme, co-financed by the Participating States and from the European Union's Horizon 2020 research and innovation programme. </xs:documentation> </xs:annotation> - <!-- ############################################################################################## First part of the XML-schema: Elements for the SI-based exchange of measured quantities. @@ -96,7 +111,7 @@ <xs:element name="value" type="si:decimalType"/> <xs:element name="unit" type="si:unitType"/> - <!-- optional timestamp --> + <!-- optional time stamp --> <xs:element name="dateTime" type="xs:dateTime" minOccurs="0"/> <!-- optional choice of uncertainty statements --> @@ -114,9 +129,9 @@ <xs:element name="expandedUnc"> <xs:annotation> <xs:documentation xml:lang="en"> - Definition of the structure that gives the necessary components for stating + Definition of the structure, that gives the necessary components for stating an expanded measurement uncertainty. This element must always be used in the - context of a real quantity which is an application within si:real and/or + context of a real quantity, which is an application within si:real and/or si:globalUnivaraiteUnc. </xs:documentation> <xs:documentation xml:lang="en"> @@ -147,9 +162,9 @@ <xs:element name="coverageInterval"> <xs:annotation> <xs:documentation xml:lang="en"> - Definition of the structure that gives the necessary components for stating + Definition of the structure, that gives the necessary components for stating a probabilistic-symmetric coverage interval for a real uncertainty. This element - must always be used in the context of a real quantity which is an application + must always be used in the context of a real quantity, which is an application within si:real and/or si:globalUnivaraiteUnc. </xs:documentation> <xs:documentation xml:lang="en"> @@ -182,7 +197,7 @@ <xs:element name="constant"> <xs:annotation> <xs:documentation xml:lang="en"> - Definition of a structure for real numbers that represent for fundamental + Definition of a structure for real numbers, that represent for fundamental physical constants and mathematical constants. </xs:documentation> <xs:documentation xml:lang="en"> @@ -196,12 +211,12 @@ (o) - element uncertainty (decimal value >= 0) (o) - element distribution (string) - The value and the uncertaitny have the unit specified by element unit. - For fundamental physical constants that are defined experimentally, the + The value and the uncertaintny have the unit specified by the element unit. + For fundamental physical constants, that are defined experimentally, the uncertainty is the standard deviation. - For rounded mathematical constants the uncertainty is the standard deviation - of a rectangular distribution (element value defines center point) that + For rounded mathematical constants, the uncertainty is the standard deviation + of a rectangular distribution (element value defines center point), that containes the exact value of the constant with 100 percent probability. ]]> </xs:documentation> @@ -233,8 +248,8 @@ <xs:annotation> <xs:documentation xml:lang="en"> The definition of complex quantities in the D-SI meta data model. - Complex quantities allow two representations of complex numerical values. - One is the Cartesian coordinate form. The other representation is the + Complex quantities allow two representations of complex numerical values: + One is the Cartesian coordinate form, the other representation is the polar coordinate form. </xs:documentation> <xs:documentation xml:lang="en"> @@ -360,7 +375,7 @@ The column has n covariance elements, where n is the amount of columns in the covariance matrix. - The covariance elements are ordered as in the covariance matrix starting + The covariance elements are ordered as in the covariance matrix, started at the element in the first row of the matrix and going to the last row of the matrix. ]]> @@ -395,7 +410,7 @@ <xs:element name="ellipsoidalRegion"> <xs:annotation> <xs:documentation xml:lang="en"> - Definition of the structure that provides a hyper-ellipsoidal coverage + Definition of the structure, that provides a hyper-ellipsoidal coverage region for stating the uncertainty of multivariate quantities. It is used in the context of uncertainty for complex quantities and lists of real or complex quantities. @@ -512,7 +527,7 @@ <xs:annotation> <xs:documentation xml:lang="en"> Meta data element definition for a real measurement quantity in list. - This implementation differes from the pure real quantitiy in the way that + This implementation differs from the pure real quantity in the way that the unit component is optional in order to allow a combination with a global unit in the list of real quantities. </xs:documentation> @@ -525,7 +540,7 @@ <xs:element name="value" type="si:decimalType"/> <!-- if list unit, then do not write this local unit --> <xs:element name="unit" type="si:unitType" minOccurs="0"/> - <!-- optional local timestamp --> + <!-- optional local time stamp --> <xs:element name="dateTime" type="xs:dateTime" minOccurs="0"/> <!-- optional choice of local uncertainty statements --> <xs:choice minOccurs="0"> @@ -547,8 +562,8 @@ <xs:element name="complex" maxOccurs="unbounded"> <xs:annotation> <xs:documentation xml:lang="en"> - Meta data element definition for a comple measurement quantity in list. - This implementation differes from the pure complex quantitiy in the way that + Meta data element definition for a complex measurement quantity in list. + This implementation differs from the pure complex quantity, in the way that the unit components are optional in order to allow a combination with a global unit in the list of complex quantities. </xs:documentation> @@ -576,7 +591,7 @@ <xs:element name="unitPhase" type="si:unitPhaseType" minOccurs="0"/> </xs:sequence> </xs:choice> - <!-- optional local timestamp --> + <!-- optional local time stamp --> <xs:element name="dateTime" type="xs:dateTime" minOccurs="0"/> <!-- optional choice of local uncertainty statements --> <xs:choice minOccurs="0"> @@ -596,7 +611,7 @@ <xs:element ref="si:rectangularRegion"/> </xs:choice> </xs:sequence> - <!-- end of list of real or complex quantitits --> + <!-- end of list of real or complex quantities --> @@ -616,9 +631,9 @@ <xs:element name="listUnivariateUnc"> <xs:annotation> <xs:documentation xml:lang="en"> - Definition of a structure for a global univariate uncertainty that + Definition of a structure, for a global univariate uncertainty, that is used within the list structure with a list of real quantities. - The global univaraite uncertinty can either be given as a expanded + The global univariate uncertainty can either be given as an expanded measurement uncertainty or as a coverage interval. </xs:documentation> </xs:annotation> @@ -637,11 +652,11 @@ <xs:element name="listBivariateUnc"> <xs:annotation> <xs:documentation xml:lang="en"> - Definition of a structure for a global bivariate uncertainty that + Definition of a structure, for a global bivariate uncertainty, that is used within the list structure with a list of complex quantities. - The global bivariate uncertinty can either be given as a hyper-ellipsoida + The global bivariate uncertainty can either be given as a hyper-ellipsoidal coverage region or a hyper-rectangular coverage region. Both - coverage regions must provide a covariance matrix of dimendion 2. + coverage regions must provide a covariance matrix of dimension 2. </xs:documentation> </xs:annotation> <xs:complexType> @@ -664,7 +679,7 @@ <xs:annotation> <xs:documentation xml:lang="en"> The hybrid elements allows to add quantities to the - machine readable D-SI format with other units than those allowed + machine readable D-SI format, with other units, than those allowed to be used with the SI by means of the BIPM SI brochure. </xs:documentation> <xs:documentation xml:lang="en"> @@ -758,7 +773,7 @@ <xs:simpleType name="uncertaintyValueType"> <xs:annotation> <xs:documentation xml:lang="en"> - Scientiffic decimal format for numerical values of uncertainties + Scientific decimal format for numerical values of uncertainties that must be positive (greater than zero or equal to zero). Based on type xs:double. </xs:documentation> @@ -772,7 +787,7 @@ <xs:simpleType name="kValueType"> <xs:annotation> <xs:documentation xml:lang="en"> - Scientiffic decimal format for coverage factor values for uncertainties + Scientific decimal format for coverage factor values for uncertainties that must be greater than one or equal to one. Based on type xs:double. </xs:documentation> @@ -786,7 +801,7 @@ <xs:annotation> <xs:documentation xml:lang="en"> Decimal format for coverage probability values for uncertainties. - The value must be within the interval [0,1]. The scientiffic exponent + The value must be within the interval [0,1]. The scientific exponent "e" (or "E") is not allowed. Based on type xs:double. </xs:documentation> @@ -796,20 +811,4 @@ </xs:restriction> </xs:simpleType> - - - - - - - - - - - - - - - - </xs:schema> diff --git a/examples/SI_Format_TestData.xsd b/examples/SI_Format_TestData.xsd index 615422f8f0506fb9c8b4587761da629595e83fd1..baa15910aaea0124c8f781ec2a21cf9fa357f084 100644 --- a/examples/SI_Format_TestData.xsd +++ b/examples/SI_Format_TestData.xsd @@ -4,8 +4,8 @@ xmlns:siTest="https://ptb.de/si/examples" xmlns:si="https://ptb.de/si" elementFormDefault="qualified"> - <xs:import namespace="https://ptb.de/si" - schemaLocation="platform:/resource/DSI_XML_Tools/xml/SI_Format.xsd" /> + + <xs:import namespace="https://ptb.de/si" schemaLocation="https://www.ptb.de/si/v1.3.0/SI_Format.xsd" /> <!-- A simple XML scheme for maintaining multiple XML test examples for the validation of the D-SI XML implementation.-->