unitsml 0.4.7 → 0.5.1

data/unitsdb/scales.yaml

@@ -0,0 +1,97 @@
+# yaml-language-server: $schema=schemas/scales-schema.yaml
+---
+schema_version: 2.0.0
+scales:
+- identifiers:
+  - id: continuous_ratio
+    type: unitsml
+  - id: s:continuous_ratio
+    type: unitsml
+  names:
+  - value: continuous ratio scale
+    lang: en
+  short: continuous_ratio
+  description:
+  - value: A measurement scale with continuous values and a true zero point, allowing
+      for ratio comparisons
+    lang: en
+  properties:
+    continuous: true
+    ordered: true
+    logarithmic: false
+    interval: true
+    ratio: true
+- identifiers:
+  - id: continuous_interval
+    type: unitsml
+  - id: s:continuous_interval
+    type: unitsml
+  names:
+  - value: continuous interval scale
+    lang: en
+  short: continuous_interval
+  description:
+  - value: A measurement scale with continuous values but an arbitrary zero point,
+      allowing for interval but not ratio comparisons
+    lang: en
+  properties:
+    continuous: true
+    ordered: true
+    logarithmic: false
+    interval: true
+    ratio: false
+- identifiers:
+  - id: logarithmic_ratio
+    type: unitsml
+  - id: s:logarithmic_ratio
+    type: unitsml
+  names:
+  - value: logarithmic ratio scale
+    lang: en
+  short: logarithmic_ratio
+  description:
+  - value: A scale where equal ratios appear as equal intervals, with a zero point
+      representing a reference value
+    lang: en
+  properties:
+    continuous: true
+    ordered: true
+    logarithmic: true
+    interval: true
+    ratio: true
+- identifiers:
+  - id: logarithmic_field
+    type: unitsml
+  - id: s:logarithmic_field
+    type: unitsml
+  names:
+  - value: logarithmic field scale
+    lang: en
+  short: logarithmic_field
+  description:
+  - value: A logarithmic scale used for field quantities that uses natural logarithms
+    lang: en
+  properties:
+    continuous: true
+    ordered: true
+    logarithmic: true
+    interval: true
+    ratio: false
+- identifiers:
+  - id: discrete
+    type: unitsml
+  - id: s:discrete
+    type: unitsml
+  names:
+  - value: discrete scale
+    lang: en
+  short: discrete
+  description:
+  - value: A scale consisting of discrete, countable values
+    lang: en
+  properties:
+    continuous: false
+    ordered: true
+    logarithmic: false
+    interval: true
+    ratio: true

data/unitsdb/schemas/README.md

@@ -0,0 +1,159 @@
+# UnitsDB YAML Schemas
+
+This directory contains JSON Schema definitions for all YAML files in the UnitsDB repository. These schemas provide validation, documentation, and IDE support for the structured data files.
+
+## Schema Files
+
+### Core Data Schemas
+
+- **`units-schema.yaml`** - Schema for `units.yaml`
+  - Defines physical units with their symbols, definitions, and relationships
+  - Includes conversion factors, dimension references, and unit systems
+
+- **`quantities-schema.yaml`** - Schema for `quantities.yaml`
+  - Defines physical quantities with their dimensional analysis
+  - Links quantities to their fundamental dimensions
+
+- **`dimensions-schema.yaml`** - Schema for `dimensions.yaml`
+  - Defines fundamental physical dimensions (length, mass, time, etc.)
+  - Includes dimensional components and mathematical symbols
+
+- **`prefixes-schema.yaml`** - Schema for `prefixes.yaml`
+  - Defines unit prefixes (kilo, mega, micro, etc.)
+  - Includes base/power notation and symbol representations
+
+- **`scales-schema.yaml`** - Schema for `scales.yaml`
+  - Defines measurement scales and their properties
+  - Includes scale types and conversion relationships
+
+- **`unit_systems-schema.yaml`** - Schema for `unit_systems.yaml`
+  - Defines coherent systems of units (SI, CGS, etc.)
+  - Includes base units and derived unit relationships
+
+## Features
+
+### Validation
+All schemas provide comprehensive validation for:
+- Required fields and data types
+- Enumerated values for controlled vocabularies
+- Pattern matching for identifiers and codes
+- Cross-references between related entities
+
+### Documentation
+Each schema includes:
+- Detailed descriptions for all fields
+- Examples of valid values
+- Explanations of relationships between entities
+
+### IDE Support
+The schemas enable:
+- Auto-completion in YAML editors
+- Real-time validation feedback
+- Hover documentation for fields
+- Error highlighting and suggestions
+
+## Usage
+
+### In VSCode
+The YAML files automatically reference their schemas via the `yaml-language-server` directive at the top of each file:
+
+```yaml
+# yaml-language-server: $schema=schemas/units-schema.yaml
+```
+
+### Programmatic Validation
+Use the provided validation script:
+
+```bash
+ruby validate_schemas.rb
+```
+
+### Manual Validation
+You can validate individual files using any JSON Schema validator that supports YAML, such as:
+- `ajv-cli`
+- `jsonschema` (Python)
+- Online validators like jsonschemavalidator.net
+
+## Schema Structure
+
+All schemas follow a consistent structure:
+
+```yaml
+$schema: "http://json-schema.org/draft-06/schema#"
+$id: "https://unitsml.org/schemas/[schema-name].yaml"
+title: "[Human Readable Title]"
+description: "[Detailed description]"
+
+type: object
+required: ["schema_version", "[main_array]"]
+properties:
+  schema_version:
+    type: string
+    pattern: "^\\d+\\.\\d+\\.\\d+$"
+  [main_array]:
+    type: array
+    items:
+      $ref: "#/definitions/[MainType]"
+
+definitions:
+  # Type definitions...
+```
+
+## Common Definitions
+
+### Identifier
+All entities use a consistent identifier structure:
+```yaml
+type: object
+required: ["type", "id"]
+properties:
+  type:
+    type: string
+    enum: ["nist", "unitsml", "si-digital-framework", ...]
+  id:
+    type: string
+```
+
+### Name
+Multilingual names follow this pattern:
+```yaml
+type: object
+required: ["value", "lang"]
+properties:
+  value:
+    type: string
+  lang:
+    type: string
+    pattern: "^[a-z]{2}(-[A-Z]{2})?$"
+```
+
+### Symbol
+Mathematical symbols are represented as:
+```yaml
+type: object
+required: ["latex", "unicode", "ascii", "html", "id", "mathml"]
+properties:
+  latex: { type: string }
+  unicode: { type: string }
+  ascii: { type: string }
+  html: { type: string }
+  id: { type: string }
+  mathml: { type: string }
+```
+
+## Validation Results
+
+✅ All schemas successfully validate their corresponding YAML files
+✅ Cross-references and relationships are properly defined
+✅ Enumerated values match actual data usage
+✅ Required fields are correctly identified
+
+## Maintenance
+
+When updating the YAML data files:
+1. Ensure changes conform to the existing schemas
+2. Update schemas if new fields or structures are added
+3. Run validation to verify compatibility
+4. Update this documentation if schema structure changes
+
+For questions or issues with the schemas, please refer to the main repository documentation or open an issue.

data/unitsdb/schemas/dimensions-schema.yaml

@@ -0,0 +1,157 @@
+# yaml-language-server: $schema=http://json-schema.org/draft-06/schema
+---
+$schema: "http://json-schema.org/draft-06/schema#"
+$id: "https://unitsml.org/schemas/dimensions-schema.yaml"
+title: "Dimensions Database Schema"
+description: "Schema for dimensions.yaml - defines fundamental physical dimensions"
+
+type: object
+required: ["schema_version", "dimensions"]
+properties:
+  schema_version:
+    type: string
+    pattern: "^\\d+\\.\\d+\\.\\d+$"
+    description: "Semantic version of the schema"
+  dimensions:
+    type: array
+    description: "Array of dimension definitions"
+    items:
+      $ref: "#/definitions/Dimension"
+
+definitions:
+  Dimension:
+    type: object
+    required: ["identifiers", "names", "short"]
+    properties:
+      identifiers:
+        type: array
+        description: "External identifiers for this dimension"
+        items:
+          $ref: "#/definitions/Identifier"
+      names:
+        type: array
+        description: "Multilingual names for this dimension"
+        items:
+          $ref: "#/definitions/Name"
+      short:
+        type: string
+        description: "Short identifier for the dimension"
+      dimensionless:
+        type: boolean
+        description: "Whether this is a dimensionless quantity"
+      length:
+        $ref: "#/definitions/DimensionComponent"
+        description: "Length dimension component"
+      mass:
+        $ref: "#/definitions/DimensionComponent"
+        description: "Mass dimension component"
+      time:
+        $ref: "#/definitions/DimensionComponent"
+        description: "Time dimension component"
+      electric_current:
+        $ref: "#/definitions/DimensionComponent"
+        description: "Electric current dimension component"
+      thermodynamic_temperature:
+        $ref: "#/definitions/DimensionComponent"
+        description: "Thermodynamic temperature dimension component"
+      amount_of_substance:
+        $ref: "#/definitions/DimensionComponent"
+        description: "Amount of substance dimension component"
+      luminous_intensity:
+        $ref: "#/definitions/DimensionComponent"
+        description: "Luminous intensity dimension component"
+      plane_angle:
+        $ref: "#/definitions/DimensionComponent"
+        description: "Plane angle dimension component"
+      references:
+        type: array
+        description: "External references and citations"
+        items:
+          $ref: "#/definitions/Reference"
+
+  Identifier:
+    type: object
+    required: ["type", "id"]
+    properties:
+      type:
+        type: string
+        enum: ["nist", "unitsml", "si-digital-framework"]
+        description: "Type of identifier system"
+      id:
+        type: string
+        description: "Identifier value within the system"
+
+  Name:
+    type: object
+    required: ["value", "lang"]
+    properties:
+      value:
+        type: string
+        description: "Name in the specified language"
+      lang:
+        type: string
+        pattern: "^[a-z]{2}(-[A-Z]{2})?$"
+        description: "Language code (ISO 639-1, optionally with ISO 3166-1 country)"
+
+  Symbol:
+    type: object
+    required: ["latex", "unicode", "ascii", "html", "id", "mathml"]
+    properties:
+      latex:
+        type: string
+        description: "LaTeX representation"
+      unicode:
+        type: string
+        description: "Unicode representation"
+      ascii:
+        type: string
+        description: "ASCII representation"
+      html:
+        type: string
+        description: "HTML representation"
+      id:
+        type: string
+        description: "Identifier for the symbol"
+      mathml:
+        type: string
+        description: "MathML representation"
+
+  DimensionComponent:
+    type: object
+    required: ["power", "symbol"]
+    properties:
+      power:
+        type: integer
+        description: "Exponent for this dimension component"
+      symbol:
+        type: string
+        description: "Symbol representing this dimension"
+      symbols:
+        type: array
+        description: "Mathematical and textual representations"
+        items:
+          $ref: "#/definitions/Symbol"
+
+  Reference:
+    type: object
+    required: ["type"]
+    properties:
+      type:
+        type: string
+        enum: ["standard", "specification", "publication", "website"]
+        description: "Type of reference"
+      authority:
+        type: string
+        description: "Authoritative body or organization"
+      uri:
+        type: string
+        format: "uri"
+        description: "URI to the reference"
+      title:
+        type: string
+        description: "Title of the reference"
+      year:
+        type: integer
+        minimum: 1000
+        maximum: 9999
+        description: "Publication year"

data/unitsdb/schemas/prefixes-schema.yaml

@@ -0,0 +1,159 @@
+# yaml-language-server: $schema=http://json-schema.org/draft-06/schema
+---
+$schema: "http://json-schema.org/draft-06/schema"
+$id: "https://unitsml.org/schemas/prefixes-schema.yaml"
+title: "Prefixes Database Schema"
+description: "Schema for prefixes.yaml - defines unit prefixes with their multipliers and symbols"
+
+type: object
+required: ["schema_version", "prefixes"]
+properties:
+  schema_version:
+    type: string
+    pattern: "^\\d+\\.\\d+\\.\\d+$"
+    description: "Semantic version of the schema"
+  prefixes:
+    type: array
+    description: "Array of prefix definitions"
+    items:
+      $ref: "#/definitions/Prefix"
+
+definitions:
+  Prefix:
+    type: object
+    required: ["identifiers", "names", "base", "power", "short", "symbols"]
+    properties:
+      identifiers:
+        type: array
+        description: "External identifiers for this prefix"
+        items:
+          $ref: "#/definitions/Identifier"
+      names:
+        type: array
+        description: "Multilingual names for this prefix"
+        items:
+          $ref: "#/definitions/Name"
+      base:
+        type: integer
+        description: "Base number for the prefix (e.g., 10 for decimal, 2 for binary)"
+      power:
+        type: integer
+        description: "Power/exponent for the prefix"
+      short:
+        type: string
+        description: "Short identifier for the prefix"
+      symbols:
+        type: array
+        description: "Mathematical and textual representations"
+        items:
+          $ref: "#/definitions/PrefixSymbol"
+      references:
+        type: array
+        description: "External references and citations"
+        items:
+          $ref: "#/definitions/Reference"
+
+  Identifier:
+    type: object
+    required: ["type", "id"]
+    properties:
+      type:
+        type: string
+        enum: ["nist", "unitsml", "ucum", "si-digital-framework"]
+        description: "Type of identifier system"
+      id:
+        type: string
+        description: "Identifier value within the system"
+
+  Name:
+    type: object
+    required: ["value", "lang"]
+    properties:
+      value:
+        type: string
+        description: "Name in the specified language"
+      lang:
+        type: string
+        pattern: "^[a-z]{2}(-[A-Z]{2})?$"
+        description: "Language code (ISO 639-1, optionally with ISO 3166-1 country)"
+
+  Symbol:
+    type: object
+    required: ["type"]
+    properties:
+      type:
+        type: string
+        enum: ["latex", "unicode", "ascii", "html", "id", "mathml"]
+        description: "Type of symbol representation"
+      value:
+        type: string
+        description: "Symbol value (required for most types)"
+    allOf:
+      - if:
+          properties:
+            type:
+              const: "id"
+        then:
+          not:
+            required: ["value"]
+        else:
+          required: ["value"]
+
+  PrefixSymbol:
+    type: object
+    required: ["latex", "unicode", "ascii", "html", "id", "mathml"]
+    properties:
+      latex:
+        type: string
+        description: "LaTeX representation"
+      unicode:
+        type: string
+        description: "Unicode representation"
+      ascii:
+        type: string
+        description: "ASCII representation"
+      html:
+        type: string
+        description: "HTML representation"
+      id:
+        type: string
+        description: "Identifier for the symbol"
+      mathml:
+        type: string
+        description: "MathML representation"
+
+  Multiplier:
+    type: object
+    required: ["base", "power"]
+    properties:
+      base:
+        type: integer
+        minimum: 2
+        description: "Base of the multiplier (typically 10)"
+      power:
+        type: integer
+        description: "Exponent for the multiplier"
+
+  Reference:
+    type: object
+    required: ["type"]
+    properties:
+      type:
+        type: string
+        enum: ["standard", "specification", "publication", "website", "normative", "informative"]
+        description: "Type of reference"
+      authority:
+        type: string
+        description: "Authoritative body or organization"
+      uri:
+        type: string
+        format: "uri"
+        description: "URI to the reference"
+      title:
+        type: string
+        description: "Title of the reference"
+      year:
+        type: integer
+        minimum: 1000
+        maximum: 9999
+        description: "Publication year"

data/unitsdb/schemas/quantities-schema.yaml

@@ -0,0 +1,120 @@
+# yaml-language-server: $schema=http://json-schema.org/draft-06/schema
+
+---
+$schema: "http://json-schema.org/draft-06/schema#"
+$id: "https://unitsml.org/schemas/quantities-schema.yaml"
+title: "Quantities Database Schema"
+description: "Schema for quantities.yaml - defines physical quantities with their dimensional analysis"
+
+type: object
+required: ["schema_version", "quantities"]
+properties:
+  schema_version:
+    type: string
+    pattern: "^\\d+\\.\\d+\\.\\d+$"
+    description: "Semantic version of the schema"
+  quantities:
+    type: array
+    description: "Array of quantity definitions"
+    items:
+      $ref: "#/definitions/Quantity"
+
+definitions:
+  Quantity:
+    type: object
+    required: ["identifiers", "names", "dimension_reference", "quantity_type", "short"]
+    properties:
+      identifiers:
+        type: array
+        description: "External identifiers for this quantity"
+        items:
+          $ref: "#/definitions/Identifier"
+      names:
+        type: array
+        description: "Multilingual names for this quantity"
+        items:
+          $ref: "#/definitions/Name"
+      dimension_reference:
+        $ref: "#/definitions/DimensionReference"
+        description: "Reference to the dimension"
+      quantity_type:
+        type: string
+        enum: ["base", "derived"]
+        description: "Type of quantity (base or derived)"
+      short:
+        type: string
+        description: "Short identifier for the quantity"
+      references:
+        type: array
+        description: "External references and citations"
+        items:
+          $ref: "#/definitions/Reference"
+
+  Identifier:
+    type: object
+    required: ["type", "id"]
+    properties:
+      type:
+        type: string
+        description: "Type of identifier system"
+      id:
+        type: string
+        description: "Identifier value within the system"
+
+  Name:
+    type: object
+    required: ["value", "lang"]
+    properties:
+      value:
+        type: string
+        description: "Name in the specified language"
+      lang:
+        type: string
+        pattern: "^[a-z]{2}(-[A-Z]{2})?$"
+        description: "Language code (ISO 639-1, optionally with ISO 3166-1 country)"
+
+  DimensionReference:
+    type: object
+    required: ["type", "id"]
+    properties:
+      type:
+        type: string
+        const: "nist"
+        description: "Reference type indicator"
+      id:
+        type: string
+        description: "Dimension identifier"
+
+  Symbol:
+    type: object
+    required: ["type"]
+    properties:
+      type:
+        type: string
+        description: "Type of symbol representation"
+      value:
+        type: string
+        description: "Symbol value"
+
+  Reference:
+    type: object
+    required: ["type"]
+    properties:
+      type:
+        type: string
+        description: "Type of reference"
+      authority:
+        type: string
+        description: "Authoritative body or organization"
+      uri:
+        type: string
+        format: "uri"
+        description: "URI to the reference"
+      title:
+        type: string
+        description: "Title of the reference"
+      year:
+        type: integer
+        minimum: 1000
+        maximum: 9999
+        description: "Publication year"