diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 838fb35eb..8b8071284 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -16,6 +16,8 @@ jobs: steps: - uses: actions/checkout@v2 + with: + submodules: 'true' - name: Set up Python 3.8 uses: actions/setup-python@v1 with: @@ -31,6 +33,8 @@ jobs: timeout-minutes: 5 steps: - uses: actions/checkout@v2 + with: + submodules: 'true' - name: Set up JDK uses: actions/setup-java@v1 with: @@ -43,6 +47,8 @@ jobs: timeout-minutes: 5 steps: - uses: actions/checkout@v2 + with: + submodules: 'true' - run: make audit_authors audit-spelling: @@ -51,6 +57,8 @@ jobs: timeout-minutes: 5 steps: - uses: actions/checkout@v2 + with: + submodules: 'true' - run: make audit_spelling audit-schemas: @@ -59,4 +67,8 @@ jobs: timeout-minutes: 5 steps: - uses: actions/checkout@v2 + with: + submodules: 'true' + - name: Install dependencies + run: pip install markdown python-markdown-math - run: make audit_schemas diff --git a/.gitignore b/.gitignore index aa6bbb87a..395e52c52 100644 --- a/.gitignore +++ b/.gitignore @@ -5,3 +5,5 @@ Makeconf* .idea/ .vscode/ .DS_Store +schemas/output +schemas/example/output diff --git a/.gitmodules b/.gitmodules new file mode 100644 index 000000000..ea6385ab8 --- /dev/null +++ b/.gitmodules @@ -0,0 +1,3 @@ +[submodule "dependencies/submodules/optimade-property-tools"] + path = dependencies/submodules/optimade-property-tools + url = https://github.com/Materials-Consortia/optimade-property-tools.git diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 5c94ad477..f02664044 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -7,6 +7,7 @@ repos: (?x)^( tests/inputs/various-whitespace.filter| tests/inputs/fuzzystring-leading-trailing-spaces.filter| + external/GNU_Units/definitions.units| units/definitions.units| .words.lst )$ diff --git a/.words.lst b/.words.lst index 3efb366ab..d3f6074ff 100644 --- a/.words.lst +++ b/.words.lst @@ -215,6 +215,8 @@ xyz yacc yb zeo -ångström +zeolites Ã¥ngström Ã¥ngström +Ã¥ngström +incrementing diff --git a/GNUmakefile b/GNUmakefile index f7ed62761..7c13e1cb1 100644 --- a/GNUmakefile +++ b/GNUmakefile @@ -19,6 +19,26 @@ # - spell: runs an interactive spellchecker # # +# Targets for generating schemas +################################ +# +# - schemas +# +# compile YAML-formatted source files for schemas, +# including property definitions, units, and constants +# in the schemas/src directory into JSON schema format +# placed in the output directory: schemas/output +# +# parameters: +# - schemas_html_pretty=true applies OPTIMADE styling to the html output +# - schemas_html_ext=true generates html files with .html extensions also +# for files meant to be served without extensions, which is useful +# for hosting, e.g., on GitHub that automatically redirects URLs without extensions. +# +# For documentation pages hosted on schema.optimade.org use: +# make schemas schemas_html_pretty=true schemas_html_ext=true +# +# # Extracting machine-readable parts of the specification ######################################################## # diff --git a/README.md b/README.md index 09483b6a5..6f35c7c84 100644 --- a/README.md +++ b/README.md @@ -34,9 +34,9 @@ If this is a pre-release, implementations are also encouraged to support the lat ## Licensing of the unit definitions database `definitions.units` The OPTIMADE standard refers to a specific version of the `definitions.units` database included with the source distribution of GNU Units. -This file is included in the OPTIMADE repository under the subdirectory [units](units). +This file is included in the OPTIMADE repository under the subdirectory [external/GNU_Units](external/GNU_Units). The file is licensed separately from other files in the repository: it is available under the GNU General Public License (GPL). -Full information on how the file is licensed is available in the [header of the file](units/definitions.units) and the license file included in that directory, [COPYING](units/COPYING). +Full information on how the file is licensed is available in the [header of the file](external/GNU_Units/definitions.units) and the license file included in that directory, [COPYING](external/GNU_Units/COPYING). The following does not constitute legal advice; however, we believe implementations under other licenses can use this file if: diff --git a/dependencies/Debian-8.6/install.sh b/dependencies/Debian-8.6/install.sh deleted file mode 100755 index 399868fce..000000000 --- a/dependencies/Debian-8.6/install.sh +++ /dev/null @@ -1,7 +0,0 @@ -#! /bin/sh - -sudo apt-get install -y \ - default-jdk \ - patch \ - unzip \ -; diff --git a/dependencies/installers/Debian-10/install.sh b/dependencies/installers/Debian-10/install.sh new file mode 100755 index 000000000..4e1b50e01 --- /dev/null +++ b/dependencies/installers/Debian-10/install.sh @@ -0,0 +1,19 @@ +#! /bin/sh + +sudo apt-get install -y \ + ant \ + default-jdk \ + make \ + patch \ + python3-mdx-math \ + unzip \ +; + +# Required by the 'optimade-property-tools' submodule +sudo apt-get install -y \ + python3-jsonschema \ + python3-markdown \ + python3-mdx-math \ + python3-pygments \ + python3-yaml \ +; diff --git a/dependencies/installers/Debian-11 b/dependencies/installers/Debian-11 new file mode 120000 index 000000000..7650ff67e --- /dev/null +++ b/dependencies/installers/Debian-11 @@ -0,0 +1 @@ +Debian-10/ \ No newline at end of file diff --git a/dependencies/installers/Debian-12 b/dependencies/installers/Debian-12 new file mode 120000 index 000000000..7650ff67e --- /dev/null +++ b/dependencies/installers/Debian-12 @@ -0,0 +1 @@ +Debian-10/ \ No newline at end of file diff --git a/dependencies/submodules/optimade-property-tools b/dependencies/submodules/optimade-property-tools new file mode 160000 index 000000000..93e4c6f92 --- /dev/null +++ b/dependencies/submodules/optimade-property-tools @@ -0,0 +1 @@ +Subproject commit 93e4c6f925783f47a51883f4f80965a82a8bf02b diff --git a/units/COPYING b/external/GNU_Units/COPYING similarity index 100% rename from units/COPYING rename to external/GNU_Units/COPYING diff --git a/units/README.md b/external/GNU_Units/README.md similarity index 100% rename from units/README.md rename to external/GNU_Units/README.md diff --git a/units/definitions.units b/external/GNU_Units/definitions.units similarity index 100% rename from units/definitions.units rename to external/GNU_Units/definitions.units diff --git a/external/README.md b/external/README.md new file mode 100644 index 000000000..f516a053a --- /dev/null +++ b/external/README.md @@ -0,0 +1,3 @@ +This directory contains a collection of subdirectories containing documents that are relevant to the OPTIMADE standard. +Please note that the files in these subdirectories are subject to separate licensing agreements that differ from those of other OPTIMADE files. +Please refer to each subdirectory for specific license information. diff --git a/external/json-api/LICENSE b/external/json-api/LICENSE new file mode 100644 index 000000000..18592e70c --- /dev/null +++ b/external/json-api/LICENSE @@ -0,0 +1,33 @@ +Creative Commons Legal Code + +CC0 1.0 Universal + +Official translations of this legal tool are available +CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED HEREUNDER. +Statement of Purpose + +The laws of most jurisdictions throughout the world automatically confer exclusive Copyright and Related Rights (defined below) upon the creator and subsequent owner(s) (each and all, an "owner") of an original work of authorship and/or a database (each, a "Work"). + +Certain owners wish to permanently relinquish those rights to a Work for the purpose of contributing to a commons of creative, cultural and scientific works ("Commons") that the public can reliably and without fear of later claims of infringement build upon, modify, incorporate in other works, reuse and redistribute as freely as possible in any form whatsoever and for any purposes, including without limitation commercial purposes. These owners may contribute to the Commons to promote the ideal of a free culture and the further production of creative, cultural and scientific works, or to gain reputation or greater distribution for their Work in part through the use and efforts of others. + +For these and/or other purposes and motivations, and without any expectation of additional consideration or compensation, the person associating CC0 with a Work (the "Affirmer"), to the extent that he or she is an owner of Copyright and Related Rights in the Work, voluntarily elects to apply CC0 to the Work and publicly distribute the Work under its terms, with knowledge of his or her Copyright and Related Rights in the Work and the meaning and intended legal effect of CC0 on those rights. + +1. Copyright and Related Rights. A Work made available under CC0 may be protected by copyright and related or neighboring rights ("Copyright and Related Rights"). Copyright and Related Rights include, but are not limited to, the following: + +the right to reproduce, adapt, distribute, perform, display, communicate, and translate a Work; +moral rights retained by the original author(s) and/or performer(s); +publicity and privacy rights pertaining to a person's image or likeness depicted in a Work; +rights protecting against unfair competition in regards to a Work, subject to the limitations in paragraph 4(a), below; +rights protecting the extraction, dissemination, use and reuse of data in a Work; +database rights (such as those arising under Directive 96/9/EC of the European Parliament and of the Council of 11 March 1996 on the legal protection of databases, and under any national implementation thereof, including any amended or successor version of such directive); and +other similar, equivalent or corresponding rights throughout the world based on applicable law or treaty, and any national implementations thereof. +2. Waiver. To the greatest extent permitted by, but not in contravention of, applicable law, Affirmer hereby overtly, fully, permanently, irrevocably and unconditionally waives, abandons, and surrenders all of Affirmer's Copyright and Related Rights and associated claims and causes of action, whether now known or unknown (including existing as well as future claims and causes of action), in the Work (i) in all territories worldwide, (ii) for the maximum duration provided by applicable law or treaty (including future time extensions), (iii) in any current or future medium and for any number of copies, and (iv) for any purpose whatsoever, including without limitation commercial, advertising or promotional purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each member of the public at large and to the detriment of Affirmer's heirs and successors, fully intending that such Waiver shall not be subject to revocation, rescission, cancellation, termination, or any other legal or equitable action to disrupt the quiet enjoyment of the Work by the public as contemplated by Affirmer's express Statement of Purpose. + +3. Public License Fallback. Should any part of the Waiver for any reason be judged legally invalid or ineffective under applicable law, then the Waiver shall be preserved to the maximum extent permitted taking into account Affirmer's express Statement of Purpose. In addition, to the extent the Waiver is so judged Affirmer hereby grants to each affected person a royalty-free, non transferable, non sublicensable, non exclusive, irrevocable and unconditional license to exercise Affirmer's Copyright and Related Rights in the Work (i) in all territories worldwide, (ii) for the maximum duration provided by applicable law or treaty (including future time extensions), (iii) in any current or future medium and for any number of copies, and (iv) for any purpose whatsoever, including without limitation commercial, advertising or promotional purposes (the "License"). The License shall be deemed effective as of the date CC0 was applied by Affirmer to the Work. Should any part of the License for any reason be judged legally invalid or ineffective under applicable law, such partial invalidity or ineffectiveness shall not invalidate the remainder of the License, and in such case Affirmer hereby affirms that he or she will not (i) exercise any of his or her remaining Copyright and Related Rights in the Work or (ii) assert any associated claims and causes of action with respect to the Work, in either case contrary to Affirmer's express Statement of Purpose. + +4. Limitations and Disclaimers. + +No trademark or patent rights held by Affirmer are waived, abandoned, surrendered, licensed or otherwise affected by this document. +Affirmer offers the Work as-is and makes no representations or warranties of any kind concerning the Work, express, implied, statutory or otherwise, including without limitation warranties of title, merchantability, fitness for a particular purpose, non infringement, or the absence of latent or other defects, accuracy, or the present or absence of errors, whether or not discoverable, all to the greatest extent permissible under applicable law. +Affirmer disclaims responsibility for clearing rights of other persons that may apply to the Work or any use thereof, including without limitation any person's Copyright and Related Rights in the Work. Further, Affirmer disclaims responsibility for obtaining any necessary consents, permissions or other rights required for any use of the Work. +Affirmer understands and acknowledges that Creative Commons is not a party to this document and has no duty or obligation with respect to this CC0 or use of the Work. diff --git a/external/json-api/schema.json b/external/json-api/schema.json new file mode 100644 index 000000000..56a404c2e --- /dev/null +++ b/external/json-api/schema.json @@ -0,0 +1,397 @@ +{ + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "JSON:API Schema", + "description": "This is a schema for responses in the JSON:API format. For more, see http://jsonapi.org", + "oneOf": [ + { + "$ref": "#/definitions/success" + }, + { + "$ref": "#/definitions/failure" + }, + { + "$ref": "#/definitions/info" + } + ], + + "definitions": { + "success": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/definitions/data" + }, + "included": { + "description": "To reduce the number of HTTP requests, servers **MAY** allow responses that include related resources along with the requested primary resources. Such responses are called \"compound documents\".", + "type": "array", + "items": { + "$ref": "#/definitions/resource" + }, + "uniqueItems": true + }, + "meta": { + "$ref": "#/definitions/meta" + }, + "links": { + "description": "Link members related to the primary data.", + "allOf": [ + { + "$ref": "#/definitions/links" + }, + { + "$ref": "#/definitions/pagination" + } + ] + }, + "jsonapi": { + "$ref": "#/definitions/jsonapi" + } + }, + "additionalProperties": false + }, + "failure": { + "type": "object", + "required": [ + "errors" + ], + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/definitions/error" + }, + "uniqueItems": true + }, + "meta": { + "$ref": "#/definitions/meta" + }, + "jsonapi": { + "$ref": "#/definitions/jsonapi" + }, + "links": { + "$ref": "#/definitions/links" + } + }, + "additionalProperties": false + }, + "info": { + "type": "object", + "required": [ + "meta" + ], + "properties": { + "meta": { + "$ref": "#/definitions/meta" + }, + "links": { + "$ref": "#/definitions/links" + }, + "jsonapi": { + "$ref": "#/definitions/jsonapi" + } + }, + "additionalProperties": false + }, + + "meta": { + "description": "Non-standard meta-information that can not be represented as an attribute or relationship.", + "type": "object", + "additionalProperties": true + }, + "data": { + "description": "The document's \"primary data\" is a representation of the resource or collection of resources targeted by a request.", + "oneOf": [ + { + "$ref": "#/definitions/resource" + }, + { + "description": "An array of resource objects, an array of resource identifier objects, or an empty array ([]), for requests that target resource collections.", + "type": "array", + "items": { + "$ref": "#/definitions/resource" + }, + "uniqueItems": true + }, + { + "description": "null if the request is one that might correspond to a single resource, but doesn't currently.", + "type": "null" + } + ] + }, + "resource": { + "description": "\"Resource objects\" appear in a JSON:API document to represent resources.", + "type": "object", + "required": [ + "type", + "id" + ], + "properties": { + "type": { + "type": "string" + }, + "id": { + "type": "string" + }, + "attributes": { + "$ref": "#/definitions/attributes" + }, + "relationships": { + "$ref": "#/definitions/relationships" + }, + "links": { + "$ref": "#/definitions/links" + }, + "meta": { + "$ref": "#/definitions/meta" + } + }, + "additionalProperties": false + }, + "relationshipLinks": { + "description": "A resource object **MAY** contain references to other resource objects (\"relationships\"). Relationships may be to-one or to-many. Relationships can be specified by including a member in a resource's links object.", + "type": "object", + "properties": { + "self": { + "description": "A `self` member, whose value is a URL for the relationship itself (a \"relationship URL\"). This URL allows the client to directly manipulate the relationship. For example, it would allow a client to remove an `author` from an `article` without deleting the people resource itself.", + "$ref": "#/definitions/link" + }, + "related": { + "$ref": "#/definitions/link" + } + }, + "additionalProperties": true + }, + "links": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/link" + } + }, + "link": { + "description": "A link **MUST** be represented as either: a string containing the link's URL or a link object.", + "oneOf": [ + { + "description": "A string containing the link's URL.", + "type": "string", + "format": "uri-reference" + }, + { + "type": "object", + "required": [ + "href" + ], + "properties": { + "href": { + "description": "A string containing the link's URL.", + "type": "string", + "format": "uri-reference" + }, + "meta": { + "$ref": "#/definitions/meta" + } + } + } + ] + }, + + "attributes": { + "description": "Members of the attributes object (\"attributes\") represent information about the resource object in which it's defined.", + "type": "object", + "patternProperties": { + "^[a-zA-Z0-9](?:[-\\w]*[a-zA-Z0-9])?$": { + "description": "Attributes may contain any valid JSON value." + } + }, + "not": { + "anyOf": [ + {"required": ["relationships"]}, + {"required": ["links"]}, + {"required": ["id"]}, + {"required": ["type"]} + ] + }, + "additionalProperties": false + }, + + "relationships": { + "description": "Members of the relationships object (\"relationships\") represent references from the resource object in which it's defined to other resource objects.", + "type": "object", + "patternProperties": { + "^[a-zA-Z0-9](?:[-\\w]*[a-zA-Z0-9])?$": { + "properties": { + "links": { + "$ref": "#/definitions/relationshipLinks" + }, + "data": { + "description": "Member, whose value represents \"resource linkage\".", + "oneOf": [ + { + "$ref": "#/definitions/relationshipToOne" + }, + { + "$ref": "#/definitions/relationshipToMany" + } + ] + }, + "meta": { + "$ref": "#/definitions/meta" + } + }, + "anyOf": [ + {"required": ["data"]}, + {"required": ["meta"]}, + {"required": ["links"]} + ], + "not": { + "anyOf": [ + {"required": ["id"]}, + {"required": ["type"]} + ] + }, + "additionalProperties": false + } + }, + "additionalProperties": false + }, + "relationshipToOne": { + "description": "References to other resource objects in a to-one (\"relationship\"). Relationships can be specified by including a member in a resource's links object.", + "anyOf": [ + { + "$ref": "#/definitions/empty" + }, + { + "$ref": "#/definitions/linkage" + } + ] + }, + "relationshipToMany": { + "description": "An array of objects each containing \"type\" and \"id\" members for to-many relationships.", + "type": "array", + "items": { + "$ref": "#/definitions/linkage" + }, + "uniqueItems": true + }, + "empty": { + "description": "Describes an empty to-one relationship.", + "type": "null" + }, + "linkage": { + "description": "The \"type\" and \"id\" to non-empty members.", + "type": "object", + "required": [ + "type", + "id" + ], + "properties": { + "type": { + "type": "string" + }, + "id": { + "type": "string" + }, + "meta": { + "$ref": "#/definitions/meta" + } + }, + "additionalProperties": false + }, + "pagination": { + "type": "object", + "properties": { + "first": { + "description": "The first page of data", + "oneOf": [ + { "$ref": "#/definitions/link" }, + { "type": "null" } + ] + }, + "last": { + "description": "The last page of data", + "oneOf": [ + { "$ref": "#/definitions/link" }, + { "type": "null" } + ] + }, + "prev": { + "description": "The previous page of data", + "oneOf": [ + { "$ref": "#/definitions/link" }, + { "type": "null" } + ] + }, + "next": { + "description": "The next page of data", + "oneOf": [ + { "$ref": "#/definitions/link" }, + { "type": "null" } + ] + } + } + }, + + "jsonapi": { + "description": "An object describing the server's implementation", + "type": "object", + "properties": { + "version": { + "type": "string" + }, + "meta": { + "$ref": "#/definitions/meta" + } + }, + "additionalProperties": false + }, + + "error": { + "type": "object", + "properties": { + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "type": "string" + }, + "links": { + "$ref": "#/definitions/links" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "type": "string" + }, + "code": { + "description": "An application-specific error code, expressed as a string value.", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem. It **SHOULD NOT** change from occurrence to occurrence of the problem, except for purposes of localization.", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "type": "string" + }, + "source": { + "type": "object", + "properties": { + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document [e.g. \"/data\" for a primary data object, or \"/data/attributes/title\" for a specific attribute].", + "type": "string" + }, + "parameter": { + "description": "A string indicating which query parameter caused the error.", + "type": "string" + } + } + }, + "meta": { + "$ref": "#/definitions/meta" + } + }, + "additionalProperties": false + } + } +} + diff --git a/external/json-api/schema.yaml b/external/json-api/schema.yaml new file mode 100644 index 000000000..1ab55d83f --- /dev/null +++ b/external/json-api/schema.yaml @@ -0,0 +1,287 @@ +$schema: http://json-schema.org/draft-06/schema# +definitions: + attributes: + additionalProperties: false + description: Members of the attributes object ("attributes") represent information + about the resource object in which it's defined. + not: + anyOf: + - required: + - relationships + - required: + - links + - required: + - id + - required: + - type + patternProperties: + ^[a-zA-Z0-9](?:[-\w]*[a-zA-Z0-9])?$: + description: Attributes may contain any valid JSON value. + type: object + data: + description: The document's "primary data" is a representation of the resource + or collection of resources targeted by a request. + oneOf: + - $ref: '#/definitions/resource' + - description: An array of resource objects, an array of resource identifier objects, + or an empty array ([]), for requests that target resource collections. + items: + $ref: '#/definitions/resource' + type: array + uniqueItems: true + - description: null if the request is one that might correspond to a single resource, + but doesn't currently. + type: 'null' + empty: + description: Describes an empty to-one relationship. + type: 'null' + error: + additionalProperties: false + properties: + code: + description: An application-specific error code, expressed as a string value. + type: string + detail: + description: A human-readable explanation specific to this occurrence of the + problem. + type: string + id: + description: A unique identifier for this particular occurrence of the problem. + type: string + links: + $ref: '#/definitions/links' + meta: + $ref: '#/definitions/meta' + source: + properties: + parameter: + description: A string indicating which query parameter caused the error. + type: string + pointer: + description: A JSON Pointer [RFC6901] to the associated entity in the + request document [e.g. "/data" for a primary data object, or "/data/attributes/title" + for a specific attribute]. + type: string + type: object + status: + description: The HTTP status code applicable to this problem, expressed as + a string value. + type: string + title: + description: A short, human-readable summary of the problem. It **SHOULD NOT** + change from occurrence to occurrence of the problem, except for purposes + of localization. + type: string + type: object + failure: + additionalProperties: false + properties: + errors: + items: + $ref: '#/definitions/error' + type: array + uniqueItems: true + jsonapi: + $ref: '#/definitions/jsonapi' + links: + $ref: '#/definitions/links' + meta: + $ref: '#/definitions/meta' + required: + - errors + type: object + info: + additionalProperties: false + properties: + jsonapi: + $ref: '#/definitions/jsonapi' + links: + $ref: '#/definitions/links' + meta: + $ref: '#/definitions/meta' + required: + - meta + type: object + jsonapi: + additionalProperties: false + description: An object describing the server's implementation + properties: + meta: + $ref: '#/definitions/meta' + version: + type: string + type: object + link: + description: 'A link **MUST** be represented as either: a string containing the + link''s URL or a link object.' + oneOf: + - description: A string containing the link's URL. + format: uri-reference + type: string + - properties: + href: + description: A string containing the link's URL. + format: uri-reference + type: string + meta: + $ref: '#/definitions/meta' + required: + - href + type: object + linkage: + additionalProperties: false + description: The "type" and "id" to non-empty members. + properties: + id: + type: string + meta: + $ref: '#/definitions/meta' + type: + type: string + required: + - type + - id + type: object + links: + additionalProperties: + $ref: '#/definitions/link' + type: object + meta: + additionalProperties: true + description: Non-standard meta-information that can not be represented as an attribute + or relationship. + type: object + pagination: + properties: + first: + description: The first page of data + oneOf: + - $ref: '#/definitions/link' + - type: 'null' + last: + description: The last page of data + oneOf: + - $ref: '#/definitions/link' + - type: 'null' + next: + description: The next page of data + oneOf: + - $ref: '#/definitions/link' + - type: 'null' + prev: + description: The previous page of data + oneOf: + - $ref: '#/definitions/link' + - type: 'null' + type: object + relationshipLinks: + additionalProperties: true + description: A resource object **MAY** contain references to other resource objects + ("relationships"). Relationships may be to-one or to-many. Relationships can + be specified by including a member in a resource's links object. + properties: + related: + $ref: '#/definitions/link' + self: + $ref: '#/definitions/link' + description: A `self` member, whose value is a URL for the relationship itself + (a "relationship URL"). This URL allows the client to directly manipulate + the relationship. For example, it would allow a client to remove an `author` + from an `article` without deleting the people resource itself. + type: object + relationshipToMany: + description: An array of objects each containing "type" and "id" members for to-many + relationships. + items: + $ref: '#/definitions/linkage' + type: array + uniqueItems: true + relationshipToOne: + anyOf: + - $ref: '#/definitions/empty' + - $ref: '#/definitions/linkage' + description: References to other resource objects in a to-one ("relationship"). + Relationships can be specified by including a member in a resource's links object. + relationships: + additionalProperties: false + description: Members of the relationships object ("relationships") represent references + from the resource object in which it's defined to other resource objects. + patternProperties: + ^[a-zA-Z0-9](?:[-\w]*[a-zA-Z0-9])?$: + additionalProperties: false + anyOf: + - required: + - data + - required: + - meta + - required: + - links + not: + anyOf: + - required: + - id + - required: + - type + properties: + data: + description: Member, whose value represents "resource linkage". + oneOf: + - $ref: '#/definitions/relationshipToOne' + - $ref: '#/definitions/relationshipToMany' + links: + $ref: '#/definitions/relationshipLinks' + meta: + $ref: '#/definitions/meta' + type: object + resource: + additionalProperties: false + description: '"Resource objects" appear in a JSON:API document to represent resources.' + properties: + attributes: + $ref: '#/definitions/attributes' + id: + type: string + links: + $ref: '#/definitions/links' + meta: + $ref: '#/definitions/meta' + relationships: + $ref: '#/definitions/relationships' + type: + type: string + required: + - type + - id + type: object + success: + additionalProperties: false + properties: + data: + $ref: '#/definitions/data' + included: + description: To reduce the number of HTTP requests, servers **MAY** allow + responses that include related resources along with the requested primary + resources. Such responses are called "compound documents". + items: + $ref: '#/definitions/resource' + type: array + uniqueItems: true + jsonapi: + $ref: '#/definitions/jsonapi' + links: + allOf: + - $ref: '#/definitions/links' + - $ref: '#/definitions/pagination' + description: Link members related to the primary data. + meta: + $ref: '#/definitions/meta' + required: + - data + type: object +description: This is a schema for responses in the JSON:API format. For more, see + http://jsonapi.org +oneOf: +- $ref: '#/definitions/success' +- $ref: '#/definitions/failure' +- $ref: '#/definitions/info' +title: JSON:API Schema diff --git a/optimade.rst b/optimade.rst index 6f193a671..a3805af33 100644 --- a/optimade.rst +++ b/optimade.rst @@ -595,7 +595,8 @@ Example of the corresponding metadata property definition contained in the field "$id": "https://properties.example.com/v1.2.0/elements_ratios_meta/_exmpl_originates_from_project", "description" : "A string naming the internal example.com project id where this property was added to the database.", "x-optimade-type": "string", - "x-optimade-unit" : "inapplicable" + "x-optimade-unit" : "inapplicable", + "type": ["string", "null"] } } } @@ -1418,7 +1419,10 @@ The response for these endpoints MUST include the following information in the : **Note**: Future versions of the OPTIMADE API will deprecate this format and require all keys that are not :field:`type` or :field:`id` to be under the :field:`attributes` key. -Example (note: the description strings have been wrapped for readability only): +An example of the data part of the entry listing info endpoint response follows below, however, note that: + +- The description strings have been wrapped for readability only (newline characters are not allowed inside JSON strings) +- The properties in the example, 'nelements' and 'lattice_vectors', mimick OPTIMADE standard properties, but are given here with simplified definitions compared to the standard definitions for these properties. .. code:: jsonc @@ -1457,21 +1461,20 @@ Example (note: the description strings have been wrapped for readability only): }, "lattice_vectors": { "$id": "urn:uuid:81edf372-7b1b-4518-9c14-7d482bd67834", - "title": "Unit cell lattice vectors", + "title": "Lattice vectors", + "x-optimade-definition": { + "label": "lattice_vectors_optimade_structures", + "kind": "property", + "format": "1.2", + "version": "1.2.0", + "name": "lattice_vectors" + }, "x-optimade-type": "list", - "type": ["array", "null"], - "description": "The three lattice vectors in Cartesian coordinates, in Ã¥ngström (Ã…).\n - \n - - MUST be a list of three vectors *a*, *b*, and *c*, where each of the vectors MUST BE a - list of the vector's coordinates along the x, y, and z Cartesian coordinates. - ", - "examples": [ - [[4.0, 0.0, 0.0], [0.0, 4.0, 0.0], [0.0, 1.0, 4.0]] - ], - "x-optimade-unit": "inapplicable", - "x-optimade-property": { - "property-format": "1.2", - "unit-definitions": [ + "x-optimade-dimensions": { + "names": ["dim_lattice", "dim_spatial"], + "lengths": [3, 3] + }, + "x-optimade-unit-definitions": [ { "symbol": "angstrom", "title": "Ã¥ngström", @@ -1482,8 +1485,8 @@ Example (note: the description strings have been wrapped for readability only): "symbol": "angstrom" } } - ] - }, + ], + "x-optimade-unit": "inapplicable", "x-optimade-implementation": { "sortable": false, "query-support": "none" @@ -1493,14 +1496,23 @@ Example (note: the description strings have been wrapped for readability only): "sortable": false, "query-support": "none" }, - "maxItems": 3, - "minItems": 3, + "type": ["array", "null"], + "description": "The three lattice vectors in Cartesian coordinates, in Ã¥ngström (Ã…).\n + \n + - MUST be a list of three vectors *a*, *b*, and *c*, where each of the vectors MUST BE a + list of the vector's coordinates along the x, y, and z Cartesian coordinates. + ", + "examples": [ + [[4.0, 0.0, 0.0], [0.0, 4.0, 0.0], [0.0, 1.0, 4.0]] + ], "items": { "type": "array", "x-optimade-type": "list", "x-optimade-unit": "inapplicable", - "maxItems": 3, - "minItems": 3, + "x-optimade-dimensions": { + "names": ["dim_spatial"], + "lengths": [3] + }, "items": { "type": "number", "x-optimade-type": "float", @@ -2074,39 +2086,61 @@ The format of Property Definitions defined below allows nesting inner Property D To make a property definition expressible in any output format, the fields of the property definition below are specified using OPTIMADE data types. When a property definition is communicated using a specific data format (e.g., JSON), the property definition is implemented in that data format by mapping the OPTIMADE data types into the corresponding data types for that output format. +Clients are meant to be able to rely on the fact that properties with the same :field:`$id` fields represents equivalently defined properties. +Hence, when a Property Definition that has been published previously is updated, it is of major importance to decide if the updates merely amend, annotate, or clarify the definition in a way that leaves it functionally the same and thus can retain the :field:`$id`, or whether the property is redefined. +An example of an update that does not functionally change the definition is the addition or modification of the examples given in the :field:`examples` field. +If a property is redefined, the redefinition MUST change the :field:`$id`. +The nature of an updated definition can also be reflected in the subfield :field:`version` of :field:`x-optimade-definition`, which allows definitions to be versioned using the `semantic versioning v2 `__ standard where the update is categorized on the levels of a patch, minor, or major change. + A Property Definition MUST be composed according to the combination of the requirements in the subsection `Property Definition keys from JSON Schema`_ below and the following additional requirements: -**REQUIRED keys for the outermost level of the Property Definition:** +**REQUIRED keys for the outermost level of the Property Definition and OPTIONAL for other levels:** -- :field:`$id`: String, :field:`title`: String, and :field:`description`: String. +- :field:`$id`: String, :field:`$schema`: String, :field:`title`: String, and :field:`description`: String. See the subsection `Property definition keys from JSON Schema`_ for the definitions of these fields. They are defined in that subsection as OPTIONAL on any level of the Property Definition, but are REQUIRED on the outermost level. -- :field:`x-optimade-property`: Dictionary. - Additional information to define the property that is not covered by fields in the JSON Schema standard. +.. _definition of the x-optimade-definition field: + +- :field:`x-optimade-definition`: Dictionary. + Additional information about the definition that is not covered by fields in the JSON Schema standard. **REQUIRED keys:** - - :field:`property-format`: String. - Specifies the minor version of the property definition format used. +.. _definition of the property-format field: + + - :field:`format`: String. + A string that declares the OPTIMADE definition format the definition adheres to. + Currently, this is expressed as the minor version of the OPTIMADE specification that describes the property definition format used. The string MUST be of the format "MAJOR.MINOR", referring to the version of the OPTIMADE standard that describes the format in which this property definition is expressed. The version number string MUST NOT be prefixed by, e.g., "v". In implementations of the present version of the standard, the value MUST be exactly :field-val:`1.2`. A client MUST disregard the property definition if the field is not a string of the format MAJOR.MINOR or if the MAJOR version number is unrecognized. This field allows future versions of this standard to support implementations keeping definitions that adhere to older versions of the property definition format. + - :field:`kind`: String. + A string specifying what entity is being defined. + For Property Definitions this MUST be the string "property". + + - :field:`name`: String. + An short identifier (as defined in `Definition of Terms`_) that provides a reasonable short non-unique name for the entity being defined. + + - :field:`label`: String. + An extended identifier (as defined in `Definition of Terms`_) that describes the entity being defined in a way that is unique within a set of definitions provided together. + The label SHOULD start with the name. + + Implementation notes: + + The name and label fields ensure implementations will be able to give meaningful names to definitions if they are translated into other formats with various requirements on human-readable names, e.g., as `RDF data `__ (see, e.g., rdfs:label). + **OPTIONAL keys:** - :field:`version`: String. - This string indicates the version of the property definition. + This string indicates the version of the definition. The string SHOULD be in the format described by the `semantic versioning v2 `__ standard. + When a definition is changed in a way that consitutes a redefinition it SHOULD indicate this by incrementing the MAJOR version number. - - :field:`unit-definitions`: List. - A list of definitions of the symbols used in the Property Definition (including its nested levels) for physical units given as values of the :field:`x-optimade-unit` field. - This field MUST be included if the defined property, at any level, includes an :field:`x-optimade-unit` with a value that is not :val:`dimensionless` or :val:`inapplicable`. - See subsection `Physical Units in Property Definitions`_ for the details on how units are represented in OPTIMADE Property Definitions and the precise format of this dictionary. - - - :field:`resource-uris`: List. + - :field:`resources`: List. A list of dictionaries that references remote resources that describe the property. The format of each dictionary is: @@ -2115,12 +2149,14 @@ A Property Definition MUST be composed according to the combination of the requi - :field:`relation`: String. A human-readable description of the relationship between the property and the remote resource, e.g., a "natural language description". - - :field:`uri`: String. - A URI of the external resource (which MAY be a resolvable URL). + - :field:`resource-id`: String. + An IRI of the external resource, which MAY be a resolvable URL. **REQUIRED keys for all levels of the Property Definition:** -- :field:`x-optimade-type`: String +.. _definition of the x-optimade-type field: + +- :field:`x-optimade-type`: String. Specifies the OPTIMADE data type for this level of the defined property. MUST be one of :val:`"string"`, :val:`"integer"`, :val:`"float"`, :val:`"boolean"`, :val:`"timestamp"`, :val:`"list"`, or :val:`"dictionary"`. @@ -2130,9 +2166,38 @@ A Property Definition MUST be composed according to the combination of the requi **OPTIONAL keys at all nested levels of the Property Definition:** +- :field:`x-optimade-unit-definitions`: List. + A list of definitions of the symbols used in the Property Definition (including its nested levels) for physical units given as values of the :field:`x-optimade-unit` field. + This field **MUST be included at the outermost level of a property definition** if the defined property, at any level, includes an :field:`x-optimade-unit` with a value that is not :val:`dimensionless` or :val:`inapplicable`, and it MUST include definitions of all units used on all levels in the property definition. + The field MAY also occur at deeper nesting levels (but this is not required). + If it does, the unit definitions provided MUST be redundant with those provided at higher nesting levels. + See subsection `Physical Units in Property Definitions`_ for the details on how units are represented in OPTIMADE Property Definitions and the precise format of this dictionary. + +.. _definition of the x-optimade-dimensions field: + +- :field:`x-optimade-dimensions`: Dictionary. + Specification of the dimensions of one or multi-dimensional data represented as multiple levels of lists. + Each dimension is given a name and optionally a fixed size. + + **REQUIRED keys:** + + - :field:`names`: List of Strings. + A list of names of the dimensions of the underlying one or multi-dimensionsional data represented as mutiple levels of lists. + The order is that the the first name applies to the outermost list, the next name to the lists embedded in that list, etc. + + - :field:`sizes`: List of Integers or :val:`null`. + A list of fixed length requirements on the underlying one or multi-dimensionsional data represented as mutiple levels of lists. + The order is that the the first name applies to the outermost list, the next name to the lists embedded in that list, etc. + The data only validates if the respective level consists of lists of exactly this length. + A value of `null` allows arbitrary-length lists at the corresponding level. + + Note: OPTIMADE Property Definitions use this field, and MUST NOT use the JSON Schema validating fields minItems and maxItems since that would require reprocessing the schema to handle requests using the OPTIMADE features that requests partial data in lists. + Instead, the length of lists can be validated against the length information provided in the :field:`sizes` subfield of :field:`x-optimade-dimensions` (which, at this time, can only specify a fixed length requirement.) + - :field:`x-optimade-implementation`: Dictionary. A dictionary describing the level of OPTIMADE API functionality provided by the present implementation. If an implementation omits this field in its response, a client interacting with that implementation SHOULD NOT make any assumptions about the availability of these features. + The dictionary has the following format: **OPTIONAL keys:** @@ -2151,9 +2216,13 @@ A Property Definition MUST be composed according to the combination of the requi - :val:`partial`: the defined property MUST be queryable with support for a subset of the filter language operators as specified by the field :field:`query-support-operators`. - :val:`none`: the defined property does not need to be queryable with any features of the filter language. + Omitting the field or :val:`null` is equivalent to :val:`none`. + - :field:`query-support-operators`: List of Strings. Defines the filter language features supported on this property. - Each string in the list MUST be one of :val:`<`, :val:`<=`, :val:`>`, :val:`>=`, :val:`=`, :val:`!=`, :val:`CONTAINS`, :val:`STARTS WITH`, :val:`ENDS WITH`:, :val:`HAS`, :val:`HAS ALL`, :val:`HAS ANY`, :val:`HAS ONLY`, :val:`IS KNOWN`, :val:`IS UNKNOWN` with the following meanings: + MUST be present and not :val:`null` if and only if :field:`query-support` is :val:`partial`. + + Each string in the list MUST be one of :val:`<`, :val:`<=`, :val:`>`, :val:`>=`, :val:`=`, :val:`!=`, :val:`CONTAINS`, :val:`STARTS WITH`, :val:`ENDS WITH`, :val:`HAS`, :val:`HAS ALL`, :val:`HAS ANY`, :val:`HAS ONLY`, :val:`IS KNOWN`, :val:`IS UNKNOWN` with the following meanings: - :val:`<`, :val:`<=`, :val:`>`, :val:`>=`, :val:`=`, :val:`!=`: indicating support for filtering this property using the respective operator. If the property is of Boolean type, support for :val:`=` also designates support for boolean comparisons with the property being true that omit ":filter-fragment:`= TRUE`", e.g., specifying that filtering for ":filter:`is_yellow = TRUE`" is supported also implies support for ":filter:`is_yellow`" (which means the same thing). @@ -2167,14 +2236,20 @@ A Property Definition MUST be composed according to the combination of the requi - :val:`IS KNOWN`, :val:`IS UNKNOWN`: indicating support for filtering this property on unknown values using the respective operator. + - :field:`response-default`: Boolean. + The value :val:`TRUE` means the implementation includes the property in responses by default, i.e., when not specifically requested. + The value :val:`FALSE` means that the property is only included when requested. + Omitting the field or :val:`null` means the implementation does not declare if the property will be included in responses by default or not. + - :field:`x-optimade-requirements`: Dictionary. A dictionary describing the level of OPTIMADE API functionality required by all implementations of this property. Omitting this field means the corresponding functionality is OPTIONAL. - The dictionary has the same format as :field:`x-optimade-implementation`, except that it also allows the following OPTIONAL field: + The dictionary has the same format as :field:`x-optimade-implementation`, *except that* the :field:`response-default` field SHOULD NOT appear, and the following additional OPTIONAL fields are allowed: - :field:`support`: String. Describes the minimal required level of support for the Property by an implementation. - This field SHOULD only appear in an :field:`x-optimade-requirements` that is at the outermost level of a Property Definition, as the meaning of its inclusion on other levels is not defined. + This field only has meaning for the defined property when appearing in the :field:`x-optimade-requirements` at the outermost level of the definition. + Nevertheless, it MAY appear in other places, e.g., if a nested property definition has been inserted that references its own :field:`$id`. The string MUST be one of the following: - :val:`must`: the defined property MUST be recognized by the implementation (e.g., in filter strings) and MUST NOT be :val:`null`. @@ -2186,6 +2261,23 @@ A Property Definition MUST be composed according to the combination of the requi Note: the specification by this field of whether the defined property can be :val:`null` or not MUST match the value of the :field:`type` field. If :val:`null` values are allowed, that field must be a list where the string :val:`"null"` is the second element. + - :field:`response-default-level`: String. + Expresses if an implementation of this property is required to include or exclude it in responses when not specifically requested. + This field only has meaning for the defined property when appearing in the :field:`x-optimade-requirements` at the outermost level of the definition. + Nevertheless, it MAY appear in other places, e.g., if a nested property definition has been inserted that references its own :field:`$id`. + + The string MUST be one of the following: + + - :val:`always`: the defined property MUST always be included in responses and cannot be excluded even by request via, e.g., the :query-param:`response_fields` query parameter. + This is primarily intended for the :field:`id` and :field:`type` fields, which are required for the JSON:API response format to be valid. + - :val:`must`: the defined property MUST be included in responses unless specifically excluded. + - :val:`should`: the defined property SHOULD be included in responses unless specifically excluded. + - :val:`may`: it is OPTIONAL for the implementation to include the defined property in responses. + - :val:`should not`: the defined property SHOULD NOT be included in responses unless specifically requested. + - :val:`must not`: the defined property MUST NOT be included in responses unless specifically requested. + + Omitting the field is equivalent to :val:`may`. + Property Definition keys from JSON Schema ----------------------------------------- @@ -2194,25 +2286,27 @@ The format described in this subsection forms a subset of the `JSON Schema Valid **REQUIRED keys** -- :field:`type`: String or List. - Specifies the corresponding JSON type for this level of the defined property and whether the property can be :val:`null` or not. - The value is directly correlated with :field:`x-optimade-type` as explained below. +.. _definition of the type field: - It MUST be one of: +- :field:`type`: List. + Specifies the corresponding JSON type for this level of the defined property and whether the property can be :val:`null` or not. + The value is directly correlated with :field:`x-optimade-type` (cf. the `definition of the x-optimade-type field`_). - - A string correlated with :field:`x-optimade-type` as follows. - If :field:`x-optimade-type` is: + It MUST be a list of one or two elements where the first element is a string correlated with :field:`x-optimade-type` as follows; if :field:`x-optimade-type` is: - * :val:`"boolean"`, `"string"`, or `"integer"` then :field:`type` is the same string. - * :val:`"dictionary"` then :field:`type` is `"object"`. - * :val:`"list"` then :field:`type` is `"array"`. - * :val:`"float"` then :field:`type` is `"number"`. - * :val:`"timestamp"` then :field:`type` is `"string"`. + * :val:`"boolean"`, :val:`"string"`, or :val:`"integer"` then :field:`type` is the same string. + * :val:`"dictionary"` then :field:`type` is `"object"`. + * :val:`"list"` then :field:`type` is `"array"`. + * :val:`"float"` then :field:`type` is `"number"`. + * :val:`"timestamp"` then :field:`type` is `"string"`. - - A list where the first item MUST be the string described above (correlated to the field :field:`x-optimade-type` in the same way) and the second item MUST be the string :val:`"null"`. - This form specifies that the defined property can be :val:`null`. + If the second element is included, it MUST be the string :val:`"null"`. + This two element form specifies that the defined property can be :val:`null`. -.. + The inclusion or not of :val:`"null"` in the field :field:`type` for a subfield defined at a nested level by a Property Definition declares if that subfield is nullable. + Property Definitions for which the nullability of a subfield differs MUST NOT share the same :field:`$id`. + However, the nullability of the subfield SHOULD NOT be taken into account when comparing the nested Property Definition for that subfield with other definitions, i.e., a nullable and non-nullable subfield that are otherwise defined the same SHOULD share the same :field:`$id`. + Hence, formally OPTIMADE Property Definitions regard nullability of a subfield to belong one level *above* where it appears in the JSON Schema definition. **Implementation notes:** @@ -2224,36 +2318,54 @@ The format described in this subsection forms a subset of the `JSON Schema Valid Values can only be defined to be a single OPTIMADE data type or, optionally, :val:`null`. This restriction is intended to reduce the complexity of possible data types that implementations have to handle in different formats and database backends. -**OPTIONAL keys** +**Keys that are REQUIRED on the outermost level of a Property Definition, but otherwise OPTIONAL:** + +- :field:`$schema`: String. + A URL for a meta schema that describes the Property Definitions format. + For Property Definitions adhering to the format described in this document, it should be set to: :val:`https://schemas.optimade.org/meta/v1.2/optimade/property_definition.json`. + +.. _definition of the $id field: - :field:`$id`: String. - A static URI identifier that is a URN or URL representing the specific version of this level of the defined property. - It SHOULD NOT be changed as long as the property definition remains the same, and SHOULD be changed when the property definition changes. + A static IRI identifier that is a URN or URL representing the specific version of this level of the defined property. (If it is a URL, clients SHOULD NOT assign any interpretation to the response when resolving that URL.) + It SHOULD NOT be changed as long as the property definition remains the same, and MUST be changed when the property definition changes. - :field:`title`: String. A short single-line human-readable explanation of the defined property appropriate to show as part of a user interface. +.. _definition of the description field: + - :field:`description`: String. A human-readable multi-line description that explains the purpose, requirements, and conventions of the defined property. The format SHOULD be a one-line description, followed by a new paragraph (two newlines), followed by a more detailed description of all the requirements and conventions of the defined property. - Formatting in the text SHOULD use Markdown in the `CommonMark v0.3 format `__. + Formatting in the text SHOULD use Markdown in the `CommonMark v0.3 format `__ format, with mathematical expressions written to render correctly with the LaTeX mode of `Mathjax 3.2 `__. + When possible, it is preferable for mathematical expressions to use as straightforward notation as possible to make them readable also when not rendered. + +**OPTIONAL keys** + +- :field:`$comment`: String. + A human-readable comment relevant in the context of the raw definition data. + These comments should normally not be shown to the end users. + Comments pertaining to the Property Definition that are relevant to end users should go into the field :field:`description`. + Formatting in the text SHOULD use Markdown using the format described in the `definition of the description field`_. - :field:`deprecated`: Boolean. If :val:`TRUE`, implementations SHOULD not use the defined property, and it MAY be removed in the future. If :val:`FALSE`, the defined property is not deprecated. The field not being present means :val:`FALSE`. + A Property Definition marked as deprecated is generally considered to be the same as its non-deprecated counterpart, i.e., it SHOULD retain its :field:`$id`. + +- :field:`examples`: List. + A list of example values that the defined property can have. + These examples MUST all be of a data type that matches the :field:`type` field and otherwise adhere to the rest of the Property Description. - :field:`enum`: List. The defined property MUST take one of the values given in the provided list. The items in the list MUST all be of a data type that matches the :field:`type` field and otherwise adhere to the rest of the Property Description. If this key is given, for :val:`null` to be a valid value of the defined property, the list MUST contain a :val:`null` value and the :field:`type` MUST be a list where the second value is the string :val:`"null"`. -- :field:`examples`: List. - A list of example values that the defined property can have. - These examples MUST all be of a data type that matches the :field:`type` field and otherwise adhere to the rest of the Property Description. - -Depending on what string the :field:`type` is equal to, or contains as first element, the following additional requirements also apply: +Furthermore, depending on what string the :field:`type` is equal to, or contains as first element, the following additional requirements also apply: - :val:`"object"`: @@ -2293,18 +2405,13 @@ Depending on what string the :field:`type` is equal to, or contains as first ele **OPTIONAL** - - :field:`maxItems`: Integer. - A non-negative integer. - The defined property is an array that MUST contain a number of items that is less than or equal to the given integer. - - - :field:`minItems`: Integer. - A non-negative integer. - The defined property is an array that MUST contain a number of items that is greater than or equal to the given integer. - - :field:`uniqueItems`: Boolean. If :val:`TRUE`, the defined property is an array that MUST only contain unique items. If :val:`FALSE`, this field sets no limitation on the defined property. + Furthermore, despite being defined in the JSON Schema standard, the fields :field:`minItems` and :field:`maxItems` MUST NOT be used to indicate limits of the number of items of a list. + See the `definition of the x-optimade-dimensions field`_ for more information. + - :val:`"integer"`: **OPTIONAL** @@ -2367,7 +2474,15 @@ Depending on what string the :field:`type` is equal to, or contains as first ele - :val:`"time"`: the full-time production in :RFC:`3339` section 5.6. - :val:`"duration"`: the duration production in :RFC:`3339` Appendix A. - :val:`"email"`: the "Mailbox" ABNF rule in :RFC:`5321` section 4.1.2. - - :val:`"uri"`: a string instance is valid against this attribute if it is a valid URI, according to :RFC:`3986`. + - :val:`"uri"`: a string instance is valid against this attribute if it is a valid URI according to :RFC:`3986`. + - :val:`"iri"`: a string instance is valid against this attribute if it is a valid IRI according to :RFC:`3987`. + + - :field:`pattern`: String. + This string SHOULD be a valid regular expression, according to the ECMA-262 regular expression dialect. + A string instance is considered valid if the regular expression matches the instance successfully. + The regular expression is not implicitly anchored, i.e., it can match the string at any position unless the expression contains a leading '^' or a trailing '$'. + +A complete example of a Property Definition is found in the appendix `Property Definition Example`_. Physical Units in Property Definitions -------------------------------------- @@ -2379,32 +2494,54 @@ Clients and servers that use other units internally thus have to do unit convers The physical unit of a property, the embedded items of a list, or values of a dictionary, are defined with the field :field:`x-optimade-unit` with the following requirements: - The field MUST be given with a non-:val:`null` value both at the highest level in the OPTIMADE Property Definition and all inner Property Definitions. -- If the property refers to a physical quantity that is dimensionless (often also referred to as having the dimension 1) or refers to a dimensionless count of something (e.g., the number of protons in a nucleus) the field MUST have the value :val:`dimensionless`. +- If the property refers to a physical quantity that is dimensionless and unitless (often also referred to as having the dimension 1) or refers to a dimensionless and unitless count of something (e.g., the number of protons in a nucleus) the field MUST have the value :val:`dimensionless`. + However, quantities that use counting units, e.g., the mole, or quantities that use dimensionless units, e.g., the radian MUST NOT set the field to :val:`dimensionless`. - If the property refers to an entity for which the assignment of a unit would not make sense, e.g., a string representing a chemical formula or a serial number the field MUST have the value :val:`inapplicable`. +- If the field does not take the value :val:`dimensionless` or :val:`inapplicable`, it MUST be set to a single unit symbol or a Compound Unit Expressions from a set of unit symbols using the format described in `Compound Unit Expressions`_. +- All unit symbols used in :field:`x-optimade-unit` fields at any level in a Property Definition MUST be defined in the :field:`units` field inside the :field:`x-optimade-property` field in the outermost level of the Property Definition, or in the :field:`units` field in the Entry info endpoint (the latter is only possible for Property Definitions embedded in such a response). +- The :field:`units` MUST be a list of dictionaries using the format for OPTIMADE Physical Unit Definitions described in `Physical Unit Definitions`_. -A standard set of unit symbols for OPTIMADE is taken from version 3.15 of the (separately versioned) unit database :val:`definitions.units` included with the `source distribution `__ of `GNU Units `__ version 2.22. -If the unit is available in this database, or if it can be expressed as a compound unit expression using these units, the value of :field:`x-optimade-unit` SHOULD use the corresponding (compound) string symbol and a corresponding definition referring to the same symbol be given in the field :field:`standard`. +Compound Unit Expressions +------------------------- -A compound unit expression based on the GNU Units symbols is created by a sequence of unit symbols separated by a single multiplication :val:`*` symbol. -Each unit symbol can also be suffixed by a single :val:`^` symbol followed by a positive or negative integer to indicate the power of the preceding unit, e.g., :val:`m^3` for cubic meter, :val:`m^-3` for inverse cubic meter. +A Compound Unit Expression is formed by a sequence of symbols for units or constants separated by a single multiplication ``*`` character. +Each symbol can also be suffixed by a single ``^`` character followed by a positive or negative integer to indicate the power of the preceding symbol, e.g., ``m^3`` for cubic meter, ``m^-3`` for inverse cubic meter. (Positive integers MUST NOT be preceded by a plus sign.) -The unit symbols MAY be prefixed by one (but not more than one) of the prefixes defined in the ``definitions.units`` file. -A prefix is indicated in the file by a trailing ``-``, but that trailing character MUST NOT be included when using it as a prefix. -If there are multiple prefixes in the file with the same meaning, an implementation SHOULD use the *shortest one* consisting of only lowercase letters a-z and underscores, but no other symbols. -If there are multiple ones with the same shortest length, then the first one of those SHOULD be used. -For example :val:`"km"` for kilometers. +Each unit or constant symbol MAY be directly prefixed by a prefix symbol. +A prefix symbol MUST be directly followed by a unit symbol, i.e., it MUST NOT be used on its own, and MUST NOT be followed by ``^`` to indicate a power. +When defining prefix symbols it is important to ensure that they do not introduce ambiguity. +If there are ambiguous interpretations of a symbol as either having or not having a prefix, it MUST be interpreted as a unit without a prefix. + Furthermore: -- No whitespace, parenthesis, or other symbols than specified above are permitted. -- If multiple string representations of the same unit exist in ``definitions.units``, the *first one* in that file consisting of only lowercase letters a-z and underscores, but no other symbols, SHOULD be used. -- The unit symbols MUST appear in alphabetical order. +- No whitespace, parentheses, or other symbols than specified above are permitted. +- The (prefixed) unit and constant symbols MUST appear in alphabetical order. -The string in :field:`x-optimade-unit` MUST be defined in the :field:`unit-definitions` field inside the :field:`x-optimade-property` field in the outermost level of the Property Definition. +Physical Unit Definitions +------------------------- -If provided, the :field:`unit-definitions` in :field:`x-optimade-property` MUST be a list of dictionaries, all adhering to the following format: +An OPTIMADE Physical Unit Definition is a dictionary adhering to the following format: **REQUIRED keys:** +- :field:`$schema`: String. + A URL for a meta schema that describes the Physical Unit Definitions format. + For Property Definitions adhering to the format described in this document, it should be set to: :val:`https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition.json`. + +- :field:`x-optimade-definition`: Dictionary. + The same field as defined in the `definition of the x-optimade-definition field`_ for Property Definitions but where the :field:`kind` subfield MUST be :val:`unit`. + +.. _definition of the $id field in Physical Unit Definitions: + +- :field:`$id`: String. + A static IRI identifier that is a URN or URL representing the specific version of the Physical Unit Definition. + (If it is a URL, clients SHOULD NOT assign any interpretation to the response when resolving that URL.) + It SHOULD NOT be changed as long as the Physical Unit Definition remains the same, and SHOULD be changed when the definition changes. + Physical Unit Definitions SHOULD be regarded as the same if they only differ by: + + - Additions of annotating notes to end of the :field:`description` field. + - Changes to the following specific fields at any level: :field:`deprecated` and :field:`$comment`. + - :field:`symbol`: String. Specifies the symbol to be used in :field:`x-optimade-unit` to reference this unit. @@ -2414,8 +2551,15 @@ If provided, the :field:`unit-definitions` in :field:`x-optimade-property` MUST - :field:`description`: String. A human-readable multiple-line detailed description of the unit. + Additions appended to the end of the :field:`description` field that are clearly marked as notes that clarify the definition without changing it are viewed as annotations to the Physical Unit Definition rather than an integral part of it. + Such annotations SHOULD only be added to the end of an otherwise unmodified :field:`description` and MUST NOT change the meaning or interpretation of the text above them. + The purpose is to provide a way to add explanations and clarifications to a definition without having to regard it as a new definition. + For example, these annotations to the description MAY be used to explain why a definition has been deprecated. + +**OPTIONAL keys:** + - :field:`standard`: Dictionary. - This field is used to define the unit symbol using a preexisting standard. + This field is used to express that the unit is part of a preexisting standard. The dictionary has the following format: **REQUIRED keys:** @@ -2424,23 +2568,54 @@ If provided, the :field:`unit-definitions` in :field:`x-optimade-property` MUST The abbreviated name of the standard being referenced. One of the following: - - :val:`"gnu units"`: the symbol is a (compound) unit expression based on the symbols in the file ``definitions.units`` distributed with `GNU Units software `__, created according to the scheme described above. - - :val:`"ucum"`: the symbol comes from `The Unified Code for Units of Measure `__ (UCUM) standard. - - :val:`"qudt"`: the symbol comes from the `QUDT `__ standard. + - :val:`"si"`: the symbol is defined as part of the SI standard of unit symbols and prefixes. + - :val:`"codata"`: the symbol is defined as part of one of the CODATA series of publications. + - :val:`"iso-iec-80000"`: the symbol is defined in the iso-iec-80000 standard. + - :val:`"gnu units"`: the symbol is a (compound) unit expression based on the symbols in the file ``definitions.units`` distributed with `GNU Units software `__. + + A standard set of symbols for units and prefixes for OPTIMADE is taken from version 3.15 of the (separately versioned) unit database ``definitions.units`` included with the `source distribution `__ of `GNU Units `__ version 2.22. + A prefix is indicated in the file by a trailing ``-``, but that trailing character MUST NOT be included when using it as a prefix. + If the unit is available in this database, or if it can be expressed as a Compound Unit Expression using these units and prefixes, the value of :field:`x-optimade-unit` SHOULD use the (compound) string symbol. + If there are multiple prefixes in the file with the same meaning, an implementation SHOULD use the *shortest one* consisting of only lowercase letters a-z and underscores, but no other symbols. + If there are multiple ones with the same shortest length, then the first one of those SHOULD be used. + For example, the GNU Units database defines the symbol :val:`"km"` for kilometers by a combination of the ``k-`` SI kilo prefix and the ``m`` symbol for the SI meter unit. + + - :val:`"ucum"`: the symbol is defined in `The Unified Code for Units of Measure `__ (UCUM) standard. + - :val:`"qudt"`: the symbol is defined in the `QUDT `__ standard. Not only symbols strictly defined within the standard are allowed, but also other compound unit expressions created according to the scheme for how new such symbols are formed in this standard. + - :field:`symbol`: String. + The symbol to use from the referenced standard, expressed according to that standard. + The field MAY use mathematical expressions written the same way as described in the `definition of the description field`_. + This field MAY be different from the symbol being defined via the definition if the unit will be referenced in `x-optimade-unit` fields using a different symbol than the one used in the standard or if the symbol is expressed in the standard in a way that requires mathematical notation. + However, if possible, the `symbol` fields SHOULD be the same. + + **OPTIONAL keys:** + - :field:`version`: String. The version string of the referenced standard. - - :field:`symbol`: String. - The symbol to use from the referenced standard, expressed according to that standard. - This field MAY be different from :field:`symbol` directly under :field:`unit-definitions`, meaning that the unit is referenced in :field:`x-optimade-unit` fields using a different symbol than the one used in the standard. - However, the :field:`symbol` fields SHOULD be the same unless multiple units sharing the same symbol need to be referenced. + - :field:`year`: Integer. + The year that the standard adopted the definition. + - :field:`category` + The category of the definition in case the standard uses categories to organize definitions. -**OPTIONAL keys:** +- :field:`alternate-symbols`: List of String. + A list of other symbols that are commonly associated with the unit. + The stings MAY use mathematical expressions written the same way as described in the `definition of the description field`_. -- :field:`resource-uris`: List. +- :field:`property-format`: String. + Specifies the minor version of the Property Definitions format that the Physical Units Definition is expressed in. + (The Physical Units Definition format is not versioned independently.) + The format is the same as described above for the `definition of the property-format field`_ in Property Definitions. + This field MUST be included when Physical Unit Definitions are used standalone, i.e., when they are not embedded inside a Property Definition that already declares a :field:`property-format` at the top level. + +- :field:`version`: String. + This string indicates the version of the Physical Unit Definition. + The string SHOULD be in the format described by the `semantic versioning v2 `__ standard. + +- :field:`resources`: List of Dictionaries. A list of dictionaries that reference remote resources that describe the unit. The format of each dictionary is: @@ -2449,8 +2624,144 @@ If provided, the :field:`unit-definitions` in :field:`x-optimade-property` MUST - :field:`relation`: String. A human-readable description of the relationship between the unit and the remote resource, e.g., a "natural language description". - - :field:`uri`: String. - A URI of the external resource (which MAY be a resolvable URL). + - :field:`resource-id`: String. + An IRI of the external resource (which MAY be a resolvable URL). + +.. _definition of defining-relation: + +- :field:`defining-relation`: Dictionary. + A dictionary that encodes a defining relation to another unit or set of units, with the primary intended use of relating a unit to its definition in SI units, if such a relationship exists. + Some units, e.g., the atomic mass unit (also known as dalton, commonly denoted ``u``), only has an approximate relationship to SI units, in which case the :field:`defining-relation` MUST be omitted or :val:`null`. + The dictionary MUST adhere to the following format: + + **OPTIONAL keys:** + + - :field:`base-units`: List of Dictionaries. + A list specifying the base IRIs and unit symbols for the units in which the dimensional formula for the defining relation is expressed. + Each item MUST be a dictionary that adheres to the following format: + + **REQUIRED keys:** + + - :field:`symbol`: String. + The symbol used to reference this unit in the dimensional formula. + + - :field:`id`: String. + The IRI of one of the units referenced in the dimensional formula for the defining relation. + + - :field:`base-units-expression`: String. + A string expressing the base units part of the defining relation for the unit being defined. + It MUST adhere to the format for compound unit expression described in `Physical Units in Property Definitions`_. + If the field is missing or :val:`null` the base-units-expression is taken to be equal to 1, i.e., the defining relation is dimensionless. + + - :field:`scale`: Dictionary. + A dictionary specifying the scale in the defining relation, adhering to the following format: + + **OPTIONAL keys:** + + - :field:`numerator`: Integer. + - :field:`denominator`: Integer. + - :field:`base`: Integer. + - :field:`exponent`: Integer. + + These four fields specify the value as the rational number :field:`numerator` / :field:`denominator`, multiplied by :field:`base` to the power of :field:`exponent`. + If omitted or :val:`null`, the defaults for the :field:`numerator`, :field:`denominator`, :field:`base`, and :field:`exponent` are respectively 1, 1, 10, and 0. + + - :field:`standard_uncertainty`: Float. + The standard uncertainty of the value used in the defining relation. + Some definitions define an entity (e.g. a constant) to a specific value along with an uncertainty of that value. + + - :field:`offset`: Dictionary. + A dictionary specifying the offset value, adhering to the same format as :field:`scale`. + If omitted or :val:`null`, the defaults for the :field:`numerator`, :field:`denominator`, and :field:`exponent` are respectively 0, 1, and 0. + + If the fields in :field:`scale` are designated as `sn`, `sd`, and `se`; and the fields in :field:`offset` are designated as ``on``, ``od``, and ``oe``; and :field:`base-units-expression` is designated as ``b``, these fields state the following defining relation: a value ``v`` multiplied by the unit being defined is equal to the following expression ``(v * (sn/sd) * 10**se + (on/od) * 10**oe)*b``, where ``*`` designates multiplication and ``**`` designates exponentiation. + For example, the defining relation of the temperature unit Fahrenheit ``F`` in Celsius ``C``, that says that ``x F = (x - 32) * (5/9) C = 5/9 x + (-160/9) C`` could be expressed as follows: + + .. code:: jsonc + + "defining-relation": { + "base-units": [ + { + "symbol": "C", + "id": "https://units.example.com/celsius" + } + ], + "base-units-expression": "C", + "scale": { + "numerator": 5, + "denominator": 9 + }, + "offset": { + "numerator": -160, + "denominator": 9 + } + } + +- :field:`approximate-relations`: List of Dictionary. + A list of dictionaries that encode approximate relations to another unit or set of units. + The intended use is to express one or a few approximate relationships from the unit being defined to other unit systems (primarily intended to be SI). + This field is useful for units not defined by such a relationship, in which case the :field:`defining-relation` field would be used. + For example, the atomic mass unit (also known as dalton, commonly denoted ``u``) is defined as one twelfth of the mass of a free carbon-12 atom at rest and only has an approximate relationship to the SI kilogram. + While this field allows expressing multiple relationships, the intent is only to provide the most relevant relationships (e.g., to an SI base unit) from which other relationships can be derived. + + Each element in the list MUST be a dictionary adhering to the following format: + + **OPTIONAL keys:** + + - :field:`base-units`: List of Dictionaries, and :field:`base-units-expression`: String. + These fields take the same format and roles as in the `definition of defining-relation`_ + + - :field:`scale`: Dictionary. + A dictionary specifying the scale in the approximate relation. + It MUST adhere to the following format: + + **REQUIRED keys:** + + - :field:`value`: Float. + The value of the scale in the approximate relation. + + **OPTIONAL keys:** + + - :field:`standard_uncertainty`: Float. + The standard uncertainty of the value in the approximate relation. + + - :field:`relative_standard_uncertainty`: Float. + The relative standard uncertainty of the value in the approximate relation. + + - :field:`offset`: Dictionary. + A dictionary specifying the offset in the approximate relation. + It MUST adhere to the same format as the :field:`scale` field above. + + The values for :field:`scale` and :field:`offset` take the same meaning as in the `definition of defining-relation`_ to express a relationship between the unit being defined and the compound unit expression in :field:`base-units-expression`. + +- :field:`deprecated`: Boolean. + If :val:`TRUE`, implementations SHOULD not use the unit defined in this Physical Unit Definition. + If :val:`FALSE`, the unit defined in this Physical Unit Definition is not deprecated. + The field not being present means :val:`FALSE`. + +- :field:`$comment`: String. + A human-readable comment relevant in the context of the raw definition data. + These comments should normally not be shown to the end users. + Comments pertaining to the Property Definition that are relevant to end users should go into the field :field:`description`. + Formatting in the text SHOULD use Markdown using the format described in the `definition of the description field`_ of Property Definitions. + +An example of a Physical Unit Definition, including a defining relation that involves more than one other unit, is embedded in the example of a Property Definition in the appendix `Property Definition Example`_. + +Prefixes and constants +---------------------- + +Prefixes and constants are defined in OPTIMADE using nearly identical schemas as the one for units in `Physical Unit Definitions`_. +The only difference is that for prefixes: + +- The :field:`$schema` SHOULD be set to: "https://schemas.optimade.org/meta/v1.2/optimade/prefix_definition.json". + +- The subfield :field:`kind` of the field :field:`x-optimade-definition` MUST be :val:`prefix`. + +And for Constants: + +- The :field:`$schema` SHOULD be set to: "https://schemas.optimade.org/meta/v1.2/optimade/constant_definition.json". + +- The subfield :field:`kind` of the field :field:`x-optimade-definition` MUST be :val:`constant`. Unrecognized keys in property definitions ----------------------------------------- @@ -4002,3 +4313,103 @@ An example of the sparse layout for multidimensional lists with three aggregated [3,7,19, ["PARTIAL-DATA-REF", ["https://example.db.org/value2"]]] [4,5,19, [ [11, 110], ["PARTIAL-DATA-REF", ["https://example.db.org/value3"]], [550, 333]]] ["PARTIAL-DATA-END", [""]] + +Property Definition Example +--------------------------- + +This appendix provides a more complete example of a Property Definition in the format defined in `Property Definitions`_. +(Note: the description strings have been wrapped for readability only.) + +.. code:: jsonc + + { + "title": "Forces and atomic masses list", + "$id": "https://properties.example.com/v1.2.0/forces_and_masses", + "x-optimade-type": "list", + "x-optimade-property": { + "version": "1.2.0", + "property-format": "1.2", + "units": [ + { + "title": "Newton", + "symbol": "N", + "$id": "https://units.example.com/v1.2.0/N", + "description": "The newton SI unit of force, defined as 1 kg m/s^2 + using the 2019 redefinition of the SI base units.", + "standard": { + "name": "gnu units", + "version": "3.15", + "symbol": "newton" + }, + "defining-relation": { + "base-units": [ + { + "symbol": "kg", + "id": "https://units.example.com/v1.2.0/kg" + }, + { + "symbol": "m", + "id": "https://units.example.com/v1.2.0/m" + }, + { + "symbol": "s", + "id": "https://units.example.com/v1.2.0/s" + } + ], + "base-units-expression": "kg*m*s^-2" + } + }, + { + "title": "Dalton mass unit", + "symbol": "u", + "$id": "https://units.example.com/v1.2.0/u", + "description": "The dalton mass unit defined as 1/12 of the mass of an + unbound neutral atom of carbon-12 in its nuclear and + electronic ground state and at rest. Approximately + equal to $1.66053906660(50)*10^{-27}$ kg", + "standard": { + "name": "gnu units", + "version": "3.15", + "symbol": "atomicmassunit" + } + } + ] + }, + "type": ["array", "null"], + "description": "A list of forces and atomic masses", + "examples": [ + [{"force": 42.0, "mass": 28.0855}, {"force": 44.2, "mass": 15.9994}], + [{"force": 12.0, "mass": 24.3050}] + ], + "x-optimade-unit": "inapplicable", + "x-optimade-requirements": { + "support": "should", + "sortable": false, + "query-support": "none" + }, + "items": { + "title": "Force and atomic mass pair", + "x-optimade-type": "dictionary", + "description": "A dictionary containing a force and mass value", + "x-optimade-unit": "inapplicable", + "type": ["object"], + "properties": { + "force": { + "title": "Force", + "description": "A force value", + "x-optimade-type": "float", + "x-optimade-unit": "N", + "type": ["number"], + "examples": [42.0] + }, + "mass": { + "title": "Mass", + "description": "An atomic mass", + "x-optimade-type": "float", + "x-optimade-unit": "u", + "type": ["number"], + "examples": [15.9994] + } + } + } + } diff --git a/schemas/README.md b/schemas/README.md new file mode 100644 index 000000000..0be23383a --- /dev/null +++ b/schemas/README.md @@ -0,0 +1,273 @@ +# OPTIMADE Property Definitions and other schemas + +## OPTIMADE Property Definitions + +The section `Property Definitions` of the OPTIMADE specification defines an output format-agnostic way to declare properties that can be communicated via OPTIMADE to describe physical quantities and related data. +The format uses a subset of JSON Schema extended with OPTIMADE-specific identifiers, as allowed by the JSON Schema standard with identifiers prefixed with `x-optimade-`. +Hence, they can be used as schemas to validate data items using standard tools for JSON Schema. + +As described in more detail below, the OPTIMADE consortium publishes the current and past standardized sets of Property Definitions, with an index available at the following URL: + + - https://schemas.optimade.org/defs/ + +Anyone can, of course, publish their own sets of Property Definitions under any URL they like. +See [Creating database-specific definitions](#creating-database-specific-definitions) and [Contributing standard definitions to OPTIMADE](#contributing-standard-definitions-to-optimade) below for more information. + + +### Using the definitions + +The primary purpose of Property Definitions is to include them in the info endpoint responses in an implementation of the OPTIMADE API to describe precisely what data a database makes available. +For example, the URI IDs in the definitions may tell a client interacting with two databases that these databases communicate the same property in the same way. + +However, they can also be used in other contexts since they provide stable URI IDs that unambiguously define both a data format and the meaning of the data represented using that format. +These URIs are user-friendly in the sense they are resolvable URLs that give a human-readable definition of the defined entity. + +A researcher who uploads research data in, say, CSV format, to an online data repository (e.g., figshare) can use the Property Definition URIs and/or the JSON definition files to unambiguously communicate the format and content of the cells in the CSV file. +The definitions can be referenced, for example, by using the stable URIs as column headers in the CSV file or by using the definition names as column headers and giving the full URIs in accompanying information (e.g., an attached README file). +The full JSON-formatted definition files can also be included in the upload to make the upload completely self-contained. + +Instead of using individual URIs or definition files for each property, it is also possible to instead give the URI to an OPTIMADE entry type or standard definition, which groups multiple Property Definitions. +Since the JSON representations of the definitions always are non-referential (i.e., they contain all the information inline with no references to external definitions), it is safe to include a single JSON file for each entity being referenced (i.e., each property, entry type, or just the one file to reference any set of properties part of the OPTIMADE standard). + + +### Physical unit definitions + +As part of standardizing property definitions, OPTIMADE also includes stable URIs for physical units (see below). +Similarly to the possible use of Property Definitions outside of the OPTIMADE API, the unit definitions may be useful for referring to specific units in other contexts unambiguously. +For example, the stable URIs and/or the JSON definition files can be used in software to carefully communicate exactly the definition of the units of the values being returned. + + +## Property Definitions in the OPTIMADE repository + +The OPTIMADE repository: + +- https://github.com/Materials-Consortia/OPTIMADE + +contains a subdirectory `schemas/src/defs/`, followed by version number directories, under which source files from which the Property Definitions for the standard OPTIMADE properties are generated. +The primary source files for properties reside under `properties`. +They are organized with one subdirectory per category, of which we presently use: + +- `core` for the most core Property Definitions of the OPTIMADE API protocol. +- `optimade` for property definitions integral to the OPTIMADE standard. + +The `optimade` category is further partitioned using subdirectories according to OPTIMADE entry types (which correspond to endpoints in the REST API). +In addition, common definitions reused across the definition source files are sorted in a special subdirectory, `common`. + +These directories contain YAML-formatted property definition source files with `.yaml` extensions. +The source files are processed with the tool `tests/scripts/process_propdefs.py` into standards-conformant JSON files where inline copies of the corresponding definitions replace references to other files to adhere to the OPTIMADE standard format for Property Definitions. + +The following makefile target processes all Property Definitions (and other schema definitions, see below) into the output directory `schemas/output`: +``` +make schemas +``` +This command also generates documentation in markdown and HTML meant to be kept alongside the JSON definition files. +Once the generation is complete, the property definitions are found under `schemas/output/defs/` using the same directory structure as under `schemas/src`. + +You can browse the definitions by starting a browser with the generated index page, e.g.: +``` + firefox schemas/output/defs/index.html +``` +The generation places extension-less HTML files alongside the JSON definition files, which this index page links to. +This should work with most browsers. + +The `make schemas` commands take two optional parameters: + +- `schemas_html_pretty=true` creates html output that is arguably styled more nicely. +- `schemas_html_ext=true` creates files with `.html` extensions also for the HTML files that are meant to be served without extensions. + To generate the files with these extensions may be useful for some hosting solutions (e.g., GitHub pages) that automatically forward URLs without extensions. + Unless the files are served using such a solution, links to the definitions (e.g., from the index page) will be broken. + + +### Stable Property Definition URIs + +Properties standardized by OPTIMADE are given stable URIs that are URLs with the following format: +``` + https://schemas.optimade.org/defs//properties/// +``` +where: + +- `` is the minor version of the property on format "vMAJOR.MINOR", e.g. "v1.2", which is the minor OPTIMADE version in which the property was created or functionally changed. + Functionally changed means that the definition of the property is not just amended or clarified, but altered in a way that changes its interpretation. + In accordance with [semantic versioning](https://semver.org/), if only the minor version number is increased, the change MUST be backward compatible (e.g., the changed definition may add a non-mandatory field to a dictionary.) +- `` is a particular namespace for the Property Definitions. + The namespace `optimade` is used for property definitions integral to the OPTIMADE standard. +- `` is the OPTIMADE entry type that the property belongs to in OPTIMADE. +- `` is an identifier of lowercase Latin characters and the underscore character identifying the property. + +The URIs are URLs that can be retrieved to fetch a human-readable description of the definition in HTML format. +Every URI can also be suffixed with the extension `.json` to obtain the machine-readable JSON definition file. +These URIs are stable in the sense that they will always refer to a single specific definition. +However, the definition description that the URL resolves to may be amended and clarified in ways that do not functionally alter the definition. +When this happens, the version number in the definition file (in the field `x-optimade-definition -> version`) will be updated to match the corresponding release of OPTIMADE. +The URI (and thus the `$id` in the JSON definition) will be retained as long as the definition functionally remains the same. + +Historical versions of the definitions are retained unmodified under URLs using the following format: +``` + https://schemas.optimade.org/releases///properties/// +``` +where `` refers to a version string on the format "vMAJOR.MINOR.PATCH", e.g., "v1.2.0" referring to the full version number of the definition and `` still refers to the format "vMAJOR.MINOR". +These URLs collect all historical versions corresponding to the OPTIMADE release with the same version. +The double URL segments for versions may look redundant. +However, they take this form to keep a complete historical record that preserves any amendments and clarifications of the older definition files. + + +### Entry type definitions + +In OPTIMADE, an entry type consists of a set of property definitions. +Machine-readable definition of these entry types are provided analgous to the property definitions with stable URIs that are URLs and historical URLs with the following formats: +``` + https://schemas.optimade.org/defs//entrytypes// + https://schemas.optimade.org/releases//entrytypes// +``` +The corresponding source files are found in the OPTIMADE repository in `schemas/output/defs//entrytypes`. + + +### Standards definitions + +A set of entry types can be bundled to define a standard. +There is presently only a single standard published by OPTIMADE, which is provided with a stable URI and historical URL with the following formats: +``` + https://schemas.optimade.org/defs//standards/optimade + https://schemas.optimade.org/releases//standards/optimade +``` +(In the future, OPTIMADE may use this feature for implementations to be able to indicate the support of data beyond what is included in the core optimade standard.) + + +### Unit, constant, and prefix definitions + +To support the definition of properties, OPTIMADE also provide definition files for units, constants, and prefixes under the corresponding subdirectories of `schemas/src/defs/`. +The format for these definitions is described in the subsection `Physical Units in Property Definitions` of `Property Definitions` in the OPTIMADE specification. + +These are also given stable URIs using the following URLs: +``` + https://schemas.optimade.org/defs//units//// + https://schemas.optimade.org/defs//constants//// + https://schemas.optimade.org/defs//prefixes// +``` +They are distinguished according to the following conventions: + +- A unit defines a reference for expressing the magnitude of a quantity. +- A constant defines a known measurement, i.e., a specific dimensioned or dimensionless quantity, possibly along with a specified standard uncertainty. +- A prefix defines a dimensionless constant whose symbols are commonly used prepended to unit symbols to express a correspondingly rescaled unit. + +For example, the Bohr magneton *unit* (defined, e.g., in Rev. Mod. Phys 41, 375 (1969)) refers to the reference magnetic moment used to express a measure in multiples of the magnetic dipole moment of an electron which orbits an atom in the orbit of lowest energy in the Bohr model. +Various experimentally determined relations of this magnetic moment to the SI base units are represented as constants in OPTIMADE. +For example, one such Bohr magneton constant is the "2018 CODATA recommended value" published in Rev. Mod. Phys. 93, 025010 (2021), which is 9.2740100783(28) x 10^(-24) J/T. +Another is the "1973 CODATA recommended value" published in J. Phys. Chem. Ref. Data 2, 663 (1973), which is 9.274078(36) x 10^(-24) J/T. +The Bohr magneton constants can be used to express an approximate relationship between the Bohr magneton unit and the SI base units. + +Analogous to how property definitions are grouped into entry types and standards, unit, constant and prefix definitions are grouped into unit systems. +Unit systems are accssible using URIs and historical URLs with the following formats: +``` + https://schemas.optimade.org/defs//unitsystems// + https://schemas.optimade.org/releases//unitsystems// +``` + + +## Versioning of definitions + +The property definition URIs are meant to be kept as static as possible to improve interoperability. +The properties standardized by OPTIMADE use OPTIMADE version numbers. +The URIs omit the PATCH version number since it is not possible for a definition to functionally change between patch releases. + +The exact Property Definition files released as part of a specific version of OPTIMADE are found using the URLs with the version number on the format "vMAJOR.MINOR.PATCH". + +For example, a full list of the Property Definitions (including their version numbers) that are part of OPTIMADE release v1.2.0 is found at: +``` + https://schemas.optimade.org/properties/v1.2.0/index.html +``` + + +## JSON-Schema for OPTIMADE response validation + +The definition files under `schemas/src/defs` are used in combination with supplied [JSON Schema](https://json-schema.org/) schemas for [JSON:API](https://jsonapi.org/) to generate JSON Schema files that can validate OPTIMADE responses. +The corresponding source file is found in `schemas/src/json-schema//optimade.yaml`. +After generating the schemas with `make schemas`, the generated JSON Schema is found in `schemas/output/json-schema//optimade.json`. + + +## JSON-LD definitions + +The definition files under `schemas/src/defs` are also used to generate definition files for [JSON-LD](https://json-ld.org/) that can be used to annotate JSON:API-formatted responses from OPTIMADE so that the containing data is compatible with JSON-LD. +The corresponding source file is found under `schemas/src/json-ld/`. +After generating the schemas with `make schemas` the generated JSON-LD context and supporting files are found under `schemas/output/json-schema/`. + +The JSON-LD context is hosted at: +``` +https://schemas.optimade.org/json-ld//optimade.json +``` +For example, if a standard JSON:API-formatted OPTIMADE v1.2 response includes a top-level field `"@context": "https://schemas.optimade.org/json-ld/v1.2/optimade.json"`, the resulting response will be parsable using standard JSON-LD tools. +To generate JSON-LD contexts that include database-specific properties, see [Creating database-specific definitions](#creating_database_specific_definitions) below. + + +## Creating database-specific definitions + +Database providers may want to use the OPTIMADE repository framework for property definitions to generate their own definition files for database-specific properties. +There is a repository provided via OPTIMADE that contains example files for this: + +- https://github.com/Materials-Consortia/optimade-property-tools + +Please see the instructions provided in the README.md file of that repository. + + +## Contributing standard definitions to OPTIMADE + +To propose new definitions, or modifications to existing definitions: + +- Clone the OPTIMADE repository from GitHub. + +- Compose or edit the YAML files for the definitions under `schemas/src`. + The format is described in the OPTIMADE standard. + You can also look at the files in `schemas/example` as examples. + +- Execute `make schemas` to process them info `schemas/output`. + +If you want to integrate these definitions into the OPTIMADE standard: + +- Decide what namespace to use and ensure your definition files are placed in appropriate directories under `schemas/src/defs/`. + For proporties to be included in the central part of the OPTIMADE standard, use `optimade` for ``. + +- Edit the `$id` fields to use the corresponding locations under `https://schemas.optimade.org/`. + +- Make a GitHub pull request from your repository to the `develop` OPTIMADE repository branch. + +When the pull request is merged, the properties will become part of the next release of the OPTIMADE standard and published under `https://schemas.optimade.org/properties/` + + +## Updating schemas.optimade.org (for OPTIMADE maintainers) + +This is the workflow to update the schemas at `https://schemas.optimade.org/`: + +- Make sure to have cloned the OPTIMADE main and schema repositories. + +- Execute in the main OPTIMADE repository: + ``` + make clean + make schemas schemas_html_pretty=true schemas_html_ext=true + ``` + +- From the OPTIMADE repository execute the following command to see what files are about to be uploaded and modified in the schemas repository: + ``` + rsync -ia --no-t --checksum --dry-run schemas/output/ /path/to/repo/for/schemas/ | tests/scripts/filter_rsync_itemize_output.sh + ``` + Be careful to include the trailing slash on `schemas/output/`. + The arguments `--no-t --checksum` makes sure to only update files only if the contents differ (not if only the modification time is different because the files have been regenerated). + You should see a new release directory being uploaded and only modified files under `defs` for the definitions we have amended or clarified since the previous release, and the occasional update of a version symlink. + Check that the output matches your expectations. + +- If all looks well: + ``` + rsync -av --no-t --checksum schemas/output/ /path/to/repo/for/schemas/ + ``` + +- Check that the changes look reasonable also from the perspective of git: + ``` + cd /path/to/repo/for/schemas/ + git status + ``` + +- Stage, commit and push the changes to the schema repo: + ``` + git add . + git commit -m "Update schemas for release" + git push + ``` diff --git a/schemas/index_openapi_schema.json b/schemas/openapi/v1.1.0/index_openapi_schema.json similarity index 100% rename from schemas/index_openapi_schema.json rename to schemas/openapi/v1.1.0/index_openapi_schema.json diff --git a/schemas/openapi_schema.json b/schemas/openapi/v1.1.0/openapi_schema.json similarity index 100% rename from schemas/openapi_schema.json rename to schemas/openapi/v1.1.0/openapi_schema.json diff --git a/schemas/src/defs/v1.2/constants/codata/2018/electromagnetic/bohrmagneton.yaml b/schemas/src/defs/v1.2/constants/codata/2018/electromagnetic/bohrmagneton.yaml new file mode 100644 index 000000000..8eea4ca29 --- /dev/null +++ b/schemas/src/defs/v1.2/constants/codata/2018/electromagnetic/bohrmagneton.yaml @@ -0,0 +1,34 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/constant_definition" +$id: "https://schemas.optimade.org/defs/v1.2/constants/codata/2018/electromagnetic/bohrmagneton" +title: "Bohr magneton" +symbol: "bohrmagneton" +display-symbol: '\(\mu_B\)' +description: |- + The 2018 CODATA Bohr magneton constant is defined as "1 \(\mu_B\) = 9.274 010 0783(28)·10^-24 J·T^-1" with joule and tesla conforming to the 2019 redefinition of the SI derived units. +resources: + - relation: "2018 CODATA value Bohr magneton: source for relationship to joules*tesla^-1" + resource-id: "https://physics.nist.gov/cgi-bin/cuu/Value?mub" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Bohr_magneton" +defining-relation: + base-units: + - symbol: "J" + id: "https://schemas.optimade.org/defs/v1.2/units/si/2019/named/joule" + - symbol: "T" + id: "https://schemas.optimade.org/defs/v1.2/units/si/2019/named/tesla" + base-units-expression: "J*T^-1" + scale: + numerator: 92740100783 + exponent: -34 + standard_uncertainty: 0.00000000028E-24 +standard: + name: "codata" + year: 2018 + category: "electromagnetic" + symbol: '\(\mu_B\)' +x-optimade-definition: + label: "bohrmagneton_constant_codata_2018_electromagnetic" + kind: "constant" + format: "1.2" + version: "1.2.0" + name: "bohrmagneton" diff --git a/schemas/src/defs/v1.2/constants/codata/2018/electromagnetic/elementarycharge.yaml b/schemas/src/defs/v1.2/constants/codata/2018/electromagnetic/elementarycharge.yaml new file mode 100644 index 000000000..6e63b8dd2 --- /dev/null +++ b/schemas/src/defs/v1.2/constants/codata/2018/electromagnetic/elementarycharge.yaml @@ -0,0 +1,34 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/constant_definition" +$id: "https://schemas.optimade.org/defs/v1.2/constants/codata/2018/electromagnetic/elementarycharge" +title: "elementary charge" +symbol: "e" +display-symbol: '\(e\)' +description: |- + The CODATA 2018 value for the absolute value of the charge of the electron. + + This constant is described in Rev. Mod. Phys. 93, 025010 (2021) as "Absolute value of the charge of the electron and one of the seven defining constants of the SI". + It is exactly 1.602176634·10â»Â¹â¹ C following the 2019 redefinition of the SI base units. +resources: + - relation: "Definition in: E. Tiesinga, P. J. Mohr, D. B. Newell, and B. N. Taylor, Rev. Mod. Phys. 93, 025010 (2021)" + resource-id: "https://doi.org/10.1103/RevModPhys.93.025010" + - relation: "Wikipedia article describing the constant" + resource-id: "https://en.wikipedia.org/wiki/Elementary_charge" +defining-relation: + base-units: + - symbol: "C" + id: "https://schemas.optimade.org/defs/v1.2/units/si/2019/named/coulomb" + base-units-expression: "C" + scale: + numerator: 1602176634 + exponent: -28 +standard: + name: "codata" + year: 2018 + category: "electromagnetic" + symbol: "e" +x-optimade-definition: + label: "elementary_charge_constant_codata_2019_electromagnetic" + kind: "constant" + format: "1.2" + version: "1.2.0" + name: "elementarycharge" diff --git a/schemas/src/defs/v1.2/constants/math/basic/pi.yaml b/schemas/src/defs/v1.2/constants/math/basic/pi.yaml new file mode 100644 index 000000000..1f4377505 --- /dev/null +++ b/schemas/src/defs/v1.2/constants/math/basic/pi.yaml @@ -0,0 +1,23 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/constant_definition" +$id: "https://schemas.optimade.org/defs/v1.2/constants/math/basic/pi" +title: "pi" +symbol: "pi" +display-symbol: "Ï€" +description: |- + The ratio of a circle's circumference to its diameter. Approximately equal to 3.1415926. + + An early definition of Ï€ as the symbol for the ratio of a circle's circumference to its diameter goes back to William Jones, Synopsis Palmariorum Matheseos (1706), page 263. +resources: + - relation: "Definition in William Jones, Synopsis Palmariorum Matheseos (1706)" + resource-id: "https://archive.org/details/SynopsisPalmariorumMatheseosOrANewIntroductionToTheMathematics/page/n283/" + - relation: "Wikipedia article describing the constant" + resource-id: "https://en.wikipedia.org/wiki/Pi" +approximate-relations: + - scale: + value: 3.141592653589793238462643383279502884197169399375105820974944592307816406286208998628034825342117067982148086513282306647093844609550582231725359408128481117450284102701938521105559644622948954930381964428810975665933446128475648233786783165271201909145648566923460348610454326648213393607260249141273724587006606315588174881520920962829254091715364367892590360011330530548820466521384146951941511609433057270365759591953092186117381932611793105118548074462379962749567351885752724891227938183011949129833673362440656643086021394946395224737190702179860943702770539217176293176752384674818467669405132000568127145263560827785771342757789609173637178721468440901224953430146549585371050792279689258923542019956112129021960864034418159813629774771309960518707211349999998372978049951059731732816096318595024459455346908302642522308253344685035261931188171010003137838752886587533208381420617177669147303598253490428755468731159562863882353787593751957781857780532171226806613001927876611195909216420199 +x-optimade-definition: + label: "pi_constant_math_basic" + kind: "constant" + format: "1.2" + version: "1.2.0" + name: "pi" diff --git a/schemas/src/defs/v1.2/entrytypes/optimade/files.yaml b/schemas/src/defs/v1.2/entrytypes/optimade/files.yaml new file mode 100644 index 000000000..520560634 --- /dev/null +++ b/schemas/src/defs/v1.2/entrytypes/optimade/files.yaml @@ -0,0 +1,139 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/entrytype_definition" +$id: "https://schemas.optimade.org/defs/v1.2/entrytypes/optimade/files" +title: "files" +description: "The files entry type describes a file with metadata and a URL to retrieve it" +x-optimade-definition: + label: "files_entrytype_optimade" + kind: "entrytype" + format: "1.2" + version: "1.2.0" + name: "files" +type: object +properties: + id: + $$inherit: "/v1.2/properties/optimade/files/id" + x-optimade-requirements: + support: "must" + sortable: false + query-support: "all mandatory" + response-level: "always" + + type: + $$inherit: "/v1.2/properties/optimade/files/type" + x-optimade-requirements: + support: "must" + sortable: false + query-support: "all mandatory" + response-level: "always" + + immutable_id: + $$inherit: "/v1.2/properties/optimade/files/immutable_id" + x-optimade-requirements: + support: "may" + sortable: false + query-support: "all mandatory" + response-level: "may" + + last_modified: + $$inherit: "/v1.2/properties/optimade/files/last_modified" + x-optimade-requirements: + support: "should" + sortable: false + query-support: "all mandatory" + response-level: "must" + + url: + $$inherit: "/v1.2/properties/optimade/files/url" + x-optimade-requirements: + support: "must" + sortable: false + query-support: "none" + response-level: "must" + + url_stable_until: + $$inherit: "/v1.2/properties/optimade/files/url_stable_until" + x-optimade-requirements: + support: "may" + sortable: false + query-support: "none" + response-level: "may" + + name: + $$inherit: "/v1.2/properties/optimade/files/name" + x-optimade-requirements: + support: "should" + sortable: false + query-support: "none" + response-level: "may" + + size: + $$inherit: "/v1.2/properties/optimade/files/size" + x-optimade-requirements: + support: "may" + sortable: false + query-support: "none" + response-level: "may" + + media_type: + $$inherit: "/v1.2/properties/optimade/files/media_type" + x-optimade-requirements: + support: "may" + sortable: false + query-support: "none" + response-level: "may" + + version: + $$inherit: "/v1.2/properties/optimade/files/version" + x-optimade-requirements: + support: "may" + sortable: false + query-support: "none" + response-level: "may" + + modification_timestamp: + $$inherit: "/v1.2/properties/optimade/files/modification_timestamp" + x-optimade-requirements: + support: "may" + sortable: false + query-support: "none" + response-level: "may" + + description: + $$inherit: "/v1.2/properties/optimade/files/description" + x-optimade-requirements: + support: "may" + sortable: false + query-support: "none" + response-level: "may" + + checksums: + $$inherit: "/v1.2/properties/optimade/files/checksums" + x-optimade-requirements: + support: "may" + sortable: false + query-support: "none" + response-level: "may" + + atime: + $$inherit: "/v1.2/properties/optimade/files/atime" + x-optimade-requirements: + support: "may" + sortable: false + query-support: "none" + response-level: "may" + + ctime: + $$inherit: "/v1.2/properties/optimade/files/ctime" + x-optimade-requirements: + support: "may" + sortable: false + query-support: "none" + response-level: "may" + + mtime: + $$inherit: "/v1.2/properties/optimade/files/mtime" + x-optimade-requirements: + support: "may" + sortable: false + query-support: "none" + response-level: "may" diff --git a/schemas/src/defs/v1.2/entrytypes/optimade/references.yaml b/schemas/src/defs/v1.2/entrytypes/optimade/references.yaml new file mode 100644 index 000000000..d4ff25c80 --- /dev/null +++ b/schemas/src/defs/v1.2/entrytypes/optimade/references.yaml @@ -0,0 +1,251 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/entrytype_definition" +$id: "https://schemas.optimade.org/defs/v1.2/entrytypes/optimade/references" +title: "references" +description: "The references entry type describes a reference" +x-optimade-definition: + label: "references_entrytype_optimade" + kind: "entrytype" + format: "1.2" + version: "1.2.0" + name: "references" +type: object +properties: + id: + $$inherit: "/v1.2/properties/optimade/references/id" + x-optimade-requirements: + support: "must" + sortable: false + query-support: "all mandatory" + response-level: "always" + + type: + $$inherit: "/v1.2/properties/optimade/references/type" + x-optimade-requirements: + support: "must" + sortable: false + query-support: "all mandatory" + response-level: "always" + + immutable_id: + $$inherit: "/v1.2/properties/optimade/references/immutable_id" + x-optimade-requirements: + support: "may" + sortable: false + query-support: "all mandatory" + response-level: "may" + + last_modified: + $$inherit: "/v1.2/properties/optimade/references/last_modified" + x-optimade-requirements: + support: "should" + sortable: false + query-support: "all mandatory" + response-level: "must" + + address: + $$inherit: "/v1.2/properties/optimade/references/address" + x-optimade-requirements: + support: "may" + sortable: false + query-support: "none" + response-level: "may" + + annote: + $$inherit: "/v1.2/properties/optimade/references/annote" + x-optimade-requirements: + support: "may" + sortable: false + query-support: "none" + response-level: "may" + + booktitle: + $$inherit: "/v1.2/properties/optimade/references/booktitle" + x-optimade-requirements: + support: "may" + sortable: false + query-support: "none" + response-level: "may" + + chapter: + $$inherit: "/v1.2/properties/optimade/references/chapter" + x-optimade-requirements: + support: "may" + sortable: false + query-support: "none" + response-level: "may" + + crossref: + $$inherit: "/v1.2/properties/optimade/references/crossref" + x-optimade-requirements: + support: "may" + sortable: false + query-support: "none" + response-level: "may" + + edition: + $$inherit: "/v1.2/properties/optimade/references/edition" + x-optimade-requirements: + support: "may" + sortable: false + query-support: "none" + response-level: "may" + + howpublished: + $$inherit: "/v1.2/properties/optimade/references/howpublished" + x-optimade-requirements: + support: "may" + sortable: false + query-support: "none" + response-level: "may" + + institution: + $$inherit: "/v1.2/properties/optimade/references/institution" + x-optimade-requirements: + support: "may" + sortable: false + query-support: "none" + response-level: "may" + + journal: + $$inherit: "/v1.2/properties/optimade/references/journal" + x-optimade-requirements: + support: "may" + sortable: false + query-support: "none" + response-level: "may" + + key: + $$inherit: "/v1.2/properties/optimade/references/key" + x-optimade-requirements: + support: "may" + sortable: false + query-support: "none" + response-level: "may" + + month: + $$inherit: "/v1.2/properties/optimade/references/month" + x-optimade-requirements: + support: "may" + sortable: false + query-support: "none" + response-level: "may" + + note: + $$inherit: "/v1.2/properties/optimade/references/note" + x-optimade-requirements: + support: "may" + sortable: false + query-support: "none" + response-level: "may" + + number: + $$inherit: "/v1.2/properties/optimade/references/number" + x-optimade-requirements: + support: "may" + sortable: false + query-support: "none" + response-level: "may" + + organization: + $$inherit: "/v1.2/properties/optimade/references/organization" + x-optimade-requirements: + support: "may" + sortable: false + query-support: "none" + response-level: "may" + + pages: + $$inherit: "/v1.2/properties/optimade/references/pages" + x-optimade-requirements: + support: "may" + sortable: false + query-support: "none" + response-level: "may" + + publisher: + $$inherit: "/v1.2/properties/optimade/references/publisher" + x-optimade-requirements: + support: "may" + sortable: false + query-support: "none" + response-level: "may" + + school: + $$inherit: "/v1.2/properties/optimade/references/school" + x-optimade-requirements: + support: "may" + sortable: false + query-support: "none" + response-level: "may" + + series: + $$inherit: "/v1.2/properties/optimade/references/series" + x-optimade-requirements: + support: "may" + sortable: false + query-support: "none" + response-level: "may" + + title: + $$inherit: "/v1.2/properties/optimade/references/title" + x-optimade-requirements: + support: "may" + sortable: false + query-support: "none" + response-level: "may" + + volume: + $$inherit: "/v1.2/properties/optimade/references/volume" + x-optimade-requirements: + support: "may" + sortable: false + query-support: "none" + response-level: "may" + + year: + $$inherit: "/v1.2/properties/optimade/references/year" + x-optimade-requirements: + support: "may" + sortable: false + query-support: "none" + response-level: "may" + + bib_type: + $$inherit: "/v1.2/properties/optimade/references/bib_type" + x-optimade-requirements: + support: "may" + sortable: false + query-support: "none" + response-level: "may" + + authors: + $$inherit: "/v1.2/properties/optimade/references/authors" + x-optimade-requirements: + support: "may" + sortable: false + query-support: "none" + response-level: "may" + + editors: + $$inherit: "/v1.2/properties/optimade/references/editors" + x-optimade-requirements: + support: "may" + sortable: false + query-support: "none" + response-level: "may" + + doi: + $$inherit: "/v1.2/properties/optimade/references/doi" + x-optimade-requirements: + support: "may" + sortable: false + query-support: "none" + response-level: "may" + + url: + $$inherit: "/v1.2/properties/optimade/references/url" + x-optimade-requirements: + support: "may" + sortable: false + query-support: "none" + response-level: "may" diff --git a/schemas/src/defs/v1.2/entrytypes/optimade/structures.yaml b/schemas/src/defs/v1.2/entrytypes/optimade/structures.yaml new file mode 100644 index 000000000..bc6b84753 --- /dev/null +++ b/schemas/src/defs/v1.2/entrytypes/optimade/structures.yaml @@ -0,0 +1,213 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/entrytype_definition" +$id: "https://schemas.optimade.org/defs/v1.2/entrytypes/optimade/structures" +title: "structures" +description: "The structures entry type describes a crystal structure via its unit cell" +x-optimade-definition: + label: "structures_entrytype_optimade" + kind: "entrytype" + format: "1.2" + version: "1.2.0" + name: "structures" +type: object +properties: + id: + $$inherit: "/v1.2/properties/optimade/structures/id" + x-optimade-requirements: + support: "must" + sortable: false + query-support: "all mandatory" + response-level: "always" + + type: + $$inherit: "/v1.2/properties/optimade/structures/type" + x-optimade-requirements: + support: "must" + sortable: false + query-support: "all mandatory" + response-level: "always" + + immutable_id: + $$inherit: "/v1.2/properties/optimade/structures/immutable_id" + x-optimade-requirements: + support: "may" + sortable: false + query-support: "all mandatory" + response-level: "may" + + last_modified: + $$inherit: "/v1.2/properties/optimade/structures/last_modified" + x-optimade-requirements: + support: "should" + sortable: false + query-support: "all mandatory" + response-level: "must" + + elements: + $$inherit: "/v1.2/properties/optimade/structures/elements" + x-optimade-requirements: + support: "should" + sortable: false + query-support: "all mandatory" + response-level: "may" + + nelements: + $$inherit: "/v1.2/properties/optimade/structures/nelements" + x-optimade-requirements: + support: "should" + sortable: false + query-support: "all mandatory" + response-level: "may" + + elements_ratios: + $$inherit: "/v1.2/properties/optimade/structures/elements_ratios" + x-optimade-requirements: + support: "should" + sortable: false + query-support: "all mandatory" + response-level: "may" + + chemical_formula_descriptive: + $$inherit: "/v1.2/properties/optimade/structures/chemical_formula_descriptive" + x-optimade-requirements: + support: "should" + sortable: false + query-support: "all mandatory" + response-level: "may" + + chemical_formula_reduced: + $$inherit: "/v1.2/properties/optimade/structures/chemical_formula_reduced" + x-optimade-requirements: + support: "should" + sortable: false + query-support: "equality only" + response-level: "may" + $comment: "If the database store chemical formulas in another format, it may not be possible to search efficiently for anything except equality." + + chemical_formula_hill: + $$inherit: "/v1.2/properties/optimade/structures/chemical_formula_hill" + x-optimade-requirements: + support: "may" + sortable: false + response-level: "may" + query-support: "none" + + chemical_formula_anonymous: + $$inherit: "/v1.2/properties/optimade/structures/chemical_formula_anonymous" + x-optimade-requirements: + support: "should" + sortable: false + query-support: "equality only" + response-level: "may" + $comment: "If the database store chemical formulas in another format, it may not be possible to search efficiently for anything except equality." + + dimension_types: + $$inherit: "/v1.2/properties/optimade/structures/dimension_types" + x-optimade-requirements: + support: "should" + sortable: false + response-level: "may" + query-support: "none" + + nperiodic_dimensions: + $$inherit: "/v1.2/properties/optimade/structures/nperiodic_dimensions" + x-optimade-requirements: + support: "should" + sortable: false + response-level: "may" + query-support: "all mandatory" + + lattice_vectors: + $$inherit: "/v1.2/properties/optimade/structures/lattice_vectors" + x-optimade-requirements: + support: "should" + sortable: false + response-level: "may" + query-support: "none" + + space_group_symmetry_operations_xyz: + $$inherit: "/v1.2/properties/optimade/structures/space_group_symmetry_operations_xyz" + x-optimade-requirements: + support: "may" + sortable: false + response-level: "may" + query-support: "none" + + space_group_symbol_hall: + $$inherit: "/v1.2/properties/optimade/structures/space_group_symbol_hall" + x-optimade-requirements: + support: "may" + sortable: false + response-level: "may" + query-support: "none" + + space_group_symbol_hermann_mauguin: + $$inherit: "/v1.2/properties/optimade/structures/space_group_symbol_hermann_mauguin" + x-optimade-requirements: + support: "may" + sortable: false + response-level: "may" + query-support: "none" + + space_group_symbol_hermann_mauguin_extended: + $$inherit: "/v1.2/properties/optimade/structures/space_group_symbol_hermann_mauguin_extended" + x-optimade-requirements: + support: "may" + sortable: false + response-level: "may" + query-support: "none" + + space_group_it_number: + $$inherit: "/v1.2/properties/optimade/structures/space_group_it_number" + x-optimade-requirements: + support: "may" + sortable: false + response-level: "may" + query-support: "none" + + cartesian_site_positions: + $$inherit: "/v1.2/properties/optimade/structures/cartesian_site_positions" + x-optimade-requirements: + support: "should" + sortable: false + response-level: "may" + query-support: "none" + + nsites: + $$inherit: "/v1.2/properties/optimade/structures/nsites" + x-optimade-requirements: + support: "should" + sortable: false + response-level: "may" + query-support: "all mandatory" + + species_at_sites: + $$inherit: "/v1.2/properties/optimade/structures/species_at_sites" + x-optimade-requirements: + support: "should" + sortable: false + response-level: "may" + query-support: "none" + + species: + $$inherit: "/v1.2/properties/optimade/structures/species" + x-optimade-requirements: + support: "should" + sortable: false + response-level: "may" + query-support: "none" + + assemblies: + $$inherit: "/v1.2/properties/optimade/structures/assemblies" + x-optimade-requirements: + support: "may" + sortable: false + response-level: "may" + query-support: "none" + + structure_features: + $$inherit: "/v1.2/properties/optimade/structures/structure_features" + x-optimade-requirements: + support: "must" + sortable: false + response-level: "may" + query-support: "all mandatory" diff --git a/schemas/src/defs/v1.2/prefixes/si/atto.yaml b/schemas/src/defs/v1.2/prefixes/si/atto.yaml new file mode 100644 index 000000000..b23e2f630 --- /dev/null +++ b/schemas/src/defs/v1.2/prefixes/si/atto.yaml @@ -0,0 +1,22 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/prefix_definition" +$id: "https://schemas.optimade.org/defs/v1.2/prefixes/si/atto" +title: "atto" +symbol: "a" +display-symbol: "a" +description: "The atto SI prefix defined as a dimensionless multiple of 10â»Â¹â¸, defined at the 12th CGPM Meeting in 1964, resolution 8." +resources: + - relation: "Definition in the 12th CGPM Meeting in 1964, resolution 8" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/12-1964/resolution-8" + - relation: "Wikipedia article describing the SI prefixes" + resource-id: "https://en.wikipedia.org/wiki/Metric_prefix" +defining-relation: + base-units: [] + base-units-expression: "" + scale: + exponent: -18 +x-optimade-definition: + label: "atto_prefix_si" + kind: "prefix" + format: "1.2" + version: "1.2.0" + name: "atto" diff --git a/schemas/src/defs/v1.2/prefixes/si/centi.yaml b/schemas/src/defs/v1.2/prefixes/si/centi.yaml new file mode 100644 index 000000000..2c13ea515 --- /dev/null +++ b/schemas/src/defs/v1.2/prefixes/si/centi.yaml @@ -0,0 +1,22 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/prefix_definition" +$id: "https://schemas.optimade.org/defs/v1.2/prefixes/si/centi" +title: "centi" +symbol: "c" +display-symbol: "c" +description: "The centi SI prefix defined as a dimensionless multiple of 10â»Â², adopted into SI at its creation at the 11th CGPM Meeting in 1960, resolution 12." +resources: + - relation: "Definition in the 11th CGPM Meeting in 1960, resolution 12" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/11-1960/resolution-12" + - relation: "Wikipedia article describing the prefix" + resource-id: "https://en.wikipedia.org/wiki/Centi-" +defining-relation: + base-units: [] + base-units-expression: "" + scale: + exponent: -2 +x-optimade-definition: + label: "centi_prefix_si" + kind: "prefix" + format: "1.2" + version: "1.2.0" + name: "centi" diff --git a/schemas/src/defs/v1.2/prefixes/si/deca.yaml b/schemas/src/defs/v1.2/prefixes/si/deca.yaml new file mode 100644 index 000000000..47c56a037 --- /dev/null +++ b/schemas/src/defs/v1.2/prefixes/si/deca.yaml @@ -0,0 +1,22 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/prefix_definition" +$id: "https://schemas.optimade.org/defs/v1.2/prefixes/si/deca" +title: "deca" +symbol: "da" +display-symbol: "da" +description: "The deca SI prefix defined as a dimensionless multiple of 10, adopted into SI at its creation at the 11th CGPM Meeting in 1960, resolution 12." +resources: + - relation: "Definition in the 11th CGPM Meeting in 1960, resolution 12" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/11-1960/resolution-12" + - relation: "Wikipedia article describing the prefix" + resource-id: "https://en.wikipedia.org/wiki/Deca-" +defining-relation: + base-units: [] + base-units-expression: "" + scale: + exponent: 1 +x-optimade-definition: + label: "deca_prefix_si" + kind: "prefix" + format: "1.2" + version: "1.2.0" + name: "deca" diff --git a/schemas/src/defs/v1.2/prefixes/si/deci.yaml b/schemas/src/defs/v1.2/prefixes/si/deci.yaml new file mode 100644 index 000000000..6bca836ca --- /dev/null +++ b/schemas/src/defs/v1.2/prefixes/si/deci.yaml @@ -0,0 +1,22 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/prefix_definition" +$id: "https://schemas.optimade.org/defs/v1.2/prefixes/si/deci" +title: "deci" +symbol: "d" +display-symbol: "d" +description: "The deci SI prefix defined as a dimensionless multiple of 10â»Â¹, adopted into SI at its creation at the 11th CGPM Meeting in 1960, resolution 12." +resources: + - relation: "Definition in the 11th CGPM Meeting in 1960, resolution 12" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/11-1960/resolution-12" + - relation: "Wikipedia article describing the prefix" + resource-id: "https://en.wikipedia.org/wiki/Deci-" +defining-relation: + base-units: [] + base-units-expression: "" + scale: + exponent: -1 +x-optimade-definition: + label: "deci_prefix_si" + kind: "prefix" + format: "1.2" + version: "1.2.0" + name: "deci" diff --git a/schemas/src/defs/v1.2/prefixes/si/exa.yaml b/schemas/src/defs/v1.2/prefixes/si/exa.yaml new file mode 100644 index 000000000..27db8ff4a --- /dev/null +++ b/schemas/src/defs/v1.2/prefixes/si/exa.yaml @@ -0,0 +1,22 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/prefix_definition" +$id: "https://schemas.optimade.org/defs/v1.2/prefixes/si/exa" +title: "exa" +symbol: "E" +display-symbol: "E" +description: "The exa SI prefix defined as a dimensionless multiple of 10¹â¸, defined at the 15th CGPM Meeting in 1975, resolution 10." +resources: + - relation: "Definition in the 15th CGPM Meeting in 1975, resolution 10" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/15-1975/resolution-10" + - relation: "Wikipedia article describing SI prefixes" + resource-id: "https://en.wikipedia.org/wiki/Metric_prefix" +defining-relation: + base-units: [] + base-units-expression: "" + scale: + exponent: 18 +x-optimade-definition: + label: "exa_prefix_si" + kind: "prefix" + format: "1.2" + version: "1.2.0" + name: "exa" diff --git a/schemas/src/defs/v1.2/prefixes/si/exbi.yaml b/schemas/src/defs/v1.2/prefixes/si/exbi.yaml new file mode 100644 index 000000000..120e5b1cf --- /dev/null +++ b/schemas/src/defs/v1.2/prefixes/si/exbi.yaml @@ -0,0 +1,23 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/prefix_definition" +$id: "https://schemas.optimade.org/defs/v1.2/prefixes/si/exbi" +title: "exbi" +symbol: "Ei" +display-symbol: "Ei" +description: "The exbi prefix as a dimensionless multiple of 2â¶â° is one of a set of recommended prefixes in the International System of Units (SI), 9th Edition for referring to powers of 2." +resources: + - relation: "Definition in the International System of Units (SI), 9th Edition" + resource-id: "https://www.bipm.org/en/publications/si-brochure" + - relation: "Wikipedia article describing SI prefixes" + resource-id: "https://en.wikipedia.org/wiki/Metric_prefix" +defining-relation: + base-units: [] + base-units-expression: "" + scale: + base: 2 + exponent: 60 +x-optimade-definition: + label: "exbi_prefix_si" + kind: "prefix" + format: "1.2" + version: "1.2.0" + name: "exbi" diff --git a/schemas/src/defs/v1.2/prefixes/si/femto.yaml b/schemas/src/defs/v1.2/prefixes/si/femto.yaml new file mode 100644 index 000000000..3fe321000 --- /dev/null +++ b/schemas/src/defs/v1.2/prefixes/si/femto.yaml @@ -0,0 +1,22 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/prefix_definition" +$id: "https://schemas.optimade.org/defs/v1.2/prefixes/si/femto" +title: "femto" +symbol: "f" +display-symbol: "f" +description: "The femto SI prefix defined as a dimensionless multiple of 10â»Â¹âµ, defined at the 12th CGPM Meeting in 1964, resolution 8." +resources: + - relation: "Definition in the 12th CGPM Meeting in 1964, resolution 8" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/12-1964/resolution-8" + - relation: "Wikipedia article describing SI prefixes" + resource-id: "https://en.wikipedia.org/wiki/Metric_prefix" +defining-relation: + base-units: [] + base-units-expression: "" + scale: + exponent: -15 +x-optimade-definition: + label: "femto_prefix_si" + kind: "prefix" + format: "1.2" + version: "1.2.0" + name: "femto" diff --git a/schemas/src/defs/v1.2/prefixes/si/gibi.yaml b/schemas/src/defs/v1.2/prefixes/si/gibi.yaml new file mode 100644 index 000000000..94d33b8cd --- /dev/null +++ b/schemas/src/defs/v1.2/prefixes/si/gibi.yaml @@ -0,0 +1,23 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/prefix_definition" +$id: "https://schemas.optimade.org/defs/v1.2/prefixes/si/gibi" +title: "gibi" +symbol: "Gi" +display-symbol: "Gi" +description: "The gibi prefix as a dimensionless multiple of 2³Ⱐis one of a set of recommended prefixes in the International System of Units (SI), 9th Edition for referring to powers of 2." +resources: + - relation: "Definition in the International System of Units (SI), 9th Edition" + resource-id: "https://www.bipm.org/en/publications/si-brochure" + - relation: "Wikipedia article describing SI prefixes" + resource-id: "https://en.wikipedia.org/wiki/Metric_prefix" +defining-relation: + base-units: [] + base-units-expression: "" + scale: + base: 2 + exponent: 30 +x-optimade-definition: + label: "gibi_prefix_si" + kind: "prefix" + format: "1.2" + version: "1.2.0" + name: "gibi" diff --git a/schemas/src/defs/v1.2/prefixes/si/giga.yaml b/schemas/src/defs/v1.2/prefixes/si/giga.yaml new file mode 100644 index 000000000..74b4d00fb --- /dev/null +++ b/schemas/src/defs/v1.2/prefixes/si/giga.yaml @@ -0,0 +1,22 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/prefix_definition" +$id: "https://schemas.optimade.org/defs/v1.2/prefixes/si/giga" +title: "giga" +symbol: "G" +display-symbol: "G" +description: "The giga SI prefix defined as a dimensionless multiple of 10â¹, adopted into SI at its creation at the 11th CGPM Meeting in 1960, resolution 12." +resources: + - relation: "Definition in the 11th CGPM Meeting in 1960, resolution 12" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/11-1960/resolution-12" + - relation: "Wikipedia article describing the prefix" + resource-id: "https://en.wikipedia.org/wiki/Giga-" +defining-relation: + base-units: [] + base-units-expression: "" + scale: + exponent: 9 +x-optimade-definition: + label: "giga_prefix_si" + kind: "prefix" + format: "1.2" + version: "1.2.0" + name: "giga" diff --git a/schemas/src/defs/v1.2/prefixes/si/hecto.yaml b/schemas/src/defs/v1.2/prefixes/si/hecto.yaml new file mode 100644 index 000000000..68da86513 --- /dev/null +++ b/schemas/src/defs/v1.2/prefixes/si/hecto.yaml @@ -0,0 +1,22 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/prefix_definition" +$id: "https://schemas.optimade.org/defs/v1.2/prefixes/si/hecto" +title: "hecto" +symbol: "h" +display-symbol: "h" +description: "The hecto SI prefix defined as a dimensionless multiple of 10², adopted into SI at its creation at the 11th CGPM Meeting in 1960, resolution 12." +resources: + - relation: "Definition in the 11th CGPM Meeting in 1960, resolution 12" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/11-1960/resolution-12" + - relation: "Wikipedia article describing the prefix" + resource-id: "https://en.wikipedia.org/wiki/Hecto-" +defining-relation: + base-units: [] + base-units-expression: "" + scale: + exponent: 2 +x-optimade-definition: + label: "hecto_prefix_si" + kind: "prefix" + format: "1.2" + version: "1.2.0" + name: "hecto" diff --git a/schemas/src/defs/v1.2/prefixes/si/kibi.yaml b/schemas/src/defs/v1.2/prefixes/si/kibi.yaml new file mode 100644 index 000000000..c940a1b5b --- /dev/null +++ b/schemas/src/defs/v1.2/prefixes/si/kibi.yaml @@ -0,0 +1,23 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/prefix_definition" +$id: "https://schemas.optimade.org/defs/v1.2/prefixes/si/kibi" +title: "kibi" +symbol: "Ki" +display-symbol: "Ki" +description: "The kibi prefix as a dimensionless multiple of 2¹Ⱐ= 1024 is one of a set of recommended prefixes in the International System of Units (SI), 9th Edition for referring to powers of 2." +resources: + - relation: "Definition in the International System of Units (SI), 9th Edition" + resource-id: "https://www.bipm.org/en/publications/si-brochure" + - relation: "Wikipedia article describing SI prefixes" + resource-id: "https://en.wikipedia.org/wiki/Metric_prefix" +defining-relation: + base-units: [] + base-units-expression: "" + scale: + base: 2 + exponent: 10 +x-optimade-definition: + label: "kibi_prefix_si" + kind: "prefix" + format: "1.2" + version: "1.2.0" + name: "kibi" diff --git a/schemas/src/defs/v1.2/prefixes/si/kilo.yaml b/schemas/src/defs/v1.2/prefixes/si/kilo.yaml new file mode 100644 index 000000000..5b5909ca2 --- /dev/null +++ b/schemas/src/defs/v1.2/prefixes/si/kilo.yaml @@ -0,0 +1,23 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/prefix_definition" +$id: "https://schemas.optimade.org/defs/v1.2/prefixes/si/kilo" +title: "kilo" +symbol: "k" +display-symbol: "k" +description: "The kilo SI prefix defined as a dimensionless multiple of 10³, adopted into SI at its creation at the 11th CGPM Meeting in 1960, resolution 12." +resources: + - relation: "Definition in the 11th CGPM Meeting in 1960, resolution 12" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/11-1960/resolution-12" + - relation: "Wikipedia article describing the prefix" + resource-id: "https://en.wikipedia.org/wiki/Kilo-" +defining-relation: + base-units: [] + base-units-expression: "" + scale: + exponent: 3 +x-optimade-definition: + label: "kilo_prefix_si" + kind: "prefix" + format: "1.2" + version: "1.2.0" + name: "kilo" + diff --git a/schemas/src/defs/v1.2/prefixes/si/mebi.yaml b/schemas/src/defs/v1.2/prefixes/si/mebi.yaml new file mode 100644 index 000000000..7982901c5 --- /dev/null +++ b/schemas/src/defs/v1.2/prefixes/si/mebi.yaml @@ -0,0 +1,23 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/prefix_definition" +$id: "https://schemas.optimade.org/defs/v1.2/prefixes/si/mebi" +title: "mebi" +symbol: "Mi" +display-symbol: "Mi" +description: "The mebi prefix as a dimensionless multiple of 2²Ⱐis one of a set of recommended prefixes in the International System of Units (SI), 9th Edition for referring to powers of 2." +resources: + - relation: "Definition in the International System of Units (SI), 9th Edition" + resource-id: "https://www.bipm.org/en/publications/si-brochure" + - relation: "Wikipedia article describing SI prefixes" + resource-id: "https://en.wikipedia.org/wiki/Metric_prefix" +defining-relation: + base-units: [] + base-units-expression: "" + scale: + base: 2 + exponent: 20 +x-optimade-definition: + label: "mebi_prefix_si" + kind: "prefix" + format: "1.2" + version: "1.2.0" + name: "mebi" diff --git a/schemas/src/defs/v1.2/prefixes/si/mega.yaml b/schemas/src/defs/v1.2/prefixes/si/mega.yaml new file mode 100644 index 000000000..fc31c8fed --- /dev/null +++ b/schemas/src/defs/v1.2/prefixes/si/mega.yaml @@ -0,0 +1,23 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/prefix_definition" +$id: "https://schemas.optimade.org/defs/v1.2/prefixes/si/mega" +title: "mega" +symbol: "M" +display-symbol: "M" +description: "The mega SI prefix defined as a dimensionless multiple of 10â¶, adopted into SI at its creation at the 11th CGPM Meeting in 1960, resolution 12." +resources: + - relation: "Definition in the 11th CGPM Meeting in 1960, resolution 12" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/11-1960/resolution-12" + - relation: "Wikipedia article describing the prefix" + resource-id: "https://en.wikipedia.org/wiki/Mega-" +defining-relation: + base-units: [] + base-units-expression: "" + scale: + exponent: 6 +x-optimade-definition: + label: "mega_prefix_si" + kind: "prefix" + format: "1.2" + version: "1.2.0" + name: "mega" + diff --git a/schemas/src/defs/v1.2/prefixes/si/micro.yaml b/schemas/src/defs/v1.2/prefixes/si/micro.yaml new file mode 100644 index 000000000..58b62e506 --- /dev/null +++ b/schemas/src/defs/v1.2/prefixes/si/micro.yaml @@ -0,0 +1,28 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/prefix_definition" +$id: "https://schemas.optimade.org/defs/v1.2/prefixes/si/micro" +title: "micro" +symbol: "mc" +display-symbol: "μ" +description: |- + The micro SI prefix defined as a dimensionless multiple of 10â»â¶, adopted into SI at its creation at the 11th CGPM Meeting in 1960, resolution 12. + + The micro SI prefix is the only one not using a Latin symbol. + Based on the recommendation of the ISMP List of Error-Prone Abbreviations, Symbols, and Dose Designations to use mcg in place of μg, i.e., mc is used as the symbol for micro using the Latin alphabet. +resources: + - relation: "Definition in the 11th CGPM Meeting in 1960, resolution 12" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/11-1960/resolution-12" + - relation: "Use of mc to represent micro in the ISMP List of Error-Prone Abbreviations, Symbols, and Dose Designations" + resource-id: "https://www.ismp.org/recommendations/error-prone-abbreviations-list" + - relation: "Wikipedia article describing the prefix" + resource-id: "https://en.wikipedia.org/wiki/Micro-" +defining-relation: + base-units: [] + base-units-expression: "" + scale: + exponent: -6 +x-optimade-definition: + label: "micro_prefix_si" + kind: "prefix" + format: "1.2" + version: "1.2.0" + name: "micro" diff --git a/schemas/src/defs/v1.2/prefixes/si/milli.yaml b/schemas/src/defs/v1.2/prefixes/si/milli.yaml new file mode 100644 index 000000000..c003d8a3a --- /dev/null +++ b/schemas/src/defs/v1.2/prefixes/si/milli.yaml @@ -0,0 +1,22 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/prefix_definition" +$id: "https://schemas.optimade.org/defs/v1.2/prefixes/si/milli" +title: "milli" +symbol: "m" +display-symbol: "m" +description: "The milli SI prefix defined as a dimensionless multiple of 10â»Â³, adopted into SI at its creation at the 11th CGPM Meeting in 1960, resolution 12." +resources: + - relation: "Definition in the 11th CGPM Meeting in 1960, resolution 12" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/11-1960/resolution-12" + - relation: "Wikipedia article describing the prefix" + resource-id: "https://en.wikipedia.org/wiki/Milli-" +defining-relation: + base-units: [] + base-units-expression: "" + scale: + exponent: -3 +x-optimade-definition: + label: "milli_prefix_si" + kind: "prefix" + format: "1.2" + version: "1.2.0" + name: "milli" diff --git a/schemas/src/defs/v1.2/prefixes/si/nano.yaml b/schemas/src/defs/v1.2/prefixes/si/nano.yaml new file mode 100644 index 000000000..0217fbda7 --- /dev/null +++ b/schemas/src/defs/v1.2/prefixes/si/nano.yaml @@ -0,0 +1,22 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/prefix_definition" +$id: "https://schemas.optimade.org/defs/v1.2/prefixes/si/nano" +title: "nano" +symbol: "n" +display-symbol: "n" +description: "The nano SI prefix defined as a dimensionless multiple of 10â»â¹, adopted into SI at its creation at the 11th CGPM Meeting in 1960, resolution 12." +resources: + - relation: "Definition in the 11th CGPM Meeting in 1960, resolution 12" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/11-1960/resolution-12" + - relation: "Wikipedia article describing the prefix" + resource-id: "https://en.wikipedia.org/wiki/Nano-" +defining-relation: + base-units: [] + base-units-expression: "" + scale: + exponent: -9 +x-optimade-definition: + label: "nano_prefix_si" + kind: "prefix" + format: "1.2" + version: "1.2.0" + name: "nano" diff --git a/schemas/src/defs/v1.2/prefixes/si/pebi.yaml b/schemas/src/defs/v1.2/prefixes/si/pebi.yaml new file mode 100644 index 000000000..06911a2ee --- /dev/null +++ b/schemas/src/defs/v1.2/prefixes/si/pebi.yaml @@ -0,0 +1,23 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/prefix_definition" +$id: "https://schemas.optimade.org/defs/v1.2/prefixes/si/pebi" +title: "pebi" +symbol: "Pi" +display-symbol: "Pi" +description: "The pebi prefix as a dimensionless multiple of 2âµâ° is one of a set of recommended prefixes in the International System of Units (SI), 9th Edition for referring to powers of 2." +resources: + - relation: "Definition in the International System of Units (SI), 9th Edition" + resource-id: "https://www.bipm.org/en/publications/si-brochure" + - relation: "Wikipedia article describing SI prefixes" + resource-id: "https://en.wikipedia.org/wiki/Metric_prefix" +defining-relation: + base-units: [] + base-units-expression: "" + scale: + base: 2 + exponent: 50 +x-optimade-definition: + label: "pebi_prefix_si" + kind: "prefix" + format: "1.2" + version: "1.2.0" + name: "pebi" diff --git a/schemas/src/defs/v1.2/prefixes/si/peta.yaml b/schemas/src/defs/v1.2/prefixes/si/peta.yaml new file mode 100644 index 000000000..38486163c --- /dev/null +++ b/schemas/src/defs/v1.2/prefixes/si/peta.yaml @@ -0,0 +1,22 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/prefix_definition" +$id: "https://schemas.optimade.org/defs/v1.2/prefixes/si/peta" +title: "peta" +symbol: "P" +display-symbol: "P" +description: "The peta SI prefix defined as a dimensionless multiple of 10¹âµ, defined at the 15th CGPM Meeting in 1975, resolution 10." +resources: + - relation: "Definition in the 15th CGPM Meeting in 1975, resolution 10" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/15-1975/resolution-10" + - relation: "Wikipedia article describing SI prefixes" + resource-id: "https://en.wikipedia.org/wiki/Metric_prefix" +defining-relation: + base-units: [] + base-units-expression: "" + scale: + exponent: 15 +x-optimade-definition: + label: "peta_prefix_si" + kind: "prefix" + format: "1.2" + version: "1.2.0" + name: "peta" diff --git a/schemas/src/defs/v1.2/prefixes/si/pico.yaml b/schemas/src/defs/v1.2/prefixes/si/pico.yaml new file mode 100644 index 000000000..c89a85a7a --- /dev/null +++ b/schemas/src/defs/v1.2/prefixes/si/pico.yaml @@ -0,0 +1,22 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/prefix_definition" +$id: "https://schemas.optimade.org/defs/v1.2/prefixes/si/pico" +title: "pico" +symbol: "p" +display-symbol: "p" +description: "The pico SI prefix defined as a dimensionless multiple of 10â»Â¹Â², adopted into SI at its creation at the 11th CGPM Meeting in 1960, resolution 12." +resources: + - relation: "Definition in the 11th CGPM Meeting in 1960, resolution 12" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/11-1960/resolution-12" + - relation: "Wikipedia article describing the SI prefixes" + resource-id: "https://en.wikipedia.org/wiki/Metric_prefix" +defining-relation: + base-units: [] + base-units-expression: "" + scale: + exponent: -12 +x-optimade-definition: + label: "pico_prefix_si" + kind: "prefix" + format: "1.2" + version: "1.2.0" + name: "pico" diff --git a/schemas/src/defs/v1.2/prefixes/si/quecto.yaml b/schemas/src/defs/v1.2/prefixes/si/quecto.yaml new file mode 100644 index 000000000..5a2e26191 --- /dev/null +++ b/schemas/src/defs/v1.2/prefixes/si/quecto.yaml @@ -0,0 +1,22 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/prefix_definition" +$id: "https://schemas.optimade.org/defs/v1.2/prefixes/si/quecto" +title: "quecto" +symbol: "q" +display-symbol: "q" +description: "The quecto SI prefix defined as a dimensionless multiple of 10â»Â³â°, defined at the 27th CGPM Meeting in 2022, resolution 3." +resources: + - relation: "Definition in the 27th CGPM Meeting in 2022, resolution 3" + resource-id: "https://www.bipm.org/en/cgpm-2022/resolution-3" + - relation: "Wikipedia article describing SI prefixes" + resource-id: "https://en.wikipedia.org/wiki/Metric_prefix" +defining-relation: + base-units: [] + base-units-expression: "" + scale: + exponent: -30 +x-optimade-definition: + label: "quecto_prefix_si" + kind: "prefix" + format: "1.2" + version: "1.2.0" + name: "quecto" diff --git a/schemas/src/defs/v1.2/prefixes/si/quetta.yaml b/schemas/src/defs/v1.2/prefixes/si/quetta.yaml new file mode 100644 index 000000000..5d125dd8f --- /dev/null +++ b/schemas/src/defs/v1.2/prefixes/si/quetta.yaml @@ -0,0 +1,22 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/prefix_definition" +$id: "https://schemas.optimade.org/defs/v1.2/prefixes/si/quetta" +title: "quetta" +symbol: "Q" +display-symbol: "Q" +description: "The quetta SI prefix defined as a dimensionless multiple of 10³â°, defined at the 27th CGPM Meeting in 2022, resolution 3." +resources: + - relation: "Definition in the 27th CGPM Meeting in 2022, resolution 3" + resource-id: "https://www.bipm.org/en/cgpm-2022/resolution-3" + - relation: "Wikipedia article describing SI prefixes" + resource-id: "https://en.wikipedia.org/wiki/Metric_prefix" +defining-relation: + base-units: [] + base-units-expression: "" + scale: + exponent: 30 +x-optimade-definition: + label: "quetta_prefix_si" + kind: "prefix" + format: "1.2" + version: "1.2.0" + name: "quetta" diff --git a/schemas/src/defs/v1.2/prefixes/si/ronna.yaml b/schemas/src/defs/v1.2/prefixes/si/ronna.yaml new file mode 100644 index 000000000..2cf710631 --- /dev/null +++ b/schemas/src/defs/v1.2/prefixes/si/ronna.yaml @@ -0,0 +1,22 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/prefix_definition" +$id: "https://schemas.optimade.org/defs/v1.2/prefixes/si/ronna" +title: "ronna" +symbol: "R" +display-symbol: "R" +description: "The ronna SI prefix defined as a dimensionless multiple of 10²â·, defined at the 27th CGPM Meeting in 2022, resolution 3." +resources: + - relation: "Definition in the 27th CGPM Meeting in 2022, resolution 3" + resource-id: "https://www.bipm.org/en/cgpm-2022/resolution-3" + - relation: "Wikipedia article describing the prefix" + resource-id: "https://en.wikipedia.org/wiki/Metric_prefix" +defining-relation: + base-units: [] + base-units-expression: "" + scale: + exponent: 27 +x-optimade-definition: + label: "ronna_prefix_si" + kind: "prefix" + format: "1.2" + version: "1.2.0" + name: "ronna" diff --git a/schemas/src/defs/v1.2/prefixes/si/ronto.yaml b/schemas/src/defs/v1.2/prefixes/si/ronto.yaml new file mode 100644 index 000000000..5a4583ccd --- /dev/null +++ b/schemas/src/defs/v1.2/prefixes/si/ronto.yaml @@ -0,0 +1,22 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/prefix_definition" +$id: "https://schemas.optimade.org/defs/v1.2/prefixes/si/ronto" +title: "ronto" +symbol: "r" +display-symbol: "r" +description: "The ronto SI prefix defined as a dimensionless multiple of 10^â»Â²â·, defined at the 27th CGPM Meeting in 2022, resolution 3." +resources: + - relation: "Definition in the 27th CGPM Meeting in 2022, resolution 3" + resource-id: "https://www.bipm.org/en/cgpm-2022/resolution-3" + - relation: "Wikipedia article describing SI prefixes" + resource-id: "https://en.wikipedia.org/wiki/Metric_prefix" +defining-relation: + base-units: [] + base-units-expression: "" + scale: + exponent: -27 +x-optimade-definition: + label: "ronto_prefix_si" + kind: "prefix" + format: "1.2" + version: "1.2.0" + name: "ronto" diff --git a/schemas/src/defs/v1.2/prefixes/si/tebi.yaml b/schemas/src/defs/v1.2/prefixes/si/tebi.yaml new file mode 100644 index 000000000..7ddf13170 --- /dev/null +++ b/schemas/src/defs/v1.2/prefixes/si/tebi.yaml @@ -0,0 +1,23 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/prefix_definition" +$id: "https://schemas.optimade.org/defs/v1.2/prefixes/si/tebi" +title: "tebi" +symbol: "Ti" +display-symbol: "Ti" +description: "The tebi prefix as a dimensionless multiple of 2â´â° is one of a set of recommended prefixes in the International System of Units (SI), 9th Edition for referring to powers of 2." +resources: + - relation: "Definition in the International System of Units (SI), 9th Edition" + resource-id: "https://www.bipm.org/en/publications/si-brochure" + - relation: "Wikipedia article describing SI prefixes" + resource-id: "https://en.wikipedia.org/wiki/Metric_prefix" +defining-relation: + base-units: [] + base-units-expression: "" + scale: + base: 2 + exponent: 40 +x-optimade-definition: + label: "tebi_prefix_si" + kind: "prefix" + format: "1.2" + version: "1.2.0" + name: "tebi" diff --git a/schemas/src/defs/v1.2/prefixes/si/tera.yaml b/schemas/src/defs/v1.2/prefixes/si/tera.yaml new file mode 100644 index 000000000..c578d28c7 --- /dev/null +++ b/schemas/src/defs/v1.2/prefixes/si/tera.yaml @@ -0,0 +1,22 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/prefix_definition" +$id: "https://schemas.optimade.org/defs/v1.2/prefixes/si/tera" +title: "tera" +symbol: "T" +display-symbol: "T" +description: "The tera SI prefix defined as a dimensionless multiple of 10¹², adopted into SI at its creation at the 11th CGPM Meeting in 1960, resolution 12." +resources: + - relation: "Definition in the 11th CGPM Meeting in 1960, resolution 12" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/11-1960/resolution-12" + - relation: "Wikipedia article describing the SI prefixes" + resource-id: "https://en.wikipedia.org/wiki/Metric_prefix" +defining-relation: + base-units: [] + base-units-expression: "" + scale: + exponent: 12 +x-optimade-definition: + label: "tera_prefix_si" + kind: "prefix" + format: "1.2" + version: "1.2.0" + name: "tera" diff --git a/schemas/src/defs/v1.2/prefixes/si/yobi.yaml b/schemas/src/defs/v1.2/prefixes/si/yobi.yaml new file mode 100644 index 000000000..a08324d52 --- /dev/null +++ b/schemas/src/defs/v1.2/prefixes/si/yobi.yaml @@ -0,0 +1,23 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/prefix_definition" +$id: "https://schemas.optimade.org/defs/v1.2/prefixes/si/yobi" +title: "yobi" +symbol: "Yi" +display-symbol: "Yi" +description: "The yobi prefix as a dimensionless multiple of 2â¸â° is one of a set of recommended prefixes in the International System of Units (SI), 9th Edition for referring to powers of 2." +resources: + - relation: "Definition in the International System of Units (SI), 9th Edition" + resource-id: "https://www.bipm.org/en/publications/si-brochure" + - relation: "Wikipedia article describing SI prefixes" + resource-id: "https://en.wikipedia.org/wiki/Metric_prefix" +defining-relation: + base-units: [] + base-units-expression: "" + scale: + base: 2 + exponent: 80 +x-optimade-definition: + label: "yobi_prefix_si" + kind: "prefix" + format: "1.2" + version: "1.2.0" + name: "yobi" diff --git a/schemas/src/defs/v1.2/prefixes/si/yocto.yaml b/schemas/src/defs/v1.2/prefixes/si/yocto.yaml new file mode 100644 index 000000000..579893f3d --- /dev/null +++ b/schemas/src/defs/v1.2/prefixes/si/yocto.yaml @@ -0,0 +1,22 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/prefix_definition" +$id: "https://schemas.optimade.org/defs/v1.2/prefixes/si/yocto" +title: "yocto" +symbol: "y" +display-symbol: "y" +description: "The yocto SI prefix defined as a dimensionless multiple of 10â»Â²â´, defined at the 19th CGPM Meeting in 1991, resolution 4." +resources: + - relation: "Definition in the 19th CGPM Meeting in 1991, resolution 4" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/19-1991/resolution-4" + - relation: "Wikipedia article describing SI prefixes" + resource-id: "https://en.wikipedia.org/wiki/Metric_prefix" +defining-relation: + base-units: [] + base-units-expression: "" + scale: + exponent: -24 +x-optimade-definition: + label: "yocto_prefix_si" + kind: "prefix" + format: "1.2" + version: "1.2.0" + name: "yocto" diff --git a/schemas/src/defs/v1.2/prefixes/si/yotta.yaml b/schemas/src/defs/v1.2/prefixes/si/yotta.yaml new file mode 100644 index 000000000..0df5a217f --- /dev/null +++ b/schemas/src/defs/v1.2/prefixes/si/yotta.yaml @@ -0,0 +1,22 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/prefix_definition" +$id: "https://schemas.optimade.org/defs/v1.2/prefixes/si/yotta" +title: "yotta" +symbol: "Y" +display-symbol: "Y" +description: "The yotta SI prefix defined as a dimensionless multiple of 10²â´, defined at the 19th CGPM Meeting in 1991, resolution 4." +resources: + - relation: "Definition in the 19th CGPM Meeting in 1991, resolution 4" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/19-1991/resolution-4" + - relation: "Wikipedia article describing SI prefixes" + resource-id: "https://en.wikipedia.org/wiki/Metric_prefix" +defining-relation: + base-units: [] + base-units-expression: "" + scale: + exponent: 24 +x-optimade-definition: + label: "yotta_prefix_si" + kind: "prefix" + format: "1.2" + version: "1.2.0" + name: "yotta" diff --git a/schemas/src/defs/v1.2/prefixes/si/zebi.yaml b/schemas/src/defs/v1.2/prefixes/si/zebi.yaml new file mode 100644 index 000000000..0ddad30be --- /dev/null +++ b/schemas/src/defs/v1.2/prefixes/si/zebi.yaml @@ -0,0 +1,23 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/prefix_definition" +$id: "https://schemas.optimade.org/defs/v1.2/prefixes/si/zebi" +title: "zebi" +symbol: "Zi" +display-symbol: "Zi" +description: "The zebi prefix as a dimensionless multiple of 2â·â° is one of a set of recommended prefixes in the International System of Units (SI), 9th Edition for referring to powers of 2." +resources: + - relation: "Definition in the International System of Units (SI), 9th Edition" + resource-id: "https://www.bipm.org/en/publications/si-brochure" + - relation: "Wikipedia article describing SI prefixes" + resource-id: "https://en.wikipedia.org/wiki/Metric_prefix" +defining-relation: + base-units: [] + base-units-expression: "" + scale: + base: 2 + exponent: 70 +x-optimade-definition: + label: "zebi_prefix_si" + kind: "prefix" + format: "1.2" + version: "1.2.0" + name: "zebi" diff --git a/schemas/src/defs/v1.2/prefixes/si/zepto.yaml b/schemas/src/defs/v1.2/prefixes/si/zepto.yaml new file mode 100644 index 000000000..b8dd1345e --- /dev/null +++ b/schemas/src/defs/v1.2/prefixes/si/zepto.yaml @@ -0,0 +1,22 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/prefix_definition" +$id: "https://schemas.optimade.org/defs/v1.2/prefixes/si/zepto" +title: "zepto" +symbol: "z" +display-symbol: "z" +description: "The zepto SI prefix defined as a dimensionless multiple of 10â»Â²Â¹, defined at the 19th CGPM Meeting in 1991, resolution 4." +resources: + - relation: "Definition in the 19th CGPM Meeting in 1991, resolution 4" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/19-1991/resolution-4" + - relation: "Wikipedia article describing SI prefixes" + resource-id: "https://en.wikipedia.org/wiki/Metric_prefix" +defining-relation: + base-units: [] + base-units-expression: "" + scale: + exponent: -21 +x-optimade-definition: + label: "zepto_prefix_si" + kind: "prefix" + format: "1.2" + version: "1.2.0" + name: "zepto" diff --git a/schemas/src/defs/v1.2/prefixes/si/zetta.yaml b/schemas/src/defs/v1.2/prefixes/si/zetta.yaml new file mode 100644 index 000000000..671a291e3 --- /dev/null +++ b/schemas/src/defs/v1.2/prefixes/si/zetta.yaml @@ -0,0 +1,22 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/prefix_definition" +$id: "https://schemas.optimade.org/defs/v1.2/prefixes/si/zetta" +title: "zetta" +symbol: "Z" +display-symbol: "Z" +description: "The zetta SI prefix defined as a dimensionless multiple of 10²¹, defined at the 19th CGPM Meeting in 1991, resolution 4." +resources: + - relation: "Definition in the 19th CGPM Meeting in 1991, resolution 4" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/19-1991/resolution-4" + - relation: "Wikipedia article describing SI prefixes" + resource-id: "https://en.wikipedia.org/wiki/Metric_prefix" +defining-relation: + base-units: [] + base-units-expression: "" + scale: + exponent: 21 +x-optimade-definition: + label: "zetta_prefix_si" + kind: "prefix" + format: "1.2" + version: "1.2.0" + name: "zetta" diff --git a/schemas/src/defs/v1.2/properties/core/features.yaml b/schemas/src/defs/v1.2/properties/core/features.yaml new file mode 100644 index 000000000..1171a4698 --- /dev/null +++ b/schemas/src/defs/v1.2/properties/core/features.yaml @@ -0,0 +1,32 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/property_definition" +$id: "https://schemas.optimade.org/defs/v1.2/properties/core/features" +title: "features" +x-optimade-type: "list" +x-optimade-definition: + label: "features_core" + kind: "property" + version: "1.2.0" + format: "1.2" + name: "features" +type: + - "array" +x-optimade-dimensions: + names: ["dim_features"] +description: |- + A list of strings that flag which special features are used by the entry. + + **Requirements/Conventions:** + + - MUST be an empty list if no special features are used. + - MUST be sorted alphabetically. + - If a feature is used, the list MUST contain the corresponding string. + - If a feature is not used, the list MUST NOT contain the corresponding string. + - This is an abstract definition, meant to be inherited by more specific definitions that define specific strings. +examples: + - ["feature1", "feature2"] +x-optimade-unit: "inapplicable" +items: + type: + - "string" + x-optimade-type: "string" + x-optimade-unit: "inapplicable" diff --git a/schemas/src/defs/v1.2/properties/core/id.yaml b/schemas/src/defs/v1.2/properties/core/id.yaml new file mode 100644 index 000000000..ea3cfb872 --- /dev/null +++ b/schemas/src/defs/v1.2/properties/core/id.yaml @@ -0,0 +1,27 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/property_definition" +$id: "https://schemas.optimade.org/defs/v1.2/properties/core/id" +title: "ID" +x-optimade-type: "string" +x-optimade-definition: + label: "id_core" + kind: "property" + version: "1.2.0" + format: "1.2" + name: "id" +type: + - "string" +description: |- + A unique string referencing a specific entry in the database. + + **Requirements/Conventions:** + + - Taken together, the ID and entry type MUST uniquely identify the entry. + - Reasonably short IDs are encouraged and SHOULD NOT be longer than 255 characters. + - IDs MAY change over time. +examples: + - "db/1234567" + - "cod/2000000" + - "cod/2000000@1234567" + - "nomad/L1234567890" + - "42" +x-optimade-unit: "inapplicable" diff --git a/schemas/src/defs/v1.2/properties/core/immutable_id.yaml b/schemas/src/defs/v1.2/properties/core/immutable_id.yaml new file mode 100644 index 000000000..ad3edf5b2 --- /dev/null +++ b/schemas/src/defs/v1.2/properties/core/immutable_id.yaml @@ -0,0 +1,24 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/property_definition" +$id: "https://schemas.optimade.org/defs/v1.2/properties/core/immutable_id" +title: "immutable ID" +x-optimade-type: "string" +x-optimade-definition: + label: "immutable_id_core" + kind: "property" + version: "1.2.0" + format: "1.2" + name: "immutable_id" +type: + - "string" + - "null" +description: |- + The entry's immutable ID (e.g., a UUID). + + **Requirements/Conventions:** + + - This is important for databases having preferred IDs that point to "the latest version" of a record, but still offer access to older variants. + - This ID maps to the version-specific record, in case it changes in the future. +examples: + - "8bd3e750-b477-41a0-9b11-3a799f21b44f" + - "fjeiwoj,54;@=%<>#32" +x-optimade-unit: "inapplicable" diff --git a/schemas/src/defs/v1.2/properties/core/last_modified.yaml b/schemas/src/defs/v1.2/properties/core/last_modified.yaml new file mode 100644 index 000000000..d8ebd2043 --- /dev/null +++ b/schemas/src/defs/v1.2/properties/core/last_modified.yaml @@ -0,0 +1,19 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/property_definition" +$id: "https://schemas.optimade.org/defs/v1.2/properties/core/last_modified" +title: "last modified" +x-optimade-type: "timestamp" +x-optimade-definition: + label: "last_modified_core" + kind: "property" + version: "1.2.0" + format: "1.2" + name: "last_modified" +type: + - "string" + - "null" +format: "date-time" +description: |- + Date and time representing when the entry was last modified. +examples: + - "2007-04-05T14:30:20Z" +x-optimade-unit: "inapplicable" diff --git a/schemas/src/defs/v1.2/properties/core/type.yaml b/schemas/src/defs/v1.2/properties/core/type.yaml new file mode 100644 index 000000000..e185dcf13 --- /dev/null +++ b/schemas/src/defs/v1.2/properties/core/type.yaml @@ -0,0 +1,22 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/property_definition" +$id: "https://schemas.optimade.org/defs/v1.2/properties/core/type" +title: "type" +x-optimade-type: "string" +x-optimade-definition: + label: "type_core" + kind: "property" + version: "1.2.0" + format: "1.2" + name: "type" +type: + - "string" +description: |- + The name of the type of an entry. + + **Requirements/Conventions:** + + - MUST be an existing entry type. + - The entry of type and ID MUST be returned in response to a request for // under the versioned or unversioned base URL serving the API. +examples: + - "structures" +x-optimade-unit: "inapplicable" diff --git a/schemas/src/defs/v1.2/properties/optimade/calculations/id.yaml b/schemas/src/defs/v1.2/properties/optimade/calculations/id.yaml new file mode 100644 index 000000000..9ca0fadf0 --- /dev/null +++ b/schemas/src/defs/v1.2/properties/optimade/calculations/id.yaml @@ -0,0 +1,2 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/property_definition" +$$inherit: "/v1.2/properties/core/id" diff --git a/schemas/src/defs/v1.2/properties/optimade/calculations/immutable_id.yaml b/schemas/src/defs/v1.2/properties/optimade/calculations/immutable_id.yaml new file mode 100644 index 000000000..543c1cec5 --- /dev/null +++ b/schemas/src/defs/v1.2/properties/optimade/calculations/immutable_id.yaml @@ -0,0 +1,2 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/property_definition" +$$inherit: "/v1.2/properties/core/immutable_id" diff --git a/schemas/src/defs/v1.2/properties/optimade/calculations/last_modified.yaml b/schemas/src/defs/v1.2/properties/optimade/calculations/last_modified.yaml new file mode 100644 index 000000000..e94788b6e --- /dev/null +++ b/schemas/src/defs/v1.2/properties/optimade/calculations/last_modified.yaml @@ -0,0 +1,2 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/property_definition" +$$inherit: "/v1.2/properties/core/last_modified" diff --git a/schemas/src/defs/v1.2/properties/optimade/calculations/type.yaml b/schemas/src/defs/v1.2/properties/optimade/calculations/type.yaml new file mode 100644 index 000000000..903078981 --- /dev/null +++ b/schemas/src/defs/v1.2/properties/optimade/calculations/type.yaml @@ -0,0 +1,2 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/property_definition" +$$inherit: "/v1.2/properties/core/type" diff --git a/schemas/src/defs/v1.2/properties/optimade/common/chemical_symbol.yaml b/schemas/src/defs/v1.2/properties/optimade/common/chemical_symbol.yaml new file mode 100644 index 000000000..67d1e9682 --- /dev/null +++ b/schemas/src/defs/v1.2/properties/optimade/common/chemical_symbol.yaml @@ -0,0 +1,26 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/property_definition" +$id: "https://schemas.optimade.org/defs/v1.2/properties/optimade/common/chemical_symbol" +title: "chemical symbol" +x-optimade-type: "string" +x-optimade-definition: + label: "chemical_symbol_optimade_common" + kind: "property" + version: "1.2.0" + format: "1.2" + name: "chemical_symbol" +description: |- + A chemical symbol referring to an element or a non-chemical element. + + **Requirements/Conventions:** + + - Must be one of the following: + + - a valid chemical-element symbol, or + - the special value `"X"` to represent a non-chemical element. +x-optimade-unit: inapplicable +examples: + - "He" + - "X" +type: + - "string" +enum: ["X", "H", "He", "Li", "Be", "B", "C", "N", "O", "F", "Ne", "Na", "Mg", "Al", "Si", "P", "S", "Cl", "Ar", "K", "Ca", "Sc", "Ti", "V", "Cr", "Mn", "Fe", "Co", "Ni", "Cu", "Zn", "Ga", "Ge", "As", "Se", "Br", "Kr", "Rb", "Sr", "Y", "Zr", "Nb", "Mo", "Tc", "Ru", "Rh", "Pd", "Ag", "Cd", "In", "Sn", "Sb", "Te", "I", "Xe", "Cs", "Ba", "La", "Ce", "Pr", "Nd", "Pm", "Sm", "Eu", "Gd", "Tb", "Dy", "Ho", "Er", "Tm", "Yb", "Lu", "Hf", "Ta", "W", "Re", "Os", "Ir", "Pt", "Au", "Hg", "Tl", "Pb", "Bi", "Po", "At", "Rn", "Fr", "Ra", "Ac", "Th", "Pa", "U", "Np", "Pu", "Am", "Cm", "Bk", "Cf", "Es", "Fm", "Md", "No", "Lr", "Rf", "Db", "Sg", "Bh", "Hs", "Mt", "Ds", "Rg", "Cn", "Uut", "Uuq", "Uup", "Uuh", "Uus", "Uuo", "Nh", "Fl", "Mc", "Lv", "Ts", "Og"] diff --git a/schemas/src/defs/v1.2/properties/optimade/common/chemical_symbol_or_vacancy.yaml b/schemas/src/defs/v1.2/properties/optimade/common/chemical_symbol_or_vacancy.yaml new file mode 100644 index 000000000..6aa722484 --- /dev/null +++ b/schemas/src/defs/v1.2/properties/optimade/common/chemical_symbol_or_vacancy.yaml @@ -0,0 +1,28 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/property_definition" +$id: "https://schemas.optimade.org/defs/v1.2/properties/optimade/common/chemical_symbol_or_vacancy" +title: "chemical symbol or vacancy" +x-optimade-type: "string" +x-optimade-definition: + label: "chemical_symbol_or_vacancy_optimade_common" + kind: "property" + version: "1.2.0" + format: "1.2" + name: "chemical_symbol_or_vacancy" +description: |- + A chemical symbol referring to an element, a non-chemical element, or a vacancy. + + **Requirements/Conventions:** + + - Must be one of the following: + + - a valid chemical-element symbol, or + - the special value `"X"` to represent a non-chemical element, or + - the special value `"vacancy"` to represent that this site has a non-zero probability of having a vacancy. +x-optimade-unit: inapplicable +examples: + - "He" + - "X" + - "vacancy" +type: + - "string" +enum: ["X", "H", "He", "Li", "Be", "B", "C", "N", "O", "F", "Ne", "Na", "Mg", "Al", "Si", "P", "S", "Cl", "Ar", "K", "Ca", "Sc", "Ti", "V", "Cr", "Mn", "Fe", "Co", "Ni", "Cu", "Zn", "Ga", "Ge", "As", "Se", "Br", "Kr", "Rb", "Sr", "Y", "Zr", "Nb", "Mo", "Tc", "Ru", "Rh", "Pd", "Ag", "Cd", "In", "Sn", "Sb", "Te", "I", "Xe", "Cs", "Ba", "La", "Ce", "Pr", "Nd", "Pm", "Sm", "Eu", "Gd", "Tb", "Dy", "Ho", "Er", "Tm", "Yb", "Lu", "Hf", "Ta", "W", "Re", "Os", "Ir", "Pt", "Au", "Hg", "Tl", "Pb", "Bi", "Po", "At", "Rn", "Fr", "Ra", "Ac", "Th", "Pa", "U", "Np", "Pu", "Am", "Cm", "Bk", "Cf", "Es", "Fm", "Md", "No", "Lr", "Rf", "Db", "Sg", "Bh", "Hs", "Mt", "Ds", "Rg", "Cn", "Uut", "Uuq", "Uup", "Uuh", "Uus", "Uuo", "Nh", "Fl", "Mc", "Lv", "Ts", "Og"] diff --git a/schemas/src/defs/v1.2/properties/optimade/common/element.yaml b/schemas/src/defs/v1.2/properties/optimade/common/element.yaml new file mode 100644 index 000000000..ad586207e --- /dev/null +++ b/schemas/src/defs/v1.2/properties/optimade/common/element.yaml @@ -0,0 +1,21 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/property_definition" +$id: "https://schemas.optimade.org/defs/v1.2/properties/optimade/common/element" +title: "element" +x-optimade-type: "string" +x-optimade-definition: + label: "element_optimade_common" + kind: "property" + version: "1.2.0" + format: "1.2" + name: "element" +description: |- + The chemical symbol of an element + + **Requirements/Conventions:** + + - The strings are the chemical symbols, i.e., either a single uppercase letter or an uppercase letter followed by a number of lowercase letters. +x-optimade-unit: inapplicable +type: + - "string" +maxLength: 3 +enum: ["X", "H", "He", "Li", "Be", "B", "C", "N", "O", "F", "Ne", "Na", "Mg", "Al", "Si", "P", "S", "Cl", "Ar", "K", "Ca", "Sc", "Ti", "V", "Cr", "Mn", "Fe", "Co", "Ni", "Cu", "Zn", "Ga", "Ge", "As", "Se", "Br", "Kr", "Rb", "Sr", "Y", "Zr", "Nb", "Mo", "Tc", "Ru", "Rh", "Pd", "Ag", "Cd", "In", "Sn", "Sb", "Te", "I", "Xe", "Cs", "Ba", "La", "Ce", "Pr", "Nd", "Pm", "Sm", "Eu", "Gd", "Tb", "Dy", "Ho", "Er", "Tm", "Yb", "Lu", "Hf", "Ta", "W", "Re", "Os", "Ir", "Pt", "Au", "Hg", "Tl", "Pb", "Bi", "Po", "At", "Rn", "Fr", "Ra", "Ac", "Th", "Pa", "U", "Np", "Pu", "Am", "Cm", "Bk", "Cf", "Es", "Fm", "Md", "No", "Lr", "Rf", "Db", "Sg", "Bh", "Hs", "Mt", "Ds", "Rg", "Cn", "Uut", "Uuq", "Uup", "Uuh", "Uus", "Uuo", "Nh", "Fl", "Mc", "Lv", "Ts", "Og"] diff --git a/schemas/src/defs/v1.2/properties/optimade/common/person.yaml b/schemas/src/defs/v1.2/properties/optimade/common/person.yaml new file mode 100644 index 000000000..c81c42bbf --- /dev/null +++ b/schemas/src/defs/v1.2/properties/optimade/common/person.yaml @@ -0,0 +1,43 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/property_definition" +$id: "https://schemas.optimade.org/defs/v1.2/properties/optimade/common/person" +title: "person" +x-optimade-type: "dictionary" +x-optimade-definition: + label: "person_optimade_common" + kind: "property" + version: "1.2.0" + format: "1.2" + name: "person" +type: + - "object" + - "null" +description: |- + A dictionary with name information about a person. + + **Requirements/Conventions**: + + - The dictionary MUST adhere to the following format: + + - **name**: Full name of the person, REQUIRED. + - **firstname**, **lastname**: Parts of the person's name, OPTIONAL. +required: ["name"] +properties: + name: + x-optimade-type: "string" + x-optimade-unit: "inapplicable" + type: + - string + firstname: + x-optimade-type: "string" + x-optimade-unit: "inapplicable" + type: + - string + lastname: + x-optimade-type: "string" + x-optimade-unit: "inapplicable" + type: + - string +examples: + - {"name": "John Smith"} + - {"name": "Arthur Dent", "firstname": "Arthur", "lastname": "Dent"} +x-optimade-unit: "inapplicable" diff --git a/schemas/src/defs/v1.2/properties/optimade/common/space_group_symmetry_operation_xyz.yaml b/schemas/src/defs/v1.2/properties/optimade/common/space_group_symmetry_operation_xyz.yaml new file mode 100644 index 000000000..38d7e8aca --- /dev/null +++ b/schemas/src/defs/v1.2/properties/optimade/common/space_group_symmetry_operation_xyz.yaml @@ -0,0 +1,30 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/property_definition" +$id: "https://schemas.optimade.org/defs/v1.2/properties/optimade/common/space_group_symmetry_operation_xyz" +title: "space group symmetry operation" +x-optimade-type: "string" +x-optimade-definition: + label: "space_group_symmetry_operation_xyz_optimade_common" + kind: "property" + version: "1.2.0" + format: "1.2" + name: "space_group_symmetry_operation_xyz" +type: + - "string" +description: |- + A single symmetry operation. + + **Requirements/Conventions**: + + - The symmetry operation is described in Jones' faithful representation (Bradley & Cracknell, 1972: pp. 35-37), adapted for computer string notation. + - The interpretation of the string MUST follow the conventions of the IUCr CIF core dictionary (IUCr, 2023). + - The letters `x`, `y` and `z` that are typesetted with overbars in printed text represent coordinate values multiplied by -1 and are encoded as `-x`, `-y` and `-z`, respectively. + - The syntax of the string representing a symmetry operation MUST conform to regular expressions given in the OPTIMADE specification appendix 'The Symmetry Operation String Regular Expressions'. + + **Bibliographic References** + + - Bradley, C. J. and Cracknell, A. P. (1972) The Mathematical Theory of Symmetry in Solids. Oxford, Clarendon Press (paperback edition 2010) 745 p. [ISBN 978-0-19-958258-7](https://isbnsearch.org/isbn/9780199582587>). + - IUCr (2023) Core dictionary (coreCIF) version 2.4.5; data name `_space_group_symop_operation_xyz`. Available from: [https://www.iucr.org/__data/iucr/cifdic_html/1/cif_core.dic/Ispace_group_symop_operation_xyz.html](https://www.iucr.org/__data/iucr/cifdic_html/1/cif_core.dic/Ispace_group_symop_operation_xyz.html) [Accessed 2023-06-18T16:46+03:00]. +examples: + - "x,y,z" + - "-x,y,-z" +x-optimade-unit: "inapplicable" diff --git a/schemas/src/defs/v1.2/properties/optimade/common/species_name.yaml b/schemas/src/defs/v1.2/properties/optimade/common/species_name.yaml new file mode 100644 index 000000000..5b0511473 --- /dev/null +++ b/schemas/src/defs/v1.2/properties/optimade/common/species_name.yaml @@ -0,0 +1,19 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/property_definition" +$id: "https://schemas.optimade.org/defs/v1.2/properties/optimade/common/species_name" +title: "name of the species" +x-optimade-type: "string" +x-optimade-definition: + label: "species_name_optimade_common" + kind: "property" + version: "1.2.0" + format: "1.2" + name: "species_name" +type: + - "string" +description: |- + The name of the species. +examples: + - "Na" + - "Si[32982]" + - "quop" +x-optimade-unit: "inapplicable" diff --git a/schemas/src/defs/v1.2/properties/optimade/common/symmetry_operation_xyz.yaml b/schemas/src/defs/v1.2/properties/optimade/common/symmetry_operation_xyz.yaml new file mode 100644 index 000000000..e201b23e4 --- /dev/null +++ b/schemas/src/defs/v1.2/properties/optimade/common/symmetry_operation_xyz.yaml @@ -0,0 +1,22 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/property_definition" +$id: "https://schemas.optimade.org/defs/v1.2/properties/optimade/common/symmetry_operation_xyz" +title: "symmetry operation" +x-optimade-type: "string" +x-optimade-definition: + label: "symmetry_operation_xyz_optimade_common" + kind: "property" + version: "1.2.0" + format: "1.2" + name: "symmetry_operation_xyz" +description: |- + A symmetry operation given as general position x, y, z coordinates in algebraic form. + + **Requirements/Conventions:** + + - The symmetry operation is described by a string that gives that symmetry operation in Jones' faithful representation (Bradley & Cracknell, 1972: pp. 35-37), adapted for computer string notation. + - The letters `x`, `y` and `z` that are typesetted with overbars in printed text represent coordinate values multiplied by -1 and are encoded as `-x`, `-y` and `-z`, respectively. + - The syntax of the strings representing symmetry operations MUST conform to regular expressions given in appendix `The Symmetry Operation String Regular Expressions`_. +x-optimade-unit: inapplicable +type: + - "string" +maxLength: 3 diff --git a/schemas/src/defs/v1.2/properties/optimade/files/atime.yaml b/schemas/src/defs/v1.2/properties/optimade/files/atime.yaml new file mode 100644 index 000000000..5578d7ac6 --- /dev/null +++ b/schemas/src/defs/v1.2/properties/optimade/files/atime.yaml @@ -0,0 +1,19 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/property_definition" +$id: "https://schemas.optimade.org/defs/v1.2/properties/optimade/files/atime" +title: "access time" +x-optimade-type: "timestamp" +x-optimade-definition: + label: "atime_optimade_files" + kind: "property" + version: "1.2.0" + format: "1.2" + name: "atime" +type: + - "string" + - "null" +format: "date-time" +description: |- + Time of last access of a file as per POSIX standard. +examples: + - "2007-04-05T14:30:20Z" +x-optimade-unit: "inapplicable" diff --git a/schemas/src/defs/v1.2/properties/optimade/files/checksums.yaml b/schemas/src/defs/v1.2/properties/optimade/files/checksums.yaml new file mode 100644 index 000000000..3a29c9787 --- /dev/null +++ b/schemas/src/defs/v1.2/properties/optimade/files/checksums.yaml @@ -0,0 +1,51 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/property_definition" +$id: "https://schemas.optimade.org/defs/v1.2/properties/optimade/files/checksums" +title: "checksums" +x-optimade-type: "dictionary" +x-optimade-definition: + label: "checksums_optimade_files" + kind: "property" + version: "1.2.0" + format: "1.2" + name: "checksums" +type: + - "object" + - "null" +description: |- + Dictionary providing checksums of file contents. + + **Requirements/Conventions:** + + - The keys in the dictionary identify checksum functions and the values are strings containing the corresponding checksum. + + - Supported dictionary keys: `md5`, `sha1`, `sha224`, `sha256`, `sha384`, `sha512`. + Checksums outside this list MAY be used, but their names MUST be prefixed by database-provider-specific namespace prefix. +examples: + - {"sha1": "8072f787eada2c50b60a27f3f098fbac7eea08cf"} +x-optimade-unit: "inapplicable" +properties: + md5: + x-optimade-type: "string" + x-optimade-unit: "inapplicable" + type: + - "string" + sha1: + x-optimade-type: "string" + x-optimade-unit: "inapplicable" + type: + - "string" + sha224: + x-optimade-type: "string" + x-optimade-unit: "inapplicable" + type: + - "string" + sha384: + x-optimade-type: "string" + x-optimade-unit: "inapplicable" + type: + - "string" + sha512: + x-optimade-type: "string" + x-optimade-unit: "inapplicable" + type: + - "string" diff --git a/schemas/src/defs/v1.2/properties/optimade/files/ctime.yaml b/schemas/src/defs/v1.2/properties/optimade/files/ctime.yaml new file mode 100644 index 000000000..9722cee5c --- /dev/null +++ b/schemas/src/defs/v1.2/properties/optimade/files/ctime.yaml @@ -0,0 +1,19 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/property_definition" +$id: "https://schemas.optimade.org/defs/v1.2/properties/optimade/files/ctime" +title: "change time" +x-optimade-type: "timestamp" +x-optimade-definition: + label: "ctime_optimade_files" + kind: "property" + version: "1.2.0" + format: "1.2" + name: "ctime" +type: + - "string" + - "null" +format: "date-time" +description: |- + Time of last status change of a file as per POSIX standard. +examples: + - "2007-04-05T14:30:20Z" +x-optimade-unit: "inapplicable" diff --git a/schemas/src/defs/v1.2/properties/optimade/files/description.yaml b/schemas/src/defs/v1.2/properties/optimade/files/description.yaml new file mode 100644 index 000000000..dbc1b9ec0 --- /dev/null +++ b/schemas/src/defs/v1.2/properties/optimade/files/description.yaml @@ -0,0 +1,18 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/property_definition" +$id: "https://schemas.optimade.org/defs/v1.2/properties/optimade/files/description" +title: "description" +x-optimade-type: "string" +x-optimade-definition: + label: "description_optimade_files" + kind: "property" + version: "1.2.0" + format: "1.2" + name: "description" +type: + - "string" + - "null" +description: |- + Free-form description of a file. +examples: + - "POSCAR format file" +x-optimade-unit: "inapplicable" diff --git a/schemas/src/defs/v1.2/properties/optimade/files/id.yaml b/schemas/src/defs/v1.2/properties/optimade/files/id.yaml new file mode 100644 index 000000000..9ca0fadf0 --- /dev/null +++ b/schemas/src/defs/v1.2/properties/optimade/files/id.yaml @@ -0,0 +1,2 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/property_definition" +$$inherit: "/v1.2/properties/core/id" diff --git a/schemas/src/defs/v1.2/properties/optimade/files/immutable_id.yaml b/schemas/src/defs/v1.2/properties/optimade/files/immutable_id.yaml new file mode 100644 index 000000000..543c1cec5 --- /dev/null +++ b/schemas/src/defs/v1.2/properties/optimade/files/immutable_id.yaml @@ -0,0 +1,2 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/property_definition" +$$inherit: "/v1.2/properties/core/immutable_id" diff --git a/schemas/src/defs/v1.2/properties/optimade/files/last_modified.yaml b/schemas/src/defs/v1.2/properties/optimade/files/last_modified.yaml new file mode 100644 index 000000000..e94788b6e --- /dev/null +++ b/schemas/src/defs/v1.2/properties/optimade/files/last_modified.yaml @@ -0,0 +1,2 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/property_definition" +$$inherit: "/v1.2/properties/core/last_modified" diff --git a/schemas/src/defs/v1.2/properties/optimade/files/media_type.yaml b/schemas/src/defs/v1.2/properties/optimade/files/media_type.yaml new file mode 100644 index 000000000..fb55a5ccc --- /dev/null +++ b/schemas/src/defs/v1.2/properties/optimade/files/media_type.yaml @@ -0,0 +1,18 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/property_definition" +$id: "https://schemas.optimade.org/defs/v1.2/properties/optimade/files/media_type" +title: "media type" +x-optimade-type: "string" +x-optimade-definition: + label: "media_type_optimade_files" + kind: "property" + version: "1.2.0" + format: "1.2" + name: "media_type" +type: + - "string" + - "null" +description: |- + Media type identifier (also known as MIME type), for a file as per [RFC 6838 Media Type Specifications and Registration Procedures](https://datatracker.ietf.org/doc/html/rfc6838). +examples: + - "chemical/x-cif" +x-optimade-unit: "inapplicable" diff --git a/schemas/src/defs/v1.2/properties/optimade/files/modification_timestamp.yaml b/schemas/src/defs/v1.2/properties/optimade/files/modification_timestamp.yaml new file mode 100644 index 000000000..ee98232b9 --- /dev/null +++ b/schemas/src/defs/v1.2/properties/optimade/files/modification_timestamp.yaml @@ -0,0 +1,22 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/property_definition" +$id: "https://schemas.optimade.org/defs/v1.2/properties/optimade/files/modification_timestamp" +title: "modification timestamp" +x-optimade-type: "timestamp" +x-optimade-definition: + label: "modification_timestamp_optimade_files" + kind: "property" + version: "1.2.0" + format: "1.2" + name: "modification_timestamp" +type: + - "string" + - "null" +description: |- + Timestamp of the last modification of file contents. A modification is understood as an addition, change or deletion of one or more bytes, resulting in file contents different from the previous. + + **Requirements/Conventions:** + + - Timestamps of subsequent file modifications SHOULD be increasing (not earlier than previous timestamps). +examples: + - "2020-04-05T14:30:20Z" +x-optimade-unit: "inapplicable" diff --git a/schemas/src/defs/v1.2/properties/optimade/files/mtime.yaml b/schemas/src/defs/v1.2/properties/optimade/files/mtime.yaml new file mode 100644 index 000000000..3f6c575b6 --- /dev/null +++ b/schemas/src/defs/v1.2/properties/optimade/files/mtime.yaml @@ -0,0 +1,25 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/property_definition" +$id: "https://schemas.optimade.org/defs/v1.2/properties/optimade/files/mtime" +title: "modification time" +x-optimade-type: "timestamp" +x-optimade-definition: + label: "mtime_optimade_files" + kind: "property" + version: "1.2.0" + format: "1.2" + name: "mtime" +type: + - "string" + - "null" +format: "date-time" +description: |- + Time of last modification of a file as per POSIX standard. + + **Requirements/Conventions:** + + - It should be noted that the values of `last_modified`, `modification_timestamp` and `mtime` do not necessary match. + `last_modified` pertains to the modification of the OPTIMADE metadata, `modification_timestamp` pertains to file contents and `mtime` pertains to the modification of the file (not necessary changing its contents). + For example, appending an empty string to a file would result in the change of `mtime` in some operating systems, but this would not be deemed as a modification of its contents. +examples: + - "2007-04-05T14:30:20Z" +x-optimade-unit: "inapplicable" diff --git a/schemas/src/defs/v1.2/properties/optimade/files/name.yaml b/schemas/src/defs/v1.2/properties/optimade/files/name.yaml new file mode 100644 index 000000000..087c43e7c --- /dev/null +++ b/schemas/src/defs/v1.2/properties/optimade/files/name.yaml @@ -0,0 +1,25 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/property_definition" +$id: "https://schemas.optimade.org/defs/v1.2/properties/optimade/files/name" +title: "name" +x-optimade-type: "string" +x-optimade-definition: + label: "name_optimade_files" + kind: "property" + version: "1.2.0" + format: "1.2" + name: "name" +type: + - "string" +description: |- + Base name of a file. + + **Requirements/Conventions:** + + - File name extension is an integral part of a file name and, if available, MUST be included. +examples: + - "1000000.cif" +x-optimade-unit: "inapplicable" +x-optimade-requirements: + support: "must" + sortable: false + query-support: "none" diff --git a/schemas/src/defs/v1.2/properties/optimade/files/size.yaml b/schemas/src/defs/v1.2/properties/optimade/files/size.yaml new file mode 100644 index 000000000..aa7890c6e --- /dev/null +++ b/schemas/src/defs/v1.2/properties/optimade/files/size.yaml @@ -0,0 +1,26 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/property_definition" +$id: "https://schemas.optimade.org/defs/v1.2/properties/optimade/files/size" +title: "size" +x-optimade-type: "integer" +x-optimade-definition: + label: "size_optimade_files" + kind: "property" + version: "1.2.0" + format: "1.2" + name: "size" +x-optimade-unit-definitions: + - $$inherit: "/v1.2/units/iso-iec-80000/2008/information_science_and_technology/byte" +type: + - "integer" + - "null" +description: |- + Size of a file in bytes. + + **Requirements/Conventions:** + + - If provided, it MUST be guaranteed that either exact size of a file is given or its upper bound. + This way if a client reserves a static buffer or truncates the download stream after this many bytes the whole file would be received. + Such provision is included to allow the providers to serve on-the-fly compressed files. +examples: + - 4711 +x-optimade-unit: "byte" diff --git a/schemas/src/defs/v1.2/properties/optimade/files/type.yaml b/schemas/src/defs/v1.2/properties/optimade/files/type.yaml new file mode 100644 index 000000000..903078981 --- /dev/null +++ b/schemas/src/defs/v1.2/properties/optimade/files/type.yaml @@ -0,0 +1,2 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/property_definition" +$$inherit: "/v1.2/properties/core/type" diff --git a/schemas/src/defs/v1.2/properties/optimade/files/url.yaml b/schemas/src/defs/v1.2/properties/optimade/files/url.yaml new file mode 100644 index 000000000..d2f57813c --- /dev/null +++ b/schemas/src/defs/v1.2/properties/optimade/files/url.yaml @@ -0,0 +1,21 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/property_definition" +$id: "https://schemas.optimade.org/defs/v1.2/properties/optimade/files/url" +title: "URL" +x-optimade-type: "string" +x-optimade-definition: + label: "url_optimade_files" + kind: "property" + version: "1.2.0" + format: "1.2" + name: "url" +type: + - "string" +description: |- + The URL to get the contents of a file. + + **Requirements/Conventions:** + + - The URL MUST point to the actual contents of a file (i.e. byte stream), not an intermediate (preview) representation. For example, if referring to a file on GitHub, a link should point to raw contents. +examples: + - "https://example.org/files/cifs/1000000.cif" +x-optimade-unit: "inapplicable" diff --git a/schemas/src/defs/v1.2/properties/optimade/files/url_stable_until.yaml b/schemas/src/defs/v1.2/properties/optimade/files/url_stable_until.yaml new file mode 100644 index 000000000..afbbe6d90 --- /dev/null +++ b/schemas/src/defs/v1.2/properties/optimade/files/url_stable_until.yaml @@ -0,0 +1,24 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/property_definition" +$id: "https://schemas.optimade.org/defs/v1.2/properties/optimade/files/url_stable_until" +title: "URL stable until" +x-optimade-type: "timestamp" +x-optimade-definition: + label: "url_stable_until_optimade_files" + kind: "property" + version: "1.2.0" + format: "1.2" + name: "url_stable_until" +type: + - "string" + - "null" +description: |- + Point in time until which the URL in `url` is guaranteed to stay stable. + + **Requirements/Conventions:** + + - `null` means that there is no stability guarantee for the URL in `url`. + Indefinite support could be communicated by providing a date sufficiently far in the future, for example, 9999-12-31. +examples: + - "2052-04-05T14:30:20Z" +x-optimade-unit: "inapplicable" +format: "date-time" diff --git a/schemas/src/defs/v1.2/properties/optimade/files/version.yaml b/schemas/src/defs/v1.2/properties/optimade/files/version.yaml new file mode 100644 index 000000000..d7e557fc5 --- /dev/null +++ b/schemas/src/defs/v1.2/properties/optimade/files/version.yaml @@ -0,0 +1,22 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/property_definition" +$id: "https://schemas.optimade.org/defs/v1.2/properties/optimade/files/version" +title: "version" +x-optimade-type: "string" +x-optimade-definition: + label: "version_optimade_files" + kind: "property" + version: "1.2.0" + format: "1.2" + name: "version" +type: + - "string" + - "null" +description: |- + Version information of a file (e.g., commit, revision, timestamp). + + **Requirements/Conventions:** + + - If provided, it MUST be guaranteed that file contents pertaining to the same combination of id and version are the same. +examples: + - "3.2.6" +x-optimade-unit: "inapplicable" diff --git a/schemas/src/defs/v1.2/properties/optimade/references/address.yaml b/schemas/src/defs/v1.2/properties/optimade/references/address.yaml new file mode 100644 index 000000000..e6ea85208 --- /dev/null +++ b/schemas/src/defs/v1.2/properties/optimade/references/address.yaml @@ -0,0 +1,18 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/property_definition" +$id: "https://schemas.optimade.org/defs/v1.2/properties/optimade/references/address" +title: "address" +x-optimade-type: "string" +x-optimade-definition: + label: "address_optimade_references" + kind: "property" + version: "1.2.0" + format: "1.2" + name: "address" +type: + - "string" + - "null" +description: |- + Typically the location of the publisher or institution (the address field in the BibTeX specification). +examples: + - "New York, NY" +x-optimade-unit: "inapplicable" diff --git a/schemas/src/defs/v1.2/properties/optimade/references/annote.yaml b/schemas/src/defs/v1.2/properties/optimade/references/annote.yaml new file mode 100644 index 000000000..0bf3b3f56 --- /dev/null +++ b/schemas/src/defs/v1.2/properties/optimade/references/annote.yaml @@ -0,0 +1,18 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/property_definition" +$id: "https://schemas.optimade.org/defs/v1.2/properties/optimade/references/annote" +title: "annote" +x-optimade-type: "string" +x-optimade-definition: + label: "annote_optimade_references" + kind: "property" + version: "1.2.0" + format: "1.2" + name: "annote" +type: + - "string" + - "null" +description: |- + Additional notes or comments on the reference (the annote field in the BibTeX specification). +examples: + - "This article obtains structures via density-functional theory." +x-optimade-unit: "inapplicable" diff --git a/schemas/src/defs/v1.2/properties/optimade/references/authors.yaml b/schemas/src/defs/v1.2/properties/optimade/references/authors.yaml new file mode 100644 index 000000000..c4c928cd3 --- /dev/null +++ b/schemas/src/defs/v1.2/properties/optimade/references/authors.yaml @@ -0,0 +1,29 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/property_definition" +$id: "https://schemas.optimade.org/defs/v1.2/properties/optimade/references/authors" +title: "authors" +x-optimade-type: "list" +x-optimade-definition: + label: "authors_optimade_references" + kind: "property" + version: "1.2.0" + format: "1.2" + name: "authors" +x-optimade-dimensions: + names: ["dim_authors"] +type: + - "array" + - "null" +description: |- + A list of dictionaries with names of the authors. + + **Requirements/Conventions**: + + - Each list member MUST be a dictionary with the following keys: + + - **name**: Full name of the person, REQUIRED. + - **firstname**, **lastname**: Parts of the person's name, OPTIONAL. +items: + $$inherit: "/v1.2/properties/optimade/common/person" +examples: + - [{"name": "John Smith"}, {"name": "Arthur Dent", "firstname": "Arthur", "lastname": "Dent"}] +x-optimade-unit: "inapplicable" diff --git a/schemas/src/defs/v1.2/properties/optimade/references/bib_type.yaml b/schemas/src/defs/v1.2/properties/optimade/references/bib_type.yaml new file mode 100644 index 000000000..5ba68f203 --- /dev/null +++ b/schemas/src/defs/v1.2/properties/optimade/references/bib_type.yaml @@ -0,0 +1,18 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/property_definition" +$id: "https://schemas.optimade.org/defs/v1.2/properties/optimade/references/bib_type" +title: "bibliographic type" +x-optimade-type: "string" +x-optimade-definition: + label: "bib_type_optimade_references" + kind: "property" + version: "1.2.0" + format: "1.2" + name: "bib_type" +type: + - "string" + - "null" +description: |- + Type of the reference (the type field in the BibTeX specification). +examples: + - "Research Note" +x-optimade-unit: "inapplicable" diff --git a/schemas/src/defs/v1.2/properties/optimade/references/booktitle.yaml b/schemas/src/defs/v1.2/properties/optimade/references/booktitle.yaml new file mode 100644 index 000000000..ba22babac --- /dev/null +++ b/schemas/src/defs/v1.2/properties/optimade/references/booktitle.yaml @@ -0,0 +1,18 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/property_definition" +$id: "https://schemas.optimade.org/defs/v1.2/properties/optimade/references/booktitle" +title: "booktitle" +x-optimade-type: "string" +x-optimade-definition: + label: "booktitle_optimade_references" + kind: "property" + version: "1.2.0" + format: "1.2" + name: "booktitle" +type: + - "string" + - "null" +description: |- + The title of a book being cited; for parts of a book, use the title field instead (the booktitle field in the BibTeX specification). +examples: + - "Density-functional Theory of Atoms and Molecules" +x-optimade-unit: "inapplicable" diff --git a/schemas/src/defs/v1.2/properties/optimade/references/chapter.yaml b/schemas/src/defs/v1.2/properties/optimade/references/chapter.yaml new file mode 100644 index 000000000..29e85321e --- /dev/null +++ b/schemas/src/defs/v1.2/properties/optimade/references/chapter.yaml @@ -0,0 +1,18 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/property_definition" +$id: "https://schemas.optimade.org/defs/v1.2/properties/optimade/references/chapter" +title: "chapter" +x-optimade-type: "string" +x-optimade-definition: + label: "chapter_optimade_references" + kind: "property" + version: "1.2.0" + format: "1.2" + name: "chapter" +type: + - "string" + - "null" +description: |- + The chapter, section, or similar part number (the chapter field in the BibTeX specification). +examples: + - "5" +x-optimade-unit: "inapplicable" diff --git a/schemas/src/defs/v1.2/properties/optimade/references/crossref.yaml b/schemas/src/defs/v1.2/properties/optimade/references/crossref.yaml new file mode 100644 index 000000000..a76d3da44 --- /dev/null +++ b/schemas/src/defs/v1.2/properties/optimade/references/crossref.yaml @@ -0,0 +1,18 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/property_definition" +$id: "https://schemas.optimade.org/defs/v1.2/properties/optimade/references/crossref" +title: "crossref" +x-optimade-type: "string" +x-optimade-definition: + label: "crossref_optimade_references" + kind: "property" + version: "1.2.0" + format: "1.2" + name: "crossref" +type: + - "string" + - "null" +description: |- + The database key of the entry being cross referenced (the crossref field in the BibTeX specification). +examples: + - "smith2022" +x-optimade-unit: "inapplicable" diff --git a/schemas/src/defs/v1.2/properties/optimade/references/doi.yaml b/schemas/src/defs/v1.2/properties/optimade/references/doi.yaml new file mode 100644 index 000000000..f3950b0d3 --- /dev/null +++ b/schemas/src/defs/v1.2/properties/optimade/references/doi.yaml @@ -0,0 +1,18 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/property_definition" +$id: "https://schemas.optimade.org/defs/v1.2/properties/optimade/references/doi" +title: "doi" +x-optimade-type: "string" +x-optimade-definition: + label: "doi_optimade_references" + kind: "property" + version: "1.2.0" + format: "1.2" + name: "doi" +type: + - "string" + - "null" +description: |- + The doi identifier of the object being referenced. +examples: + - "10.1103/PhysRev.136.B864" +x-optimade-unit: "inapplicable" diff --git a/schemas/src/defs/v1.2/properties/optimade/references/edition.yaml b/schemas/src/defs/v1.2/properties/optimade/references/edition.yaml new file mode 100644 index 000000000..1e8021fc2 --- /dev/null +++ b/schemas/src/defs/v1.2/properties/optimade/references/edition.yaml @@ -0,0 +1,18 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/property_definition" +$id: "https://schemas.optimade.org/defs/v1.2/properties/optimade/references/edition" +title: "edition" +x-optimade-type: "string" +x-optimade-definition: + label: "edition_optimade_references" + kind: "property" + version: "1.2.0" + format: "1.2" + name: "edition" +type: + - "string" + - "null" +description: |- + The edition of a book (the edition field in the BibTeX specification). +examples: + - "Second" +x-optimade-unit: "inapplicable" diff --git a/schemas/src/defs/v1.2/properties/optimade/references/editors.yaml b/schemas/src/defs/v1.2/properties/optimade/references/editors.yaml new file mode 100644 index 000000000..9976bf2e4 --- /dev/null +++ b/schemas/src/defs/v1.2/properties/optimade/references/editors.yaml @@ -0,0 +1,29 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/property_definition" +$id: "https://schemas.optimade.org/defs/v1.2/properties/optimade/references/editors" +title: "editors" +x-optimade-type: "list" +x-optimade-definition: + label: "editors_optimade_references" + kind: "property" + version: "1.2.0" + format: "1.2" + name: "editors" +x-optimade-dimensions: + names: ["dim_editors"] +type: + - "array" + - "null" +description: |- + A list of dictionaries with names of the editors. + + **Requirements/Conventions**: + + - Each list member MUST be a dictionary with the following keys: + + - **name**: Full name of the person, REQUIRED. + - **firstname**, **lastname**: Parts of the person's name, OPTIONAL. +items: + $$inherit: "/v1.2/properties/optimade/common/person" +examples: + - [{"name": "John Smith"}, {"name": "Arthur Dent", "firstname": "Arthur", "lastname": "Dent"}] +x-optimade-unit: "inapplicable" diff --git a/schemas/src/defs/v1.2/properties/optimade/references/howpublished.yaml b/schemas/src/defs/v1.2/properties/optimade/references/howpublished.yaml new file mode 100644 index 000000000..499643b21 --- /dev/null +++ b/schemas/src/defs/v1.2/properties/optimade/references/howpublished.yaml @@ -0,0 +1,18 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/property_definition" +$id: "https://schemas.optimade.org/defs/v1.2/properties/optimade/references/howpublished" +title: "how published" +x-optimade-type: "string" +x-optimade-definition: + label: "howpublished_optimade_references" + kind: "property" + version: "1.2.0" + format: "1.2" + name: "howpublished" +type: + - "string" + - "null" +description: |- + The method of publication (the howpublished field in the BibTeX specification) +examples: + - "\\url{https://www.example.com/papers/example_paper}" +x-optimade-unit: "inapplicable" diff --git a/schemas/src/defs/v1.2/properties/optimade/references/id.yaml b/schemas/src/defs/v1.2/properties/optimade/references/id.yaml new file mode 100644 index 000000000..9ca0fadf0 --- /dev/null +++ b/schemas/src/defs/v1.2/properties/optimade/references/id.yaml @@ -0,0 +1,2 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/property_definition" +$$inherit: "/v1.2/properties/core/id" diff --git a/schemas/src/defs/v1.2/properties/optimade/references/immutable_id.yaml b/schemas/src/defs/v1.2/properties/optimade/references/immutable_id.yaml new file mode 100644 index 000000000..543c1cec5 --- /dev/null +++ b/schemas/src/defs/v1.2/properties/optimade/references/immutable_id.yaml @@ -0,0 +1,2 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/property_definition" +$$inherit: "/v1.2/properties/core/immutable_id" diff --git a/schemas/src/defs/v1.2/properties/optimade/references/institution.yaml b/schemas/src/defs/v1.2/properties/optimade/references/institution.yaml new file mode 100644 index 000000000..cdbed3ec7 --- /dev/null +++ b/schemas/src/defs/v1.2/properties/optimade/references/institution.yaml @@ -0,0 +1,18 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/property_definition" +$id: "https://schemas.optimade.org/defs/v1.2/properties/optimade/references/institution" +title: "institution" +x-optimade-type: "string" +x-optimade-definition: + label: "institution_optimade_references" + kind: "property" + version: "1.2.0" + format: "1.2" + name: "institution" +type: + - "string" + - "null" +description: |- + The sponsoring institution of a technical report (the institution field in the BibTeX specification). +examples: + - "Massachusetts Institute of Technology" +x-optimade-unit: "inapplicable" diff --git a/schemas/src/defs/v1.2/properties/optimade/references/journal.yaml b/schemas/src/defs/v1.2/properties/optimade/references/journal.yaml new file mode 100644 index 000000000..8ab0ff9e0 --- /dev/null +++ b/schemas/src/defs/v1.2/properties/optimade/references/journal.yaml @@ -0,0 +1,18 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/property_definition" +$id: "https://schemas.optimade.org/defs/v1.2/properties/optimade/references/journal" +title: "journal" +x-optimade-type: "string" +x-optimade-definition: + label: "journal_optimade_references" + kind: "property" + version: "1.2.0" + format: "1.2" + name: "journal" +type: + - "string" + - "null" +description: |- + The name of a journal (the journal field in the BibTeX specification). +examples: + - "Journal of Environmental Science" +x-optimade-unit: "inapplicable" diff --git a/schemas/src/defs/v1.2/properties/optimade/references/key.yaml b/schemas/src/defs/v1.2/properties/optimade/references/key.yaml new file mode 100644 index 000000000..d5563b146 --- /dev/null +++ b/schemas/src/defs/v1.2/properties/optimade/references/key.yaml @@ -0,0 +1,18 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/property_definition" +$id: "https://schemas.optimade.org/defs/v1.2/properties/optimade/references/key" +title: "key" +x-optimade-type: "string" +x-optimade-definition: + label: "key_optimade_references" + kind: "property" + version: "1.2.0" + format: "1.2" + name: "key" +type: + - "string" + - "null" +description: |- + Used for alphabetizing, cross-referencing, and creating a label (the key field in the BibTeX specification). +examples: + - "smith2022" +x-optimade-unit: "inapplicable" diff --git a/schemas/src/defs/v1.2/properties/optimade/references/last_modified.yaml b/schemas/src/defs/v1.2/properties/optimade/references/last_modified.yaml new file mode 100644 index 000000000..e94788b6e --- /dev/null +++ b/schemas/src/defs/v1.2/properties/optimade/references/last_modified.yaml @@ -0,0 +1,2 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/property_definition" +$$inherit: "/v1.2/properties/core/last_modified" diff --git a/schemas/src/defs/v1.2/properties/optimade/references/month.yaml b/schemas/src/defs/v1.2/properties/optimade/references/month.yaml new file mode 100644 index 000000000..3b351adaa --- /dev/null +++ b/schemas/src/defs/v1.2/properties/optimade/references/month.yaml @@ -0,0 +1,18 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/property_definition" +$id: "https://schemas.optimade.org/defs/v1.2/properties/optimade/references/month" +title: "month" +x-optimade-type: "string" +x-optimade-definition: + label: "month_optimade_references" + kind: "property" + version: "1.2.0" + format: "1.2" + name: "month" +type: + - "string" + - "null" +description: |- + The three-letter abbreviation of the month of publication or writing (the month field in the BibTeX specification). +examples: + - "jul" +x-optimade-unit: "inapplicable" diff --git a/schemas/src/defs/v1.2/properties/optimade/references/note.yaml b/schemas/src/defs/v1.2/properties/optimade/references/note.yaml new file mode 100644 index 000000000..d7d30d668 --- /dev/null +++ b/schemas/src/defs/v1.2/properties/optimade/references/note.yaml @@ -0,0 +1,18 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/property_definition" +$id: "https://schemas.optimade.org/defs/v1.2/properties/optimade/references/note" +title: "note" +x-optimade-type: "string" +x-optimade-definition: + label: "note_optimade_references" + kind: "property" + version: "1.2.0" + format: "1.2" + name: "note" +type: + - "string" + - "null" +description: |- + Additional information about the reference (the note field in the BibTeX specification). +examples: + - "Accessed: 2022-11-04" +x-optimade-unit: "inapplicable" diff --git a/schemas/src/defs/v1.2/properties/optimade/references/number.yaml b/schemas/src/defs/v1.2/properties/optimade/references/number.yaml new file mode 100644 index 000000000..aafd0563c --- /dev/null +++ b/schemas/src/defs/v1.2/properties/optimade/references/number.yaml @@ -0,0 +1,18 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/property_definition" +$id: "https://schemas.optimade.org/defs/v1.2/properties/optimade/references/number" +title: "number" +x-optimade-type: "string" +x-optimade-definition: + label: "number_optimade_references" + kind: "property" + version: "1.2.0" + format: "1.2" + name: "number" +type: + - "string" + - "null" +description: |- + The number of a journal, magazine, technical report, or work in a series (the number field in the BibTeX specification). +examples: + - "3" +x-optimade-unit: "inapplicable" diff --git a/schemas/src/defs/v1.2/properties/optimade/references/organization.yaml b/schemas/src/defs/v1.2/properties/optimade/references/organization.yaml new file mode 100644 index 000000000..e9bd73640 --- /dev/null +++ b/schemas/src/defs/v1.2/properties/optimade/references/organization.yaml @@ -0,0 +1,18 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/property_definition" +$id: "https://schemas.optimade.org/defs/v1.2/properties/optimade/references/organization" +title: "organization" +x-optimade-type: "string" +x-optimade-definition: + label: "organization_optimade_references" + kind: "property" + version: "1.2.0" + format: "1.2" + name: "organization" +type: + - "string" + - "null" +description: |- + The organization sponsoring a conference or publishing a manual (the organization field in the BibTeX specification) +examples: + - "International Association of Engineers" +x-optimade-unit: "inapplicable" diff --git a/schemas/src/defs/v1.2/properties/optimade/references/pages.yaml b/schemas/src/defs/v1.2/properties/optimade/references/pages.yaml new file mode 100644 index 000000000..c36e4b20c --- /dev/null +++ b/schemas/src/defs/v1.2/properties/optimade/references/pages.yaml @@ -0,0 +1,18 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/property_definition" +$id: "https://schemas.optimade.org/defs/v1.2/properties/optimade/references/pages" +title: "pages" +x-optimade-type: "string" +x-optimade-definition: + label: "pages_optimade_references" + kind: "property" + version: "1.2.0" + format: "1.2" + name: "pages" +type: + - "string" + - "null" +description: |- + The page number(s) of the reference (the pages field in the BibTeX specification). +examples: + - "147--154" +x-optimade-unit: "inapplicable" diff --git a/schemas/src/defs/v1.2/properties/optimade/references/publisher.yaml b/schemas/src/defs/v1.2/properties/optimade/references/publisher.yaml new file mode 100644 index 000000000..a84cecde1 --- /dev/null +++ b/schemas/src/defs/v1.2/properties/optimade/references/publisher.yaml @@ -0,0 +1,18 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/property_definition" +$id: "https://schemas.optimade.org/defs/v1.2/properties/optimade/references/publisher" +title: "publisher" +x-optimade-type: "string" +x-optimade-definition: + label: "publisher_optimade_references" + kind: "property" + version: "1.2.0" + format: "1.2" + name: "publisher" +type: + - "string" + - "null" +description: |- + The name of the publisher (the publisher field in the BibTeX specification). +examples: + - "ACM" +x-optimade-unit: "inapplicable" diff --git a/schemas/src/defs/v1.2/properties/optimade/references/school.yaml b/schemas/src/defs/v1.2/properties/optimade/references/school.yaml new file mode 100644 index 000000000..09abdc2a5 --- /dev/null +++ b/schemas/src/defs/v1.2/properties/optimade/references/school.yaml @@ -0,0 +1,18 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/property_definition" +$id: "https://schemas.optimade.org/defs/v1.2/properties/optimade/references/school" +title: "school" +x-optimade-type: "string" +x-optimade-definition: + label: "school_optimade_references" + kind: "property" + version: "1.2.0" + format: "1.2" + name: "school" +type: + - "string" + - "null" +description: |- + The name of the school where a thesis was written (the school field in the BibTeX specification). +examples: + - "Stanford University" +x-optimade-unit: "inapplicable" diff --git a/schemas/src/defs/v1.2/properties/optimade/references/series.yaml b/schemas/src/defs/v1.2/properties/optimade/references/series.yaml new file mode 100644 index 000000000..763fe8656 --- /dev/null +++ b/schemas/src/defs/v1.2/properties/optimade/references/series.yaml @@ -0,0 +1,18 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/property_definition" +$id: "https://schemas.optimade.org/defs/v1.2/properties/optimade/references/series" +title: "series" +x-optimade-type: "string" +x-optimade-definition: + label: "series_optimade_references" + kind: "property" + version: "1.2.0" + format: "1.2" + name: "series" +type: + - "string" + - "null" +description: |- + The name of a series or set of books (the series field in the BibTeX specification). +examples: + - "Lecture Notes in Computer Science" +x-optimade-unit: "inapplicable" diff --git a/schemas/src/defs/v1.2/properties/optimade/references/title.yaml b/schemas/src/defs/v1.2/properties/optimade/references/title.yaml new file mode 100644 index 000000000..538d74a6a --- /dev/null +++ b/schemas/src/defs/v1.2/properties/optimade/references/title.yaml @@ -0,0 +1,18 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/property_definition" +$id: "https://schemas.optimade.org/defs/v1.2/properties/optimade/references/title" +title: "title" +x-optimade-type: "string" +x-optimade-definition: + label: "title_optimade_references" + kind: "property" + version: "1.2.0" + format: "1.2" + name: "title" +type: + - "string" + - "null" +description: |- + The title of the work (the title field in the BibTeX specification). +examples: + - "A Study on the Effects of Sleep Deprivation on Cognitive Performance" +x-optimade-unit: "inapplicable" diff --git a/schemas/src/defs/v1.2/properties/optimade/references/type.yaml b/schemas/src/defs/v1.2/properties/optimade/references/type.yaml new file mode 100644 index 000000000..903078981 --- /dev/null +++ b/schemas/src/defs/v1.2/properties/optimade/references/type.yaml @@ -0,0 +1,2 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/property_definition" +$$inherit: "/v1.2/properties/core/type" diff --git a/schemas/src/defs/v1.2/properties/optimade/references/url.yaml b/schemas/src/defs/v1.2/properties/optimade/references/url.yaml new file mode 100644 index 000000000..0d63f98b6 --- /dev/null +++ b/schemas/src/defs/v1.2/properties/optimade/references/url.yaml @@ -0,0 +1,18 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/property_definition" +$id: "https://schemas.optimade.org/defs/v1.2/properties/optimade/references/url" +title: "URL" +x-optimade-type: "string" +x-optimade-definition: + label: "url_optimade_references" + kind: "property" + version: "1.2.0" + format: "1.2" + name: "url" +type: + - "string" + - "null" +description: |- + The URL of the object being referenced. +examples: + - "https://example.com/papers/my_paper" +x-optimade-unit: "inapplicable" diff --git a/schemas/src/defs/v1.2/properties/optimade/references/volume.yaml b/schemas/src/defs/v1.2/properties/optimade/references/volume.yaml new file mode 100644 index 000000000..bef3718f6 --- /dev/null +++ b/schemas/src/defs/v1.2/properties/optimade/references/volume.yaml @@ -0,0 +1,18 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/property_definition" +$id: "https://schemas.optimade.org/defs/v1.2/properties/optimade/references/volume" +title: "volume" +x-optimade-type: "string" +x-optimade-definition: + label: "volume_optimade_references" + kind: "property" + version: "1.2.0" + format: "1.2" + name: "volume" +type: + - "string" + - "null" +description: |- + The volume number of a journal or multivolume book (the volume field in the BibTeX specification). +examples: + - "14" +x-optimade-unit: "inapplicable" diff --git a/schemas/src/defs/v1.2/properties/optimade/references/year.yaml b/schemas/src/defs/v1.2/properties/optimade/references/year.yaml new file mode 100644 index 000000000..4eb035d63 --- /dev/null +++ b/schemas/src/defs/v1.2/properties/optimade/references/year.yaml @@ -0,0 +1,18 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/property_definition" +$id: "https://schemas.optimade.org/defs/v1.2/properties/optimade/references/year" +title: "year" +x-optimade-type: "string" +x-optimade-definition: + label: "year_optimade_references" + kind: "property" + version: "1.2.0" + format: "1.2" + name: "year" +type: + - "string" + - "null" +description: |- + The year of publication or writing. +examples: + - "1984" +x-optimade-unit: "inapplicable" diff --git a/schemas/src/defs/v1.2/properties/optimade/structures/assemblies.yaml b/schemas/src/defs/v1.2/properties/optimade/structures/assemblies.yaml new file mode 100644 index 000000000..ac655d40c --- /dev/null +++ b/schemas/src/defs/v1.2/properties/optimade/structures/assemblies.yaml @@ -0,0 +1,186 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/property_definition" +$id: "https://schemas.optimade.org/defs/v1.2/properties/optimade/structures/assemblies" +title: "assemblies" +x-optimade-type: "dictionary" +x-optimade-definition: + label: "assemblies_optimade_structures" + kind: "property" + version: "1.2.0" + format: "1.2" + name: "assemblies" +type: + - "object" + - "null" +description: |- + A description of groups of sites that are statistically correlated. + + **Requirements/Conventions**: + + - The property SHOULD be `null` for entries that have no partial occupancies. + - If present, the correct flag MUST be set in the list `structure_features` (see property `structure_features`). + - Client implementations MUST check its presence (as its presence changes the interpretation of the structure). + - If present, it MUST be a list of dictionaries, each of which represents an assembly and MUST have the following two keys: + + - **sites_in_groups**: Index of the sites (0-based) that belong to each group for each assembly. + + Example: `[[1], [2]]`: two groups, one with the second site, one with the third. + Example: `[[1,2], [3]]`: one group with the second and third site, one with the fourth. + + - **group_probabilities**: Statistical probability of each group. It MUST have the same length as `sites_in_groups`. + It SHOULD sum to one. + See below for examples of how to specify the probability of the occurrence of a vacancy. + The possible reasons for the values not to sum to one are the same as already specified above for the `concentration` of each `species`, see property `species`. + + - If a site is not present in any group, it means that it is present with 100 % probability (as if no assembly was specified). + - A site MUST NOT appear in more than one group. + + **Explained examples**: + + - `{"sites_in_groups": [[0], [1]], "group_probabilities": [0.3, 0.7]}`: the first site and the second site never occur at the same time in the unit cell. + Statistically, 30 % of the times the first site is present, while 70 % of the times the second site is present. + - `{"sites_in_groups": [[1,2], [3]], "group_probabilities": [0.3, 0.7]}`: the second and third sites are either present together or not present; they form the first group of atoms for this assembly. + The second group is formed by the fourth site. + Sites of the first group (the second and the third) are never present at the same time as the fourth site. + 30 % of times sites 1 and 2 are present (and site 3 is absent); 70 % of times site 3 is present (and sites 1 and 2 are absent). + + **Notes**: + + - Assemblies are essential to represent, for instance, the situation where an atom can statistically occupy two different positions (sites). + - By defining groups, it is possible to represent, e.g., the case where a functional molecule (and not just one atom) is either present or absent (or the case where it is present in two conformations). + - Considerations on virtual alloys and on vacancies: In the special case of a virtual alloy, these specifications allow two different, equivalent ways of specifying them. + For instance, for a site at the origin with 30 % probability of being occupied by Si, 50 % probability of being occupied by Ge, and 20 % of being a vacancy, the following two representations are possible: + + - Using a single species: + + { + "cartesian_site_positions": [[0,0,0]], + "species_at_sites": ["SiGe-vac"], + "species": [ + { + "name": "SiGe-vac", + "chemical_symbols": ["Si", "Ge", "vacancy"], + "concentration": [0.3, 0.5, 0.2] + } + ] + // ... + } + + + + - Using multiple species and the assemblies: + + { + "cartesian_site_positions": [ [0,0,0], [0,0,0], [0,0,0] ], + "species_at_sites": ["Si", "Ge", "vac"], + "species": [ + { "name": "Si", "chemical_symbols": ["Si"], "concentration": [1.0] }, + { "name": "Ge", "chemical_symbols": ["Ge"], "concentration": [1.0] }, + { "name": "vac", "chemical_symbols": ["vacancy"], "concentration": [1.0] } + ], + "assemblies": [ + { + "sites_in_groups": [ [0], [1], [2] ], + "group_probabilities": [0.3, 0.5, 0.2] + } + ] + // ... + } + + - It is up to the database provider to decide which representation to use, typically depending on the internal format in which the structure is stored. + However, given a structure identified by a unique ID, the API implementation MUST always provide the same representation for it. + - The probabilities of occurrence of different assemblies are uncorrelated. + So, for instance in the following case with two assemblies: + + { + "assemblies": [ + { + "sites_in_groups": [ [0], [1] ], + "group_probabilities": [0.2, 0.8] + }, + { + "sites_in_groups": [ [2], [3] ], + "group_probabilities": [0.3, 0.7] + } + ] + } + + Site 0 is present with a probability of 20 % and site 1 with a probability of 80 %. These two sites are correlated (either site 0 or 1 is present). Similarly, site 2 is present with a probability of 30 % and site 3 with a probability of 70 %. + These two sites are correlated (either site 2 or 3 is present). + However, the presence or absence of sites 0 and 1 is not correlated with the presence or absence of sites 2 and 3 (in the specific example, the pair of sites (0, 2) can occur with 0.2·0.3 = 6% probability; the pair (0, 3) with 0.2·0.7 = 14% probability; the pair (1, 2) with 0.8·0.3 = 24 % probability; and the pair (1, 3) with 0.8·0.7 = 56 % probability). +examples: + - {"sites_in_groups": [[0], [1]], "group_probabilities": [0.3, 0.7]} + - {"sites_in_groups": [[1,2], [3]], "group_probabilities": [0.3, 0.7]} +x-optimade-unit: "inapplicable" +properties: + sites_in_groups: + title: "sites in groups" + x-optimade-type: "list" + x-optimade-dimensions: + names: ["dim_assembly_groups", "dim_assembly_groups_sites"] + type: + - "array" + description: |- + Index of the sites (0-based) that belong to each group for each assembly. + + **Explained examples**: + + - `[[1], [2]]`: two groups, one with the second site, one with the third. + - `[[1,2], [3]]`: one group with the second and third site, one with the fourth. + examples: + - [[1], [2]] + - [[1,2], [3]] + x-optimade-unit: "inapplicable" + items: + title: "group of sites" + x-optimade-type: "list" + x-optimade-dimensions: + names: ["dim_assembly_groups_sites"] + type: + - "array" + description: |- + A list of sites that belong to one group in the assembly. + examples: + - [1] + - [1,2] + x-optimade-unit: "inapplicable" + items: + title: "a site reference" + x-optimade-type: "integer" + type: + - "integer" + description: |- + An integer that refers to a site by index (0-based). + examples: + - 2 + x-optimade-unit: "inapplicable" + group_probabilities: + title: "group probabilities" + x-optimade-type: "list" + x-optimade-dimensions: + names: ["dim_assembly_groups"] + type: + - "array" + description: |- + Statistical probability of each group. + + **Requirements/Conventions**: + + - It MUST have the same length as `sites_in_groups`. + - It SHOULD sum to one. + - The possible reasons for the values not to sum to one are the same as specified in the `concentration` field of the `species` property. + examples: + - [0.3, 0.7] + x-optimade-unit: "inapplicable" + items: + title: "a concentration" + x-optimade-type: "float" + type: + - "number" + description: |- + A float that specifies the statistical probability of a group in the description of assemblies. + examples: + - 0.4 + x-optimade-unit: "dimensionless" +required: + - "sites_in_groups" + - "group_probabilities" diff --git a/schemas/src/defs/v1.2/properties/optimade/structures/cartesian_site_positions.yaml b/schemas/src/defs/v1.2/properties/optimade/structures/cartesian_site_positions.yaml new file mode 100644 index 000000000..f9efe02c7 --- /dev/null +++ b/schemas/src/defs/v1.2/properties/optimade/structures/cartesian_site_positions.yaml @@ -0,0 +1,47 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/property_definition" +$id: "https://schemas.optimade.org/defs/v1.2/properties/optimade/structures/cartesian_site_positions" +title: "Cartesian site positions" +x-optimade-type: "list" +x-optimade-definition: + label: "cartesian_site_positions_optimade_structures" + kind: "property" + version: "1.2.0" + format: "1.2" + name: "cartesian_site_positions" +x-optimade-unit-definitions: + - $$inherit: "/v1.2/units/si/general/angstrom" +x-optimade-dimensions: + names: ["dim_sites", "dim_spatial"] + sizes: [null, 3] +type: + - "array" + - "null" +description: |- + Cartesian positions of each site in the structure. + + A site is usually used to describe positions of atoms; what atoms can be encountered at a given site is conveyed by the `species_at_sites` property, and the species themselves are described in the `species` property. + + **Requirements/Conventions**: + + - It MUST be a list of length equal to the number of sites in the structure, where every element is a list of the three Cartesian coordinates of a site expressed as float values in the unit angstrom (Ã…). + - An entry MAY have multiple sites at the same Cartesian position (for a relevant use of this, see e.g., the property `assemblies`). + + **Explained examples**: + + - `[[0,0,0],[0,0,2]]` indicates a structure with two sites, one sitting at the origin and one along the (positive) *z*-axis, 2 Ã… away from the origin. +examples: + - [[0,0,0],[0,0,2]] +x-optimade-unit: "inapplicable" +items: + x-optimade-type: "list" + x-optimade-dimensions: + names: ["dim_spatial"] + sizes: [3] + type: + - "array" + x-optimade-unit: "inapplicable" + items: + x-optimade-type: "float" + type: + - "number" + x-optimade-unit: "angstrom" diff --git a/schemas/src/defs/v1.2/properties/optimade/structures/chemical_formula_anonymous.yaml b/schemas/src/defs/v1.2/properties/optimade/structures/chemical_formula_anonymous.yaml new file mode 100644 index 000000000..ee4554086 --- /dev/null +++ b/schemas/src/defs/v1.2/properties/optimade/structures/chemical_formula_anonymous.yaml @@ -0,0 +1,19 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/property_definition" +$id: "https://schemas.optimade.org/defs/v1.2/properties/optimade/structures/chemical_formula_anonymous" +title: "anonymous chemical formula" +x-optimade-type: "string" +x-optimade-definition: + label: "chemical_formula_anonymous_optimade_structures" + kind: "property" + version: "1.2.0" + format: "1.2" + name: "chemical_formula_anonymous" +type: + - "string" + - "null" +description: |- + The anonymous formula is the chemical_formula_reduced, but where the elements are instead first ordered by their chemical proportion number, and then, in order left to right, replaced by anonymous symbols A, B, C, ..., Z, Aa, Ba, ..., Za, Ab, Bb, ... and so on. +examples: + - "A2B" + - "A42B42C16D12E10F9G5" +x-optimade-unit: "inapplicable" diff --git a/schemas/src/defs/v1.2/properties/optimade/structures/chemical_formula_descriptive.yaml b/schemas/src/defs/v1.2/properties/optimade/structures/chemical_formula_descriptive.yaml new file mode 100644 index 000000000..9fd820dd5 --- /dev/null +++ b/schemas/src/defs/v1.2/properties/optimade/structures/chemical_formula_descriptive.yaml @@ -0,0 +1,37 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/property_definition" +$id: "https://schemas.optimade.org/defs/v1.2/properties/optimade/structures/chemical_formula_descriptive" +title: "descriptive chemical formula" +x-optimade-type: "string" +x-optimade-definition: + label: "chemical_formula_descriptive_optimade_structures" + kind: "property" + version: "1.2.0" + format: "1.2" + name: "chemical_formula_descriptive" +type: + - "string" + - "null" +description: |- + The chemical formula for a structure as a string in a form chosen by the API implementation. + + **Requirements/Conventions**: + + - The chemical formula is given as a string consisting of properly capitalized element symbols followed by integers or decimal numbers, balanced parentheses, square, and curly brackets `(`,\ `)`, `[`,\ `]`, `{`, `}`, commas, the `+`, `-`, `:` and `=` symbols. + The parentheses are allowed to be followed by a number. + Spaces are allowed anywhere except within chemical symbols. + The order of elements and any groupings indicated by parentheses or brackets are chosen freely by the API implementation. + - The string SHOULD be arithmetically consistent with the element ratios in the `chemical_formula_reduced` property. + - It is RECOMMENDED, but not mandatory, that symbols, parentheses and brackets, if used, are used with the meanings prescribed by [IUPAC's Nomenclature of Organic Chemistry](https://www.qmul.ac.uk/sbcs/iupac/bibliog/blue.html). + + **Query examples**: + + - Note: the free-form nature of this property is likely to make queries on it across different databases inconsistent. + - A filter that matches an exactly given formula: `chemical_formula_descriptive="(H2O)2 Na"`. + - A filter that does a partial match: `chemical_formula_descriptive CONTAINS "H2O"`. +examples: + - "(H2O)2 Na" + - "NaCl" + - "CaCO3" + - "CCaO3" + - "(CH3)3N+ - [CH2]2-OH = Me3N+ - CH2 - CH2OH" +x-optimade-unit: "inapplicable" diff --git a/schemas/src/defs/v1.2/properties/optimade/structures/chemical_formula_hill.yaml b/schemas/src/defs/v1.2/properties/optimade/structures/chemical_formula_hill.yaml new file mode 100644 index 000000000..006b8ca2e --- /dev/null +++ b/schemas/src/defs/v1.2/properties/optimade/structures/chemical_formula_hill.yaml @@ -0,0 +1,36 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/property_definition" +$id: "https://schemas.optimade.org/defs/v1.2/properties/optimade/structures/chemical_formula_hill" +title: "Hill chemical formula" +x-optimade-type: "string" +x-optimade-definition: + label: "chemical_formula_hill_optimade_structures" + kind: "property" + version: "1.2.0" + format: "1.2" + name: "chemical_formula_hill" +type: + - "string" + - "null" +description: |- + The chemical formula for a structure in [Hill form](https://dx.doi.org/10.1021/ja02046a005) with element symbols followed by integer chemical proportion numbers. The proportion number MUST be omitted if it is 1. + + **Requirements/Conventions**: + + - The overall scale factor of the chemical proportions is chosen such that the resulting values are integers that indicate the most chemically relevant unit of which the system is composed. + For example, if the structure is a repeating unit cell with four hydrogens and four oxygens that represents two hydroperoxide molecules, `chemical_formula_hill` is `"H2O2"` (i.e., not `"HO"`, nor `"H4O4"`). + - If the chemical insight needed to ascribe a Hill formula to the system is not present, the property MUST be handled as unset. + - Element symbols MUST have proper capitalization (e.g., `"Si"`, not `"SI"` for "silicon"). + - Elements MUST be placed in [Hill order](https://dx.doi.org/10.1021/ja02046a005>), followed by their integer chemical proportion number. + Hill order means: if carbon is present, it is placed first, and if also present, hydrogen is placed second. + After that, all other elements are ordered alphabetically. + If carbon is not present, all elements are ordered alphabetically. + - If the system has sites with partial occupation and the total occupations of each element do not all sum up to integers, then the Hill formula SHOULD be handled as unset. + - No spaces or separators are allowed. + + **Query examples**: + + - A filter that matches an exactly given formula is `chemical_formula_hill="H2O2"`. + +examples: + - H2O2 +x-optimade-unit: "inapplicable" diff --git a/schemas/src/defs/v1.2/properties/optimade/structures/chemical_formula_reduced.yaml b/schemas/src/defs/v1.2/properties/optimade/structures/chemical_formula_reduced.yaml new file mode 100644 index 000000000..058c60e77 --- /dev/null +++ b/schemas/src/defs/v1.2/properties/optimade/structures/chemical_formula_reduced.yaml @@ -0,0 +1,33 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/property_definition" +$id: "https://schemas.optimade.org/defs/v1.2/properties/optimade/structures/chemical_formula_reduced" +title: "reduced chemical formula" +x-optimade-type: "string" +x-optimade-definition: + label: "chemical_formula_reduced_optimade_structures" + kind: "property" + version: "1.2.0" + format: "1.2" + name: "chemical_formula_reduced" +type: + - "string" + - "null" +description: |- + The reduced chemical formula for a structure as a string with element symbols and integer chemical proportion numbers. + + **Requirements/Conventions**: + + - Intricate queries on formula components are suggested to be formulated using set-type filter operators on the multi valued `elements` and `elements_ratios` properties. + - Element symbols MUST have proper capitalization (e.g., `"Si"`, not `"SI"` for "silicon"). + - Elements MUST be placed in alphabetical order, followed by their integer chemical proportion number. + - For structures with no partial occupation, the chemical proportion numbers are the smallest integers for which the chemical proportion is exactly correct. + - For structures with partial occupation, the chemical proportion numbers are integers that within reasonable approximation indicate the correct chemical proportions. The precise details of how to perform the rounding is chosen by the API implementation. + - No spaces or separators are allowed. + + **Query examples**: + + - A filter that matches an exactly given formula is `chemical_formula_reduced="H2NaO"`. +examples: + - "H2NaO" + - "ClNa" + - "CCaO3" +x-optimade-unit: "inapplicable" diff --git a/schemas/src/defs/v1.2/properties/optimade/structures/dimension_types.yaml b/schemas/src/defs/v1.2/properties/optimade/structures/dimension_types.yaml new file mode 100644 index 000000000..bc29710a4 --- /dev/null +++ b/schemas/src/defs/v1.2/properties/optimade/structures/dimension_types.yaml @@ -0,0 +1,43 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/property_definition" +$id: "https://schemas.optimade.org/defs/v1.2/properties/optimade/structures/dimension_types" +title: "dimension types" +x-optimade-type: "list" +x-optimade-definition: + label: "dimension_types_optimade_structures" + kind: "property" + version: "1.2.0" + format: "1.2" + name: "dimension_types" +x-optimade-dimensions: + names: ["dim_lattice"] +type: + - "array" + - "null" +description: |- + List of three integers describing the periodicity of the boundaries of the unit cell. For each direction indicated by the three lattice_vectors, this list indicates if the direction is periodic (value 1) or non-periodic (value 0). Note: the elements in this list each refer to the direction of the corresponding entry in lattice_vectors and not the Cartesian x, y, z directions. + + **Requirements/Conventions**: + + - MUST be a list of length 3. + - Each integer element MUST assume only the value 0 or 1. + + **Explained examples**: + + - A nonperiodic structure, for example, for a single molecule : `[0, 0, 0]` + - A unit cell that is periodic in the direction of the third lattice vector, for example for a carbon nanotube: `[0, 0, 1]` + - For a 2D surface/slab, with a unit cell that is periodic in the direction of the first and third lattice vectors: `[1, 0, 1]` + - For a bulk 3D system with a unit cell that is periodic in all directions: `[1, 1, 1]` +examples: + - [0, 0, 0] + - [0, 0, 1] + - [1, 0, 1] +x-optimade-unit: "inapplicable" +items: + x-optimade-type: integer + type: + - "integer" + x-optimade-unit: "inapplicable" + description: "The integers 0 and 1 are used to mean false/true in a boolean flag indicating a periodic direction." + enum: + - 0 + - 1 diff --git a/schemas/src/defs/v1.2/properties/optimade/structures/elements.yaml b/schemas/src/defs/v1.2/properties/optimade/structures/elements.yaml new file mode 100644 index 000000000..be71935b2 --- /dev/null +++ b/schemas/src/defs/v1.2/properties/optimade/structures/elements.yaml @@ -0,0 +1,36 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/property_definition" +$id: "https://schemas.optimade.org/defs/v1.2/properties/optimade/structures/elements" +title: "elements" +x-optimade-type: "list" +x-optimade-definition: + label: "elements_optimade_structures" + kind: "property" + version: "1.2.0" + format: "1.2" + name: "elements" +x-optimade-dimensions: + names: ["dim_elements"] +type: + - "array" + - "null" +description: |- + The chemical symbols of the different elements present in the structure. + + **Requirements/Conventions**: + + - The strings are the chemical symbols, i.e., either a single uppercase letter or an uppercase letter followed by a number of lowercase letters. + - The order MUST be alphabetical. + - MUST refer to the same elements in the same order, and therefore be of the same length, as `elements_ratios`, if the latter is provided. + - Note: This property SHOULD NOT contain the string "X" to indicate non-chemical elements or "vacancy" to indicate vacancies (in contrast to the field `chemical_symbols` for the species property). + + **Query examples**: + + - A filter that matches all records of structures that contain Si, Al **and** O, and possibly other elements: `elements HAS ALL "Si", "Al", "O"`. + - To match structures with exactly these three elements, use `elements HAS ALL "Si", "Al", "O" AND elements LENGTH 3`. + - Note: length queries on this property can be equivalently formulated by filtering on the `nelements` property directly. +examples: + - ['Al', 'Si', 'O'] + - ['He'] +x-optimade-unit: "inapplicable" +items: + $$inherit: "/v1.2/properties/optimade/common/element" diff --git a/schemas/src/defs/v1.2/properties/optimade/structures/elements_ratios.yaml b/schemas/src/defs/v1.2/properties/optimade/structures/elements_ratios.yaml new file mode 100644 index 000000000..4e9f146ce --- /dev/null +++ b/schemas/src/defs/v1.2/properties/optimade/structures/elements_ratios.yaml @@ -0,0 +1,40 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/property_definition" +$id: "https://schemas.optimade.org/defs/v1.2/properties/optimade/structures/elements_ratios" +title: "elements ratios" +x-optimade-type: "list" +x-optimade-definition: + label: "elements_ratios_optimade_structures" + kind: "property" + version: "1.2.0" + format: "1.2" + name: "elements_ratios" +x-optimade-dimensions: + names: ["dim_elements"] +type: + - "array" + - "null" +description: |- + Relative proportions of different elements in the structure. + + **Requirements/Conventions**: + + - Composed by the proportions of elements in the structure as a list of floating point numbers. + - The sum of the numbers MUST be 1.0 (within floating point accuracy) + - MUST refer to the same elements in the same order, and therefore be of the same length, as `elements`, if the latter is provided. + + **Query examples**: + + - Note: Useful filters can be formulated using the set operator syntax for correlated values. + However, since the values are floating point values, the use of equality comparisons is generally inadvisable. + - OPTIONAL: a filter that matches structures where approximately 1/3 of the atoms in the structure are the element Al is: `elements:elements_ratios HAS ALL "Al":>0.3333, "Al":<0.3334`. +examples: + - [1.0] + - [0.3333333333333333, 0.2222222222222222, 0.4444444444444444] +x-optimade-unit: "inapplicable" +items: + x-optimade-type: "float" + type: + - "number" + x-optimade-unit: "dimensionless" + minimum: 0.0 + maximum: 1.0 diff --git a/schemas/src/defs/v1.2/properties/optimade/structures/id.yaml b/schemas/src/defs/v1.2/properties/optimade/structures/id.yaml new file mode 100644 index 000000000..9ca0fadf0 --- /dev/null +++ b/schemas/src/defs/v1.2/properties/optimade/structures/id.yaml @@ -0,0 +1,2 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/property_definition" +$$inherit: "/v1.2/properties/core/id" diff --git a/schemas/src/defs/v1.2/properties/optimade/structures/immutable_id.yaml b/schemas/src/defs/v1.2/properties/optimade/structures/immutable_id.yaml new file mode 100644 index 000000000..543c1cec5 --- /dev/null +++ b/schemas/src/defs/v1.2/properties/optimade/structures/immutable_id.yaml @@ -0,0 +1,2 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/property_definition" +$$inherit: "/v1.2/properties/core/immutable_id" diff --git a/schemas/src/defs/v1.2/properties/optimade/structures/last_modified.yaml b/schemas/src/defs/v1.2/properties/optimade/structures/last_modified.yaml new file mode 100644 index 000000000..e94788b6e --- /dev/null +++ b/schemas/src/defs/v1.2/properties/optimade/structures/last_modified.yaml @@ -0,0 +1,2 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/property_definition" +$$inherit: "/v1.2/properties/core/last_modified" diff --git a/schemas/src/defs/v1.2/properties/optimade/structures/lattice_vectors.yaml b/schemas/src/defs/v1.2/properties/optimade/structures/lattice_vectors.yaml new file mode 100644 index 000000000..4df975a62 --- /dev/null +++ b/schemas/src/defs/v1.2/properties/optimade/structures/lattice_vectors.yaml @@ -0,0 +1,51 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/property_definition" +$id: "https://schemas.optimade.org/defs/v1.2/properties/optimade/structures/lattice_vectors" +title: "lattice vectors" +x-optimade-definition: + label: "lattice_vectors_optimade_structures" + kind: "property" + version: "1.2.0" + format: "1.2" + name: "lattice_vectors" +x-optimade-type: "list" +x-optimade-dimensions: + names: ["dim_lattice", "dim_spatial"] + lengths: [3, 3] +x-optimade-unit-definitions: + - $$inherit: "/v1.2/units/si/general/angstrom" +type: + - "array" + - "null" +description: |- + The three lattice vectors in Cartesian coordinates, in Ã¥ngström (Ã…). + + **Requirements/Conventions**: + + - MUST be a list of three vectors *a*, *b*, and *c*, where each of the vectors MUST BE a list of the vector's coordinates along the x, y, and z Cartesian coordinates. + (Therefore, the first index runs over the three lattice vectors and the second index runs over the x, y, z Cartesian coordinates). + - For databases that do not define an absolute Cartesian system (e.g., only defining the length and angles between vectors), the first lattice vector SHOULD be set along *x* and the second on the *xy*-plane. + - MUST always contain three vectors of three coordinates each, independently of the elements of property `dimension_types`. + The vectors SHOULD by convention be chosen so the determinant of the `lattice_vectors` matrix is different from zero. + The vectors in the non-periodic directions have no significance beyond fulfilling these requirements. + - The coordinates of the lattice vectors of non-periodic dimensions (i.e., those dimensions for which `dimension_types` is `0`) MAY be given as a list of all `null` values. + If a lattice vector contains the value `null`, all coordinates of that lattice vector MUST be `null`. + + **Explained examples**: + + - `[[4.0,0.0,0.0],[0.0,4.0,0.0],[0.0,1.0,4.0]]` represents a cell, where the first vector is (4, 0, 0), i.e., a vector aligned along the x axis of length 4 Ã…; the second vector is (0, 4, 0); and the third vector is (0, 1, 4). +examples: + - [[4.0,0.0,0.0],[0.0,4.0,0.0],[0.0,1.0,4.0]] +x-optimade-unit: "inapplicable" +items: + x-optimade-type: "list" + x-optimade-dimensions: + names: ["dim_spatial"] + lengths: [3] + type: + - "array" + x-optimade-unit: "inapplicable" + items: + x-optimade-type: "float" + type: + - "number" + x-optimade-unit: "angstrom" diff --git a/schemas/src/defs/v1.2/properties/optimade/structures/nelements.yaml b/schemas/src/defs/v1.2/properties/optimade/structures/nelements.yaml new file mode 100644 index 000000000..091143345 --- /dev/null +++ b/schemas/src/defs/v1.2/properties/optimade/structures/nelements.yaml @@ -0,0 +1,32 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/property_definition" +$id: "https://schemas.optimade.org/defs/v1.2/properties/optimade/structures/nelements" +title: "number of elements" +x-optimade-type: "integer" +x-optimade-definition: + label: "nelements_optimade_structures" + kind: "property" + version: "1.2.0" + format: "1.2" + name: "nelements" +type: + - "integer" + - "null" +description: |- + Number of different elements in the structure as an integer. + + **Requirements/Conventions**: + + - MUST be equal to the lengths of the list properties elements and elements_ratios, if they are provided. + + **Querying**: + + - Queries on this property can equivalently be formulated using `elements LENGTH`. + - A filter that matches structures that have exactly 4 elements: `nelements=4`. + - A filter that matches structures that have between 2 and 7 elements: `nelements>=2 AND nelements<=7`. +examples: + - 3 +x-optimade-unit: "dimensionless" +x-optimade-requirements: + support: "should" + sortable: false + query-support: "all mandatory" diff --git a/schemas/src/defs/v1.2/properties/optimade/structures/nperiodic_dimensions.yaml b/schemas/src/defs/v1.2/properties/optimade/structures/nperiodic_dimensions.yaml new file mode 100644 index 000000000..9931d675a --- /dev/null +++ b/schemas/src/defs/v1.2/properties/optimade/structures/nperiodic_dimensions.yaml @@ -0,0 +1,33 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/property_definition" +$id: "https://schemas.optimade.org/defs/v1.2/properties/optimade/structures/nperiodic_dimensions" +title: "number of periodic dimensions" +x-optimade-type: "integer" +x-optimade-definition: + label: "nperiodic_dimensions_optimade_structures" + kind: "property" + version: "1.2.0" + format: "1.2" + name: "nperiodic_dimensions" +type: + - "integer" + - "null" +description: |- + An integer specifying the number of periodic dimensions in the structure, equivalent to the number of non-zero entries in `dimension_types`. + + **Requirements/Conventions**: + + - The integer value MUST be between 0 and 3 inclusive and MUST be equal to the sum of the items in the dimension_types property. + + - This property only reflects the treatment of the lattice vectors provided for the structure, and not any physical interpretation of the dimensionality of its contents. + + **Explained examples** + + - `2` should be indicated in cases where dimension_types is any of `[1, 1, 0]`, `[1, 0, 1]`, `[0, 1, 1]`. + + **Query examples**: + + - Match only structures with exactly 3 periodic dimensions: `nperiodic_dimensions=3` + - Match all structures with 2 or fewer periodic dimensions: `nperiodic_dimensions<=2` +examples: + - 2 +x-optimade-unit: "dimensionless" diff --git a/schemas/src/defs/v1.2/properties/optimade/structures/nsites.yaml b/schemas/src/defs/v1.2/properties/optimade/structures/nsites.yaml new file mode 100644 index 000000000..19cfc9e1e --- /dev/null +++ b/schemas/src/defs/v1.2/properties/optimade/structures/nsites.yaml @@ -0,0 +1,27 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/property_definition" +$id: "https://schemas.optimade.org/defs/v1.2/properties/optimade/structures/nsites" +title: "number of sites" +x-optimade-type: "integer" +x-optimade-definition: + label: "nsites_optimade_structures" + kind: "property" + version: "1.2.0" + format: "1.2" + name: "nsites" +type: + - "integer" + - "null" +description: |- + An integer specifying the length of the `cartesian_site_positions` property. + + **Requirements/Conventions**: + + - MUST be equal to the lengths of the list properties elements and elements_ratios, if they are provided. + + **Query examples**: + + - Match only structures with exactly 4 sites: `nsites=4` + - Match structures that have between 2 and 7 sites: `nsites>=2 AND nsites<=7` +examples: + - 42 +x-optimade-unit: "dimensionless" diff --git a/schemas/src/defs/v1.2/properties/optimade/structures/space_group_it_number.yaml b/schemas/src/defs/v1.2/properties/optimade/structures/space_group_it_number.yaml new file mode 100644 index 000000000..e64364147 --- /dev/null +++ b/schemas/src/defs/v1.2/properties/optimade/structures/space_group_it_number.yaml @@ -0,0 +1,23 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/property_definition" +$id: "https://schemas.optimade.org/defs/v1.2/properties/optimade/structures/space_group_it_number" +title: "space group IT number" +x-optimade-type: "integer" +x-optimade-definition: + label: "space_group_it_number_optimade_structures" + kind: "property" + version: "1.2.0" + format: "1.2" + name: "space_group_it_number" +type: + - "integer" + - "null" +description: |- + Space group number for the structure assigned by the International Tables for Crystallography Vol. A. + + **Requirements/Conventions**: + + - The integer value MUST be between 1 and 230. + - MUST be `null` if `nperiodic_dimensions` is not equal to 3. +examples: + - 42 +x-optimade-unit: "unapplicable" diff --git a/schemas/src/defs/v1.2/properties/optimade/structures/space_group_symbol_hall.yaml b/schemas/src/defs/v1.2/properties/optimade/structures/space_group_symbol_hall.yaml new file mode 100644 index 000000000..f39fc6a33 --- /dev/null +++ b/schemas/src/defs/v1.2/properties/optimade/structures/space_group_symbol_hall.yaml @@ -0,0 +1,46 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/property_definition" +$id: "https://schemas.optimade.org/defs/v1.2/properties/optimade/structures/space_group_symbol_hall" +title: "Hall space group symbol" +x-optimade-type: "string" +x-optimade-definition: + label: "space_group_symbol_hall_optimade_structures" + kind: "property" + version: "1.2.0" + format: "1.2" + name: "space_group_symbol_hall" +type: + - "string" + - "null" +description: |- + A Hall space group symbol representing the symmetry of the structure as defined in Hall, S. R. (1981), Acta Cryst. A37, 517-525 and erratum (1981), A37, 921. + + **Requirements/Conventions**: + + - The change-of-basis operations are used as defined in the International Tables of Crystallography (ITC) Vol. B, Sect. 1.4, Appendix A1.4.2 (IUCr, 2001). + - Each component of the Hall symbol MUST be separated by a single space symbol. + - If there exists a standard Hall symbol which represents the symmetry it SHOULD be used. + - MUST be `null` if `nperiodic_dimensions` is not equal to 3. + + **Explained examples**: + + - Space group symbols with explicit origin (the Hall symbols): + + - `P 2c -2ac` + - `-I 4bd 2ab 3` + + - Space group symbols with change-of-basis operations: + + - `P 2yb (-1/2*x+z,1/2*x,y)` + - `-I 4 2 (1/2*x+1/2*y,-1/2*x+1/2*y,z)` + + **Bibliographic References** + + - Hall, S. R. (1981) Space-group notation with an explicit origin. Acta Crystallographica Section A, 37, 517-525, International Union of Crystallography (IUCr), DOI: https://doi.org/10.1107/s0567739481001228 + - Hall, S. R. (1981a) Space-group notation with an explicit origin; erratum. Acta Crystallographica Section A, 37, 921-921, International Union of Crystallography (IUCr), DOI: https://doi.org/10.1107/s0567739481001976 + - IUCr (2001). International Tables for Crystallography vol. B. Reciprocal Space. Ed. U. Shmueli. 2-nd edition. Dordrecht/Boston/London, Kluwer Academic Publishers. +examples: + - "P 2c -2ac" + - "-I 4db 2ab 3" + - "P 2yb (-1/2*x+z,1/2*x,y)" + - "-I 4 2 (1/2*x+1/2*y,-1/2*x+1/2*y,z)" +x-optimade-unit: "unapplicable" diff --git a/schemas/src/defs/v1.2/properties/optimade/structures/space_group_symbol_hermann_mauguin.yaml b/schemas/src/defs/v1.2/properties/optimade/structures/space_group_symbol_hermann_mauguin.yaml new file mode 100644 index 000000000..e28399ea8 --- /dev/null +++ b/schemas/src/defs/v1.2/properties/optimade/structures/space_group_symbol_hermann_mauguin.yaml @@ -0,0 +1,35 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/property_definition" +$id: "https://schemas.optimade.org/defs/v1.2/properties/optimade/structures/space_group_symbol_hermann_mauguin" +title: "Hermann-Mauguin space group symbol" +x-optimade-type: "string" +x-optimade-definition: + label: "space_group_symbol_hermann_mauguin_optimade_structures" + kind: "property" + version: "1.2.0" + format: "1.2" + name: "space_group_symbol_hermann_mauguin" +type: + - "string" + - "null" +description: |- + A human- and machine-readable string containing the short Hermann-Mauguin (H-M) symbol which specifies the space group of the structure in the response. + + **Requirements/Conventions**: + + - The H-M symbol SHOULD aim to convey the closest representation of the symmetry information that can be specified using the short format used in the International Tables for Crystallography vol. A (IUCr, 2005), Table 4.3.2.1 as described in the accompanying text. + - The symbol MAY be a non-standard short H-M symbol. + - The H-M symbol does not unambiguously communicate the axis, cell, and origin choice, and the given symbol SHOULD NOT be amended to convey this information. + - To encode as character strings, the following adaptations MUST be made when representing H-M symbols given in their typesetted form: + + - the overbar above the numbers MUST be changed to the minus sign in front of the digit (e.g. `-2`); + - subscripts that denote screw axes are written as digits immediately after the axis designator without a space (e.g. `P 32`); + - the space group generators MUST be separated by a single space (e.g. `P 21 21 2`); + - there MUST be no spaces in the space group generator designation (i.e. use `P 21/m`, not the `P 21 / m`); + + **Bibliographic References** + + - IUCr (2005). International Tables for Crystallography vol. A. Space-Group Symmetry. Ed. Theo Hahn. 5-th edition. Dordrecht, Springer. +examples: + - "C 2" + - "P 21 21 21" +x-optimade-unit: "unapplicable" diff --git a/schemas/src/defs/v1.2/properties/optimade/structures/space_group_symbol_hermann_mauguin_extended.yaml b/schemas/src/defs/v1.2/properties/optimade/structures/space_group_symbol_hermann_mauguin_extended.yaml new file mode 100644 index 000000000..1965269bd --- /dev/null +++ b/schemas/src/defs/v1.2/properties/optimade/structures/space_group_symbol_hermann_mauguin_extended.yaml @@ -0,0 +1,31 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/property_definition" +$id: "https://schemas.optimade.org/defs/v1.2/properties/optimade/structures/space_group_symbol_hermann_mauguin_extended" +title: "extended Hermann-Mauguin space group symbol" +x-optimade-type: "string" +x-optimade-definition: + label: "space_group_symbol_hermann_mauguin_extended_optimade_structures" + kind: "property" + version: "1.2.0" + format: "1.2" + name: "space_group_symbol_hermann_mauguin_extended" +type: + - "string" + - "null" +description: |- + A human- and machine-readable string containing the extended Hermann-Mauguin (H-M) symbol which specifies the space group of the structure in the response. + + **Requirements/Conventions**: + + - The H-M symbols SHOULD be given as specified in the International Tables for Crystallography vol. A (IUCr, 2005), Table 4.3.2.1. + - The change-of-basis operation SHOULD be provided for the non-standard axis and cell choices. + - The extended H-M symbol does not unambiguously communicate the origin choice, and the given symbol SHOULD NOT be amended to convey this information. + - The description of the change-of-basis SHOULD follow conventions of the ITC Vol. B, Sect. 1.4, Appendix A1.4.2 (IUCr, 2001). + - The same character string encoding conventions MUST be used as for the specification of the `space_group_symbol_hermann_mauguin` property. + + **Bibliographic References** + + - IUCr (2001). International Tables for Crystallography vol. B. Reciprocal Space. Ed. U. Shmueli. 2-nd edition. Dordrecht/Boston/London, Kluwer Academic Publishers. + - IUCr (2005). International Tables for Crystallography vol. A. Space-Group Symmetry. Ed. Theo Hahn. 5-th edition. Dordrecht, Springer. +examples: + - "C 1 2 1" +x-optimade-unit: "unapplicable" diff --git a/schemas/src/defs/v1.2/properties/optimade/structures/space_group_symmetry_operations_xyz.yaml b/schemas/src/defs/v1.2/properties/optimade/structures/space_group_symmetry_operations_xyz.yaml new file mode 100644 index 000000000..345c041f1 --- /dev/null +++ b/schemas/src/defs/v1.2/properties/optimade/structures/space_group_symmetry_operations_xyz.yaml @@ -0,0 +1,50 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/property_definition" +$id: "https://schemas.optimade.org/defs/v1.2/properties/optimade/structures/space_group_symmetry_operations_xyz" +title: "space group symmetry operations" +x-optimade-type: "list" +x-optimade-definition: + label: "space_group_symmetry_operations_xyz_optimade_structures" + kind: "property" + version: "1.2.0" + format: "1.2" + name: "space_group_symmetry_operations_xyz" +type: + - "array" + - "null" +description: |- + A list of symmetry operations given as general position x, y and z coordinates in algebraic form. + + **Requirements/Conventions**: + + - MUST be `null` if the property `nperiodic_dimensions` is equal to 0. + - Each symmetry operation is described by a string that gives that symmetry operation in Jones' faithful representation (Bradley & Cracknell, 1972: pp. 35-37), adapted for computer string notation. + - The letters `x`, `y` and `z` that are typesetted with overbars in printed text represent coordinate values multiplied by -1 and are encoded as `-x`, `-y` and `-z`, respectively. + - The syntax of the string representing a symmetry operation MUST conform to regular expressions given in the OPTIMADE specification appendix 'The Symmetry Operation String Regular Expressions'. + - The interpretation of the strings MUST follow the conventions of the IUCr CIF core dictionary (IUCr, 2023). + - In particular, this property MUST explicitly provide all symmetry operations needed to generate all the atoms in the unit cell from the atoms in the asymmetric unit, for the setting used. + - This symmetry operation set MUST always include the `x,y,z` identity operation. + - The symmetry operations are to be applied to fractional atom coordinates. + - In case only Cartesian coordinates are available, these Cartesian coordinates must be converted to fractional coordinates before the application of the provided symmetry operations. + - If the symmetry operation list is present, it MUST be compatible with other space group specifications (e.g. the ITC space group number, the Hall symbol, the Hermann-Mauguin symbol) if these are present. + + **Notes**: + + - The list of space group symmetry operations applies to the whole periodic array of atoms and together with the lattice translations given in the `lattice_vectors` property provides the necessary information to reconstruct all atom site positions of the periodic material. + - Thus, the symmetry operations described in this property are only applicable to material models with at least one periodic dimension. + - This property is not meant to represent arbitrary symmetries of molecules, non-periodic (finite) collections of atoms or non-crystallographic symmetry. + + **Explained examples**: + + - Space group operations for the space group with ITC number 3 (H-M symbol `P 2`, extended H-M symbol `P 1 2 1`, Hall symbol `P 2y`): `["x,y,z", "-x,y,-z"]` + - Space group operations for the space group with ITC number 5 (H-M symbol `C 2`, extended H-M symbol `C 1 2 1`, Hall symbol `C 2y`): `["x,y,z", "-x,y,-z", "x+1/2,y+1/2,z", "-x+1/2,y+1/2,-z"]` + + **Bibliographic References** + + - Bradley, C. J. and Cracknell, A. P. (1972) The Mathematical Theory of Symmetry in Solids. Oxford, Clarendon Press (paperback edition 2010) 745 p. [ISBN 978-0-19-958258-7](https://isbnsearch.org/isbn/9780199582587>). + - IUCr (2023) Core dictionary (coreCIF) version 2.4.5; data name `_space_group_symop_operation_xyz`. Available from: [https://www.iucr.org/__data/iucr/cifdic_html/1/cif_core.dic/Ispace_group_symop_operation_xyz.html](https://www.iucr.org/__data/iucr/cifdic_html/1/cif_core.dic/Ispace_group_symop_operation_xyz.html) [Accessed 2023-06-18T16:46+03:00]. +examples: + - ["x,y,z", "-x,y,-z"] + - ["x,y,z", "-x,y,-z", "x+1/2,y+1/2,z", "-x+1/2,y+1/2,-z"] +x-optimade-unit: "unapplicable" +items: + $$inherit: "/v1.2/properties/optimade/common/space_group_symmetry_operation_xyz" diff --git a/schemas/src/defs/v1.2/properties/optimade/structures/species.yaml b/schemas/src/defs/v1.2/properties/optimade/structures/species.yaml new file mode 100644 index 000000000..03eb82792 --- /dev/null +++ b/schemas/src/defs/v1.2/properties/optimade/structures/species.yaml @@ -0,0 +1,234 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/property_definition" +$id: "https://schemas.optimade.org/defs/v1.2/properties/optimade/structures/species" +title: "species" +x-optimade-type: "list" +x-optimade-definition: + label: "species_optimade_structures" + kind: "property" + version: "1.2.0" + format: "1.2" + name: "species" +x-optimade-dimensions: + names: ["dim_species"] +x-optimade-unit-definitions: + - $$inherit: "/v1.2/units/si/general/atomicmassunit" +type: + - "array" + - "null" +description: |- + A list describing the species of the sites of this structure. Species can represent pure chemical elements, virtual-crystal atoms representing a statistical occupation of a given site by multiple chemical elements, and/or a location to which there are attached atoms, i.e., atoms whose precise location are unknown beyond that they are attached to that position (frequently used to indicate hydrogen atoms attached to another element, e.g., a carbon with three attached hydrogens might represent a methyl group, -CH3). + + **Requirements/Conventions**: + + - Each list member MUST be a dictionary with the following keys: + + - **name**: REQUIRED; gives the name of the species; the **name** value MUST be unique in the `species` list; + + - **chemical\_symbols**: REQUIRED; MUST be a list of strings of all chemical elements composing this species. Each item of the list MUST be one of the following: + + - a valid chemical-element symbol, or + - the special value `"X"` to represent a non-chemical element, or + - the special value `"vacancy"` to represent that this site has a non-zero probability of having a vacancy (the respective probability is indicated in the `concentration` list, see below). + + If any one entry in the `species` list has a `chemical_symbols` list that is longer than 1 element, the correct flag MUST be set in the list `structure_features` (see property `structure_features`). + + - **concentration**: REQUIRED; MUST be a list of floats, with same length as `chemical_symbols`. The numbers represent the relative concentration of the corresponding chemical symbol in this species. + The numbers SHOULD sum to one. Cases in which the numbers do not sum to one typically fall only in the following two categories: + + - Numerical errors when representing float numbers in fixed precision, e.g. for two chemical symbols with concentrations `1/3` and `2/3`, the concentration might look something like `[0.33333333333, 0.66666666666]`. If the client is aware that the sum is not one because of numerical precision, it can renormalize the values so that the sum is exactly one. + - Experimental errors in the data present in the database. In this case, it is the responsibility of the client to decide how to process the data. + + Note that concentrations are uncorrelated between different sites (even of the same species). + + - **attached**: OPTIONAL; if provided MUST be a list of length 1 or more of strings of chemical symbols for the elements attached to this site, or "X" for a non-chemical element. + - **nattached**: OPTIONAL; if provided MUST be a list of length 1 or more of integers indicating the number of attached atoms of the kind specified in the value of the `attached` key. + + The implementation MUST include either both or none of the `attached` and `nattached` keys, and if they are provided, they MUST be of the same length. + Furthermore, if they are provided, the `structure_features` property MUST include the string `site_attachments`. + + - **mass**: OPTIONAL. If present MUST be a list of floats, with the same length as `chemical_symbols`, providing element masses expressed in a.m.u. + Elements denoting vacancies MUST have masses equal to 0. + - **original\_name**: OPTIONAL. Can be any valid Unicode string, and SHOULD contain (if specified) the name of the species that is used internally in the source database. + + **Note**: With regard to "source database", we refer to the immediate source being queried via the OPTIMADE API implementation. + The main use of this field is for source databases that use species names, containing characters that are not allowed (see description of the list property `species_at_sites`). + + - For systems that have only species formed by a single chemical symbol, and that have at most one species per chemical symbol, SHOULD use the chemical symbol as species name (e.g., `"Ti"` for titanium, `"O"` for oxygen, etc.) + However, note that this is OPTIONAL, and client implementations MUST NOT assume that the key corresponds to a chemical symbol, nor assume that if the species name is a valid chemical symbol, that it represents a species with that chemical symbol. + This means that a species `{"name": "C", "chemical_symbols": ["Ti"], "concentration": [1.0]}` is valid and represents a titanium species (and *not* a carbon species). + - It is NOT RECOMMENDED that a structure includes species that do not have at least one corresponding site. + + **Explained examples**: + + - `[ {"name": "Ti", "chemical_symbols": ["Ti"], "concentration": [1.0]} ]`: any site with this species is occupied by a Ti atom. + - `[ {"name": "Ti", "chemical_symbols": ["Ti", "vacancy"], "concentration": [0.9, 0.1]} ]`: any site with this species is occupied by a Ti atom with 90 % probability, and has a vacancy with 10 % probability. + - `[ {"name": "BaCa", "chemical_symbols": ["vacancy", "Ba", "Ca"], "concentration": [0.05, 0.45, 0.5], "mass": [0.0, 137.327, 40.078]} ]`: any site with this species is occupied by a Ba atom with 45 % probability, a Ca atom with 50 % probability, and by a vacancy with 5 % probability. + - `[ {"name": "C12", "chemical_symbols": ["C"], "concentration": [1.0], "mass": [12.0]} ]`: any site with this species is occupied by a carbon isotope with mass 12. + - `[ {"name": "C13", "chemical_symbols": ["C"], "concentration": [1.0], "mass": [13.0]} ]`: any site with this species is occupied by a carbon isotope with mass 13. + - `[ {"name": "CH3", "chemical_symbols": ["C"], "concentration": [1.0], "attached": ["H"], "nattached": [3]} ]`: any site with this species is occupied by a methyl group, -CH3, which is represented without specifying precise positions of the hydrogen atoms. +examples: + - [ {"name": "Ti", "chemical_symbols": ["Ti"], "concentration": [1.0]} ] + - [ {"name": "Ti", "chemical_symbols": ["Ti", "vacancy"], "concentration": [0.9, 0.1]} ] + - [ {"name": "BaCa", "chemical_symbols": ["vacancy", "Ba", "Ca"], "concentration": [0.05, 0.45, 0.5], "mass": [0.0, 137.327, 40.078]} ] + - [ {"name": "C12", "chemical_symbols": ["C"], "concentration": [1.0], "mass": [12.0]} ] + - [ {"name": "C13", "chemical_symbols": ["C"], "concentration": [1.0], "mass": [13.0]} ] + - [ {"name": "CH3", "chemical_symbols": ["C"], "concentration": [1.0], "attached": ["H"], "nattached": [3]} ] +x-optimade-unit: "inapplicable" +items: + title: "species declaration" + x-optimade-type: "dictionary" + description: |- + A declaration of a species of the sites of this structure. Species can represent pure chemical elements, virtual-crystal atoms representing a statistical occupation of a given site by multiple chemical elements, and/or a location to which there are attached atoms, i.e., atoms whose precise location are unknown beyond that they are attached to that position (frequently used to indicate hydrogen atoms attached to another element, e.g., a carbon with three attached hydrogens might represent a methyl group, -CH3). + x-optimade-unit: inapplicable + type: + - "object" + properties: + name: + $$inherit: "/v1.2/properties/optimade/common/species_name" + chemical_symbols: + title: "chemical symbols" + x-optimade-type: "list" + x-optimade-dimensions: + names: ["dim_species_chemical_symbols"] + type: + - "array" + description: |- + The chemical symbols for the elements composing this species. + + **Requirements/Conventions**: + + - MUST be a list of strings of all chemical elements composing this species. + Each item of the list MUST be one of the following: + + - a valid chemical-element symbol, or + - the special value `"X"` to represent a non-chemical element, or + - the special value `"vacancy"` to represent that this site has a non-zero probability of having a vacancy (the respective probability is indicated in the `concentration` list, see below). + + If any one entry in the `species` list has a `chemical_symbols` list that is longer than 1 element, the correct flag MUST be set in the list `structure_features` (see property `structure_features`). + examples: + - ["Na", "Cl"] + - ["Si", "Mn", "X", "vacancy"] + x-optimade-unit: "inapplicable" + items: + $$inherit: "/v1.2/properties/optimade/common/chemical_symbol_or_vacancy" + concentration: + title: "concentration" + x-optimade-type: "list" + x-optimade-dimensions: + names: ["dim_species_chemical_symbols"] + type: + - "array" + description: |- + A list of the relative concentrations of the elements composing this species. + + **Requirements/Conventions**: + + - MUST be a list of floats, with same length as `chemical_symbols`. The numbers represent the relative concentration of the corresponding chemical symbol in this species. + - The numbers SHOULD sum to one. Cases in which the numbers do not sum to one typically fall only in the following two categories: + + - Numerical errors when representing float numbers in fixed precision, e.g. for two chemical symbols with concentrations `1/3` and `2/3`, the concentration might look something like `[0.33333333333, 0.66666666666]`. If the client is aware that the sum is not one because of numerical precision, it can renormalize the values so that the sum is exactly one. + - Experimental errors in the data present in the database. In this case, it is the responsibility of the client to decide how to process the data. + + Note that concentrations are uncorrelated between different sites (even of the same species). + examples: + - [1.0] + - [0.3333333333333333, 0.2222222222222222, 0.4444444444444444] + x-optimade-unit: "inapplicable" + items: + x-optimade-type: "float" + type: + - "number" + x-optimade-unit: "dimensionless" + minimum: 0.0 + maximum: 1.0 + attached: + title: "attached chemical symbols" + x-optimade-type: "list" + x-optimade-dimensions: + names: ["dim_species_attached"] + type: + - "array" + description: |- + The chemical symbols of the elements or non-chemical elements attached to a site that has been assinged this species. + + **Requirements/Conventions**: + + - MUST be a list of strings of all chemical elements composing this species. + Each item of the list MUST be one of the following: + + - a valid chemical-element symbol. + - the special value `"X"` to represent a non-chemical element. + + If any one entry in the `species` list has a `attached` list that is longer than 1 element, the correct flag MUST be set in the list `structure_features` (see property `structure_features`). + examples: + - ["Na", "Cl"] + - ["Si", "Mn", "X"] + x-optimade-unit: "inapplicable" + items: + $$inherit: "/v1.2/properties/optimade/common/chemical_symbol" + nattached: + title: "number of attached entities" + x-optimade-type: "list" + x-optimade-dimensions: + names: ["dim_species_attached"] + type: + - "array" + description: |- + MUST be a list of length 1 or more of integers indicating the number of attached atoms of the kind specified in the value of the `attached` key. + + **Requirements/Conventions**: + + - The implementation MUST include either both or none of the `attached` and `nattached` keys, and if they are provided, they MUST be of the same length. + Furthermore, if they are provided, the `structure_features` property MUST include the string `site_attachments`. + examples: + - [1, 2, 5, 7] + x-optimade-unit: "inapplicable" + items: + x-optimade-type: "integer" + type: + - "integer" + x-optimade-unit: "dimensionless" + minimum: 0 + mass: + title: "masses of the entities composing the species" + x-optimade-type: "list" + x-optimade-dimensions: + names: ["dim_species_chemical_symbols"] + type: + - "array" + description: |- + MUST be a list of floats, with the same length as `chemical_symbols`, providing element masses expressed in a.m.u. + + **Requirements/Conventions**: + + - Elements denoting vacancies MUST have masses equal to 0. + examples: + - [58.933195, 28.0855] + x-optimade-unit: "inapplicable" + items: + x-optimade-type: "float" + type: + - "number" + x-optimade-unit: "dalton" + minimum: 0.0 + original_name: + title: "original name" + x-optimade-type: "string" + type: + - "string" + description: |- + A name for the species that derives from the source database. + + **Requirements/Conventions**: + + - Can be any valid Unicode string, and SHOULD contain (if specified) the name of the species that is used internally in the source database. + + **Note**: With regard to "source database", we refer to the immediate source being queried via the OPTIMADE API implementation. + The main use of this field is for source databases that use species names, containing characters that are not allowed (see description of the list property `species_at_sites`). + examples: + - "Na[49385]" + x-optimade-unit: "inapplicable" + required: + - "name" + - "chemical_symbols" + - "concentration" diff --git a/schemas/src/defs/v1.2/properties/optimade/structures/species_at_sites.yaml b/schemas/src/defs/v1.2/properties/optimade/structures/species_at_sites.yaml new file mode 100644 index 000000000..de9389a5d --- /dev/null +++ b/schemas/src/defs/v1.2/properties/optimade/structures/species_at_sites.yaml @@ -0,0 +1,36 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/property_definition" +$id: "https://schemas.optimade.org/defs/v1.2/properties/optimade/structures/species_at_sites" +title: "species at sites" +x-optimade-type: "list" +x-optimade-definition: + label: "species_at_sites_optimade_structures" + kind: "property" + version: "1.2.0" + format: "1.2" + name: "species_at_sites" +x-optimade-dimensions: + names: ["dim_sites"] +type: + - "array" + - "null" +description: |- + Name of the species at each site (where values for sites are specified with the same order of the property `cartesian_site_positions`). The properties of the species are found in the property `species`. + + **Requirements/Conventions**: + + - MUST have length equal to the number of sites in the structure (first dimension of the list property `cartesian_site_positions`). + - Each species name mentioned in the `species_at_sites` list MUST be described in the list property `species` (i.e. for each value in the `species_at_sites` list there MUST exist exactly one dictionary in the `species` list with the `name` attribute equal to the corresponding `species_at_sites` value). + - Each site MUST be associated only to a single species. + **Note**: However, species can represent mixtures of atoms, and multiple species MAY be defined for the same chemical element. + This latter case is useful when different atoms of the same type need to be grouped or distinguished, for instance in simulation codes to assign different initial spin states. + + **Explained examples**: + + - `["Ti","O2"]` indicates that the first site is hosting a species labeled `"Ti"` and the second a species labeled `"O2"` + - `["Ac", "Ac", "Ag", "Ir"]` indicates that the first two sites contain the `"Ac"` species, while the third and fourth sites contain the `"Ag"` and `"Ir"` species, respectively. +examples: + - ["Ti","O2"] + - ["Ac", "Ac", "Ag", "Ir"] +x-optimade-unit: "inapplicable" +items: + $$inherit: "/v1.2/properties/optimade/common/species_name" diff --git a/schemas/src/defs/v1.2/properties/optimade/structures/structure_features.yaml b/schemas/src/defs/v1.2/properties/optimade/structures/structure_features.yaml new file mode 100644 index 000000000..86028c400 --- /dev/null +++ b/schemas/src/defs/v1.2/properties/optimade/structures/structure_features.yaml @@ -0,0 +1,31 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/property_definition" +$id: "https://schemas.optimade.org/defs/v1.2/properties/optimade/structures/structure_features" +title: "structure features" +$$inherit: "/v1.2/properties/core/features" +x-optimade-definition: + label: "structure_features_optimade_structures" + kind: "property" + version: "1.2.0" + format: "1.2" + name: "structure_features" +description: |- + A list of strings that flag which special features are used by the structure. + + **Requirements/Conventions:** + + - MUST be an empty list if no special features are used. + - MUST be sorted alphabetically. + - If a special feature listed below is used, the list MUST contain the corresponding string. + - If a special feature listed below is not used, the list MUST NOT contain the corresponding string. + - **List of strings used to indicate special structure features:** + + - `disorder`: this flag MUST be present if any one entry in the species list has a `chemical_symbols` list that is longer than 1 element. + - `implicit_atoms`: this flag MUST be present if the structure contains atoms that are not assigned to sites via the property `species_at_sites` (e.g., because their positions are unknown). When this flag is present, the properties related to the chemical formula will likely not match the type and count of atoms represented by the `species_at_sites`, `species`, and `assemblies` properties. + - `site_attachments`: this flag MUST be present if any one entry in the species list includes `attached` and `nattached`. + - `assemblies`: this flag MUST be present if the property assemblies is present. + + **Explained examples**: + + - A structure having implicit atoms and using assemblies: `["assemblies", "implicit_atoms"]` +examples: + - ["assemblies", "implicit_atoms"] diff --git a/schemas/src/defs/v1.2/properties/optimade/structures/type.yaml b/schemas/src/defs/v1.2/properties/optimade/structures/type.yaml new file mode 100644 index 000000000..903078981 --- /dev/null +++ b/schemas/src/defs/v1.2/properties/optimade/structures/type.yaml @@ -0,0 +1,2 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/property_definition" +$$inherit: "/v1.2/properties/core/type" diff --git a/schemas/src/defs/v1.2/standards/optimade.yaml b/schemas/src/defs/v1.2/standards/optimade.yaml new file mode 100644 index 000000000..5cc1af42b --- /dev/null +++ b/schemas/src/defs/v1.2/standards/optimade.yaml @@ -0,0 +1,23 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/standard_definition" +$id: "https://schemas.optimade.org/defs/v1.2/standards/optimade" +title: "OPTIMADE standard" +description: "The OPTIMADE standard node types and properties" +x-optimade-definition: + label: "optimade_standard" + kind: "standard" + format: "1.2" + version: "1.2.0" + name: "optimade" +entrytypes: + structures: + $$inherit: "/v1.2/entrytypes/optimade/structures" + x-optimade-requirements: + support: "must" + files: + $$inherit: "/v1.2/entrytypes/optimade/files" + x-optimade-requirements: + support: "may" + references: + $$inherit: "/v1.2/entrytypes/optimade/references" + x-optimade-requirements: + support: "may" diff --git a/schemas/src/defs/v1.2/units/codata/1969/electromagnetic/bohrmagneton.yaml b/schemas/src/defs/v1.2/units/codata/1969/electromagnetic/bohrmagneton.yaml new file mode 100644 index 000000000..7ca73c1b0 --- /dev/null +++ b/schemas/src/defs/v1.2/units/codata/1969/electromagnetic/bohrmagneton.yaml @@ -0,0 +1,30 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/codata/1969/electromagnetic/bohrmagneton" +title: "Bohr magneton" +symbol: "bohrmagneton" +display-symbol: '\(\mu_B\)' +description: |- + A unit expressing the magnetic moment of an electron caused by its orbital or spin angular momentum defined as part of CODATA 1969. + + "The magneton moment of the free electron in units of the Bohr magneton \(\mu_B=e\hbar/2m_e\)" [B. N. Taylor, W. H. Parker, and D. N. Langenberg, Rev. Mod. Phys. 41(3), 375-496 (1969)] +resources: + - relation: 'Defining paper: B. N. Taylor, W. H. Parker, and D. N. Langenberg, Rev. Mod. Phys. 41(3), 375-496 (1969)' + resource-id: "https://doi.org/10.1103/RevModPhys.41.375" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Bohr_magneton" +approximate-relations: + - base-units: + - symbol: "bohrmagneton" + id: "https://schemas.optimade.org/defs/v1.2/constants/codata/2018/electromagnetic/bohrmagneton" + base-units-expression: "bohrmagneton" +standard: + name: "codata" + year: 1969 + category: "electromagnetic" + symbol: '\(\mu_B\)' +x-optimade-definition: + label: "bohrmagneton_codata_1969_electromagnetic" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "bohrmagneton" diff --git a/schemas/src/defs/v1.2/units/independent/1948/information/bit.yaml b/schemas/src/defs/v1.2/units/independent/1948/information/bit.yaml new file mode 100644 index 000000000..84c2a79a3 --- /dev/null +++ b/schemas/src/defs/v1.2/units/independent/1948/information/bit.yaml @@ -0,0 +1,20 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/independent/1948/information/bit" +title: "bit" +symbol: "bit" +display-symbol: "bit" +description: |- + A basic unit of digital information representing a single logical state with one of two possible values, defined by Shannon in 1948. + + "If the base 2 is used the resulting units may be called binary digits, or more briefly bits, a word suggested by J. W. Tukey. A device with two stable positions, such as a relay or a flip-flop circuit, can store one bit of information." ["A Mathematical Theory of Communication", C. E. Shannon, The Bell System Technical Journal 27, 379 (1948)]. +resources: + - relation: 'Defining paper: "A Mathematical Theory of Communication" by C. E. Shannon, The Bell System Technical Journal, Vol. 27, pp. 379–423 (1948).' + resource-id: "https://doi.org/10.1002/j.1538-7305.1948.tb01338.x" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Bit" +x-optimade-definition: + label: "bit_independent_1948_information" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "bit" diff --git a/schemas/src/defs/v1.2/units/iso-iec-80000/2008/information_science_and_technology/byte.yaml b/schemas/src/defs/v1.2/units/iso-iec-80000/2008/information_science_and_technology/byte.yaml new file mode 100644 index 000000000..d01daab22 --- /dev/null +++ b/schemas/src/defs/v1.2/units/iso-iec-80000/2008/information_science_and_technology/byte.yaml @@ -0,0 +1,32 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/iso-iec-80000/2008/information_science_and_technology/byte" +title: "byte" +symbol: "B" +display-symbol: "B" +description: |- + A unit of digital information representing eight bits, defined in the International System of Quantities in ISO/IEC 80000-13 (2008). + + "In English, the name byte, symbol B, is used as a synonym for octet. Here byte means an eight-bit byte." [ISO/IEC 80000-13 (2008)] +resources: + - relation: "Defining standard" + resource-id: "https://www.iso.org/standard/31898.html" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Byte" +defining-relation: + base-units: + - symbol: "bit" + id: "https://schemas.optimade.org/defs/v1.2/units/independent/1948/information/bit" + base-units-expression: "bit" + scale: + numerator: 8 +standard: + name: "iso-iec-80000" + year: 2008 + category: "information_science_and_technology" + symbol: "B" +x-optimade-definition: + label: "byte_iso_iec_80000_2008_information_science_and_technology" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "byte" diff --git a/schemas/src/defs/v1.2/units/si/1960/base/ampere.yaml b/schemas/src/defs/v1.2/units/si/1960/base/ampere.yaml new file mode 100644 index 000000000..f0b2d2633 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/1960/base/ampere.yaml @@ -0,0 +1,33 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/base/ampere" +title: "ampere" +symbol: "A" +display-symbol: "A" +description: |- + The SI base unit of electric current defined from the force between parallel wires carrying an electric current, which was included in the SI at the 11th CGPM Meeting in 1960. + + "The ampere is that constant current which, if maintained in two straight parallel conductors of infinite length, of negligible circular cross-section, and placed 1 metre apart in vacuum, would produce between these conductors a force equal to 2×10â»â· MKS unit of force per metre of length." [41st CIPM meeting (1946), Resolution 2]. + The ampere was adopted into SI at the 11th CGPM Meeting in 1960, resolution 12. + + Furthermore, the SI 1960 definition of the ampere depend on: + + - the SI 1960 metre (https://schemas.optimade.org/defs/v1.2/units/si/1960/base/metre) + - the MKS unit of force, which references the derived SI unit newton (https://schemas.optimade.org/defs/v1.2/units/si/1960/derived/newton) equal to kilogram·metre·secondâ»Â², referencing the SI 1960 kilogram (https://schemas.optimade.org/defs/v1.2/units/si/1960/base/kilogram), metre (https://schemas.optimade.org/defs/v1.2/units/si/1960/base/metre) and second (https://schemas.optimade.org/defs/v1.2/units/si/1960/base/second). +resources: + - relation: "Definition at the 41st CIPM meeting (1946), resolution 2" + resource-id: "https://www.bipm.org/en/committees/ci/cipm/41-1946/resolution-2" + - relation: "Establishment of the SI unit system at the 11th CGPM meeting (1960), resolution 12." + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/11-1960/resolution-12" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Ampere" +standard: + name: "si" + year: 1960 + category: "base" + symbol: "A" +x-optimade-definition: + label: "ampere_si_1960_base" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "ampere" diff --git a/schemas/src/defs/v1.2/units/si/1960/base/candela.yaml b/schemas/src/defs/v1.2/units/si/1960/base/candela.yaml new file mode 100644 index 000000000..53de864b4 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/1960/base/candela.yaml @@ -0,0 +1,33 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/base/candela" +title: "candela" +symbol: "cd" +display-symbol: "cd" +description: |- + The SI base unit of luminous intensity in a given direction defined from the radiation of a black body at the solidification temperature of platinum, which was included into SI at the 11th CGPM Meeting in 1960. + + "The candela is the sixtieth of the luminous intensity emitted perpendicularly by one square centimeter of a perfect radiator (black body) at the solidification temperature of platinum." [9th CGPM meeting (1948)]. + This was a ratification of a definition of a definition at the 41st CIPM meeting in 1946, resolution 1, with a different phrasing: "The value of the new candle is such that the brightness of the full radiator at the temperature of solidification of platinum is 60 new candles per square centimetre." + The candela was adopted into SI at the 11th CGPM Meeting in 1960, resolution 12. + + Furthermore, in the definition SI 1960 definition of the candela the centimeter in the definition references 10â»Â² times the SI 1960 metre (https://schemas.optimade.org/defs/v1.2/units/si/1960/base/metre). +resources: + - relation: "Definition at the 9th CGPM meeting (1948)" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/9-1948" + - relation: "Related definition at the 41st CIPM meeting (1946)" + resource-id: "https://www.bipm.org/en/committees/ci/cipm/41-1946/resolution-1" + - relation: "Establishment of the SI unit system at the 11th CGPM meeting (1960), resolution 12." + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/11-1960/resolution-12" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Candela" +standard: + name: "si" + year: 1960 + category: "base" + symbol: "cd" +x-optimade-definition: + label: "candela_si_1960_base" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "candela" diff --git a/schemas/src/defs/v1.2/units/si/1960/base/degreekelvin.yaml b/schemas/src/defs/v1.2/units/si/1960/base/degreekelvin.yaml new file mode 100644 index 000000000..e95705b74 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/1960/base/degreekelvin.yaml @@ -0,0 +1,28 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/base/degreekelvin" +title: "degree Kelvin" +symbol: "degK" +display-symbol: "°K" +description: |- + The base SI unit of thermodynamic temperature defined from the triple point of water, which was adopted into SI at the 11th CGPM Meeting in 1960, resolution 12. + + "The 10th Conférence Générale des Poids et Mesures decides to define the thermodynamic temperature scale by choosing the triple point of water as the fundamental fixed point, and assigning to it the temperature 273.16 degrees Kelvin, exactly." [10th CGPM Meeting (1954), resolution 3] + The degree Kelvin was adopted into SI at the 11th CGPM Meeting in 1960, resolution 12. +resources: + - relation: "Definition at the 10th CGPM meeting (1954), resolution 3" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/10-1954/resolution-3" + - relation: "Establishment of the SI unit system at the 11th CGPM meeting (1960), resolution 12." + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/11-1960/resolution-12" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Kelvin" +standard: + name: "si" + year: 1960 + category: "base" + symbol: "degK" +x-optimade-definition: + label: "degreekelvin_si_1960_base" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "degreekelvin" diff --git a/schemas/src/defs/v1.2/units/si/1960/base/kilogram.yaml b/schemas/src/defs/v1.2/units/si/1960/base/kilogram.yaml new file mode 100644 index 000000000..32483d184 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/1960/base/kilogram.yaml @@ -0,0 +1,28 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/base/kilogram" +title: "kilogram" +symbol: "kg" +display-symbol: "kg" +description: |- + The SI base unit of mass as defined as the mass of the international kilogram prototype, which was adopted into SI at the 11th CGPM Meeting in 1960. + + "The prototype of the kilogram adopted by the International Committee; This prototype will henceforth be considered as the unit of mass;", referring to the international prototype of the kilogram made of platinum-iridium [1st CGPM Meeting (1889)]. + The kilogram was adopted into SI at the 11th CGPM Meeting in 1960, resolution 12. +resources: + - relation: "Definition at the 1st CGPM meeting (1889)" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/1-1889" + - relation: "Establishment of the SI unit system at the 11th CGPM meeting (1960), resolution 12." + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/11-1960/resolution-12" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Kilogram" +standard: + name: "si" + year: 1960 + category: "base" + symbol: "kg" +x-optimade-definition: + label: "kilogram_si_1960_base" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "kilogram" diff --git a/schemas/src/defs/v1.2/units/si/1960/base/metre.yaml b/schemas/src/defs/v1.2/units/si/1960/base/metre.yaml new file mode 100644 index 000000000..33a5012c9 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/1960/base/metre.yaml @@ -0,0 +1,31 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/base/metre" +title: "metre" +symbol: "m" +display-symbol: "m" +alternate-symbols: + - "metre" + - "meter" +description: |- + The metre, or meter, is the SI base unit of length defined in terms of the wavelength of the radiation for a specific transition in krypton 86 as redefined at the 11th CGPM Meeting in 1960. + + "The metre is the length equal to 1650763.73 wavelengths in vacuum of the radiation corresponding to the transition between the levels 2pâ‚â‚€ and 5dâ‚… of the krypton 86 atom." [11th CGPM meeting (1960), resolution 6] + The metre was adopted into SI at the 11th CGPM Meeting in 1960, resolution 12. +resources: + - relation: "Definition at the 11th CGPM meeting (1960), resolution 6." + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/11-1960/resolution-6" + - relation: "Establishment of the SI unit system at the 11th CGPM meeting (1960), resolution 12." + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/11-1960/resolution-12" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Metre" +standard: + name: "si" + year: 1960 + category: "base" + symbol: "m" +x-optimade-definition: + label: "metre_si_1960_base" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "metre" diff --git a/schemas/src/defs/v1.2/units/si/1960/base/second.yaml b/schemas/src/defs/v1.2/units/si/1960/base/second.yaml new file mode 100644 index 000000000..c40b133ef --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/1960/base/second.yaml @@ -0,0 +1,29 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/base/second" +title: "second" +symbol: "s" +display-symbol: "s" +description: |- + The SI base unit of time defined as a specific fraction of the tropical year 1900 at the 11th CGPM Meeting in 1960. + + "The second is the fraction 1/31556925.9747 of the tropical year for 1900 January 0 at 12 hours ephemeris time." [11th CGPM Meeting in 1960, resolution 9] + The second was included into SI at the 11th CGPM Meeting in 1960 in resolution 12. +resources: + - relation: "Definition at the 11th CGPM meeting (1960), resolution 6." + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/11-1960/resolution-6" + - relation: "Establishment of the SI unit system at the 11th CGPM meeting (1960), resolution 12." + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/11-1960/resolution-12" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Second" +standard: + name: "si" + year: 1960 + category: "base" + symbol: "s" +x-optimade-definition: + label: "second_si_1960_base" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "second" + diff --git a/schemas/src/defs/v1.2/units/si/1960/named/coulomb.yaml b/schemas/src/defs/v1.2/units/si/1960/named/coulomb.yaml new file mode 100644 index 000000000..675532186 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/1960/named/coulomb.yaml @@ -0,0 +1,34 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/named/coulomb" +title: "coulomb" +symbol: "C" +display-symbol: "C" +description: |- + A derived SI unit for electric charge, equal to s·A in the 1960 SI base units. + + "The coulomb is the amount of electricity transported in one second by a current of one ampere." [9th CGPM meeting in 1946] +resources: + - relation: "Definition at the 9th CGPM meeting (1948)" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/9-1948" + - relation: "Definition and establishment of the SI unit system at the 11th CGPM meeting (1960), resolution 12." + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/11-1960/resolution-12" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Coulomb" +defining-relation: + base-units: + - symbol: "s" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/base/second" + - symbol: "A" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/base/ampere" + base-units-expression: "A*s" +standard: + name: "si" + year: 1960 + category: "named" + symbol: "C" +x-optimade-definition: + label: "coulomb_si_1960_named" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "coulomb" diff --git a/schemas/src/defs/v1.2/units/si/1960/named/degcelsius.yaml b/schemas/src/defs/v1.2/units/si/1960/named/degcelsius.yaml new file mode 100644 index 000000000..85dd8998c --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/1960/named/degcelsius.yaml @@ -0,0 +1,33 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/named/degcelsius" +title: "degree Celsius" +symbol: "degC" +display-symbol: "°C" +alternate-symbols: + - "degreecelsius" +description: |- + A derived SI unit of temperature, defined as degree kelvin offset with +273.15 in the SI base units adopted at the 11th CGPM Meeting in 1960. + + "If we add to the practical international Celsius temperatures defined above Tâ‚€ = 273.15 degrees, we obtain the practical international Kelvin temperatures. By subtracting Tâ‚€ from the thermodynamic temperatures, we obtain the thermodynamic Celsius temperatures." [11th CGPM meeting (1960)] +resources: + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Celsius" +defining-relation: + base-units: + - symbol: "degK" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/base/degreekelvin" + base-units-expression: "degK" + offset: + numerator: 27315 + denominator: 100 +standard: + name: "si" + year: 1960 + category: "named" + symbol: "degC" +x-optimade-definition: + label: "degcelsius_si_1960_named" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "degcelsius" diff --git a/schemas/src/defs/v1.2/units/si/1960/named/farad.yaml b/schemas/src/defs/v1.2/units/si/1960/named/farad.yaml new file mode 100644 index 000000000..3369c34f2 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/1960/named/farad.yaml @@ -0,0 +1,38 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/named/farad" +title: "farad" +symbol: "F" +display-symbol: "F" +description: |- + A derived SI unit for electrical capacitance equal to kgâ»Â¹Â·mâ»Â²Â·sâ´Â·A² in the 1960 SI base units. + + "The farad is the capacitance of an electric capacitor between whose plates an electric potential difference of one volt appears when it is charged with an amount of electricity equal to one coulomb." [9th CGPM meeting in 1946] +resources: + - relation: "Definition at the 9th CGPM meeting (1948)" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/9-1948" + - relation: "Definition and establishment of the SI unit system at the 11th CGPM meeting (1960), resolution 12." + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/11-1960/resolution-12" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Farad" +defining-relation: + base-units: + - symbol: "A" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/base/ampere" + - symbol: "kg" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/base/kilogram" + - symbol: "m" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/base/metre" + - symbol: "s" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/base/second" + base-units-expression: "A^2*kg^-1*m^-2*s^4" +standard: + name: "si" + year: 1960 + category: "named" + symbol: "F" +x-optimade-definition: + label: "farad_si_1960_named" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "farad" diff --git a/schemas/src/defs/v1.2/units/si/1960/named/henry.yaml b/schemas/src/defs/v1.2/units/si/1960/named/henry.yaml new file mode 100644 index 000000000..b3368083c --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/1960/named/henry.yaml @@ -0,0 +1,38 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/named/henry" +title: "henry" +symbol: "H" +display-symbol: "H" +description: |- + A derived SI unit for inductance equal to kg·m²·sâ»Â²Â·Aâ»Â² in the 1960 SI base units. + + "The henry is the inductance of a closed circuit in which an electromotive force of one volt is produced when the electric current passing through the circuit varies uniformly at a rate of one ampere per second." [9th CGPM meeting in 1946] +resources: + - relation: "Definition at the 9th CGPM meeting (1948)" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/9-1948" + - relation: "Definition and establishment of the SI unit system at the 11th CGPM meeting (1960), resolution 12." + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/11-1960/resolution-12" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Henry_(unit)" +defining-relation: + base-units: + - symbol: "A" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/base/ampere" + - symbol: "kg" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/base/kilogram" + - symbol: "m" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/base/metre" + - symbol: "s" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/base/second" + base-units-expression: "A^-2*kg*m^2*s^-2" +standard: + name: "si" + year: 1960 + category: "named" + symbol: "H" +x-optimade-definition: + label: "henry_si_1960_named" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "henry" diff --git a/schemas/src/defs/v1.2/units/si/1960/named/hertz.yaml b/schemas/src/defs/v1.2/units/si/1960/named/hertz.yaml new file mode 100644 index 000000000..5ffce3b48 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/1960/named/hertz.yaml @@ -0,0 +1,32 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/named/hertz" +title: "hertz" +symbol: "Hz" +display-symbol: "Hz" +description: |- + A derived SI unit for frequency equal to sâ»Â¹ in the 1960 SI base units. + + "The frequency of a periodic phenomenon is expressed in hertz, as the inverse of its period expressed in seconds." [9th CGPM meeting in 1946] +resources: + - relation: "Definition at the 9th CGPM meeting (1948)" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/9-1948" + - relation: "Definition and establishment of the SI unit system at the 11th CGPM meeting (1960), resolution 12." + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/11-1960/resolution-12" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Hertz" +defining-relation: + base-units: + - symbol: "s" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/base/second" + base-units-expression: "s^-1" +standard: + name: "si" + year: 1960 + category: "named" + symbol: "Hz" +x-optimade-definition: + label: "hertz_si_1960_named" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "hertz" diff --git a/schemas/src/defs/v1.2/units/si/1960/named/joule.yaml b/schemas/src/defs/v1.2/units/si/1960/named/joule.yaml new file mode 100644 index 000000000..41ab751f0 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/1960/named/joule.yaml @@ -0,0 +1,36 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/named/joule" +title: "joule" +symbol: "J" +display-symbol: "J" +description: |- + A derived SI unit for energy, work, and heat equal to kg·m²·sâ»Â² in the 1960 SI base units. + + "The joule is the work produced by a newton whose point of application moves one meter in the direction of the force." [9th CGPM meeting in 1946] +resources: + - relation: "Definition at the 9th CGPM meeting (1948)" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/9-1948" + - relation: "Definition and establishment of the SI unit system at the 11th CGPM meeting (1960), resolution 12." + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/11-1960/resolution-12" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Joule" +defining-relation: + base-units: + - symbol: "kg" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/base/kilogram" + - symbol: "m" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/base/metre" + - symbol: "s" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/base/second" + base-units-expression: "kg*m^2*s^-2" +standard: + name: "si" + year: 1960 + category: "named" + symbol: "J" +x-optimade-definition: + label: "joule_si_1960_named" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "joule" diff --git a/schemas/src/defs/v1.2/units/si/1960/named/lumen.yaml b/schemas/src/defs/v1.2/units/si/1960/named/lumen.yaml new file mode 100644 index 000000000..3e4d4c5bc --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/1960/named/lumen.yaml @@ -0,0 +1,34 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/named/lumen" +title: "lumen" +symbol: "lm" +display-symbol: "lm" +description: |- + A derived SI unit for luminous flux equal to cd·sr in the 1960 SI base units. + + "The lumen is the luminous flux emitted in a steradian by a uniform point source with a luminous intensity of one candela." [9th CGPM meeting in 1946] +resources: + - relation: "Definition at the 9th CGPM meeting (1948)" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/9-1948" + - relation: "Definition and establishment of the SI unit system at the 11th CGPM meeting (1960), resolution 12." + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/11-1960/resolution-12" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Lumen_(unit)" +defining-relation: + base-units: + - symbol: "cd" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/base/candela" + - symbol: "sr" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/supplementary/steradian" + base-units-expression: "cd*sr" +standard: + name: "si" + year: 1960 + category: "named" + symbol: "lm" +x-optimade-definition: + label: "lumen_si_1960_named" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "lumen" diff --git a/schemas/src/defs/v1.2/units/si/1960/named/lux.yaml b/schemas/src/defs/v1.2/units/si/1960/named/lux.yaml new file mode 100644 index 000000000..f770c84b5 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/1960/named/lux.yaml @@ -0,0 +1,36 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/named/lux" +title: "lux" +symbol: "lx" +display-symbol: "lx" +description: |- + A derived SI unit for illuminance equal to cdâ‹…srâ‹…mâ»Â² in the 1960 SI base units. + + "The lux is the illuminance of a surface that receives a uniformly distributed luminous flux of one lumen per square meter." [9th CGPM meeting in 1946] +resources: + - relation: "Definition at the 9th CGPM meeting (1948)" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/9-1948" + - relation: "Definition and establishment of the SI unit system at the 11th CGPM meeting (1960), resolution 12." + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/11-1960/resolution-12" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Lux" +defining-relation: + base-units: + - symbol: "cd" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/base/candela" + - symbol: "sr" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/supplementary/steradian" + - symbol: "m" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/base/metre" + base-units-expression: "cd*m^-2*sr" +standard: + name: "si" + year: 1960 + category: "named" + symbol: "lx" +x-optimade-definition: + label: "lux_si_1960_named" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "lux" diff --git a/schemas/src/defs/v1.2/units/si/1960/named/newton.yaml b/schemas/src/defs/v1.2/units/si/1960/named/newton.yaml new file mode 100644 index 000000000..060d98207 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/1960/named/newton.yaml @@ -0,0 +1,36 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/named/newton" +title: "newton" +symbol: "N" +display-symbol: "N" +description: | + A derived SI unit for force and weight equal to kg·m·sâ»Â² in the 1960 SI base units. + + "The newton is the force that, in one second, imparts to a mass equal to one kilogram an increase in speed of one meter per second." [9th CGPM meeting in 1946] +resources: + - relation: "Definition at the 9th CGPM meeting (1948)" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/9-1948" + - relation: "Definition and establishment of the SI unit system at the 11th CGPM meeting (1960), resolution 12." + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/11-1960/resolution-12" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Newton_(unit)" +defining-relation: + base-units: + - symbol: "kg" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/base/kilogram" + - symbol: "m" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/base/metre" + - symbol: "s" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/base/second" + base-units-expression: "kg*m*s^-2" +standard: + name: "si" + year: 1960 + category: "named" + symbol: "N" +x-optimade-definition: + label: "newton_si_1960_named" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "newton" diff --git a/schemas/src/defs/v1.2/units/si/1960/named/ohm.yaml b/schemas/src/defs/v1.2/units/si/1960/named/ohm.yaml new file mode 100644 index 000000000..c909723f7 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/1960/named/ohm.yaml @@ -0,0 +1,38 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/named/ohm" +title: "ohm" +symbol: "ohm" +display-symbol: "Ω" +description: |- + A derived SI unit for electrical resistance equal to kg·m²·sâ»Â³Â·Aâ»Â² in the 1960 SI base units. + + "The ohm is the electrical resistance that exists between two points of a conductor when a constant potential difference of one volt, applied between these two points, produces a current of one ampere in the conductor, provided that the conductor is not the seat of any electromotive force." [9th CGPM meeting in 1946] +resources: + - relation: "Definition at the 9th CGPM meeting (1948)" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/9-1948" + - relation: "Definition and establishment of the SI unit system at the 11th CGPM meeting (1960), resolution 12." + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/11-1960/resolution-12" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Ohm" +defining-relation: + base-units: + - symbol: "A" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/base/ampere" + - symbol: "kg" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/base/kilogram" + - symbol: "m" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/base/metre" + - symbol: "s" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/base/second" + base-units-expression: "A^-2*kg*m^2*s^-3" +standard: + name: "si" + year: 1960 + category: "named" + symbol: "ohm" +x-optimade-definition: + label: "ohm_si_1960_named" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "ohm" diff --git a/schemas/src/defs/v1.2/units/si/1960/named/tesla.yaml b/schemas/src/defs/v1.2/units/si/1960/named/tesla.yaml new file mode 100644 index 000000000..c8f431db4 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/1960/named/tesla.yaml @@ -0,0 +1,34 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/named/tesla" +title: "tesla" +symbol: "T" +display-symbol: "T" +description: |- + The tesla is a derived SI unit for magnetic flux density equal to kg·sâ»Â²Â·Aâ»Â¹ in the 1960 SI base units. + + The tesla was defined as 1 Wb/m in the introduction of the SI unit system at the 11th CGPM Meeting in 1960. +resources: + - relation: "Definition and establishment of the SI unit system at the 11th CGPM meeting (1960), resolution 12." + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/11-1960/resolution-12" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Tesla_(unit)" +defining-relation: + base-units: + - symbol: "A" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/base/ampere" + - symbol: "kg" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/base/kilogram" + - symbol: "s" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/base/second" + base-units-expression: "A^-1*kg*s^-2" +standard: + name: "si" + year: 1960 + category: "named" + symbol: "T" +x-optimade-definition: + label: "tesla_si_1960_named" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "tesla" diff --git a/schemas/src/defs/v1.2/units/si/1960/named/volt.yaml b/schemas/src/defs/v1.2/units/si/1960/named/volt.yaml new file mode 100644 index 000000000..f86a67e59 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/1960/named/volt.yaml @@ -0,0 +1,38 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/named/volt" +title: "volt" +symbol: "V" +display-symbol: "V" +description: |- + The volt is a derived SI unit for electric potential, voltage, and electromotive force equal to kg·m²·sâ»Â³Â·Aâ»Â¹ in the 1960 SI base units. + + "The volt is the electric potential difference that exists between two points of a conducting wire carrying a constant current of one ampere when the power dissipated between these points is equal to one watt." [9th CGPM meeting in 1946] +resources: + - relation: "Definition at the 9th CGPM meeting (1948)" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/9-1948" + - relation: "Definition and establishment of the SI unit system at the 11th CGPM meeting (1960), resolution 12." + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/11-1960/resolution-12" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Volt" +defining-relation: + base-units: + - symbol: "kg" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/base/kilogram" + - symbol: "m" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/base/metre" + - symbol: "s" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/base/second" + - symbol: "A" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/base/ampere" + base-units-expression: "A^-1*kg*m^2*s^-3" +standard: + name: "si" + year: 1960 + category: "named" + symbol: "V" +x-optimade-definition: + label: "volt_si_1960_named" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "volt" diff --git a/schemas/src/defs/v1.2/units/si/1960/named/watt.yaml b/schemas/src/defs/v1.2/units/si/1960/named/watt.yaml new file mode 100644 index 000000000..786aa3803 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/1960/named/watt.yaml @@ -0,0 +1,36 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/named/watt" +title: "watt" +symbol: "W" +display-symbol: "W" +description: |- + A derived SI unit for power and radiant flux equal to kg·m²·sâ»Â³ in the 1960 SI base units. + + "The watt is the power that produces one joule per second." [9th CGPM meeting in 1946] +resources: + - relation: "Definition at the 9th CGPM meeting (1948)" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/9-1948" + - relation: "Definition and establishment of the SI unit system at the 11th CGPM meeting (1960), resolution 12." + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/11-1960/resolution-12" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Watt" +defining-relation: + base-units: + - symbol: "kg" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/base/kilogram" + - symbol: "m" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/base/metre" + - symbol: "s" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/base/second" + base-units-expression: "kg*m^2*s^-3" +standard: + name: "si" + year: 1960 + category: "named" + symbol: "W" +x-optimade-definition: + label: "watt_si_1960_named" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "watt" diff --git a/schemas/src/defs/v1.2/units/si/1960/named/weber.yaml b/schemas/src/defs/v1.2/units/si/1960/named/weber.yaml new file mode 100644 index 000000000..4f903851a --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/1960/named/weber.yaml @@ -0,0 +1,38 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/named/weber" +title: "weber" +symbol: "Wb" +display-symbol: "Wb" +description: |- + A derived SI unit for magnetic flux equal to kg·m²·sâ»Â³Â·Aâ»Â¹ in the 1960 SI base units. + + "The weber is the magnetic induction flux that, passing through a single-turn circuit, produces an electromotive force of one volt if it is reduced to zero in one second by uniform decay." [9th CGPM meeting in 1946] +resources: + - relation: "Definition at the 9th CGPM meeting (1948)" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/9-1948" + - relation: "Definition and establishment of the SI unit system at the 11th CGPM meeting (1960), resolution 12." + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/11-1960/resolution-12" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Weber_(unit)" +defining-relation: + base-units: + - symbol: "A" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/base/ampere" + - symbol: "kg" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/base/kilogram" + - symbol: "m" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/base/metre" + - symbol: "s" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/base/second" + base-units-expression: "A^-1*kg*m^2*s^-3" +standard: + name: "si" + year: 1960 + category: "named" + symbol: "Wb" +x-optimade-definition: + label: "weber_si_1960_named" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "weber" diff --git a/schemas/src/defs/v1.2/units/si/1960/supplementary/radian.yaml b/schemas/src/defs/v1.2/units/si/1960/supplementary/radian.yaml new file mode 100644 index 000000000..3b62aa063 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/1960/supplementary/radian.yaml @@ -0,0 +1,36 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/supplementary/radian" +title: "radian" +symbol: "rad" +display-symbol: "rad" +description: |- + An SI unit of plane angle defined from the relation of the arc length on a circle intercepted at a given radius so that the full circle has an angle of 4Ï€ radians. + + The radian is defined at the 9th CGPM Meeting in 1948 as: "The radian is the angle with its vertex at the center of a circle that intercepts an arc of length equal to the radius on the circumference of that circle." + + The International System of Units (SI), 9th ed. (2019) has a longer but equivalent definition: "The plane angle, expressed in radian, between two lines originating from a common point is the length of circular arc \(s\), swept out between the lines by a radius vector of length \(r\) from the common point divided by the length of the radius vector, \(\theta\) = \(s/r\) rad. The phase angle (often just referred to as the “phaseâ€) is the argument of any complex number. It is the angle between the positive real axis and the radius of the polar representation of the complex number in the complex plane. One radian corresponds to the angle for which \(s = r\), thus 1 rad = 1. The measure of the right angle is exactly equal to the number Ï€/2." + + The radian is categorized in the International System of Units (SI), 1st Edition as a supplementary SI unit. + At the 20th CGPM meeting in 1995, resolution 8 the categorization was changed to a dimensionless derived SI unit. +resources: + - relation: "Definition at the 9th CGPM meeting (1948)" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/9-1948" + - relation: "Definition in the International System of Units (SI), 9th Edition" + resource-id: "https://www.bipm.org/en/publications/si-brochure" + - relation: "Establishment of the SI unit system at the 11th CGPM meeting (1960), resolution 12." + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/11-1960/resolution-12" + - relation: "Reclassification at the 20th CGPM meeting (1995)" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/20-1995/resolution-8" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Radian" +standard: + name: "si" + year: 1960 + category: "supplementary" + symbol: "rad" +x-optimade-definition: + label: "radian_si_1960_supplementary" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "radian" diff --git a/schemas/src/defs/v1.2/units/si/1960/supplementary/steradian.yaml b/schemas/src/defs/v1.2/units/si/1960/supplementary/steradian.yaml new file mode 100644 index 000000000..53d3c7c12 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/1960/supplementary/steradian.yaml @@ -0,0 +1,36 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/supplementary/steradian" +title: "steradian" +symbol: "sr" +display-symbol: "sr" +alternate-symbols: + - "sterad" +description: |- + A supplementary SI unit of solid angle defined from the relation of the area cut out on a sphere at a given radius so that the entire sphere has a solid angle of 4Ï€ steradians, defined at the 9th CGPM Meeting in 1948 and included into SI at the 11th CGPM Meeting in 1960. + + The radian is defined at the 9th CGPM Meeting in 1948 as: "The unit of solid angle is the steradian. The steradian is the solid angle with its vertex at the center of a sphere with a radius of one meter, which cuts out an area of one square meter on the surface of that sphere." + + The International System of Units (SI), 9th Edition give a rephrased but equivalent definition: "The solid angle, expressed in steradian, corresponds to the ratio between an area \(A\) of the surface of a sphere of radius \(r\) and the squared radius, \(\Omega = A/r^2\) sr. One steradian corresponds to the solid angle for which \(A = r^2\), thus 1 sr = 1." + + The steradian is categorized in the International System of Units (SI), 1st Edition as a supplementary SI unit. + At the 20th CGPM meeting in 1995, resolution 8 the categorization was changed to a dimensionless derived SI unit. +resources: + - relation: "Definition at the 9th CGPM meeting (1948)" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/9-1948" + - relation: "Establishment of the SI unit system at the 11th CGPM meeting (1960), resolution 12." + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/11-1960/resolution-12" + - relation: "Reclassification at the 20th CGPM meeting (1995)" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/20-1995/resolution-8" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Steradian" +standard: + name: "si" + year: 1960 + category: "supplementary" + symbol: "sr" +x-optimade-definition: + label: "steradian_si_1960_supplementary" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "steradian" diff --git a/schemas/src/defs/v1.2/units/si/1964/accepted/litre.yaml b/schemas/src/defs/v1.2/units/si/1964/accepted/litre.yaml new file mode 100644 index 000000000..a56c9a60b --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/1964/accepted/litre.yaml @@ -0,0 +1,30 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/1964/accepted/litre" +title: "litre" +symbol: "l" +display-symbol: "l" +alternate-symbols: + - "L" + - "liter" +description: |- + The litre, or liter is a unit of volume equal to a cubic decimetre (1 dm³), with meter defined according to the 1960 SI units. + + "The 12th Conférence Générale des Poids et Mesures (CGPM) [...] declares that the word 'litre' may be employed as a special name for the cubic decimetre" [12th CGPM meeting (1964), resolution 6]. +resources: + - relation: "Definition at the 12th CGPM meeting (1964), resolution 6" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/12-1964/resolution-6" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Litre" +defining-relation: + base-units: + - symbol: "m" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/base/metre" + base-units-expression: "m^3" + scale: + exponent: -3 +x-optimade-definition: + label: "litre_si_1964_accepted" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "litre" diff --git a/schemas/src/defs/v1.2/units/si/1964/temporary/curie.yaml b/schemas/src/defs/v1.2/units/si/1964/temporary/curie.yaml new file mode 100644 index 000000000..c88fa177e --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/1964/temporary/curie.yaml @@ -0,0 +1,34 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/1964/temporary/curie" +title: "curie" +symbol: "Ci" +display-symbol: "Ci" +description: |- + A non-SI unit of activity with the value 3.7·10â»Â¹â° sâ»Â¹ defined at the 12th CGPM meeting in 1964. + + Defined as outside the SI at the 12th CGPM meeting in 1964, resolution 7. + + - The International System of Units (SI), 1st ed. (1970) categorizes the unit as "Units in use temporarily with the International System." + - The International System of Units (SI), 7th ed. (1998) changes the categorization to "Other non-SI units". + - The curie is omitted in the International System of Units (SI), 8th Edition (2006). +resources: + - relation: "Definition at the 12th CGPM meeting (1964), resolution 3" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/12-1964/resolution-3" + - relation: "Le Système International d'Unités (SI) (1970)" + resource-id: "https://www.bipm.org/en/publications/si-brochure" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Curie_(unit)" +defining-relation: + base-units: + - symbol: "s" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/base/second" + base-units-expression: "s^-1" + scale: + numerator: 37 + exponent: -11 +x-optimade-definition: + label: "curie_si_1964_temporary" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "curie" diff --git a/schemas/src/defs/v1.2/units/si/1967/base/ampere.yaml b/schemas/src/defs/v1.2/units/si/1967/base/ampere.yaml new file mode 100644 index 000000000..c272926b6 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/1967/base/ampere.yaml @@ -0,0 +1,32 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/1967/base/ampere" +title: "ampere" +symbol: "A" +display-symbol: "A" +description: |- + The SI base unit of electric current defined from the force between parallel wires carrying an electric current at the 41st CIPM meeting (1946), resolution 2 and implicitly redefined via the redefinition of the second at the 13th CGPM Meeting in 1967, resolution 1. + + "The ampere is that constant current which, if maintained in two straight parallel conductors of infinite length, of negligible circular cross-section, and placed 1 metre apart in vacuum, would produce between these conductors a force equal to 2×10â»â· MKS unit of force per metre of length." [41st CIPM meeting (1946), Resolution 2]. + + Furthermore, following the redefinition of the second at the 13th CGPM Meeting in 1967, resolution 1, the implicitly redefined ampere references: + + - the metre in the definition references the SI 1960 metre (https://schemas.optimade.org/defs/v1.2/units/si/1960/base/metre) + - the MKS unit of force references the derived newton unit (https://schemas.optimade.org/defs/v1.2/units/si/1960/derived/newton) equal to kilogram·metre·secondâ»Â², referencing the SI 1960 kilogram (https://schemas.optimade.org/defs/v1.2/units/si/1960/base/kilogram) and metre (https://schemas.optimade.org/defs/v1.2/units/si/1960/base/metre); and the 1967 definition of the second (https://schemas.optimade.org/defs/v1.2/units/si/1967/base/second). +resources: + - relation: "Definition at the 41st CIPM meeting (1946), resolution 2" + resource-id: "https://www.bipm.org/en/committees/ci/cipm/41-1946/resolution-2" + - relation: "Establishment of the SI unit system at the 11th CGPM meeting (1960), resolution 12." + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/11-1960/resolution-12" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Ampere" +standard: + name: "si" + year: 1967 + category: "base" + symbol: "A" +x-optimade-definition: + label: "ampere_si_1967_base" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "ampere" diff --git a/schemas/src/defs/v1.2/units/si/1967/base/candela.yaml b/schemas/src/defs/v1.2/units/si/1967/base/candela.yaml new file mode 100644 index 000000000..0d1af7679 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/1967/base/candela.yaml @@ -0,0 +1,32 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/1967/base/candela" +title: "candela" +symbol: "cd" +display-symbol: "cd" +description: |- + The candela is the SI base unit of luminous intensity in a given direction defined in from the radiation of a black body at the temperature of freezing platinum as defined at the 9th CGPM meeting in 1948, clarified at the 13th CGPM Meeting in 1967, resolution 5; and implicitly redefined due to the 1967 SI redefinition of the second. + + At the 13th CGPM Meeting in 1967, resolution 5 the previous definition from the 9th CGPM meeting in 1948 was rephrased to be more clear: "The candela is the luminous intensity, in the perpendicular direction, of a surface of 1/600000 square metre of a black body at the temperature of freezing platinum under a pressure of 101325 newtons per square metre." + + Furthermore, the SI 1967 definition of the candela references: + + - the SI 1960 metre (https://schemas.optimade.org/defs/v1.2/units/si/1960/base/metre). + - the SI 1967 derived newton unit (https://schemas.optimade.org/defs/v1.2/units/si/1967/named/newton) equal to kilogram·metre·secondâ»Â², referencing the SI 1960 kilogram (https://schemas.optimade.org/defs/v1.2/units/si/1960/base/kilogram) and metre (https://schemas.optimade.org/defs/v1.2/units/si/1960/base/metre); and the 1967 definition of the second (https://schemas.optimade.org/defs/v1.2/units/si/1967/base/second). +resources: + - relation: "Definition at the 13th CGPM meeting (1967)" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/13-1967/resolution-5" + - relation: "Previous definition at the 9th CGPM meeting (1948)" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/9-1948" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Candela" +standard: + name: "si" + year: 1967 + category: "base" + symbol: "cd" +x-optimade-definition: + label: "candela_si_1967_base" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "candela" diff --git a/schemas/src/defs/v1.2/units/si/1967/base/kelvin.yaml b/schemas/src/defs/v1.2/units/si/1967/base/kelvin.yaml new file mode 100644 index 000000000..1bd7086e5 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/1967/base/kelvin.yaml @@ -0,0 +1,35 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/1967/base/kelvin" +title: "kelvin" +symbol: "K" +display-symbol: "K" +description: |- + The kelvin is the SI base unit of thermodynamic temperature defined from the triple point of water at the 13th CGPM Meeting in 1967, resolution 3 and 4 and clarified at the 23rd CGPM Meeting in 2007, resolution 10. + + The definition is functionally the same as the prior definition of degree Kelvin from the 10th CGPM meeting in 1954. + However, at the 13th CGPM Meeting in 1967, resolution 4, the definition was rephrased as: "The kelvin, unit of thermodynamic temperature, is the fraction 1/273.16 of the thermodynamic temperature of the triple point of water." + In this defining text, and as decided in resolution 3, the unit is named kelvin with the symbol K, replacing the prior use of degree Kelvin and variations. + + The 23rd CGPM meeting in 2007, resolution 10, approved to append a clarification to the above definition: "This definition refers to water having the isotopic composition defined by the following amount-of-substance ratios: 0.00015576 mole of ²H per mole of ¹H, 0.0003799 mole of ¹â·O per mole of ¹â¶O and 0.0020052 mole of ¹â¸O per mole of ¹â¶O." +compatibility: + - "https://schemas.optimade.org/defs/v1.2/units/si/1960/base/degreekelvin" +resources: + - relation: "Definition at the 13th CGPM meeting (1967), resolution 4" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/13-1967/resolution-4" + - relation: "Definition of the name kelvin and symbol K at the 13th CGPM meeting (1967), resolution 3" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/13-1967/resolution-3" + - relation: "Clarification at the 23rd CGPM meeting (2007), resolution 10" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/23-2007/resolution-10" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Kelvin" +standard: + name: "si" + year: 1967 + category: "base" + symbol: "K" +x-optimade-definition: + label: "kelvin_si_1967_base" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "kelvin" diff --git a/schemas/src/defs/v1.2/units/si/1967/base/second.yaml b/schemas/src/defs/v1.2/units/si/1967/base/second.yaml new file mode 100644 index 000000000..859b049c7 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/1967/base/second.yaml @@ -0,0 +1,29 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/1967/base/second" +title: "second" +symbol: "s" +display-symbol: "s" +description: |- + The SI base unit of time defined via the periods of transitions between levels in the caesium 133 atom after the redefinition at the 13th CGPM Meeting in 1967. + + "The second is the duration of 9192631770 periods of the radiation corresponding to the transition between the two hyperfine levels of the ground state of the caesium 133 atom" [13th CGPM Meeting (1967), resolution 1] + + At the 26th CGPM Meeting (2018), resolution 1 the definition was rephrased to: "The second, symbol s, is the SI unit of time. It is defined by taking the fixed numerical value of the caesium frequency, \(\Delta \nu_\textrm{Cs}\), the unperturbed ground-state hyperfine transition frequency of the caesium 133 atom, to be 9192631770 when expressed in the unit Hz, which is equal to sâ»Â¹." +resources: + - relation: "Definition in the 13th CGPM Meeting (1967), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/13-1967/resolution-1" + - relation: "Rephrased definition in the 26th CGPM Meeting (2018), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/26-2018/resolution-1" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Second" +standard: + name: "si" + year: 1967 + category: "base" + symbol: "s" +x-optimade-definition: + label: "second_si_1967_base" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "second" diff --git a/schemas/src/defs/v1.2/units/si/1967/named/coulomb.yaml b/schemas/src/defs/v1.2/units/si/1967/named/coulomb.yaml new file mode 100644 index 000000000..f828ef1c3 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/1967/named/coulomb.yaml @@ -0,0 +1,38 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/1967/named/coulomb" +title: "coulomb" +symbol: "C" +display-symbol: "C" +description: |- + A derived SI unit for electric charge equal to s·A in the 1967 SI base units. + + "The coulomb is the amount of electricity transported in one second by a current of one ampere." [9th CGPM meeting in 1946] + + The coulomb was defined at the 9th CGPM Meeting in 1946, included in SI at the 11th CGPM meeting in 1960, resolution 12 and implicitly redefined via the redefinition of the second at the 13th CGPM Meeting in 1967, resolution 1. +resources: + - relation: "Definition at the 9th CGPM meeting (1948)" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/9-1948" + - relation: "Definition and establishment of the SI unit system at the 11th CGPM meeting (1960), resolution 12." + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/11-1960/resolution-12" + - relation: "Redefinition of the second in the 13th CGPM Meeting (1967), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/13-1967/resolution-1" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Coulomb" +defining-relation: + base-units: + - symbol: "s" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1967/base/second" + - symbol: "A" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1967/base/ampere" + base-units-expression: "A*s" +standard: + name: "si" + year: 1967 + category: "named" + symbol: "C" +x-optimade-definition: + label: "coulomb_si_1967_named" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "coulomb" diff --git a/schemas/src/defs/v1.2/units/si/1967/named/degcelsius.yaml b/schemas/src/defs/v1.2/units/si/1967/named/degcelsius.yaml new file mode 100644 index 000000000..10f861f8e --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/1967/named/degcelsius.yaml @@ -0,0 +1,39 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/1967/named/degcelsius" +title: "degree Celsius" +symbol: "degC" +display-symbol: "°C" +alternate-symbols: + - "degcelsius" +description: |- + A derived SI unit of temperature, defined as degree kelvin offset with +273.15 in 1967 SI units. + + "If we add to the practical international Celsius temperatures defined above Tâ‚€ = 273.15 degrees, we obtain the practical international Kelvin temperatures. By subtracting Tâ‚€ from the thermodynamic temperatures, we obtain the thermodynamic Celsius temperatures." [11th CGPM meeting (1960)] + + The degree Celsius was defined and included in SI at the 11th CGPM meeting in 1960, resolution 12 and implicitly redefined via the redefinition of the kelvin at the 13th CGPM Meeting in 1967, resolution 4. +resources: + - relation: "Redefinition of the kelvin at the 13th CGPM meeting (1967), resolution 4" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/13-1967/resolution-4" + - relation: "Definition of the kelvin at the 11th CGPM meeting (1960)" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/11-1960" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Celsius" +defining-relation: + base-units: + - symbol: "K" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1967/base/kelvin" + base-units-expression: "K" + offset: + numerator: 27315 + denominator: 100 +standard: + name: "si" + year: 1967 + category: "named" + symbol: "degC" +x-optimade-definition: + label: "degcelsius_si_1967_named" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "degcelsius" diff --git a/schemas/src/defs/v1.2/units/si/1967/named/farad.yaml b/schemas/src/defs/v1.2/units/si/1967/named/farad.yaml new file mode 100644 index 000000000..45588ea58 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/1967/named/farad.yaml @@ -0,0 +1,40 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/1967/named/farad" +title: "farad" +symbol: "F" +display-symbol: "F" +description: |- + A derived SI unit for electrical capacitance equal to kgâ»Â¹Â·mâ»Â²Â·sâ´Â·A² in the 1967 SI units. + + "The farad is the capacitance of an electric capacitor between whose plates an electric potential difference of one volt appears when it is charged with an amount of electricity equal to one coulomb." [9th CGPM meeting in 1946] + + The farad was defined at the 9th CGPM Meeting in 1946, included in SI at the 11th CGPM meeting in 1960, resolution 12 and implicitly redefined via the redefinition of the second at the 13th CGPM Meeting in 1967, resolution 1. +resources: + - relation: "Definition and establishment of the SI unit system at the 11th CGPM meeting (1960), resolution 12." + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/11-1960/resolution-12" + - relation: "Redefinition of the second in the 13th CGPM Meeting (1967), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/13-1967/resolution-1" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Farad" +defining-relation: + base-units: + - symbol: "A" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1967/base/ampere" + - symbol: "kg" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/base/kilogram" + - symbol: "m" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/base/metre" + - symbol: "s" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1967/base/second" + base-units-expression: "A^2*kg^-1*m^-2*s^4" +standard: + name: "si" + year: 1967 + category: "named" + symbol: "F" +x-optimade-definition: + label: "farad_si_1967_named" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "farad" diff --git a/schemas/src/defs/v1.2/units/si/1967/named/henry.yaml b/schemas/src/defs/v1.2/units/si/1967/named/henry.yaml new file mode 100644 index 000000000..eccb96f1b --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/1967/named/henry.yaml @@ -0,0 +1,42 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/1967/named/henry" +title: "henry" +symbol: "H" +display-symbol: "H" +description: |- + A derived SI unit for inductance equal to kg·m²·sâ»Â²Â·Aâ»Â² in the 1967 SI units. + + "The henry is the inductance of a closed circuit in which an electromotive force of one volt is produced when the electric current passing through the circuit varies uniformly at a rate of one ampere per second." [9th CGPM meeting in 1946] + + The henry was defined at the 9th CGPM Meeting in 1946, included in SI at the 11th CGPM meeting in 1960, resolution 12 and implicitly redefined via the redefinition of the second at the 13th CGPM Meeting in 1967, resolution 1. +resources: + - relation: "Definition at the 9th CGPM meeting (1948)" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/9-1948" + - relation: "Definition and establishment of the SI unit system at the 11th CGPM meeting (1960), resolution 12." + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/11-1960/resolution-12" + - relation: "Redefinition of the second in the 13th CGPM Meeting (1967), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/13-1967/resolution-1" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Henry_(unit)" +defining-relation: + base-units: + - symbol: "A" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1967/base/ampere" + - symbol: "kg" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/base/kilogram" + - symbol: "m" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/base/metre" + - symbol: "s" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1967/base/second" + base-units-expression: "A^-2*kg*m^2*s^-2" +standard: + name: "si" + year: 1967 + category: "named" + symbol: "H" +x-optimade-definition: + label: "henry_si_1967_named" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "henry" diff --git a/schemas/src/defs/v1.2/units/si/1967/named/hertz.yaml b/schemas/src/defs/v1.2/units/si/1967/named/hertz.yaml new file mode 100644 index 000000000..49e962020 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/1967/named/hertz.yaml @@ -0,0 +1,36 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/1967/named/hertz" +title: "hertz" +symbol: "Hz" +display-symbol: "Hz" +description: |- + A derived SI unit for frequency equal to sâ»Â¹ in the 1967 SI units. + + "The frequency of a periodic phenomenon is expressed in hertz, as the inverse of its period expressed in seconds." [9th CGPM meeting in 1946] + + The hertz was defined at the 9th CGPM Meeting in 1946, included in SI at the 11th CGPM meeting in 1960, resolution 12 and implicitly redefined via the redefinition of the second at the 13th CGPM Meeting in 1967, resolution 1. +resources: + - relation: "Definition at the 9th CGPM meeting (1948)" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/9-1948" + - relation: "Definition and establishment of the SI unit system at the 11th CGPM meeting (1960), resolution 12." + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/11-1960/resolution-12" + - relation: "Redefinition of the second in the 13th CGPM Meeting (1967), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/13-1967/resolution-1" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Hertz" +defining-relation: + base-units: + - symbol: "s" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1967/base/second" + base-units-expression: "s^-1" +standard: + name: "si" + year: 1967 + category: "named" + symbol: "Hz" +x-optimade-definition: + label: "hertz_si_1967_named" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "hertz" diff --git a/schemas/src/defs/v1.2/units/si/1967/named/joule.yaml b/schemas/src/defs/v1.2/units/si/1967/named/joule.yaml new file mode 100644 index 000000000..708c6261e --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/1967/named/joule.yaml @@ -0,0 +1,40 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/1967/named/joule" +title: "joule" +symbol: "J" +display-symbol: "J" +description: |- + A derived SI unit for energy, work, and heat equal to kg·m²·sâ»Â² in the 1967 SI units. + + "The joule is the work produced by a newton whose point of application moves one meter in the direction of the force." [9th CGPM meeting in 1946] + + The joule was defined at the 9th CGPM Meeting in 1946, included in SI at the 11th CGPM meeting in 1960, resolution 12 and implicitly redefined via the redefinition of the second at the 13th CGPM Meeting in 1967, resolution 1. +resources: + - relation: "Definition at the 9th CGPM meeting (1948)" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/9-1948" + - relation: "Definition and establishment of the SI unit system at the 11th CGPM meeting (1960), resolution 12." + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/11-1960/resolution-12" + - relation: "Redefinition of the second in the 13th CGPM Meeting (1967), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/13-1967/resolution-1" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Joule" +defining-relation: + base-units: + - symbol: "kg" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/base/kilogram" + - symbol: "m" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/base/metre" + - symbol: "s" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1967/base/second" + base-units-expression: "kg*m^2*s^-2" +standard: + name: "si" + year: 1967 + category: "named" + symbol: "J" +x-optimade-definition: + label: "joule_si_1967_named" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "joule" diff --git a/schemas/src/defs/v1.2/units/si/1967/named/lumen.yaml b/schemas/src/defs/v1.2/units/si/1967/named/lumen.yaml new file mode 100644 index 000000000..640e6a7d0 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/1967/named/lumen.yaml @@ -0,0 +1,36 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/1967/named/lumen" +title: "lumen" +symbol: "lm" +display-symbol: "lm" +description: |- + A derived SI unit for luminous flux equal to cd·sr in the 1967 SI units. + + "The lumen is the luminous flux emitted in a steradian by a uniform point source with a luminous intensity of one candela." [9th CGPM meeting in 1946] + + The lumen was defined at the 9th CGPM Meeting in 1946, included in SI at the 11th CGPM meeting in 1960, resolution 12 and implicitly redefined via the redefinition of the second at the 13th CGPM Meeting in 1967, resolution 1. +resources: + - relation: "Definition and establishment of the SI unit system at the 11th CGPM meeting (1960), resolution 12." + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/11-1960/resolution-12" + - relation: "Redefinition of the second in the 13th CGPM Meeting (1967), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/13-1967/resolution-1" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Lumen_(unit)" +defining-relation: + base-units: + - symbol: "cd" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1967/base/candela" + - symbol: "sr" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/supplementary/steradian" + base-units-expression: "cd*sr" +standard: + name: "si" + year: 1967 + category: "named" + symbol: "lm" +x-optimade-definition: + label: "lumen_si_1967_named" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "lumen" diff --git a/schemas/src/defs/v1.2/units/si/1967/named/lux.yaml b/schemas/src/defs/v1.2/units/si/1967/named/lux.yaml new file mode 100644 index 000000000..7db619b00 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/1967/named/lux.yaml @@ -0,0 +1,40 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/1967/named/lux" +title: "lux" +symbol: "lx" +display-symbol: "lx" +description: |- + A derived SI unit for illuminance equal to cdâ‹…srâ‹…mâ»Â² in 1967 SI units. + + "The lux is the illuminance of a surface that receives a uniformly distributed luminous flux of one lumen per square meter." [9th CGPM meeting in 1946] + + The lux was defined at the 9th CGPM Meeting in 1946, included in SI at the 11th CGPM meeting in 1960, resolution 12 and implicitly redefined via the redefinition of the second at the 13th CGPM Meeting in 1967, resolution 1. +resources: + - relation: "Definition at the 9th CGPM meeting (1948)" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/9-1948" + - relation: "Definition and establishment of the SI unit system at the 11th CGPM meeting (1960), resolution 12." + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/11-1960/resolution-12" + - relation: "Redefinition of the second in the 13th CGPM Meeting (1967), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/13-1967/resolution-1" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Lux" +defining-relation: + base-units: + - symbol: "cd" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1967/base/candela" + - symbol: "sr" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/supplementary/steradian" + - symbol: "m" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/base/metre" + base-units-expression: "cd*m^-2*sr" +standard: + name: "si" + year: 1967 + category: "named" + symbol: "lx" +x-optimade-definition: + label: "lux_si_1967_named" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "lux" diff --git a/schemas/src/defs/v1.2/units/si/1967/named/newton.yaml b/schemas/src/defs/v1.2/units/si/1967/named/newton.yaml new file mode 100644 index 000000000..4fcc5f0ea --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/1967/named/newton.yaml @@ -0,0 +1,38 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/1967/named/newton" +title: "newton" +symbol: "N" +display-symbol: "N" +description: |- + The newton is a derived SI unit for force and weight equal to kg·m·sâ»Â² in 1967 SI units. + + "The newton is the force that, in one second, imparts to a mass equal to one kilogram an increase in speed of one meter per second." [9th CGPM meeting in 1946] + + The newton was defined at the 9th CGPM Meeting in 1946, included in SI at the 11th CGPM meeting in 1960, resolution 12 and implicitly redefined via the redefinition of the second at the 13th CGPM Meeting in 1967, resolution 1. +resources: + - relation: "Definition and establishment of the SI unit system at the 11th CGPM meeting (1960), resolution 12." + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/11-1960/resolution-12" + - relation: "Redefinition of the second in the 13th CGPM Meeting (1967), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/13-1967/resolution-1" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Newton_(unit)" +defining-relation: + base-units: + - symbol: "kg" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/base/kilogram" + - symbol: "m" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/base/metre" + - symbol: "s" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1967/base/second" + base-units-expression: "kg*m*s^-2" +standard: + name: "si" + year: 1967 + category: "named" + symbol: "N" +x-optimade-definition: + label: "newton_si_1967_named" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "newton" diff --git a/schemas/src/defs/v1.2/units/si/1967/named/ohm.yaml b/schemas/src/defs/v1.2/units/si/1967/named/ohm.yaml new file mode 100644 index 000000000..8cc4bedc5 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/1967/named/ohm.yaml @@ -0,0 +1,42 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/1967/named/ohm" +title: "ohm" +symbol: "ohm" +display-symbol: "Ω" +description: |- + A derived SI unit for electrical resistance equal to kg·m²·sâ»Â³Â·Aâ»Â² in the 1967 SI units. + + "The ohm is the electrical resistance that exists between two points of a conductor when a constant potential difference of one volt, applied between these two points, produces a current of one ampere in the conductor, provided that the conductor is not the seat of any electromotive force." [9th CGPM meeting in 1946] + + The ohm was defined at the 9th CGPM Meeting in 1946, included in SI at the 11th CGPM meeting in 1960, resolution 12 and implicitly redefined via the redefinition of the second at the 13th CGPM Meeting in 1967, resolution 1. +resources: + - relation: "Definition at the 9th CGPM meeting (1948)" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/9-1948" + - relation: "Definition and establishment of the SI unit system at the 11th CGPM meeting (1960), resolution 12." + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/11-1960/resolution-12" + - relation: "Redefinition of the second in the 13th CGPM Meeting (1967), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/13-1967/resolution-1" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Ohm" +defining-relation: + base-units: + - symbol: "A" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1967/base/ampere" + - symbol: "kg" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/base/kilogram" + - symbol: "m" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/base/metre" + - symbol: "s" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1967/base/second" + base-units-expression: "A^-2*kg*m^2*s^-3" +standard: + name: "si" + year: 1967 + category: "named" + symbol: "ohm" +x-optimade-definition: + label: "ohm_si_1967_named" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "ohm" diff --git a/schemas/src/defs/v1.2/units/si/1967/named/tesla.yaml b/schemas/src/defs/v1.2/units/si/1967/named/tesla.yaml new file mode 100644 index 000000000..8a3da3415 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/1967/named/tesla.yaml @@ -0,0 +1,34 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/1967/named/tesla" +title: "tesla" +symbol: "T" +display-symbol: "T" +description: |- + A derived SI unit for magnetic flux density equal to kg·sâ»Â²Â·Aâ»Â¹ in the 1967 SI units. + + The tesla was defined as 1 Wb/m in the introduction of the SI unit system the 11th CGPM Meeting in 1960, resolution 12 and implicitly redefined via the redefinition of the second at the 13th CGPM Meeting in 1967, resolution 1. +resources: + - relation: "Definition and establishment of the SI unit system at the 11th CGPM meeting (1960), resolution 12." + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/11-1960/resolution-12" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Tesla_(unit)" +defining-relation: + base-units: + - symbol: "A" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1967/base/ampere" + - symbol: "kg" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/base/kilogram" + - symbol: "s" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1967/base/second" + base-units-expression: "A^-1*kg*s^-2" +standard: + name: "si" + year: 1967 + category: "named" + symbol: "T" +x-optimade-definition: + label: "tesla_si_1967_named" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "tesla" diff --git a/schemas/src/defs/v1.2/units/si/1967/named/volt.yaml b/schemas/src/defs/v1.2/units/si/1967/named/volt.yaml new file mode 100644 index 000000000..81f3cba14 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/1967/named/volt.yaml @@ -0,0 +1,42 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/1967/named/volt" +title: "volt" +symbol: "V" +display-symbol: "V" +description: |- + A derived SI unit for electric potential, voltage, and electromotive force equal to kg·m²·sâ»Â³Â·Aâ»Â¹ in the 1967 SI units. + + "The volt is the electric potential difference that exists between two points of a conducting wire carrying a constant current of one ampere when the power dissipated between these points is equal to one watt." [9th CGPM meeting in 1946] + + The volt was defined at the 9th CGPM Meeting in 1946, included in SI at the 11th CGPM meeting in 1960, resolution 12 and implicitly redefined via the redefinition of the second at the 13th CGPM Meeting in 1967, resolution 1. +resources: + - relation: "Definition at the 9th CGPM meeting (1948)" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/9-1948" + - relation: "Definition and establishment of the SI unit system at the 11th CGPM meeting (1960), resolution 12." + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/11-1960/resolution-12" + - relation: "Redefinition of the second in the 13th CGPM Meeting (1967), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/13-1967/resolution-1" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Volt" +defining-relation: + base-units: + - symbol: "kg" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/base/kilogram" + - symbol: "m" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/base/metre" + - symbol: "s" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1967/base/second" + - symbol: "A" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1967/base/ampere" + base-units-expression: "A^-1*kg*m^2*s^-3" +standard: + name: "si" + year: 1967 + category: "named" + symbol: "V" +x-optimade-definition: + label: "volt_si_1967_named" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "volt" diff --git a/schemas/src/defs/v1.2/units/si/1967/named/watt.yaml b/schemas/src/defs/v1.2/units/si/1967/named/watt.yaml new file mode 100644 index 000000000..f2196dd4b --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/1967/named/watt.yaml @@ -0,0 +1,40 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/1967/named/watt" +title: "watt" +symbol: "W" +display-symbol: "W" +description: |- + A derived SI unit for power and radiant flux equal to kg·m²·sâ»Â³ in the 1967 SI units. + + "The watt is the power that produces one joule per second." [9th CGPM meeting in 1946] + + The watt was defined at the 9th CGPM Meeting in 1946, included in SI at the 11th CGPM meeting in 1960, resolution 12 and implicitly redefined via the redefinition of the second at the 13th CGPM Meeting in 1967, resolution 1. +resources: + - relation: "Definition at the 9th CGPM meeting (1948)" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/9-1948" + - relation: "Definition and establishment of the SI unit system at the 11th CGPM meeting (1960), resolution 12." + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/11-1960/resolution-12" + - relation: "Redefinition of the second in the 13th CGPM Meeting (1967), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/13-1967/resolution-1" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Watt" +defining-relation: + base-units: + - symbol: "kg" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/base/kilogram" + - symbol: "m" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/base/metre" + - symbol: "s" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1967/base/second" + base-units-expression: "kg*m^2*s^-3" +standard: + name: "si" + year: 1967 + category: "named" + symbol: "W" +x-optimade-definition: + label: "watt_si_1967_named" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "watt" diff --git a/schemas/src/defs/v1.2/units/si/1967/named/weber.yaml b/schemas/src/defs/v1.2/units/si/1967/named/weber.yaml new file mode 100644 index 000000000..428fc5ffb --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/1967/named/weber.yaml @@ -0,0 +1,42 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/1967/named/weber" +title: "weber" +symbol: "Wb" +display-symbol: "Wb" +description: |- + A derived SI unit for magnetic flux equal to kg·m²·sâ»Â³Â·Aâ»Â¹ in the 1967 SI base units. + + "The weber is the magnetic induction flux that, passing through a single-turn circuit, produces an electromotive force of one volt if it is reduced to zero in one second by uniform decay." [9th CGPM meeting in 1946] + + The weber was defined at the 9th CGPM Meeting in 1946, included in SI at the 11th CGPM meeting in 1960, resolution 12 and implicitly redefined via the redefinition of the second at the 13th CGPM Meeting in 1967, resolution 1. +resources: + - relation: "Definition at the 9th CGPM meeting (1948)" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/9-1948" + - relation: "Definition and establishment of the SI unit system at the 11th CGPM meeting (1960), resolution 12." + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/11-1960/resolution-12" + - relation: "Redefinition of the second in the 13th CGPM Meeting (1967), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/13-1967/resolution-1" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Weber_(unit)" +defining-relation: + base-units: + - symbol: "A" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1967/base/ampere" + - symbol: "kg" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/base/kilogram" + - symbol: "m" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/base/metre" + - symbol: "s" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1967/base/second" + base-units-expression: "A^-1*kg*m^2*s^-3" +standard: + name: "si" + year: 1967 + category: "named" + symbol: "Wb" +x-optimade-definition: + label: "weber_si_1967_named" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "weber" diff --git a/schemas/src/defs/v1.2/units/si/1967/temporary/curie.yaml b/schemas/src/defs/v1.2/units/si/1967/temporary/curie.yaml new file mode 100644 index 000000000..4438019af --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/1967/temporary/curie.yaml @@ -0,0 +1,37 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/1967/temporary/curie" +title: "curie" +symbol: "Ci" +display-symbol: "Ci" +description: |- + A non-SI unit of activity with the value 3.7·10â»Â¹â° sâ»Â¹ in the 1967 SI units. + + Defined as outside the SI at the 12th CGPM meeting in 1964, resolution 7. + Implicitly redefined via the redefinition of the second at the 13th CGPM Meeting in 1967, resolution 1. + + - The International System of Units (SI), 1st ed. (1970) categorizes the unit as "Units in use temporarily with the International System." + - The International System of Units (SI), 7th ed. (1998) changes the categorization to "Other non-SI units". + - The curie is omitted in the International System of Units (SI), 8th Edition (2006). +resources: + - relation: "Definition at the 12th CGPM meeting (1964), resolution 3" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/12-1964/resolution-3" + - relation: "Redefinition of the second in the 13th CGPM Meeting (1967), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/13-1967/resolution-1" + - relation: "Le Système International d'Unités (SI) (1970)" + resource-id: "https://www.bipm.org/en/publications/si-brochure" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Curie_(unit)" +defining-relation: + base-units: + - symbol: "s" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1967/base/second" + base-units-expression: "s^-1" + scale: + numerator: 37 + exponent: -11 +x-optimade-definition: + label: "curie_si_1967_temporary" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "curie" diff --git a/schemas/src/defs/v1.2/units/si/1970/accepted/arcminute.yaml b/schemas/src/defs/v1.2/units/si/1970/accepted/arcminute.yaml new file mode 100644 index 000000000..dc4e6e2b2 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/1970/accepted/arcminute.yaml @@ -0,0 +1,46 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/1970/accepted/arcminute" +title: "arcminute" +symbol: "arcmin" +display-symbol: "′" +alternate-symbols: + - "minute of arc" + - "minute of angle" + - "MOA" + - "'" +description: |- + A unit of plane and phase angle equal to 1/60 of a degree which is 1/21600 of a circle and equivalent to pi/10800 rad, with rad defined according to the 1960 supplementary SI unit. + + This definition uses "arcminute" as the unit name to distinguish it from the time unit named minute. + A footnote in the International System of Units, 9th ed. (2019) note that "arcsecond is an alternative name for second of plane angle". + However, "arcminute" and "arcmin" have so far not been mentioned in any of the editions of the International System of Units. + They are defined in the GNU Units 3.15 unit database as 1/60 degree. + + The unit appear under the name minute (with symbol ′) in the International System of Units (SI), 1st ed. (1970) defined as "1′ = (1/60)° = (Ï€/10800) rad". + + - The International System of Units (SI), 1st ed. (1970) categorizes the unit as "Units in use with the International System." + - The International System of Units (SI), 7th ed. (1998) adds as a footnote: "ISO 31 recommends that the degree be subdivided decimally rather than using the minute and second." + - The International System of Units (SI), 8th ed. (2006) further adds to that footnote: "For navigation and surveying, however, the minute has the advantage that one minute of latitude on the surface of the Earth corresponds (approximately) to one nautical mile." + - The International System of Units (SI), 9th ed. (2019) replaces the footnote with: "For some applications such as in astronomy, small angles are measured in arcseconds (i.e. seconds of plane angle), denoted as or ′′, or milliarcseconds, microarcseconds and picoarcseconds, denoted mas, μas and pas, respectively, where arcsecond is an alternative name for second of plane angle." + - The formulation "denoted as or ″" is reproduced here faithfully from the source and suggests an alternate symbol may have been omitted due to a typographical error. + It is not clear what alternate symbol was intended to be referenced. +resources: + - relation: "Definition in the International System of Units (SI), 1st Edition" + resource-id: "https://www.bipm.org/en/publications/si-brochure" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Minute_and_second_of_arc" +defining-relation: + base-units: + - symbol: "pi" + id: "https://schemas.optimade.org/defs/v1.2/constants/math/basic/pi" + - symbol: "rad" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/supplementary/radian" + base-units-expression: "pi*rad" + scale: + denominator: 10800 +x-optimade-definition: + label: "arcminute_si_1970_accepted" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "arcminute" diff --git a/schemas/src/defs/v1.2/units/si/1970/accepted/arcsecond.yaml b/schemas/src/defs/v1.2/units/si/1970/accepted/arcsecond.yaml new file mode 100644 index 000000000..1d5a8a274 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/1970/accepted/arcsecond.yaml @@ -0,0 +1,41 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/1970/accepted/arcsecond" +title: "arcsecond" +symbol: "arcsec" +display-symbol: "″" +alternate-symbols: + - "second of plane angle" + - "second of arc" + - "\"" +description: |- + A unit of plane and phase angle equal to 1/60 of an arcminute, which is 1/1296000 of a circle and equivalent to pi/648000 rad, with rad defined according to the 1960 supplementary SI unit. + + This definition uses "arcsecond" as the unit name to distinguish it from the time unit named minute. + The unit appear under the name second (with symbol ″) in the International System of Units (SI), 1st ed. (1970) defined as "1″ = (1/60)′ = (Ï€/648 000) rad." + + - The International System of Units (SI), 1st ed. (1970) categorizes the unit as "Units in use with the International System." + - The International System of Units (SI), 7th ed. (1998) adds as a footnote: "ISO 31 recommends that the degree be subdivided decimally rather than using the minute and second." + - The International System of Units (SI), 8th ed. (2006) further adds to that footnote: "For navigation and surveying, however, the minute has the advantage that one minute of latitude on the surface of the Earth corresponds (approximately) to one nautical mile." + - The International System of Units (SI), 9th ed. (2019) replaces the footnote with: "For some applications such as in astronomy, small angles are measured in arcseconds (i.e. seconds of plane angle), denoted as or ′′, or milliarcseconds, microarcseconds and picoarcseconds, denoted mas, μas and pas, respectively, where arcsecond is an alternative name for second of plane angle." + The formulation "denoted as or ″" is reproduced here faithfully from the source and suggests an alternate symbol may have been omitted due to a typographical error. + It is not clear what alternate symbol was intended to be referenced. +resources: + - relation: "Definition in the International System of Units (SI), 1st Edition" + resource-id: "https://www.bipm.org/en/publications/si-brochure" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Minute_and_second_of_arc" +defining-relation: + base-units: + - symbol: "pi" + id: "https://schemas.optimade.org/defs/v1.2/constants/math/basic/pi" + - symbol: "rad" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/supplementary/radian" + base-units-expression: "pi*rad" + scale: + denominator: 648000 +x-optimade-definition: + label: "arcsecond_si_1970_accepted" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "arcsecond" diff --git a/schemas/src/defs/v1.2/units/si/1970/accepted/astronomicalunit.yaml b/schemas/src/defs/v1.2/units/si/1970/accepted/astronomicalunit.yaml new file mode 100644 index 000000000..81f99ce76 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/1970/accepted/astronomicalunit.yaml @@ -0,0 +1,43 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/1970/accepted/astronomicalunit" +title: "astronomical unit" +symbol: "au" +display-symbol: "au" +alternate-symbols: + - "AU" +description: |- + A length representing the mean distance between the Earth and the Sun defined via the circular orbit radius for a body with a specific angular velocity. + + The International System of Units (SI), 1st ed. (1970) defines the unit in a footnote as "The astronomical unit of distance is the length of the unperturbed circular orbit about the Sun of a body of infinitesimal mass in motion around the Sun with an angular sidereal velocity of 0.017202098950 radians per ephemeris day of 86,400 seconds. In the System of Astronomical Constants of the International Astronomical Union, the adopted value is: 1 AU = 149,600 x 10ⶠm." + + This definition interprets the definition to be the expression in radians and seconds, with the meter value regarded only as an approximation. + + - The radian refers to the 1960 supplementary SI unit (https://schema.optimade.org/units/si/1960/supplementary/radian) + - The second refers to the 1967 base SI unit (https://schema.optimade.org/units/si/1967/base/second) + + - The International System of Units (SI), 1st ed. (1970) categorizes the unit as "Units for use with the SI in specific domains." + - The International System of Units (SI), 2nd ed. (1973) categorizes the unit as "Non-SI units accepted for use with the International System, whose values in SI units are obtained experimentally" and prefixes the footnote with: "This unit does not have an international symbol; abbreviations are used, for example, UA in French, AU in English, AG in German, а.е. in Russian, etc." + - The International System of Units (SI), 4th ed. (1981) omits the unit. + - The International System of Units (SI), 7th ed. (1998) reintroduces the unit in the category "Non-SI units accepted for use with the International System, whose values in SI units are obtained experimentally." with the experimental relationship "1 au = 1.49597870691(30)×10¹¹ m" with the footnote: "The astronomical unit is a unit of length approximatively equal to the mean Earth-Sun distance. Its value is such that, when used to describe the motion of bodies in the Solar System, the heliocentric gravitational constant is (0.01720209895)² ua³⋅dâ»Â²." + - The International System of Units (SI), 8th ed. (2006) notes the experimental relationship "1 au = 1.49597870691(6)×10¹¹ m" and changes the footnote to: "The astronomical unit is approximately equal to the mean Earth-Sun distance. It is the radius of an unperturbed circular Newtonian orbit about the Sun of a particle having infinitesimal mass, moving with a mean motion of 0.01720209895 radians per day (known as the Gaussian constant). The value given for the astronomical unit is quoted from the IERS Conventions 2003 (D.D. McCarthy and G. Petit eds., IERS Technical Note 32, Frankfurt am Main: Verlag des Bundesamts für Kartographie und Geodäsie, 2004, 12). The value of the astronomical unit in metres comes from the JPL ephemerides DE403 (Standish E.M., Report of the IAU WGAS Sub-Group on Numerical Standards, Highlights of Astronomy, Appenzeller ed., Dordrecht: Kluwer Academic Publishers, 1995, 180-184)." + - The International System of Units (SI), 9th ed. (2019) redefines the unit to have an exact relationship to the meter with the footnote: "As decided at the XXVIII General Assembly of the International Astronomical Union (Resolution B2, 2012)." + This redefined astronomical unit is regarded as a different unit and is thus not covered by this unit definition. +resources: + - relation: "Definition in the International System of Units (SI), 1st Edition" + resource-id: "https://www.bipm.org/en/publications/si-brochure" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Astronomical_unit" +approximate-relations: + - base-units: + - symbol: "m" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/base/metre" + base-units-expression: "m" + scale: + value: 1.49597870691E+11 + standard_uncertainty: 0.00000000006E+11 +x-optimade-definition: + label: "astronomicalunit_si_1970_accepted" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "astronomicalunit" diff --git a/schemas/src/defs/v1.2/units/si/1970/accepted/atmosphere.yaml b/schemas/src/defs/v1.2/units/si/1970/accepted/atmosphere.yaml new file mode 100644 index 000000000..71644ae2f --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/1970/accepted/atmosphere.yaml @@ -0,0 +1,40 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/1970/accepted/atmosphere" +title: "standard atmosphere" +symbol: "atm" +display-symbol: "atm" +description: |- + A pressure approximately equal to the average atmospheric pressure at sea level on Earth, defined as 101325 Pa using the 1967 SI units. + + The standard atmosphere unit appears in the International System of Units (SI), 1st ed. (1970) defined as "1 atm = 101325 Pa" with the footnote "Resolution 4 at the 10th C.G.P.M. (1954)." + (While the pascal unit appears in the 1st ed. as a symbol for N·s/m², it was adopted into SI at the 14th CGPM meeting in 1971.) + + - In the International System of Units (SI), 1st ed. (1970) it is categorized as "temporarily admitted" for use with the SI units. + - The International System of Units (SI), 4th ed. (1981) changes the categorization to "Other units generally deprecated" and adds to the footnote that: "The designation "standard atmosphere" for a reference pressure of 101 325 Pa is still acceptable." + - The International System of Units (SI), 7th ed. (1998) changes the categorization to "Examples of other non-SI units." + - The International System of Units (SI), 8th ed. (2006) omits the unit, but uses the term in a footnote to the definition of the unit bar to clarify that prior to 1982 the standard pressure used to tabulate thermodynamical data was the standard atmosphere. + - The International System of Units (SI), 9th ed. (2006) no longer references the unit or designation. +resources: + - relation: "Definition in the International System of Units (SI), 9th Edition" + resource-id: "https://www.bipm.org/en/publications/si-brochure" + - relation: "Definition of pascal at the 14th CGPM Meeting (1971)" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/14-1971" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Standard_atmosphere_(unit)" +defining-relation: + base-units: + - symbol: "kg" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/base/kilogram" + - symbol: "m" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/base/metre" + - symbol: "s" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1967/base/second" + base-units-expression: "kg*m^-1*s^-2" + scale: + numerator: 101325 +x-optimade-definition: + label: "atmosphere_si_1970_accepted" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "atmosphere" diff --git a/schemas/src/defs/v1.2/units/si/1970/accepted/atomicmassunit.yaml b/schemas/src/defs/v1.2/units/si/1970/accepted/atomicmassunit.yaml new file mode 100644 index 000000000..d3f05238a --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/1970/accepted/atomicmassunit.yaml @@ -0,0 +1,43 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/1970/accepted/atomicmassunit" +title: "atomic mass unit" +symbol: "u" +display-symbol: "u" +alternate-symbols: + - "dalton" + - "Da" +description: |- + A unit of mass defined as 1/12 of the mass of a free carbon 12 atom, at rest and in its ground state. + + The International System of Units (SI), 1st ed. (1970) defines the atomic mass unit in the section "Units used with the International System" (known as "Non-SI units accepted for use with the SI units" in later editions). + The unit is defined in a footnote as: "The atomic mass unit (unified) is equal to 1/12 of the mass of an atom of the nuclide ¹²C; 1 u = 1.66053 x 10â»Â²â· kg approximately." + + The definition is retained in the International System of Units up to the 7th edition (1998), where the conditions are slightly clarified and dalton (Da) is introduced as an alternative name: "The unified atomic mass unit is equal to 1/12 of the mass of an unbound atom of the nuclide ¹²C, at rest, and in its ground state. In the field of biochemistry, the unified atomic mass unit is also called the dalton, symbol Da." + + In the 8th ed. (2006) the definition is slightly adjusted, replacing "unbound" with "free": "The dalton (Da) and the unified atomic mass unit (u) are alternative names (and symbols) for the same unit, equal to 1/12 times the mass of a free carbon 12 atom, at rest and in its ground state." + + All editions of the International System of Units note approximate relationships to the kilogram. + The 9th ed. states "1 Da = 1.660 539 066 60(50)×10â»Â²â· kg", where the 2018 CODATA value has been used and the 2019 SI kilogram is referenced (https://schemas.optimade.org/defs/v1.2/units/si/2019/base/kilogram). + + In the 2019 redefinition of the SI units, the atomic mass unit is the only unit listed as accepted for use with SI that has a value in SI units which is determined experimentally. +resources: + - relation: "Definition in the International System of Units (SI), 9th Edition" + resource-id: "https://www.bipm.org/en/publications/si-brochure" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Dalton_(unit)" + - relation: "CODATA unified atomic mass unit fundamental physical constant: source for relationship to kg" + resource-id: "https://physics.nist.gov/cgi-bin/cuu/Value?ukg" +approximate-relations: + - base-units: + - symbol: "kg" + id: "https://schemas.optimade.org/defs/v1.2/units/si/2019/base/kilogram" + base-units-expression: "kg" + scale: + value: 1.66053906660E-27 + standard_uncertainty: 0.00000000050E-27 +x-optimade-definition: + label: "atomicmassunit_si_1970_accepted" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "atomicmassunit" diff --git a/schemas/src/defs/v1.2/units/si/1970/accepted/day.yaml b/schemas/src/defs/v1.2/units/si/1970/accepted/day.yaml new file mode 100644 index 000000000..cd146eece --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/1970/accepted/day.yaml @@ -0,0 +1,32 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/1970/accepted/day" +title: "day" +symbol: "day" +display-symbol: "day" +alternate-symbols: + - "d" +description: |- + A unit of time equal to 86 400 seconds, using the 1967 base SI units. + + The day unit appears in the International System of Units (SI), 1st ed. (1970) defined as "1 d = 24 h = 86400 s". + + - The International System of Units (SI), 1st ed. (1970) categorizes the unit as "Units in use with the International System." + - The International System of Units (SI), 7th ed. (1998) changes the categorization to "Non-SI units accepted for use with the International System." +resources: + - relation: "Definition in the International System of Units (SI), 1st Edition" + resource-id: "https://www.bipm.org/en/publications/si-brochure" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Day" +defining-relation: + base-units: + - symbol: "s" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/base/second" + base-units-expression: "s" + scale: + numerator: 86400 +x-optimade-definition: + label: "day_si_1970_accepted" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "day" diff --git a/schemas/src/defs/v1.2/units/si/1970/accepted/degree.yaml b/schemas/src/defs/v1.2/units/si/1970/accepted/degree.yaml new file mode 100644 index 000000000..d7b3cc3da --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/1970/accepted/degree.yaml @@ -0,0 +1,36 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/1970/accepted/degree" +title: "degree" +symbol: "degree" +display-symbol: "°" +description: |- + A unit of plane and phase angle where a full circle is 360 degrees, which is equivalent to pi/180 rad, with rad defined according to the 1960 SI units. + + The degree unit appears in the International System of Units (SI), 1st ed. (1970) defined as "1° = (pi/180) rad". + + - The International System of Units (SI), 1st ed. (1970) categorizes the unit as "Units in use with the International System." + - The International System of Units (SI), 7th ed. (1998) adds as a footnote: "ISO 31 recommends that the degree be subdivided decimally rather than using the minute and second." + - The International System of Units (SI), 8th ed. (2006) further adds to that footnote: "For navigation and surveying, however, the minute has the advantage that one minute of latitude on the surface of the Earth corresponds (approximately) to one nautical mile." + - The International System of Units (SI), 9th ed. (2019) replaces the footnote with: "For some applications such as in astronomy, small angles are measured in arcseconds (i.e. seconds of plane angle), denoted as or ′′, or milliarcseconds, microarcseconds and picoarcseconds, denoted mas, μas and pas, respectively, where arcsecond is an alternative name for second of plane angle." + The formulation "denoted as or ″" is reproduced here faithfully from the source and suggests an alternate symbol may have been omitted due to a typographical error. + It is not clear what alternate symbol was intended to be referenced. +resources: + - relation: "Definition in the International System of Units (SI), 9th Edition" + resource-id: "https://www.bipm.org/en/publications/si-brochure" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Degree_(angle)" +defining-relation: + base-units: + - symbol: "pi" + id: "https://schemas.optimade.org/defs/v1.2/constants/math/basic/pi" + - symbol: "rad" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/supplementary/radian" + base-units-expression: "pi*rad" + scale: + denominator: 180 +x-optimade-definition: + label: "degree_si_1970_accepted" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "degree" diff --git a/schemas/src/defs/v1.2/units/si/1970/accepted/electronvolt.yaml b/schemas/src/defs/v1.2/units/si/1970/accepted/electronvolt.yaml new file mode 100644 index 000000000..c1be896dc --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/1970/accepted/electronvolt.yaml @@ -0,0 +1,37 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/1970/accepted/electronvolt" +title: "electron volt" +symbol: "eV" +display-symbol: "eV" +description: |- + A unit of energy equal to the amount of kinetic energy acquired by an electron as it accelerates through a 1 volt potential difference in a vacuum using the 1967 SI units. + + The electronvolt unit appears in the International System of Units (SI), 1st ed. (1970) defined as "1 electronvolt is the energy acquired by an electron after traversing a potential difference of 1 V in a vacuum; 1 eV = 1.60219×10â»Â¹â¹ J approximately." + The definition makes the unit equal to 1 volt times the experimentally determined value of the elementary charge. + Later editions update the approximate relation to use the respectively recommended value by CODATA at the time. + + In the 1970 definition, the volt refers to the 1967 volt derived named SI unit (https://schemas.optimade.org/defs/v1.2/units/si/1967/named/volt). + + - The International System of Units (SI), 1st ed. (1970) categorizes the unit as "Units for use with the SI in specific domains." + - The International System of Units (SI), 2nd ed. (1973) categorizes the unit as "Non-SI units accepted for use with the International System, whose values in SI units are obtained experimentally." + - Following the redefinitions of the SI units 2019, the electronvolt has an exact relationship to the joule, hence the International System of Units (SI), 9th ed. (2019) notes "1 eV = 1.602176634·10â»Â¹â¹ J" and categorizes the unit as "Non-SI units accepted for use with the SI units". + The footnote is also rephrased to say: "The electron volt is the kinetic energy acquired by an electron after traversing a potential difference of 1 V in a vacuum. The electronvolt is often combined with the SI prefixes." +resources: + - relation: "Definition in the International System of Units (SI), 9th Edition" + resource-id: "https://www.bipm.org/en/publications/si-brochure" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Electronvolt" +approximate-relations: + - base-units: + - symbol: "V" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1967/named/volt" + - symbol: "e" + id: "https://schemas.optimade.org/defs/v1.2/constants/codata/2018/electromagnetic/elementarycharge" + base-units-expression: "e*V" +x-optimade-definition: + label: "electronvolt_si_1970_accepted" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "electronvolt" + diff --git a/schemas/src/defs/v1.2/units/si/1970/accepted/hour.yaml b/schemas/src/defs/v1.2/units/si/1970/accepted/hour.yaml new file mode 100644 index 000000000..1a331f39a --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/1970/accepted/hour.yaml @@ -0,0 +1,30 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/1970/accepted/hour" +title: "hour" +symbol: "h" +display-symbol: "h" +description: |- + A unit of time equal to 60 minutes, or 3600 seconds, using the 1967 base SI units. + + The hour unit appears in the International System of Units (SI), 1st ed. (1970) defined as "1 h = 60 min = 3600 s". + + - The International System of Units (SI), 1st ed. (1970) categorizes the unit as "Units in use with the International System." + - The International System of Units (SI), 7th ed. (1998) changes the categorization to "Non-SI units accepted for use with the International System." +resources: + - relation: "Definition in the International System of Units (SI), 1st Edition" + resource-id: "https://www.bipm.org/en/publications/si-brochure" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Hour" +defining-relation: + base-units: + - symbol: "s" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/base/second" + base-units-expression: "s" + scale: + numerator: 3600 +x-optimade-definition: + label: "hour_si_1970_accepted" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "hour" diff --git a/schemas/src/defs/v1.2/units/si/1970/accepted/minute.yaml b/schemas/src/defs/v1.2/units/si/1970/accepted/minute.yaml new file mode 100644 index 000000000..84d5a97f3 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/1970/accepted/minute.yaml @@ -0,0 +1,30 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/1970/accepted/minute" +title: "minute" +symbol: "min" +display-symbol: "min" +description: |- + A unit of time that is equal to 60 seconds, using the 1967 base SI units. + + The minute unit appears in the International System of Units (SI), 1st ed. (1970) defined as "1 min = 60 s". + + - The International System of Units (SI), 1st ed. (1970) categorizes the unit as "Units in use with the International System." + - The International System of Units (SI), 7th ed. (1998) changes the categorization to "Non-SI units accepted for use with the International System." +resources: + - relation: "Definition in the International System of Units (SI), 1st Edition" + resource-id: "https://www.bipm.org/en/publications/si-brochure" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Minute" +defining-relation: + base-units: + - symbol: "s" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/base/second" + base-units-expression: "s" + scale: + numerator: 60 +x-optimade-definition: + label: "minute_si_1970_accepted" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "minute" diff --git a/schemas/src/defs/v1.2/units/si/1970/accepted/parsec.yaml b/schemas/src/defs/v1.2/units/si/1970/accepted/parsec.yaml new file mode 100644 index 000000000..e1b90adc2 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/1970/accepted/parsec.yaml @@ -0,0 +1,30 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/1970/accepted/parsec" +title: "parsec" +symbol: "pc" +display-symbol: "pc" +description: |- + The distance at which 1 astronomical unit subtends an angle of 1 arcsecond using the definition of the astronomical unit and arcsecond appearing in the International System of Units (SI), 1st ed. (1970) + + The parsec unit appears in the International System of Units (SI), 1st ed. (1970) defined in a footnote as "1 parsec is the distance at which 1 astronomical unit subtends an angle of 1 arcsecond; therefore, approximately, 1 pc = 206 265 AU = 30 857 x 10¹² m." + + - The International System of Units (SI), 1st ed. (1970) categorizes the unit as "Units for use with the SI in specific domains." + - The International System of Units (SI), 2nd ed. (1973) categorizes the unit as "Non-SI units accepted for use with the International System, whose values in SI units are obtained experimentally." + - The International System of Units (SI), 4th ed. (1981) and later editions omit the unit. +resources: + - relation: "Definition in the International System of Units (SI), 1st Edition" + resource-id: "https://www.bipm.org/en/publications/si-brochure" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Parsec" +approximate-relations: + - base-units: + - symbol: "m" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/base/metre" + scale: + value: 3.0857e+16 +x-optimade-definition: + label: "parsec_si_1970_accepted" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "parsec" diff --git a/schemas/src/defs/v1.2/units/si/1970/accepted/tonne.yaml b/schemas/src/defs/v1.2/units/si/1970/accepted/tonne.yaml new file mode 100644 index 000000000..499177965 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/1970/accepted/tonne.yaml @@ -0,0 +1,33 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/1970/accepted/tonne" +title: "tonne" +symbol: "t" +display-symbol: "t" +alternate-symbols: + - "t" +description: |- + A unit of mass defined as 1000 kg, with kilogram defined according to the 1960 SI units. + + The International System of Units (SI), 1st ed. (1970) defines the tonne as "1 t = 10³ kg" with the footnote "The symbol and the unit was defined in resolution 7 at the 9th meeting of the C.G.P.M. (1948)." + + - The International System of Units (SI), 1st ed. (1970) categorizes the unit as "Units used with the International System" + - The International System of Units (SI), 3rd ed. (19) changes the reference of the definition to the 1879 meeting of the CIPM page 41. + - The International System of Units (SI), 6th ed. (1991) further adds "In some English-speaking countries this unit is called ≪metric ton≫." +resources: + - relation: "Definition in the International System of Units (SI), 1st Edition" + resource-id: "https://www.bipm.org/en/publications/si-brochure" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Tonne" +defining-relation: + base-units: + - symbol: "kg" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/base/kilogram" + base-units-expression: "kg" + scale: + exponent: 3 +x-optimade-definition: + label: "tonne_si_1970_accepted" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "tonne" diff --git a/schemas/src/defs/v1.2/units/si/1970/temporary/angstrom.yaml b/schemas/src/defs/v1.2/units/si/1970/temporary/angstrom.yaml new file mode 100644 index 000000000..f5f20c31f --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/1970/temporary/angstrom.yaml @@ -0,0 +1,32 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/1970/temporary/angstrom" +title: "Ã¥ngström" +symbol: "angstrom" +display-symbol: "Ã…" +description: |- + A length equal to 10â»Â¹â° meter, with meter defined according to the 1960 SI base units. + + The Ã¥ngström unit appears in the International System of Units (SI), 1st ed. (1970) defined as "1 Ã… = 0.1 nm = 10â»Â¹â° m". + + - The International System of Units (SI), 1st ed. (1970) categorizes the unit as "temporarily admitted" for use with the SI units. + - The International System of Units (SI), 7th ed. (1998) changes the categorization to "Other non-SI units currently accepted for use with the International System." + - The International System of Units (SI), 8th ed. (2006) changes the categorization to "Other non-SI units" and adds as a clarifying footnote "The Ã¥ngström is widely used by x-ray crystallographers and structural chemists because all chemical bonds lie in the range 1 to 3 Ã¥ngströms. However it has no official sanction from the CIPM or the CGPM." + - The Ã¥ngström is omitted in the International System of Units (SI), 9th Edition (2019). +resources: + - relation: "Definition in the International System of Units (SI), 1st Edition" + resource-id: "https://www.bipm.org/en/publications/si-brochure" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Angstrom" +defining-relation: + base-units: + - symbol: "m" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/base/metre" + base-units-expression: "m" + scale: + exponent: -10 +x-optimade-definition: + label: "angstrom_si_1970_temporary" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "angstrom" diff --git a/schemas/src/defs/v1.2/units/si/1970/temporary/are.yaml b/schemas/src/defs/v1.2/units/si/1970/temporary/are.yaml new file mode 100644 index 000000000..a61a6b786 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/1970/temporary/are.yaml @@ -0,0 +1,32 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/1970/temporary/are" +title: "are" +symbol: "a" +display-symbol: "a" +description: |- + A unit of area equal to 100 square meters (10² m²), with meter defined according to the 1960 SI base units. + + The are unit appears in the International System of Units (SI), 1st ed. (1970) defined as "1 a = 1 dam² = 10² m²" with the footnote "This unit and its symbol were adopted by the International Committee in 1879 (Proces-Verbaux C.I.P.M., 1879, p. 41)." + + - The International System of Units (SI), 1st ed. (1970) categorizes the unit as "units in use temporarily". + - The International System of Units (SI), 5th ed. (1985) adds the clarification that the unit is "used to express agrarian areas." + - The International System of Units (SI), 7th ed. (1998) changes the categorization to "Other non-SI units currently accepted for use with the International System." + - The International System of Units (SI), 8th ed. (2006) completely removes the unit (but still defines the hectare). +resources: + - relation: "Definition in the International System of Units (SI), 1st Edition" + resource-id: "https://www.bipm.org/en/publications/si-brochure" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Hectare#Are" +defining-relation: + base-units: + - symbol: "m" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/base/metre" + base-units-expression: "m^2" + scale: + exponent: 4 +x-optimade-definition: + label: "are_si_1970_temporary" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "are" diff --git a/schemas/src/defs/v1.2/units/si/1970/temporary/bar.yaml b/schemas/src/defs/v1.2/units/si/1970/temporary/bar.yaml new file mode 100644 index 000000000..c5e01618c --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/1970/temporary/bar.yaml @@ -0,0 +1,37 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/1970/temporary/bar" +title: "bar" +symbol: "bar" +display-symbol: "bar" +description: |- + A unit of pressure equal to 10âµ N/m using the 1967 base SI units. + + The bar unit appears in the International System of Units (SI), 1st ed. (1970) defined as "1 bar = 0,1 MPa = 10âµ Pa" with the footnote "This unit and its symbol are included in Resolution 7 of the 9th C.G.P.M. (1948)." + (While the pascal unit appears in the 1st ed. as a symbol for N·s/m², it was adopted into SI at the 14th CGPM meeting in 1971.) + + - The International System of Units (SI), 1st ed. (1970) categorizes the unit as "Units in use temporarily with the International System." + - The International System of Units (SI), 7th ed. (1998) changes the categorization to "Other non-SI units currently accepted for use with the International System." + - The International System of Units (SI), 8th ed. (2006) changes the categorization to "Other non-SI units" and updates the footnote to: "The bar and its symbol are included in Resolution 7 of the 9th CGPM (1948; CR, 70). Since 1982 one bar has been used as the standard pressure for tabulating all thermodynamic data. Prior to 1982 the standard pressure used to be the standard atmosphere, equal to 1.013 25 bar, or 101 325 Pa." + - The bar is omitted in the International System of Units (SI), 9th Edition (2019) (except appearing as an example in the context of typesetting of units). +resources: + - relation: "Definition in the International System of Units (SI), 9th Edition" + resource-id: "https://www.bipm.org/en/publications/si-brochure" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Bar_(unit)" +defining-relation: + base-units: + - symbol: "kg" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/base/kilogram" + - symbol: "m" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/base/metre" + - symbol: "s" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1967/base/second" + base-units-expression: "kg*m^-1*s^-2" + scale: + exponent: 5 +x-optimade-definition: + label: "bar_si_1970_temporary" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "bar" diff --git a/schemas/src/defs/v1.2/units/si/1970/temporary/barn.yaml b/schemas/src/defs/v1.2/units/si/1970/temporary/barn.yaml new file mode 100644 index 000000000..24fc2b72f --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/1970/temporary/barn.yaml @@ -0,0 +1,33 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/1970/temporary/barn" +title: "barn" +symbol: "b" +display-symbol: "b" +description: |- + A unit of area used in nuclear physics to express cross sections equal to 100 fm², with meter defined according to the 1960 SI units. + + The International System of Units (SI), 1st ed. (1970) states: "1 b = 100 fm² = 10â»Â²â¸ m" with a footnote "The barn is a special unit used in nuclear physics to express cross sections." + + - The International System of Units (SI), 1st ed. (1970) categorizes the unit as "Units in use temporarily with the International System." + - The International System of Units (SI), 8th ed. (2006) categorizes the unit as "Other non-SI units currently accepted for use with the International System." + - The International System of Units (SI), 9th ed. (2019) categorizes the unit as "Other non-SI units." +resources: + - relation: "Definition in the International System of Units (SI), 9th Edition" + resource-id: "https://www.bipm.org/en/publications/si-brochure" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Barn_(unit)" +defining-relation: + base-units: + - symbol: "m" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/base/metre" + scale: + - exponent: -28 + base-units-expression: "m^2" + scale: + exponent: 4 +x-optimade-definition: + label: "barn_si_1970_temporary" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "barn" diff --git a/schemas/src/defs/v1.2/units/si/1970/temporary/gal.yaml b/schemas/src/defs/v1.2/units/si/1970/temporary/gal.yaml new file mode 100644 index 000000000..59ae36da4 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/1970/temporary/gal.yaml @@ -0,0 +1,34 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/1970/temporary/gal" +title: "gal" +symbol: "Gal" +display-symbol: "Gal" +description: |- + A unit of acceleration equal to 1 centimeter per second squared (1 cm/s²), defined according to the 1967 SI units. + + The gal unit appears in the International System of Units (SI), 1st ed. (1970) defined as "1 Gal = 1 cm/s² = 10â»Â² m/s²" with the footnote "The gal is a special unit of acceleration employed in geodesy and geophysics to express acceleration due to gravity." + + - The International System of Units (SI), 1st ed. (1970) categorizes the unit as "units in use temporarily". + - The International System of Units (SI), 7th ed. (1998) changes the categorization to "derived CGS units with special names". + - The International System of Units (SI), 9th ed. (2019) moves the unit definition to the margin aside the table for Non-SI units accepted for use with the SI units. + It is not clear how to interpret the categorization intended with this placement of the unit. +resources: + - relation: "Definition in the International System of Units (SI), 1st Edition" + resource-id: "https://www.bipm.org/en/publications/si-brochure" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Gal_(unit)" +defining-relation: + base-units: + - symbol: "m" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/base/metre" + - symbol: "s" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1967/base/second" + base-units-expression: "m*s^-2" + scale: + exponent: -2 +x-optimade-definition: + label: "gal_si_1970_temporary" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "gal" diff --git a/schemas/src/defs/v1.2/units/si/1970/temporary/hectare.yaml b/schemas/src/defs/v1.2/units/si/1970/temporary/hectare.yaml new file mode 100644 index 000000000..d03e1bc68 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/1970/temporary/hectare.yaml @@ -0,0 +1,31 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/1970/temporary/hectare" +title: "hectare" +symbol: "ha" +display-symbol: "ha" +description: |- + A unit of area equal to 1000 square meters (1 hm²), with meter defined according to the 1960 SI base unit. + + The hectare unit appears in the International System of Units (SI), 1st ed. (1970) defined as "1 ha = 1 hm² = 10â´ m²" with the footnote "This unit and its symbol were adopted by the International Committee in 1879 (Proces-Verbaux C.I.P.M., 1879, p. 41)." + + - The International System of Units (SI), 1st ed. (1970) categorizes the unit as "units in use temporarily". + - The International System of Units (SI), 5th ed. (1985) add the clarification that the unit is "used to express agrarian areas." + - The International System of Units (SI), 7th ed. (1998) changes the categorization to "Other non-SI units currently accepted for use with the International System." +resources: + - relation: "Definition in the International System of Units (SI), 9th Edition" + resource-id: "https://www.bipm.org/en/publications/si-brochure" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Hectare" +defining-relation: + base-units: + - symbol: "m" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/base/metre" + base-units-expression: "m^2" + scale: + exponent: 4 +x-optimade-definition: + label: "hectare_si_1970_temporary" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "hectare" diff --git a/schemas/src/defs/v1.2/units/si/1970/temporary/knot.yaml b/schemas/src/defs/v1.2/units/si/1970/temporary/knot.yaml new file mode 100644 index 000000000..a937482fa --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/1970/temporary/knot.yaml @@ -0,0 +1,35 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/1970/temporary/knot" +title: "knot" +symbol: "knot" +display-symbol: "knot" +description: |- + A unit of speed primarily used in navigation defined as 1 nautical mile per hour which is equal to (1852/3600) m/s using the 1967 SI units. + + The knot unit appears in the International System of Units (SI), 1st ed. (1970) defined as "1 nautical mile per hour = (1852/3600) m/s." + + - The International System of Units (SI), 1st ed. (1970) categorizes the unit as "Units in use temporarily with the International System." + - The International System of Units (SI), 7th ed. (1998) changes the categorization to "Other non-SI units currently accepted for use with the International System." + - The International System of Units (SI), 8th ed. (2006) changes the categorization to "Other non-SI units." + - The knot is omitted in the International System of Units (SI), 9th Edition (2019). +resources: + - relation: "Definition in the International System of Units (SI), 1st Edition" + resource-id: "https://www.bipm.org/en/publications/si-brochure" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Knot_(unit)" +defining-relation: + base-units: + - symbol: "m" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/base/metre" + - symbol: "s" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1967/base/second" + base-units-expression: "ms^-1" + scale: + numerator: 1852 + denominator: 3600 +x-optimade-definition: + label: "knot_si_1970_temporary" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "knot" diff --git a/schemas/src/defs/v1.2/units/si/1970/temporary/nauticalmile.yaml b/schemas/src/defs/v1.2/units/si/1970/temporary/nauticalmile.yaml new file mode 100644 index 000000000..569f79035 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/1970/temporary/nauticalmile.yaml @@ -0,0 +1,37 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/1970/temporary/nauticalmile" +title: "nautical mile" +symbol: "M" +display-symbol: "M" +alternate-symbols: + - "NM" + - "Nm" + - "nmi" +description: |- + A unit of length primarily used in navigation defined as 1852 m using the 1960 SI meter. + + The nautical mile unit appears in the International System of Units (SI), 1st ed. (1970) defined as "1 nautical mile = 1852 m" with the footnote "The nautical mile is a special unit employed for marine and aerial navigation to express distance. The conventional value given above was adopted by the First International Extraordinary Hydrographic Conference, Monaco, 1929, under the name 'International nautical mile'." + Historically, the nautical mile was defined as the meridian arc length corresponding to one arcminute of latitude. + + - The International System of Units (SI), 1st ed. (1970) categorizes the unit as "Units in use temporarily with the International System." + - The International System of Units (SI), 7th ed. (1998) changes the categorization to "Other non-SI units currently accepted for use with the International System" and adds to the footnote that: "As yet there is no internationally agreed symbol. This unit was originally chosen because one nautical mile on the surface of the Earth subtends approximately one minute of angle at the centre." + - The International System of Units (SI), 8th ed. (2006) changes the categorization to "Other non-SI units" and adjusts the footnote to say: "As yet there is no internationally agreed symbol, but the symbols M, NM, Nm, and nmi are all used; in the table the symbol M is used. The unit was originally chosen, and continues to be used, because one nautical mile on the surface of the Earth subtends approximately one minute of angle at the centre of the Earth, which is convenient when latitude and longitude are measured in degrees and minutes of angle." + - The nautical mile is omitted in the International System of Units (SI), 9th Edition (2019). +resources: + - relation: "Definition in the International System of Units (SI), 1st Edition" + resource-id: "https://www.bipm.org/en/publications/si-brochure" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Nautical_mile" +defining-relation: + base-units: + - symbol: "m" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/base/metre" + base-units-expression: "m" + scale: + numerator: 1852 +x-optimade-definition: + label: "nauticalmile_si_1970_temporary" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "nauticalmile" diff --git a/schemas/src/defs/v1.2/units/si/1970/temporary/radiationunit.yaml b/schemas/src/defs/v1.2/units/si/1970/temporary/radiationunit.yaml new file mode 100644 index 000000000..852ccd60c --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/1970/temporary/radiationunit.yaml @@ -0,0 +1,36 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/1970/temporary/radiationunit" +title: "radiation unit" +symbol: "radiationunit" +display-symbol: "rad" +description: |- + A unit used to express the absorbed dose of ionizing radiation defined as 10â»Â² J/kg using the 1967 SI units. + + This unit definition uses "radiationunit" as the symbol for this unit despite "rad" being in common use to distinguish it from the radian, which is an SI unit with rad as its symbol. + + The radiation unit appears in the International System of Units (SI), 1st ed. (1970) defined as "1 rad = 10â»Â² J/kg" with the footnote: "The rad is a special unit employed to express absorbed dose of ionizing radiation. When there is risk of confusion with the symbol for radian, rd may be used as the symbol for rad." + + - The International System of Units (SI), 1st ed. (1970) categorizes the unit as "Units in use temporarily with the International System." + - The International System of Units (SI), 3rd ed. (1977) changes the definition to use the unit gray: "1 rad = cGy = 10â»Â² Gy." + - The International System of Units (SI), 7th ed. (1998) changes the categorization to "Examples of other non-SI units" and adds the additional footnote: "Note that this non-SI unit is exactly equivalent to an SI unit with an appropriate submultiple prefix." + - The International System of Units (SI), 8th ed. (2006) omits the unit. +resources: + - relation: "Definition in the International System of Units (SI), 1st Edition" + resource-id: "https://www.bipm.org/en/publications/si-brochure" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Rad_(radiation_unit)" +defining-relation: + base-units: + - symbol: "J" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1967/named/joule" + - symbol: "kg" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/base/kilogram" + base-units-expression: "J*kg^-1" + scale: + exponent: -2 +x-optimade-definition: + label: "radiationunit_si_1970_temporary" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "radiationunit" diff --git a/schemas/src/defs/v1.2/units/si/1970/temporary/roentgen.yaml b/schemas/src/defs/v1.2/units/si/1970/temporary/roentgen.yaml new file mode 100644 index 000000000..b92c01029 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/1970/temporary/roentgen.yaml @@ -0,0 +1,35 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/1970/temporary/roentgen" +title: "roentgen" +symbol: "R" +display-symbol: "R" +description: |- + A unit used to express the exposure of ionizing radiation defined as 2.58 x 10â»â´ C/kg using the 1967 SI units. + + The roentgen unit appears in the International System of Units (SI), 1st ed. (1970) defined as "1 R = 2.58 x 10â»â´ C/kg" with the footnote: "The roentgen is a special unit used to express the ionization exposure of ionizing radiation." + + - The International System of Units (SI), 1st ed. (1970) categorizes the unit as "Units in use temporarily with the International System." + - The International System of Units (SI), 2nd ed. (1973) rephrases the footnote to: "The roentgen is a special unit used to express the exposure of X or gamma radiation." + - The International System of Units (SI), 7th ed. (1998) changes the categorization to "Examples of other non-SI units". + - The International System of Units (SI), 8th ed. (2006) omits the unit. +resources: + - relation: "Definition in the International System of Units (SI), 1st Edition" + resource-id: "https://www.bipm.org/en/publications/si-brochure" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Roentgen_(unit)" +defining-relation: + base-units: + - symbol: "C" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1967/named/coulomb" + - symbol: "kg" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/base/kilogram" + base-units-expression: "C*kg^-1" + scale: + numerator: 258 + exponent: -6 +x-optimade-definition: + label: "roentgen_si_1970_temporary" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "roentgen" diff --git a/schemas/src/defs/v1.2/units/si/1971/base/mole.yaml b/schemas/src/defs/v1.2/units/si/1971/base/mole.yaml new file mode 100644 index 000000000..5112293fd --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/1971/base/mole.yaml @@ -0,0 +1,29 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/1971/base/mole" +title: "mole" +symbol: "mol" +display-symbol: "mol" +description: |- + The SI base unit of amount of substance defined via the number of atoms in 12 grams of carbon 12 at the 14th CGPM Meeting in 1971 and clarified at the 69th CIPM meeting in 1980. + + "1. The mole is the amount of substance of a system which contains as many elementary entities as there are atoms in 0.012 kilogram of carbon 12. 2. When the mole is used, the elementary entities must be specified and may be atoms, molecules, ions, electrons, other particles, or specified groups of such particles." [14th CGPM Meeting (1971), resolution 3]. + + The 69th CIPM meeting in 1980 approved to append a clarification to the above definition: "In this definition, it is understood that unbound atoms of carbon 12, at rest and in their ground state, are referred to." +resources: + - relation: "Definition in the 14th CGPM Meeting in 1971, resolution 3" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/14-1971/resolution-3" + - relation: "Clarification in the 96th meeting of the CIPM" + resource-id: "https://www.bipm.org/en/committees/ci/cipm/69-1980" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Mole_(unit)" +standard: + name: "si" + year: 1971 + category: "base" + symbol: "mol" +x-optimade-definition: + label: "mole_si_1971_base" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "mole" diff --git a/schemas/src/defs/v1.2/units/si/1971/named/pascal.yaml b/schemas/src/defs/v1.2/units/si/1971/named/pascal.yaml new file mode 100644 index 000000000..73998865d --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/1971/named/pascal.yaml @@ -0,0 +1,34 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/1971/named/pascal" +title: "pascal" +symbol: "Pa" +display-symbol: "Pa" +description: |- + A derived SI unit for pressure and stress equal to kg·mâ»Â¹Â·sâ»Â² using the 1967 SI base units, defined at the 14th CGPM Meeting (1971). + + "The International Committee will ask the General Conference to approve two special names: pascal (symbol Pa) for the SI unit of pressure (N/m²), [...]" [14th CGPM Meeting (1971)]. +resources: + - relation: "Definition at the 14th CGPM Meeting (1971)" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/14-1971" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Pascal_(unit)" +defining-relation: + base-units: + - symbol: "kg" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/base/kilogram" + - symbol: "m" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/base/metre" + - symbol: "s" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1967/base/second" + base-units-expression: "kg*m^-1*s^-2" +standard: + name: "si" + year: 1971 + category: "named" + symbol: "Pa" +x-optimade-definition: + label: "pascal_si_1971_named" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "pascal" diff --git a/schemas/src/defs/v1.2/units/si/1971/named/siemens.yaml b/schemas/src/defs/v1.2/units/si/1971/named/siemens.yaml new file mode 100644 index 000000000..b776bdaf6 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/1971/named/siemens.yaml @@ -0,0 +1,36 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/1971/named/siemens" +title: "siemens" +symbol: "S" +display-symbol: "S" +description: |- + A derived SI unit for electrical conductance equal to kgâ»Â¹Â·mâ»Â²Â·s³·A² using the 1967 SI base units, defined at the 14th CGPM Meeting (1971). + + "The International Committee will ask the General Conference to approve two special names: [...] siemens (symbol S) for the SI unit of conductance (Ωâ»Â¹)." [14th CGPM Meeting (1971)]. +resources: + - relation: "Definition at the 14th CGPM Meeting (1971)" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/14-1971" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Siemens_(unit)" +defining-relation: + base-units: + - symbol: "A" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1967/base/ampere" + - symbol: "kg" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/base/kilogram" + - symbol: "m" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/base/metre" + - symbol: "s" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1967/base/second" + base-units-expression: "A^2*kg^-1*m^-2*s^3" +standard: + name: "si" + year: 1971 + category: "named" + symbol: "S" +x-optimade-definition: + label: "siemens_si_1971_named" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "siemens" diff --git a/schemas/src/defs/v1.2/units/si/1975/named/becquerel.yaml b/schemas/src/defs/v1.2/units/si/1975/named/becquerel.yaml new file mode 100644 index 000000000..9639e4f35 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/1975/named/becquerel.yaml @@ -0,0 +1,30 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/1975/named/becquerel" +title: "becquerel" +symbol: "Bq" +display-symbol: "Bq" +description: |- + A derived SI unit for radioactivity, defined as sâ»Â¹ using the 1967 SI second, defined at the 15th CGPM Meeting in 1975. + + "The 15th Conférence Générale des Poids et Mesures, [...] adopts the following special name for the SI unit of activity: becquerel, symbol Bq, equal to one reciprocal second." [15th CGPM Meeting (1975)] +resources: + - relation: "Definition at the 15th CGPM Meeting (1975)" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/15-1975" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Becquerel" +defining-relation: + base-units: + - symbol: "s" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1967/base/second" + base-units-expression: "s^-1" +standard: + name: "si" + year: 1975 + category: "named" + symbol: "Bq" +x-optimade-definition: + label: "becquerel_si_1975_named" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "becquerel" diff --git a/schemas/src/defs/v1.2/units/si/1975/named/gray.yaml b/schemas/src/defs/v1.2/units/si/1975/named/gray.yaml new file mode 100644 index 000000000..700036416 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/1975/named/gray.yaml @@ -0,0 +1,32 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/1975/named/gray" +title: "gray" +symbol: "Gy" +display-symbol: "Gy" +description: |- + A derived SI unit for absorbed dose of ionizing radiation equal to m²·sâ»Â² using the 1967 base SI units at the 15th CGPM Meeting in 1975. + + "The 15th Conférence Générale des Poids et Mesures, [...] adopts the following special name for the SI unit of ionizing radiation: gray, symbol Gy, equal to one joule per kilogram." [15th CGPM Meeting (1975)] +resources: + - relation: "Definition at the 15th CGPM Meeting (1975)" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/15-1975" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Gray_(unit)" +defining-relation: + base-units: + - symbol: "m" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/base/metre" + - symbol: "s" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1967/base/second" + base-units-expression: "m^2*s^-2" +standard: + name: "si" + year: 1975 + category: "named" + symbol: "Gy" +x-optimade-definition: + label: "gray_si_1975_named" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "gray" diff --git a/schemas/src/defs/v1.2/units/si/1979/base/candela.yaml b/schemas/src/defs/v1.2/units/si/1979/base/candela.yaml new file mode 100644 index 000000000..c4711efb1 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/1979/base/candela.yaml @@ -0,0 +1,33 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/1979/base/candela" +title: "candela" +symbol: "cd" +display-symbol: "cd" +description: |- + The SI base unit of luminous intensity in a given direction defined from the luminous intensity of monochromatic radiation at a specific frequency and radiant intensity at the 16th CGPM Meeting in 1979. + + "The candela is the luminous intensity, in a given direction, of a source that emits monochromatic radiation of frequency 540×10¹² hertz and that has a radiant intensity in that direction of 1/683 watt per steradian." [16th CGPM Meeting (1979), resolution 3]. + + The hertz, watt, and steradian units referenced in this definition are: + + - the SI 1967 derived hertz unit (https://schemas.optimade.org/defs/v1.2/units/si/1967/named/hertz) equal to secondâ»Â¹, referencing the SI 1967 base unit second (https://schemas.optimade.org/defs/v1.2/units/si/1967/base/second). + - the SI 1967 derived watt unit (https://schemas.optimade.org/defs/v1.2/units/si/1967/named/watt) equal to kilogram·meter²·secondâ»Â³, referencing the SI 1960 base unit kilogram (https://schemas.optimade.org/defs/v1.2/units/si/1960/base/kilogram) and metre (https://schemas.optimade.org/defs/v1.2/units/si/1960/base/metre); and the 1967 base unit second (https://schemas.optimade.org/defs/v1.2/units/si/1967/base/second). + - the SI 1960 supplementary unit steradian (https://schemas.optimade.org/defs/v1.2/units/si/1960/supplementary/steradian). +resources: + - relation: "Redefinition of the candela at the 16th CGPM Meeting in 1979, resolution 3." + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/16-1979/resolution-3" + - relation: "Previous definition at the 13th CGPM meeting (1967)" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/13-1967/resolution-5" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Candela" +standard: + name: "si" + year: 1979 + category: "base" + symbol: "cd" +x-optimade-definition: + label: "candela_si_1979_base" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "candela" diff --git a/schemas/src/defs/v1.2/units/si/1979/named/lumen.yaml b/schemas/src/defs/v1.2/units/si/1979/named/lumen.yaml new file mode 100644 index 000000000..b8ce501c8 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/1979/named/lumen.yaml @@ -0,0 +1,38 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/1979/named/lumen" +title: "lumen" +symbol: "lm" +display-symbol: "lm" +description: |- + A derived SI unit for luminous flux equal to cd·sr using the 1983 SI units. + + "The lumen is the luminous flux emitted in a steradian by a uniform point source with a luminous intensity of one candela." [9th CGPM meeting in 1946] + + The lumen was defined at the 9th CGPM meeting in 1946, implicitly redefined via the redefinition of the second at the 13th CGPM Meeting in 1967, resolution 1, and the redefinition of the candela at the 16th CGPM Meeting in 1979, resolution 3. +resources: + - relation: "Definition and establishment of the SI unit system at the 11th CGPM meeting (1960), resolution 12." + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/11-1960/resolution-12" + - relation: "Redefinition of the candela at the 16th CGPM Meeting in 1979, resolution 3." + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/16-1979/resolution-3" + - relation: "Redefinition of the second in the 13th CGPM Meeting (1967), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/13-1967/resolution-1" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Lumen_(unit)" +defining-relation: + base-units: + - symbol: "cd" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1979/base/candela" + - symbol: "sr" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/supplementary/steradian" + base-units-expression: "cd*sr" +standard: + name: "si" + year: 1979 + category: "named" + symbol: "lm" +x-optimade-definition: + label: "lumen_si_1979_named" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "lumen" diff --git a/schemas/src/defs/v1.2/units/si/1979/named/lux.yaml b/schemas/src/defs/v1.2/units/si/1979/named/lux.yaml new file mode 100644 index 000000000..cf467d335 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/1979/named/lux.yaml @@ -0,0 +1,40 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/1979/named/lux" +title: "lux" +symbol: "lx" +display-symbol: "lx" +description: |- + A derived SI unit for illuminance equal to cdâ‹…srâ‹…mâ»Â² in the 1979 SI units. + + "The lux is the illuminance of a surface that receives a uniformly distributed luminous flux of one lumen per square meter." [9th CGPM meeting in 1946] + + The lux was defined at the 9th CGPM meeting in 1946, and implicitly redefined via the redefinition of the second at the 13th CGPM Meeting in 1967, resolution 1 and the redefinition of the candela at the 16th CGPM Meeting in 1979, resolution 3. +resources: + - relation: "Definition and establishment of the SI unit system at the 11th CGPM meeting (1960), resolution 12." + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/11-1960/resolution-12" + - relation: "Redefinition of the candela at the 16th CGPM Meeting in 1979, resolution 3." + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/16-1979/resolution-3" + - relation: "Redefinition of the second in the 13th CGPM Meeting (1967), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/13-1967/resolution-1" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Lux" +defining-relation: + base-units: + - symbol: "cd" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1979/base/candela" + - symbol: "sr" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/supplementary/steradian" + - symbol: "m" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/base/metre" + base-units-expression: "cd*m^-2*sr" +standard: + name: "si" + year: 1979 + category: "named" + symbol: "lx" +x-optimade-definition: + label: "lux_si_1979_named" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "lux" diff --git a/schemas/src/defs/v1.2/units/si/1979/named/sievert.yaml b/schemas/src/defs/v1.2/units/si/1979/named/sievert.yaml new file mode 100644 index 000000000..2f80e414a --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/1979/named/sievert.yaml @@ -0,0 +1,32 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/1979/named/sievert" +title: "sievert" +symbol: "Sv" +display-symbol: "Sv" +description: |- + A derived SI unit for equivalent dose of ionizing radiation equal to J·kgâ»Â¹ (m²·sâ»Â²) using the 1967 SI base units, defined at the 16th CGPM meeting in 1979. + + "The 16th Conférence Générale des Poids et Mesures, [...] adopts the special name sievert, symbol Sv, for the SI unit of dose equivalent in the field of radioprotection. The sievert is equal to the joule per kilogram." [16th CGPM meeting (1979), resolution 5] +resources: + - relation: "Definition at the 16th CGPM Meeting (1979), resolution 5" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/16-1979/resolution-5" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Sievert" +defining-relation: + base-units: + - symbol: "m" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/base/metre" + - symbol: "s" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1967/base/second" + base-units-expression: "m^2*s^-2" +standard: + name: "si" + year: 1979 + category: "named" + symbol: "Sv" +x-optimade-definition: + label: "sievert_si_1979_named" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "sievert" diff --git a/schemas/src/defs/v1.2/units/si/1981/temporary/rem.yaml b/schemas/src/defs/v1.2/units/si/1981/temporary/rem.yaml new file mode 100644 index 000000000..c7fd63efa --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/1981/temporary/rem.yaml @@ -0,0 +1,31 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/1981/temporary/rem" +title: "roentgen equivalent man" +symbol: "rem" +display-symbol: "rem" +description: |- + The "roentgen equivalent man" (rem) is a unit used in radioprotection meant to represent a dose of any ionizing radiation comparable in effect to one roentgen of high-voltage x-radiation, taken to be equal to 10â»Â² Sv using the 1967 SI units. + + The rem unit appears in the International System of Units (SI), 4th ed. (1981) defined as "1 rem = 1 cSv = 10â»Â² Sv" with the footnote: "The rem is a special unit used in radioprotection to express the equivalent dose." +resources: + - relation: "Definition in the International System of Units (SI), 4th Edition" + resource-id: "https://www.bipm.org/en/publications/si-brochure" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Roentgen_equivalent_man" +defining-relation: + base-units: + - symbol: "kg" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/base/kilogram" + - symbol: "m" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/base/metre" + - symbol: "s" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1967/base/second" + base-units-expression: "kg*m^2*s^-2" + scale: + exponent: -2 +x-optimade-definition: + label: "rem_si_1981_temporary" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "rem" diff --git a/schemas/src/defs/v1.2/units/si/1983/accepted/electronvolt.yaml b/schemas/src/defs/v1.2/units/si/1983/accepted/electronvolt.yaml new file mode 100644 index 000000000..2f2349b00 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/1983/accepted/electronvolt.yaml @@ -0,0 +1,42 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/1983/accepted/electronvolt" +title: "electron volt" +symbol: "eV" +display-symbol: "eV" +description: |- + A unit of energy equal to the amount of kinetic energy acquired by an electron as it accelerates through a 1 volt potential difference in a vacuum using the 1967 SI units. + + The electronvolt unit appears in the International System of Units (SI), 1st ed. (1970) defined as "1 electronvolt is the energy acquired by an electron after traversing a potential difference of 1 V in a vacuum; 1 eV = 1.60219×10â»Â¹â¹ J approximately." + The definition makes the unit equal to 1 volt times the experimentally determined value of the elementary charge. + Later editions update the approximate relation to use the respectively recommended value by CODATA at the time. + + In the 1983 redefinition of the electron volt, the volt refers to the 1983 volt derived named SI unit (https://schemas.optimade.org/defs/v1.2/units/si/1983/named/volt). + + - The International System of Units (SI), 1st ed. (1970) categorizes the unit as "Units for use with the SI in specific domains." + - The International System of Units (SI), 2nd ed. (1973) categorizes the unit as "Non-SI units accepted for use with the International System, whose values in SI units are obtained experimentally." + + Following the redefinitions of the SI units 2019, the electronvolt has an exact relationship to the joule, hence the International System of Units (SI), 9th ed. (2019) notes "1 eV = 1.602176634·10â»Â¹â¹ J" and categorizes the unit as "Non-SI units accepted for use with the SI units". + The footnote is also rephrased to say: "The electron volt is the kinetic energy acquired by an electron after traversing a potential difference of 1 V in a vacuum. The electronvolt is often combined with the SI prefixes." + + The electron volt unit was implicitly redefined via the redefinition of the metre at the 17th CGPM meeting (1983), resolution 1. +resources: + - relation: "Definition in the International System of Units (SI), 9th Edition" + resource-id: "https://www.bipm.org/en/publications/si-brochure" + - relation: "Redefinition of the metre at the 17th CGPM meeting (1983), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/17-1983/resolution-1" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Electronvolt" +approximate-relations: + - base-units: + - symbol: "V" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1983/named/volt" + - symbol: "e" + id: "https://schemas.optimade.org/defs/v1.2/constants/codata/2018/electromagnetic/elementarycharge" + base-units-expression: "e*V" +x-optimade-definition: + label: "electronvolt_si_1983_accepted" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "electronvolt" + diff --git a/schemas/src/defs/v1.2/units/si/1983/accepted/litre.yaml b/schemas/src/defs/v1.2/units/si/1983/accepted/litre.yaml new file mode 100644 index 000000000..0986ab5f0 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/1983/accepted/litre.yaml @@ -0,0 +1,34 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/1983/accepted/litre" +title: "litre" +symbol: "l" +display-symbol: "l" +alternate-symbols: + - "L" + - "liter" +description: |- + The litre, or liter is a unit of volume equal to a cubic decimetre (1 dm³) implicitly redefined via the redefinition of the meter at the 17th CGPM Meeting in 1983, resolution 1. + + "The 12th Conférence Générale des Poids et Mesures (CGPM) [...] declares that the word 'litre' may be employed as a special name for the cubic decimetre" [12th CGPM meeting (1964), resolution 6]. + + The litre was defined at the 12th CGPM meeting in 1964, resolution 6, and implicitly redefined with the redefinition of the metre at the 17th CGPM Meeting in 1983, resolution 1. +resources: + - relation: "Definition at the 12th CGPM meeting (1964), resolution 6" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/12-1964/resolution-6" + - relation: "Redefinition of the metre at the 17th CGPM meeting (1983), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/17-1983/resolution-1" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Litre" +defining-relation: + base-units: + - symbol: "m" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1983/base/metre" + base-units-expression: "m^3" + scale: + exponent: -3 +x-optimade-definition: + label: "litre_si_1983_accepted" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "litre" diff --git a/schemas/src/defs/v1.2/units/si/1983/base/ampere.yaml b/schemas/src/defs/v1.2/units/si/1983/base/ampere.yaml new file mode 100644 index 000000000..9862d893d --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/1983/base/ampere.yaml @@ -0,0 +1,36 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/1983/base/ampere" +title: "ampere" +symbol: "A" +display-symbol: "A" +description: |- + The SI base unit of electric current defined from the force between parallel wires carrying an electric current at the 41st CIPM meeting (1946) and implicitly redefined via the redefinition of the second at the 13th CGPM Meeting in 1967 and the redefinition of the metre at the 17th CGPM Meeting in 1983. + + "The ampere is that constant current which, if maintained in two straight parallel conductors of infinite length, of negligible circular cross-section, and placed 1 metre apart in vacuum, would produce between these conductors a force equal to 2×10â»â· MKS unit of force per metre of length." [41st CIPM meeting (1946), Resolution 2]. + + Following the redefinition of the second at the 13th CGPM Meeting in 1967, resolution 1, and the redefinition of the metre at the 17th CGPM Meeting in 1983, resolution 1, the implicitly redefined ampere references: + + - the metre in the definition references the SI 1983 metre (https://schemas.optimade.org/defs/v1.2/units/si/1983/base/metre) + - the MKS unit of force references the derived newton unit (https://schemas.optimade.org/defs/v1.2/units/si/1983/derived/newton) equal to kilogram·metre·secondâ»Â², referencing the SI 1960 kilogram (https://schemas.optimade.org/defs/v1.2/units/si/1960/base/kilogram) and the SI 1983 metre (https://schemas.optimade.org/defs/v1.2/units/si/1983/base/metre); and the SI 1967 definition of the second (https://schemas.optimade.org/defs/v1.2/units/si/1967/base/second). +resources: + - relation: "Definition at the 41st CIPM meeting (1946), resolution 2" + resource-id: "https://www.bipm.org/en/committees/ci/cipm/41-1946/resolution-2" + - relation: "Inclusion in SI at the establishment of the SI unit system at the 11th CGPM meeting (1960), resolution 12." + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/11-1960/resolution-12" + - relation: "Redefinition of the metre at the 17th CGPM meeting (1983), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/17-1983/resolution-1" + - relation: "Redefinition of the second at the 13th CGPM meeting (1967), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/13-1967/resolution-1" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Ampere" +standard: + name: "si" + year: 1983 + category: "base" + symbol: "A" +x-optimade-definition: + label: "ampere_si_1983_base" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "ampere" diff --git a/schemas/src/defs/v1.2/units/si/1983/base/candela.yaml b/schemas/src/defs/v1.2/units/si/1983/base/candela.yaml new file mode 100644 index 000000000..b40506fe7 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/1983/base/candela.yaml @@ -0,0 +1,37 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/1983/base/candela" +title: "candela" +symbol: "cd" +display-symbol: "cd" +description: |- + The candela is the SI base unit of luminous intensity in a given direction defined from the luminous intensity of monochromatic radiation at a specific frequency and radiant intensity at the 16th CGPM Meeting in 1979; implicitly redefined via the redefinition of the metre at the 17th CGPM Meeting in 1983. + + "The candela is the luminous intensity, in a given direction, of a source that emits monochromatic radiation of frequency 540×10¹² hertz and that has a radiant intensity in that direction of 1/683 watt per steradian." [16th CGPM Meeting (1979), resolution 3]. + + Following the redefinition of the metre at the 17th CGPM Meeting in 1983, resolution 1, the implicitly redefined candela references: + + - the SI 1967 derived hertz unit (https://schemas.optimade.org/defs/v1.2/units/si/1967/named/hertz). + - the SI 1983 derived watt unit (https://schemas.optimade.org/defs/v1.2/units/si/1983/named/watt). + - the SI 1960 supplementary unit steradian (https://schemas.optimade.org/defs/v1.2/units/si/1960/supplementary/steradian). +resources: + - relation: "Definition at the 41st CIPM meeting (1946), resolution 2" + resource-id: "https://www.bipm.org/en/committees/ci/cipm/41-1946/resolution-2" + - relation: "Inclusion in SI at the establishment of the SI unit system at the 11th CGPM meeting (1960), resolution 12." + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/11-1960/resolution-12" + - relation: "Redefinition of the metre at the 17th CGPM meeting (1983), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/17-1983/resolution-1" + - relation: "Redefinition of the second at the 13th CGPM meeting (1967), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/13-1967/resolution-1" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Candela" +standard: + name: "si" + year: 1983 + category: "base" + symbol: "cd" +x-optimade-definition: + label: "candela_si_1983_base" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "candela" diff --git a/schemas/src/defs/v1.2/units/si/1983/base/metre.yaml b/schemas/src/defs/v1.2/units/si/1983/base/metre.yaml new file mode 100644 index 000000000..3ebcc4fc4 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/1983/base/metre.yaml @@ -0,0 +1,32 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/1983/base/metre" +title: "metre" +symbol: "m" +display-symbol: "m" +alternate-symbols: + - "metre" + - "meter" +description: |- + The metre, or meter, is the SI base unit of length defined via the distance light travels in vacuum during a fixed time interval after the redefinition at the 17th CGPM Meeting in 1983. + + "The metre is the length of the path travelled by light in vacuum during a time interval of 1/299792458 of a second." [17th CGPM Meeting (1983), resolution 1]. + + At the 26th CGPM Meeting (2018), resolution 1 the definition was rephrased to: "The metre, symbol m, is the SI unit of length. It is defined by taking the fixed numerical value of the speed of light in vacuum \(c\) to be 299792458 when expressed in the unit mâ‹…sâ»Â¹, where the second is defined in terms of the caesium frequency \(\Delta \nu_\textrm{Cs}\)." + + This definition references the SI 1967 second (https://schemas.optimade.org/defs/v1.2/units/si/1967/base/second). +resources: + - relation: "Definition at the 17th CGPM meeting (1983), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/17-1983/resolution-1" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Metre" +standard: + name: "si" + year: 1983 + category: "base" + symbol: "m" +x-optimade-definition: + label: "metre_si_1983_base" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "metre" diff --git a/schemas/src/defs/v1.2/units/si/1983/named/coulomb.yaml b/schemas/src/defs/v1.2/units/si/1983/named/coulomb.yaml new file mode 100644 index 000000000..f39a546ae --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/1983/named/coulomb.yaml @@ -0,0 +1,38 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/1983/named/coulomb" +title: "coulomb" +symbol: "C" +display-symbol: "C" +description: |- + A derived SI unit for electric charge equal to s·A in the 1983 SI base units. + + "The coulomb is the amount of electricity transported in one second by a current of one ampere." [9th CGPM meeting in 1946] + + The coulomb was defined at the 9th CGPM Meeting in 1946, included in SI at the 11th CGPM meeting in 1960, resolution 12, implicitly redefined via the redefinition of the second at the 13th CGPM Meeting in 1967, resolution 1, and again implicitly redefined via the redefinition of the metre at the 17th CGPM Meeting in 1983, resolution 1. +resources: + - relation: "Definition at the 9th CGPM meeting (1948)" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/9-1948" + - relation: "Definition and establishment of the SI unit system at the 11th CGPM meeting (1960), resolution 12." + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/11-1960/resolution-12" + - relation: "Redefinition of the second in the 13th CGPM Meeting (1967), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/13-1967/resolution-1" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Coulomb" +defining-relation: + base-units: + - symbol: "s" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1967/base/second" + - symbol: "A" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1983/base/ampere" + base-units-expression: "A*s" +standard: + name: "si" + year: 1983 + category: "named" + symbol: "C" +x-optimade-definition: + label: "coulomb_si_1983_named" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "coulomb" diff --git a/schemas/src/defs/v1.2/units/si/1983/named/farad.yaml b/schemas/src/defs/v1.2/units/si/1983/named/farad.yaml new file mode 100644 index 000000000..30c49735f --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/1983/named/farad.yaml @@ -0,0 +1,42 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/1983/named/farad" +title: "farad" +symbol: "F" +display-symbol: "F" +description: |- + A derived SI unit for electrical capacitance equal to kgâ»Â¹Â·mâ»Â²Â·sâ´Â·A² in the 1967 SI units. + + "The farad is the capacitance of an electric capacitor between whose plates an electric potential difference of one volt appears when it is charged with an amount of electricity equal to one coulomb." [9th CGPM meeting in 1946] + + The farad was defined at the 9th CGPM Meeting in 1946, included in SI at the 11th CGPM meeting in 1960, resolution 12 implicitly redefined via the redefinition of the second at the 13th CGPM Meeting in 1967, resolution 1, and again implicitly redefined via the redefinition of the metre at the 17th CGPM meeting (1983), resolution 1. +resources: + - relation: "Definition and establishment of the SI unit system at the 11th CGPM meeting (1960), resolution 12." + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/11-1960/resolution-12" + - relation: "Redefinition of the metre at the 17th CGPM meeting (1983), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/17-1983/resolution-1" + - relation: "Redefinition of the second in the 13th CGPM Meeting (1967), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/13-1967/resolution-1" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Farad" +defining-relation: + base-units: + - symbol: "A" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1983/base/ampere" + - symbol: "kg" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/base/kilogram" + - symbol: "m" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1983/base/metre" + - symbol: "s" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1967/base/second" + base-units-expression: "A^2*kg^-1*m^-2*s^4" +standard: + name: "si" + year: 1983 + category: "named" + symbol: "F" +x-optimade-definition: + label: "farad_si_1983_named" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "farad" diff --git a/schemas/src/defs/v1.2/units/si/1983/named/gray.yaml b/schemas/src/defs/v1.2/units/si/1983/named/gray.yaml new file mode 100644 index 000000000..9586038e8 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/1983/named/gray.yaml @@ -0,0 +1,36 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/1983/named/gray" +title: "gray" +symbol: "Gy" +display-symbol: "Gy" +description: |- + A derived SI unit for absorbed dose of ionizing radiation equal to m²·sâ»Â² using the 1983 SI units. + + "The 15th Conférence Générale des Poids et Mesures, [...] adopts the following special name for the SI unit of ionizing radiation: gray, symbol Gy, equal to one joule per kilogram." [15th CGPM Meeting (1975)] + + The gray was defined at the 15th CGPM Meeting in 1975, and implicitly redefined via the redefinition of the meter at the 17th CGPM Meeting in 1983, resolution 1. +resources: + - relation: "Definition at the 15th CGPM Meeting (1975)" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/15-1975" + - relation: "Redefinition of the metre at the 17th CGPM meeting (1983), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/17-1983/resolution-1" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Gray_(unit)" +defining-relation: + base-units: + - symbol: "m" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1983/base/metre" + - symbol: "s" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1967/base/second" + base-units-expression: "m^2*s^-2" +standard: + name: "si" + year: 1983 + category: "named" + symbol: "Gy" +x-optimade-definition: + label: "gray_si_1983_named" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "gray" diff --git a/schemas/src/defs/v1.2/units/si/1983/named/henry.yaml b/schemas/src/defs/v1.2/units/si/1983/named/henry.yaml new file mode 100644 index 000000000..fd99a3033 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/1983/named/henry.yaml @@ -0,0 +1,42 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/1983/named/henry" +title: "henry" +symbol: "H" +display-symbol: "H" +description: |- + A derived SI unit for inductance equal to kg·m²·sâ»Â²Â·Aâ»Â² in the 1983 SI units. + + "The henry is the inductance of a closed circuit in which an electromotive force of one volt is produced when the electric current passing through the circuit varies uniformly at a rate of one ampere per second." [9th CGPM meeting in 1946] + + The henry was defined at the 9th CGPM Meeting in 1946, included in SI at the 11th CGPM meeting in 1960, resolution 12, implicitly redefined via the redefinition of the second at the 13th CGPM Meeting in 1967, resolution 1, and again implicitly redefined via the redefinition of the metre at the 17th CGPM meeting (1983), resolution 1. +resources: + - relation: "Definition and establishment of the SI unit system at the 11th CGPM meeting (1960), resolution 12." + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/11-1960/resolution-12" + - relation: "Redefinition of the metre at the 17th CGPM meeting (1983), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/17-1983/resolution-1" + - relation: "Redefinition of the second at the 13th CGPM Meeting (1967), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/13-1967/resolution-1" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Henry_(unit)" +defining-relation: + base-units: + - symbol: "A" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1983/base/ampere" + - symbol: "kg" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/base/kilogram" + - symbol: "m" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1983/base/metre" + - symbol: "s" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1967/base/second" + base-units-expression: "A^-2*kg*m^2*s^-2" +standard: + name: "si" + year: 1983 + category: "named" + symbol: "H" +x-optimade-definition: + label: "henry_si_1983_named" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "henry" diff --git a/schemas/src/defs/v1.2/units/si/1983/named/joule.yaml b/schemas/src/defs/v1.2/units/si/1983/named/joule.yaml new file mode 100644 index 000000000..188f13e44 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/1983/named/joule.yaml @@ -0,0 +1,42 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/1983/named/joule" +title: "joule" +symbol: "J" +display-symbol: "J" +description: |- + A derived SI unit for energy, work, and heat equal to kg·m²·sâ»Â² in the 1983 SI units. + + "The joule is the work produced by a newton whose point of application moves one meter in the direction of the force." [9th CGPM meeting in 1946] + + The joule was defined at the 9th CGPM Meeting in 1946, included in SI at the 11th CGPM meeting in 1960, resolution 12, implicitly redefined via the redefinition of the second at the 13th CGPM Meeting in 1967, resolution 1, and again implicitly redefined via the redefinition of the metre at the 17th CGPM meeting (1983), resolution 1. +resources: + - relation: "Definition at the 9th CGPM meeting (1948)" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/9-1948" + - relation: "Definition and establishment of the SI unit system at the 11th CGPM meeting (1960), resolution 12." + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/11-1960/resolution-12" + - relation: "Redefinition of the metre at the 17th CGPM meeting (1983), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/17-1983/resolution-1" + - relation: "Redefinition of the second in the 13th CGPM Meeting (1967), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/13-1967/resolution-1" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Joule" +defining-relation: + base-units: + - symbol: "kg" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/base/kilogram" + - symbol: "m" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1983/base/metre" + - symbol: "s" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1967/base/second" + base-units-expression: "kg*m^2*s^-2" +standard: + name: "si" + year: 1983 + category: "named" + symbol: "J" +x-optimade-definition: + label: "joule_si_1983_named" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "joule" diff --git a/schemas/src/defs/v1.2/units/si/1983/named/lumen.yaml b/schemas/src/defs/v1.2/units/si/1983/named/lumen.yaml new file mode 100644 index 000000000..fd6efbd89 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/1983/named/lumen.yaml @@ -0,0 +1,40 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/1983/named/lumen" +title: "lumen" +symbol: "lm" +display-symbol: "lm" +description: |- + A derived SI unit for luminous flux equal to cd·sr using the 1983 SI units. + + "The lumen is the luminous flux emitted in a steradian by a uniform point source with a luminous intensity of one candela." [9th CGPM meeting in 1946] + + The lumen was defined at the 9th CGPM meeting in 1946, implicitly redefined via the redefinition of the second at the 13th CGPM Meeting in 1967, resolution 1, the redefinition of the candela at the 16th CGPM Meeting in 1979, resolution 3, and the redefinition of the metre at the 17th CGPM Meeting in 1983, resolution 1. +resources: + - relation: "Definition and establishment of the SI unit system at the 11th CGPM meeting (1960), resolution 12." + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/11-1960/resolution-12" + - relation: "Redefinition of the candela at the 16th CGPM Meeting in 1979, resolution 3." + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/16-1979/resolution-3" + - relation: "Redefinition of the second in the 13th CGPM Meeting in 1967, resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/13-1967/resolution-1" + - relation: "Redefinition of the metre at the 17th CGPM meeting in 1983, resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/17-1983/resolution-1" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Lumen_(unit)" +defining-relation: + base-units: + - symbol: "cd" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1983/base/candela" + - symbol: "sr" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/supplementary/steradian" + base-units-expression: "cd*sr" +standard: + name: "si" + year: 1983 + category: "named" + symbol: "lm" +x-optimade-definition: + label: "lumen_si_1983_named" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "lumen" diff --git a/schemas/src/defs/v1.2/units/si/1983/named/lux.yaml b/schemas/src/defs/v1.2/units/si/1983/named/lux.yaml new file mode 100644 index 000000000..a7ec4d211 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/1983/named/lux.yaml @@ -0,0 +1,44 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/1983/named/lux" +title: "lux" +symbol: "lx" +display-symbol: "lx" +description: |- + A derived SI unit for illuminance equal to cdâ‹…srâ‹…mâ»Â² in 1983 SI units. + + "The lux is the illuminance of a surface that receives a uniformly distributed luminous flux of one lumen per square meter." [9th CGPM meeting in 1946] + + The lux was defined at the 9th CGPM meeting in 1946, and implicitly redefined via the redefinitions of the second at the 13th CGPM Meeting in 1967, resolution 1, the candela at the 16th CGPM Meeting in 1979, resolution 3, and the metre at the 17th CGPM meeting (1983), resolution 1. +resources: + - relation: "Definition at the 9th CGPM meeting (1948)" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/9-1948" + - relation: "Definition and establishment of the SI unit system at the 11th CGPM meeting (1960), resolution 12." + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/11-1960/resolution-12" + - relation: "Redefinition of the metre at the 17th CGPM meeting (1983), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/17-1983/resolution-1" + - relation: "Redefinition of the second in the 13th CGPM Meeting (1967), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/13-1967/resolution-1" + - relation: "Redefinition of the candela at the 16th CGPM Meeting in 1979, resolution 3." + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/16-1979/resolution-3" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Lux" +defining-relation: + base-units: + - symbol: "cd" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1983/base/candela" + - symbol: "sr" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/supplementary/steradian" + - symbol: "m" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1983/base/metre" + base-units-expression: "cd*m^-2*sr" +standard: + name: "si" + year: 1983 + category: "named" + symbol: "lx" +x-optimade-definition: + label: "lux_si_1983_named" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "lux" diff --git a/schemas/src/defs/v1.2/units/si/1983/named/newton.yaml b/schemas/src/defs/v1.2/units/si/1983/named/newton.yaml new file mode 100644 index 000000000..dbb9bfc20 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/1983/named/newton.yaml @@ -0,0 +1,40 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/1983/named/newton" +title: "newton" +symbol: "N" +display-symbol: "N" +description: |- + The newton is a derived SI unit for force and weight equal to kg·m·sâ»Â² in 1983 SI units. + + "The newton is the force that, in one second, imparts to a mass equal to one kilogram an increase in speed of one meter per second." [9th CGPM meeting in 1946] + + The newton was defined at the 9th CGPM Meeting in 1946, included in SI at the 11th CGPM meeting in 1960, resolution 12, implicitly redefined via the redefinition of the second at the 13th CGPM Meeting in 1967, resolution 1, and again implicitly redefined via the redefinition of the metre at the 17th CGPM meeting (1983), resolution 1. +resources: + - relation: "Definition and establishment of the SI unit system at the 11th CGPM meeting (1960), resolution 12." + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/11-1960/resolution-12" + - relation: "Redefinition of the second in the 13th CGPM Meeting (1967), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/13-1967/resolution-1" + - relation: "Redefinition of the metre at the 17th CGPM meeting (1983), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/17-1983/resolution-1" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Newton_(unit)" +defining-relation: + base-units: + - symbol: "kg" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/base/kilogram" + - symbol: "m" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1983/base/metre" + - symbol: "s" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1967/base/second" + base-units-expression: "kg*m*s^-2" +standard: + name: "si" + year: 1983 + category: "named" + symbol: "N" +x-optimade-definition: + label: "newton_si_1983_named" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "newton" diff --git a/schemas/src/defs/v1.2/units/si/1983/named/ohm.yaml b/schemas/src/defs/v1.2/units/si/1983/named/ohm.yaml new file mode 100644 index 000000000..0035c556a --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/1983/named/ohm.yaml @@ -0,0 +1,44 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/1983/named/ohm" +title: "ohm" +symbol: "ohm" +display-symbol: "Ω" +description: |- + A derived SI unit for electrical resistance equal to kg·m²·sâ»Â³Â·Aâ»Â² in the 1983 SI units. + + "The ohm is the electrical resistance that exists between two points of a conductor when a constant potential difference of one volt, applied between these two points, produces a current of one ampere in the conductor, provided that the conductor is not the seat of any electromotive force." [9th CGPM meeting in 1946] + + The ohm was defined at the 9th CGPM Meeting in 1946, included in SI at the 11th CGPM meeting in 1960, resolution 12, implicitly redefined via the redefinition of the second at the 13th CGPM Meeting in 1967, resolution 1, and again implicitly redefined via the redefinition of the metre at the 17th CGPM meeting (1983), resolution 1. +resources: + - relation: "Definition at the 9th CGPM meeting (1948)" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/9-1948" + - relation: "Definition and establishment of the SI unit system at the 11th CGPM meeting (1960), resolution 12." + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/11-1960/resolution-12" + - relation: "Redefinition of the metre at the 17th CGPM meeting (1983), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/17-1983/resolution-1" + - relation: "Redefinition of the second in the 13th CGPM Meeting (1967), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/13-1967/resolution-1" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Ohm" +defining-relation: + base-units: + - symbol: "A" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1983/base/ampere" + - symbol: "kg" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/base/kilogram" + - symbol: "m" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1983/base/metre" + - symbol: "s" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1967/base/second" + base-units-expression: "A^-2*kg*m^2*s^-3" +standard: + name: "si" + year: 1983 + category: "named" + symbol: "ohm" +x-optimade-definition: + label: "ohm_si_1983_named" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "ohm" diff --git a/schemas/src/defs/v1.2/units/si/1983/named/pascal.yaml b/schemas/src/defs/v1.2/units/si/1983/named/pascal.yaml new file mode 100644 index 000000000..23375258e --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/1983/named/pascal.yaml @@ -0,0 +1,38 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/1983/named/pascal" +title: "pascal" +symbol: "Pa" +display-symbol: "Pa" +description: |- + A derived SI unit for pressure and stress equal to kg·mâ»Â¹Â·sâ»Â² using the 1983 SI units. + + "The International Committee will ask the General Conference to approve two special names: pascal (symbol Pa) for the SI unit of pressure (N/m²), [...]" [14th CGPM Meeting (1971)]. + + The pascal was defined at the 14th CGPM Meeting in 1971 and implicitly redefined via the redefinition of the metre at the 17th CGPM Meeting in 1983, resolution 1. +resources: + - relation: "Definition at the 14th CGPM Meeting (1971)" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/14-1971" + - relation: "Redefinition of the metre at the 17th CGPM meeting (1983), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/17-1983/resolution-1" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Pascal_(unit)" +defining-relation: + base-units: + - symbol: "kg" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/base/kilogram" + - symbol: "m" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1983/base/metre" + - symbol: "s" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1967/base/second" + base-units-expression: "kg*m^-1*s^-2" +standard: + name: "si" + year: 1983 + category: "named" + symbol: "Pa" +x-optimade-definition: + label: "pascal_si_1983_named" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "pascal" diff --git a/schemas/src/defs/v1.2/units/si/1983/named/siemens.yaml b/schemas/src/defs/v1.2/units/si/1983/named/siemens.yaml new file mode 100644 index 000000000..df317e1f8 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/1983/named/siemens.yaml @@ -0,0 +1,40 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/1983/named/siemens" +title: "siemens" +symbol: "S" +display-symbol: "S" +description: |- + A derived SI unit for electrical conductance equal to kgâ»Â¹Â·mâ»Â²Â·s³·A² using the 1983 SI base units. + + "The International Committee will ask the General Conference to approve two special names: [...] siemens (symbol S) for the SI unit of conductance (Ωâ»Â¹)." [14th CGPM Meeting (1971)]. + + The siemens was defined at the 14th CGPM Meeting in 1971 and implicitly redefined via the redefinition of the meter at the 17th CGPM Meeting in 1983, resolution 1. +resources: + - relation: "Definition at the 14th CGPM Meeting (1971)" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/14-1971" + - relation: "Redefinition of the metre at the 17th CGPM meeting (1983), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/17-1983/resolution-1" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Siemens_(unit)" +defining-relation: + base-units: + - symbol: "A" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1967/base/ampere" + - symbol: "kg" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/base/kilogram" + - symbol: "m" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1983/base/metre" + - symbol: "s" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1967/base/second" + base-units-expression: "A^2*kg^-1*m^-2*s^3" +standard: + name: "si" + year: 1983 + category: "named" + symbol: "S" +x-optimade-definition: + label: "siemens_si_1983_named" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "siemens" diff --git a/schemas/src/defs/v1.2/units/si/1983/named/sievert.yaml b/schemas/src/defs/v1.2/units/si/1983/named/sievert.yaml new file mode 100644 index 000000000..a1c0f6773 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/1983/named/sievert.yaml @@ -0,0 +1,36 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/1983/named/sievert" +title: "sievert" +symbol: "Sv" +display-symbol: "Sv" +description: |- + A derived SI unit for equivalent dose of ionizing radiation equal to m²·sâ»Â² using the 1983 SI base units. + + "The 16th Conférence Générale des Poids et Mesures, [...] adopts the special name sievert, symbol Sv, for the SI unit of dose equivalent in the field of radioprotection. The sievert is equal to the joule per kilogram." [16th CGPM meeting (1979), resolution 5] + + The sievert was defined at the 16th CGPM meeting in 1979 and implicitly redefined via the redefinition of the meter at the 17th CGPM Meeting in 1983, resolution 1. +resources: + - relation: "Definition at the 16th CGPM meeting (1979), resolution 5" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/16-1979/resolution-5" + - relation: "Redefinition of the metre at the 17th CGPM meeting (1983), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/17-1983/resolution-1" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Sievert" +defining-relation: + base-units: + - symbol: "m" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/base/metre" + - symbol: "s" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1967/base/second" + base-units-expression: "m^2*s^-2" +standard: + name: "si" + year: 1983 + category: "named" + symbol: "Sv" +x-optimade-definition: + label: "sievert_si_1983_named" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "sievert" diff --git a/schemas/src/defs/v1.2/units/si/1983/named/tesla.yaml b/schemas/src/defs/v1.2/units/si/1983/named/tesla.yaml new file mode 100644 index 000000000..7566e2a20 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/1983/named/tesla.yaml @@ -0,0 +1,36 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/1983/named/tesla" +title: "tesla" +symbol: "T" +display-symbol: "T" +description: |- + A derived SI unit for magnetic flux density equal to kg·sâ»Â²Â·Aâ»Â¹ in the 1983 SI units. + + The tesla was defined as 1 Wb/m in the introduction of the SI unit system the 11th CGPM Meeting in 1960, resolution 12, implicitly redefined via the redefinition of the second at the 13th CGPM Meeting in 1967, resolution 1, and again implicitly redefined with the redefinition of the ampere (implicitly via the redefinition of the metre) at the 17th CGPM Meeting in 1983, resolution 1. +resources: + - relation: "Definition and establishment of the SI unit system at the 11th CGPM meeting (1960), resolution 12." + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/11-1960/resolution-12" + - relation: "Redefinition of the metre at the 17th CGPM meeting (1983), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/17-1983/resolution-1" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Tesla_(unit)" +defining-relation: + base-units: + - symbol: "A" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1983/base/ampere" + - symbol: "kg" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/base/kilogram" + - symbol: "s" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1967/base/second" + base-units-expression: "A^-1*kg*s^-2" +standard: + name: "si" + year: 1983 + category: "named" + symbol: "T" +x-optimade-definition: + label: "tesla_si_1983_named" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "tesla" diff --git a/schemas/src/defs/v1.2/units/si/1983/named/volt.yaml b/schemas/src/defs/v1.2/units/si/1983/named/volt.yaml new file mode 100644 index 000000000..31f3629b4 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/1983/named/volt.yaml @@ -0,0 +1,42 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/1983/named/volt" +title: "volt" +symbol: "V" +display-symbol: "V" +description: |- + A derived SI unit for electric potential, voltage, and electromotive force equal to kg·m²·sâ»Â³Â·Aâ»Â¹ in the 1983 SI units. + + "The volt is the electric potential difference that exists between two points of a conducting wire carrying a constant current of one ampere when the power dissipated between these points is equal to one watt." [9th CGPM meeting in 1946] + + The volt was defined at the 9th CGPM Meeting in 1946, included in SI at the 11th CGPM meeting in 1960, resolution 12 and implicitly redefined via the redefinition of the second at the 13th CGPM Meeting in 1967, resolution 1, and again redefined via the redefinition of the metre at the 17th CGPM Meeting in 1983, resolution 1. +resources: + - relation: "Definition and establishment of the SI unit system at the 11th CGPM meeting (1960), resolution 12." + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/11-1960/resolution-12" + - relation: "Redefinition of the metre at the 17th CGPM meeting (1983), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/17-1983/resolution-1" + - relation: "Redefinition of the second in the 13th CGPM Meeting (1967), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/13-1967/resolution-1" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Volt" +defining-relation: + base-units: + - symbol: "kg" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/base/kilogram" + - symbol: "m" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1983/base/metre" + - symbol: "s" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1967/base/second" + - symbol: "A" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1983/base/ampere" + base-units-expression: "A^-1*kg*m^2*s^-3" +standard: + name: "si" + year: 1983 + category: "named" + symbol: "V" +x-optimade-definition: + label: "volt_si_1983_named" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "volt" diff --git a/schemas/src/defs/v1.2/units/si/1983/named/watt.yaml b/schemas/src/defs/v1.2/units/si/1983/named/watt.yaml new file mode 100644 index 000000000..1a238f153 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/1983/named/watt.yaml @@ -0,0 +1,42 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/1983/named/watt" +title: "watt" +symbol: "W" +display-symbol: "W" +description: |- + A derived SI unit for power and radiant flux equal to kg·m²·sâ»Â³ in the 1983 SI units. + + "The watt is the power that produces one joule per second." [9th CGPM meeting in 1946] + + The watt was defined at the 9th CGPM Meeting in 1946, included in SI at the 11th CGPM meeting in 1960, resolution 12, implicitly redefined via the redefinition of the second at the 13th CGPM Meeting in 1967, resolution 1, and again implicitly redefined via the redefinition of the metre at the 17th CGPM meeting (1983), resolution 1. +resources: + - relation: "Definition and establishment of the SI unit system at the 11th CGPM meeting (1960), resolution 12." + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/11-1960/resolution-12" + - relation: "Redefinition of the metre at the 17th CGPM meeting (1983), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/17-1983/resolution-1" + - relation: "Redefinition of the second in the 13th CGPM Meeting (1967), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/13-1967/resolution-1" + - relation: "Redefinition of the metre at the 17th CGPM meeting (1983), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/17-1983/resolution-1" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Watt" +defining-relation: + base-units: + - symbol: "kg" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/base/kilogram" + - symbol: "m" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1983/base/metre" + - symbol: "s" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1967/base/second" + base-units-expression: "kg*m^2*s^-3" +standard: + name: "si" + year: 1983 + category: "named" + symbol: "W" +x-optimade-definition: + label: "watt_si_1983_named" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "watt" diff --git a/schemas/src/defs/v1.2/units/si/1983/named/weber.yaml b/schemas/src/defs/v1.2/units/si/1983/named/weber.yaml new file mode 100644 index 000000000..b7332dcab --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/1983/named/weber.yaml @@ -0,0 +1,44 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/1983/named/weber" +title: "weber" +symbol: "Wb" +display-symbol: "Wb" +description: |- + A derived SI unit for magnetic flux equal to kg·m²·sâ»Â³Â·Aâ»Â¹ in the 1983 SI units. + + "The weber is the magnetic induction flux that, passing through a single-turn circuit, produces an electromotive force of one volt if it is reduced to zero in one second by uniform decay." [9th CGPM meeting in 1946] + + The weber was defined at the 9th CGPM Meeting in 1946, included in SI at the 11th CGPM meeting in 1960, resolution 12, implicitly redefined via the redefinition of the second at the 13th CGPM Meeting in 1967, resolution 1, and again implicitly redefined via the redefinition of the metre at the 17th CGPM meeting (1983), resolution 1. +resources: + - relation: "Definition at the 41st CIPM meeting (1946), resolution 2" + resource-id: "https://www.bipm.org/en/committees/ci/cipm/41-1946/resolution-2" + - relation: "Definition and establishment of the SI unit system at the 11th CGPM meeting (1960), resolution 12." + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/11-1960/resolution-12" + - relation: "Redefinition of the metre at the 17th CGPM meeting (1983), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/17-1983/resolution-1" + - relation: "Redefinition of the second in the 13th CGPM Meeting (1967), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/13-1967/resolution-1" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Weber_(unit)" +defining-relation: + base-units: + - symbol: "A" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1983/base/ampere" + - symbol: "kg" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/base/kilogram" + - symbol: "m" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1983/base/metre" + - symbol: "s" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1967/base/second" + base-units-expression: "A^-1*kg*m^2*s^-3" +standard: + name: "si" + year: 1983 + category: "named" + symbol: "Wb" +x-optimade-definition: + label: "weber_si_1983_named" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "weber" diff --git a/schemas/src/defs/v1.2/units/si/1983/temporary/angstrom.yaml b/schemas/src/defs/v1.2/units/si/1983/temporary/angstrom.yaml new file mode 100644 index 000000000..a66669f1e --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/1983/temporary/angstrom.yaml @@ -0,0 +1,36 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/1983/temporary/angstrom" +title: "Ã¥ngström" +symbol: "angstrom" +display-symbol: "Ã…" +description: |- + A length equal to 10â»Â¹â° meter, with meter defined according to the 1983 SI base units. + + The Ã¥ngström unit appears in the International System of Units (SI), 1st ed. (1970) defined as "1 Ã… = 0.1 nm = 10â»Â¹â° m". + + - The International System of Units (SI), 1st ed. (1970) categorizes the unit as "temporarily admitted" for use with the SI units. + - The International System of Units (SI), 7th ed. (1998) changes the categorization to "Other non-SI units currently accepted for use with the International System." + - The International System of Units (SI), 8th ed. (2006) changes the categorization to "Other non-SI units" and adds as a clarifying footnote "The Ã¥ngström is widely used by x-ray crystallographers and structural chemists because all chemical bonds lie in the range 1 to 3 Ã¥ngströms. However it has no official sanction from the CIPM or the CGPM." + - The Ã¥ngström is omitted in the International System of Units (SI), 9th Edition (2019). + + The Ã¥ngström unit was implicitly redefined via the redefinition of the metre at the 17th CGPM meeting (1983), resolution 1. +resources: + - relation: "Definition in the International System of Units (SI), 1st Edition" + resource-id: "https://www.bipm.org/en/publications/si-brochure" + - relation: "Redefinition of the metre at the 17th CGPM meeting (1983), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/17-1983/resolution-1" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Angstrom" +defining-relation: + base-units: + - symbol: "m" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1983/base/metre" + base-units-expression: "m" + scale: + exponent: -10 +x-optimade-definition: + label: "angstrom_si_1983_temporary" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "angstrom" diff --git a/schemas/src/defs/v1.2/units/si/1983/temporary/are.yaml b/schemas/src/defs/v1.2/units/si/1983/temporary/are.yaml new file mode 100644 index 000000000..68a955714 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/1983/temporary/are.yaml @@ -0,0 +1,34 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/1983/temporary/are" +title: "are" +symbol: "a" +display-symbol: "a" +description: |- + A unit of area equal to 100 square meters (10² m²), with meter defined according to the 1983 SI units. + + The are unit appears in the International System of Units (SI), 1st ed. (1970) defined as "1 a = 1 dam² = 10² m²" with the footnote "This unit and its symbol were adopted by the International Committee in 1879 (Proces-Verbaux C.I.P.M., 1879, p. 41)." + + - The International System of Units (SI), 1st ed. (1970) categorizes the unit as "units in use temporarily". + - The International System of Units (SI), 5th ed. (1985) adds the clarification that the unit is "used to express agrarian areas." + - The International System of Units (SI), 7th ed. (1998) changes the categorization to "Other non-SI units currently accepted for use with the International System." + - The International System of Units (SI), 8th ed. (2006) completely removes the unit (but still defines the hectare). + + The are unit was implicitly redefined via the redefinition of the metre at the 17th CGPM meeting (1983), resolution 1. +resources: + - relation: "Definition in the International System of Units (SI), 1st Edition" + resource-id: "https://www.bipm.org/en/publications/si-brochure" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Hectare#Are" +defining-relation: + base-units: + - symbol: "m" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1983/base/metre" + base-units-expression: "m^2" + scale: + exponent: 4 +x-optimade-definition: + label: "are_si_1983_temporary" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "are" diff --git a/schemas/src/defs/v1.2/units/si/1983/temporary/bar.yaml b/schemas/src/defs/v1.2/units/si/1983/temporary/bar.yaml new file mode 100644 index 000000000..c44c17625 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/1983/temporary/bar.yaml @@ -0,0 +1,39 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/1983/temporary/bar" +title: "bar" +symbol: "bar" +display-symbol: "bar" +description: |- + A unit of pressure equal to 10âµ N/m using the 1983 base SI units. + + The bar unit appears in the International System of Units (SI), 1st ed. (1970) defined as "1 bar = 0,1 MPa = 10âµ Pa" with the footnote "This unit and its symbol are included in Resolution 7 of the 9th C.G.P.M. (1948)." + (While the pascal unit appears in the 1st ed. as a symbol for N·s/m², it was adopted into SI at the 14th CGPM meeting in 1971.) + + - The International System of Units (SI), 1st ed. (1970) categorizes the unit as "Units in use temporarily with the International System." + - The International System of Units (SI), 7th ed. (1998) changes the categorization to "Other non-SI units currently accepted for use with the International System." + - The International System of Units (SI), 8th ed. (2006) changes the categorization to "Other non-SI units" and updates the footnote to: "The bar and its symbol are included in Resolution 7 of the 9th CGPM (1948; CR, 70). Since 1982 one bar has been used as the standard pressure for tabulating all thermodynamic data. Prior to 1982 the standard pressure used to be the standard atmosphere, equal to 1.013 25 bar, or 101 325 Pa." + - The bar is omitted in the International System of Units (SI), 9th Edition (2019) (except appearing as an example in the context of typesetting of units). + + The bar unit was implicitly redefined via the redefinition of the metre at the 17th CGPM meeting (1983), resolution 1. +resources: + - relation: "Definition in the International System of Units (SI), 9th Edition" + resource-id: "https://www.bipm.org/en/publications/si-brochure" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Bar_(unit)" +defining-relation: + base-units: + - symbol: "kg" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/base/kilogram" + - symbol: "m" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1983/base/metre" + - symbol: "s" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1967/base/second" + base-units-expression: "kg*m^-1*s^-2" + scale: + exponent: 5 +x-optimade-definition: + label: "bar_si_1983_temporary" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "bar" diff --git a/schemas/src/defs/v1.2/units/si/1983/temporary/barn.yaml b/schemas/src/defs/v1.2/units/si/1983/temporary/barn.yaml new file mode 100644 index 000000000..08a651d9f --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/1983/temporary/barn.yaml @@ -0,0 +1,37 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/1983/temporary/barn" +title: "barn" +symbol: "b" +display-symbol: "b" +description: |- + A unit of area used in nuclear physics to express cross sections equal to 100 fm², with meter defined according to the 1983 SI units. + + The International System of Units (SI), 1st ed. (1970) states: "1 b = 100 fm² = 10â»Â²â¸ m" with a footnote "The barn is a special unit used in nuclear physics to express cross sections." + + - The International System of Units (SI), 1st ed. (1970) categorizes the unit as "Units in use temporarily with the International System." + - The International System of Units (SI), 8th ed. (2006) categorizes the unit as "Other non-SI units currently accepted for use with the International System." + - The International System of Units (SI), 9th ed. (2019) categorizes the unit as "Other non-SI units." + + The are unit was implicitly redefined via the redefinition of the metre at the 17th CGPM meeting (1983), resolution 1. +resources: + - relation: "Definition in the International System of Units (SI), 9th Edition" + resource-id: "https://www.bipm.org/en/publications/si-brochure" + - relation: "Redefinition of the metre at the 17th CGPM meeting (1983), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/17-1983/resolution-1" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Barn_(unit)" +defining-relation: + base-units: + - symbol: "m" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1983/base/metre" + scale: + - exponent: -28 + base-units-expression: "m^2" + scale: + exponent: 4 +x-optimade-definition: + label: "barn_si_1983_temporary" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "barn" diff --git a/schemas/src/defs/v1.2/units/si/1983/temporary/gal.yaml b/schemas/src/defs/v1.2/units/si/1983/temporary/gal.yaml new file mode 100644 index 000000000..707fdbac5 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/1983/temporary/gal.yaml @@ -0,0 +1,38 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/1983/temporary/gal" +title: "gal" +symbol: "Gal" +display-symbol: "Gal" +description: |- + A unit of acceleration equal to 1 centimeter per second squared (1 cm/s²), defined according to the 1983 SI units. + + The gal unit appears in the International System of Units (SI), 1st ed. (1970) defined as "1 Gal = 1 cm/s² = 10â»Â² m/s²" with the footnote "The gal is a special unit of acceleration employed in geodesy and geophysics to express acceleration due to gravity." + + - The International System of Units (SI), 1st ed. (1970) categorizes the unit as "units in use temporarily". + - The International System of Units (SI), 7th ed. (1998) changes the categorization to "derived CGS units with special names". + - The International System of Units (SI), 9th ed. (2019) moves the unit definition to the margin aside the table for Non-SI units accepted for use with the SI units. + It is not clear how to interpret the categorization intended with this placement of the unit. + + The gal unit was implicitly redefined via the redefinition of the metre at the 17th CGPM meeting (1983), resolution 1. +resources: + - relation: "Definition in the International System of Units (SI), 1st Edition" + resource-id: "https://www.bipm.org/en/publications/si-brochure" + - relation: "Redefinition of the metre at the 17th CGPM meeting (1983), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/17-1983/resolution-1" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Gal_(unit)" +defining-relation: + base-units: + - symbol: "m" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1983/base/metre" + - symbol: "s" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1967/base/second" + base-units-expression: "m*s^-2" + scale: + exponent: -2 +x-optimade-definition: + label: "gal_si_1983_temporary" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "gal" diff --git a/schemas/src/defs/v1.2/units/si/1983/temporary/hectare.yaml b/schemas/src/defs/v1.2/units/si/1983/temporary/hectare.yaml new file mode 100644 index 000000000..b1b48232a --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/1983/temporary/hectare.yaml @@ -0,0 +1,35 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/1983/temporary/hectare" +title: "hectare" +symbol: "ha" +display-symbol: "ha" +description: |- + A unit of area equal to 1000 square meters (1 hm²), with meter defined according to the 1983 SI base unit. + + The hectare unit appears in the International System of Units (SI), 1st ed. (1970) defined as "1 ha = 1 hm² = 10â´ m²" with the footnote "This unit and its symbol were adopted by the International Committee in 1879 (Proces-Verbaux C.I.P.M., 1879, p. 41)." + + - The International System of Units (SI), 1st ed. (1970) categorizes the unit as "units in use temporarily". + - The International System of Units (SI), 5th ed. (1985) add the clarification that the unit is "used to express agrarian areas." + - The International System of Units (SI), 7th ed. (1998) changes the categorization to "Other non-SI units currently accepted for use with the International System." + + The hectare unit was implicitly redefined via the redefinition of the metre at the 17th CGPM meeting (1983), resolution 1. +resources: + - relation: "Definition in the International System of Units (SI), 9th Edition" + resource-id: "https://www.bipm.org/en/publications/si-brochure" + - relation: "Redefinition of the metre at the 17th CGPM meeting (1983), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/17-1983/resolution-1" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Hectare" +defining-relation: + base-units: + - symbol: "m" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1983/base/metre" + base-units-expression: "m^2" + scale: + exponent: 4 +x-optimade-definition: + label: "hectare_si_1983_temporary" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "hectare" diff --git a/schemas/src/defs/v1.2/units/si/1983/temporary/knot.yaml b/schemas/src/defs/v1.2/units/si/1983/temporary/knot.yaml new file mode 100644 index 000000000..0e93b922f --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/1983/temporary/knot.yaml @@ -0,0 +1,39 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/1983/temporary/knot" +title: "knot" +symbol: "knot" +display-symbol: "knot" +description: |- + A unit of speed primarily used in navigation defined as 1 nautical mile per hour which is equal to (1852/3600) m/s using the 1983 SI units. + + The knot unit appears in the International System of Units (SI), 1st ed. (1970) defined as "1 nautical mile per hour = (1852/3600) m/s." + + - The International System of Units (SI), 1st ed. (1970) categorizes the unit as "Units in use temporarily with the International System." + - The International System of Units (SI), 7th ed. (1998) changes the categorization to "Other non-SI units currently accepted for use with the International System." + - The International System of Units (SI), 8th ed. (2006) changes the categorization to "Other non-SI units." + - The knot is omitted in the International System of Units (SI), 9th Edition (2019). + + The knot unit was implicitly redefined via the redefinition of the metre at the 17th CGPM meeting (1983), resolution 1. +resources: + - relation: "Definition in the International System of Units (SI), 1st Edition" + resource-id: "https://www.bipm.org/en/publications/si-brochure" + - relation: "Redefinition of the metre at the 17th CGPM meeting (1983), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/17-1983/resolution-1" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Knot_(unit)" +defining-relation: + base-units: + - symbol: "m" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1983/base/metre" + - symbol: "s" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1967/base/second" + base-units-expression: "ms^-1" + scale: + numerator: 1852 + denominator: 3600 +x-optimade-definition: + label: "knot_si_1983_temporary" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "knot" diff --git a/schemas/src/defs/v1.2/units/si/1983/temporary/nauticalmile.yaml b/schemas/src/defs/v1.2/units/si/1983/temporary/nauticalmile.yaml new file mode 100644 index 000000000..16e565a53 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/1983/temporary/nauticalmile.yaml @@ -0,0 +1,41 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/1983/temporary/nauticalmile" +title: "nautical mile" +symbol: "M" +display-symbol: "M" +alternate-symbols: + - "NM" + - "Nm" + - "nmi" +description: |- + A unit of length primarily used in navigation defined as 1852 m using the 1983 SI meter. + + The nautical mile unit appears in the International System of Units (SI), 1st ed. (1970) defined as "1 nautical mile = 1852 m" with the footnote "The nautical mile is a special unit employed for marine and aerial navigation to express distance. The conventional value given above was adopted by the First International Extraordinary Hydrographic Conference, Monaco, 1929, under the name 'International nautical mile'." + Historically, the nautical mile was defined as the meridian arc length corresponding to one arcminute of latitude. + + - The International System of Units (SI), 1st ed. (1970) categorizes the unit as "Units in use temporarily with the International System." + - The International System of Units (SI), 7th ed. (1998) changes the categorization to "Other non-SI units currently accepted for use with the International System" and adds to the footnote that: "As yet there is no internationally agreed symbol. This unit was originally chosen because one nautical mile on the surface of the Earth subtends approximately one minute of angle at the centre." + - The International System of Units (SI), 8th ed. (2006) changes the categorization to "Other non-SI units" and adjusts the footnote to say: "As yet there is no internationally agreed symbol, but the symbols M, NM, Nm, and nmi are all used; in the table the symbol M is used. The unit was originally chosen, and continues to be used, because one nautical mile on the surface of the Earth subtends approximately one minute of angle at the centre of the Earth, which is convenient when latitude and longitude are measured in degrees and minutes of angle." + - The nautical mile is omitted in the International System of Units (SI), 9th Edition (2019). + + The nautical mile unit was implicitly redefined via the redefinition of the metre at the 17th CGPM meeting (1983), resolution 1. +resources: + - relation: "Definition in the International System of Units (SI), 1st Edition" + resource-id: "https://www.bipm.org/en/publications/si-brochure" + - relation: "Redefinition of the metre at the 17th CGPM meeting (1983), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/17-1983/resolution-1" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Nautical_mile" +defining-relation: + base-units: + - symbol: "m" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1983/base/metre" + base-units-expression: "m" + scale: + numerator: 1852 +x-optimade-definition: + label: "nauticalmile_si_1983_temporary" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "nauticalmile" diff --git a/schemas/src/defs/v1.2/units/si/1983/temporary/radiationunit.yaml b/schemas/src/defs/v1.2/units/si/1983/temporary/radiationunit.yaml new file mode 100644 index 000000000..6623d29b7 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/1983/temporary/radiationunit.yaml @@ -0,0 +1,40 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/1983/temporary/radiationunit" +title: "radiation unit" +symbol: "radiationunit" +display-symbol: "rad" +description: |- + A unit used to express the absorbed dose of ionizing radiation defined as 10â»Â² J/kg using the 1983 SI units. + + This unit definition uses "radiationunit" as the symbol for this unit despite "rad" being in common use to distinguish it from the radian, which is an SI unit with rad as its symbol. + + The radiation unit appears in the International System of Units (SI), 1st ed. (1970) defined as "1 rad = 10â»Â² J/kg" with the footnote: "The rad is a special unit employed to express absorbed dose of ionizing radiation. When there is risk of confusion with the symbol for radian, rd may be used as the symbol for rad." + + - The International System of Units (SI), 1st ed. (1970) categorizes the unit as "Units in use temporarily with the International System." + - The International System of Units (SI), 3rd ed. (1977) changes the definition to use the unit gray: "1 rad = cGy = 10â»Â² Gy." + - The International System of Units (SI), 7th ed. (1998) changes the categorization to "Examples of other non-SI units" and adds the additional footnote: "Note that this non-SI unit is exactly equivalent to an SI unit with an appropriate submultiple prefix." + - The International System of Units (SI), 8th ed. (2006) omits the unit. + + The roentgen unit was implicitly redefined via the redefinition of the metre at the 17th CGPM meeting (1983), resolution 1. +resources: + - relation: "Definition in the International System of Units (SI), 1st Edition" + resource-id: "https://www.bipm.org/en/publications/si-brochure" + - relation: "Redefinition of the metre at the 17th CGPM meeting (1983), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/17-1983/resolution-1" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Rad_(radiation_unit)" +defining-relation: + base-units: + - symbol: "J" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1983/named/joule" + - symbol: "kg" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/base/kilogram" + base-units-expression: "J*kg^-1" + scale: + exponent: -2 +x-optimade-definition: + label: "radiationunit_si_1983_temporary" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "radiationunit" diff --git a/schemas/src/defs/v1.2/units/si/1983/temporary/roentgen.yaml b/schemas/src/defs/v1.2/units/si/1983/temporary/roentgen.yaml new file mode 100644 index 000000000..6be1e10c7 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/1983/temporary/roentgen.yaml @@ -0,0 +1,39 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/1983/temporary/roentgen" +title: "roentgen" +symbol: "R" +display-symbol: "R" +description: |- + A unit used to express the exposure of ionizing radiation defined as 2.58 x 10â»â´ C/kg using the 1983 SI units. + + The roentgen unit appears in the International System of Units (SI), 1st ed. (1970) defined as "1 R = 2.58 x 10â»â´ C/kg" with the footnote: "The roentgen is a special unit used to express the ionization exposure of ionizing radiation." + + - The International System of Units (SI), 1st ed. (1970) categorizes the unit as "Units in use temporarily with the International System." + - The International System of Units (SI), 2nd ed. (1973) rephrases the footnote to: "The roentgen is a special unit used to express the exposure of X or gamma radiation." + - The International System of Units (SI), 7th ed. (1998) changes the categorization to "Examples of other non-SI units". + - The International System of Units (SI), 8th ed. (2006) omits the unit. + + The roentgen unit was implicitly redefined via the redefinition of the metre at the 17th CGPM meeting (1983), resolution 1. +resources: + - relation: "Definition in the International System of Units (SI), 1st Edition" + resource-id: "https://www.bipm.org/en/publications/si-brochure" + - relation: "Redefinition of the metre at the 17th CGPM meeting (1983), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/17-1983/resolution-1" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Roentgen_(unit)" +defining-relation: + base-units: + - symbol: "C" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1983/named/coulomb" + - symbol: "kg" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/base/kilogram" + base-units-expression: "C*kg^-1" + scale: + numerator: 258 + exponent: -6 +x-optimade-definition: + label: "roentgen_si_1983_temporary" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "roentgen" diff --git a/schemas/src/defs/v1.2/units/si/1998/accepted/dalton.yaml b/schemas/src/defs/v1.2/units/si/1998/accepted/dalton.yaml new file mode 100644 index 000000000..bb9dec8c0 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/1998/accepted/dalton.yaml @@ -0,0 +1,44 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/1998/accepted/dalton" +title: "dalton" +symbol: "Da" +display-symbol: "Da" +alternate-symbols: + - "u" +description: |- + A unit of mass defined as 1/12 of the mass of a free carbon 12 atom, at rest and in its ground state. + + The name dalton as an alternative name to *atomic mass unit* is defined in the International System of Units (SI), 7th ed. (1998) in a footnote to a table labeled "Non-SI units accepted for use with the International System, whose values in SI units are obtained experimentally" in the section "Units outside the international system". + The definition given is: "The unified atomic mass unit is equal to 1/12 of the mass of an unbound atom of the nuclide ¹²C, at rest, and in its ground state. In the field of biochemistry, the unified atomic mass unit is also called the dalton, symbol Da." + + This definition makes the dalton equivalent to the atomic mass unit defined in the International System of Units (SI), 1st ed. (1970) (https://schemas.optimade.org/defs/v1.2/units/si/1970/accepted/atomicmassunit) + + In the International System of Units (SI) 8th ed. (2006) the definition is slightly adjusted, replacing "unbound" with "free": "The dalton (Da) and the unified atomic mass unit (u) are alternative names (and symbols) for the same unit, equal to 1/12 times the mass of a free carbon 12 atom, at rest and in its ground state." + + All editions of the International System of Units (SI) note approximate relationships to the kilogram. + The 9th ed. states "1 Da = 1.660 539 066 60(50)×10â»Â²â· kg", where the 2018 CODATA value has been used and the 2019 SI kilogram is referenced (https://schemas.optimade.org/defs/v1.2/units/si/2019/base/kilogram). + + Note: in the 2019 redefinition of the SI units, the dalton is the only unit listed as accepted for use with SI that does not have an exact relation to the base SI units. +resources: + - relation: "Definition in the International System of Units (SI), 9th Edition" + resource-id: "https://www.bipm.org/en/publications/si-brochure" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Dalton_(unit)" + - relation: "CODATA unified atomic mass unit fundamental physical constant: source for relationship to kg" + resource-id: "https://physics.nist.gov/cgi-bin/cuu/Value?ukg" +compatibility: + - "https://schemas.optimade.org/defs/v1.2/units/si/1970/accepted/atomicmassunit" +approximate-relations: + - base-units: + - symbol: "kg" + id: "https://schemas.optimade.org/defs/v1.2/units/si/2019/base/kilogram" + base-units-expression: "kg" + scale: + value: 1.66053906660E-27 + standard_uncertainty: 0.00000000050E-27 +x-optimade-definition: + label: "dalton_si_1998_accepted" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "dalton" diff --git a/schemas/src/defs/v1.2/units/si/1999/named/katal.yaml b/schemas/src/defs/v1.2/units/si/1999/named/katal.yaml new file mode 100644 index 000000000..6c47d8177 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/1999/named/katal.yaml @@ -0,0 +1,32 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/1999/named/katal" +title: "katal" +symbol: "kat" +display-symbol: "kat" +description: |- + A derived SI unit for catalytic activity, defined as mol·sâ»Â¹ defined at the 21st CGPM meeting in 1999. + + "The 21st Conférence Générale des Poids et Mesures, [...] decides to adopt the special name katal, symbol kat, for the SI unit mole per second to express catalytic activity, especially in the fields of medicine and biochemistry, and recommends that when the katal is used, the measurand be specified by reference to the measurement procedure; the measurement procedure must identify the indicator reaction." [21st CGPM meeting (1999), resolution 12] +resources: + - relation: "Definition of the unit at the 21st CGPM (1999)" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/21-1999/resolution-12" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Katal" +defining-relation: + base-units: + - symbol: "mol" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1971/base/mole" + - symbol: "s" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1967/base/second" + base-units-expression: "mol*s^-1" +standard: + name: "si" + year: 1999 + category: "named" + symbol: "kat" +x-optimade-definition: + label: "katal_si_1999_named" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "katal" diff --git a/schemas/src/defs/v1.2/units/si/2019/accepted/astronomicalunit.yaml b/schemas/src/defs/v1.2/units/si/2019/accepted/astronomicalunit.yaml new file mode 100644 index 000000000..202535d05 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/2019/accepted/astronomicalunit.yaml @@ -0,0 +1,29 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/2019/accepted/astronomicalunit" +title: "astronomical unit" +symbol: "au" +display-symbol: "au" +description: |- + A unit defined as exactly 149597870700 meters which is meant to represent the mean distance between the Earth and the Sun using the SI 1983 meter. + + The International System of Units (SI), 9th ed. (2019) changed the definition of the astronomical unit given in prior editions into: "1 au = 149 597 870 700 m" with the footnote "As decided at the XXVIII General Assembly of the International Astronomical Union (Resolution B2, 2012)." + + The International System of Units (SI), 9th ed. (2019) categorizes the astronomical unit as a "non-SI unit accepted for use with the SI units". +resources: + - relation: "Definition in the International System of Units (SI), 9th Edition" + resource-id: "https://www.bipm.org/en/publications/si-brochure" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Astronomical_unit" +defining-relation: + base-units: + - symbol: "m" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1983/base/metre" + base-units-expression: "m" + scale: + numerator: 149597870700 +x-optimade-definition: + label: "astronomicalunit_si_2019_accepted" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "astronomicalunit" diff --git a/schemas/src/defs/v1.2/units/si/2019/accepted/electronvolt.yaml b/schemas/src/defs/v1.2/units/si/2019/accepted/electronvolt.yaml new file mode 100644 index 000000000..91b0022b6 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/2019/accepted/electronvolt.yaml @@ -0,0 +1,34 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/2019/accepted/electronvolt" +title: "electron volt" +symbol: "eV" +display-symbol: "eV" +description: |- + A unit of energy equal to the amount of kinetic energy acquired by an electron as it accelerates through a 1 volt potential difference in a vacuum using the 2019 SI units. + + The electronvolt unit appears in the International System of Units (SI), 1st ed. (1970) defined as "1 electronvolt is the energy acquired by an electron after traversing a potential difference of 1 V in a vacuum; 1 eV = 1.60219×10â»Â¹â¹ J approximately." + This definition makes the unit equal to 1 volt times the value of the elementary charge. + + In the 2019 redefinition of the SI units the elementary charge is exactly 1.602176634·10â»Â¹â¹ C, making the electron volt exactly equal to 1.602176634·10â»Â¹â¹ J. + The International System of Units (SI), 9th ed. (2019) accordingly notes the exact relationship with the SI 2019 derived unit joule as "1 eV = 1.602176634·10â»Â¹â¹ J" but retains the definition from 1970 in a footnote. + + The unit is categorized in the International System of Units (SI), 9th ed. (2019) as "Non-SI units accepted for use with the SI units". +resources: + - relation: "Definition in the International System of Units (SI), 9th Edition" + resource-id: "https://www.bipm.org/en/publications/si-brochure" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Electronvolt" +approximate-relations: + - base-units: + - symbol: "V" + id: "https://schemas.optimade.org/defs/v1.2/units/si/2019/named/volt" + - symbol: "e" + id: "https://schemas.optimade.org/defs/v1.2/constants/codata/2018/electromagnetic/elementarycharge" + base-units-expression: "e*V" +x-optimade-definition: + label: "electronvolt_si_2019_accepted" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "electronvolt" + diff --git a/schemas/src/defs/v1.2/units/si/2019/accepted/tonne.yaml b/schemas/src/defs/v1.2/units/si/2019/accepted/tonne.yaml new file mode 100644 index 000000000..61341a990 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/2019/accepted/tonne.yaml @@ -0,0 +1,35 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/2019/accepted/tonne" +title: "tonne" +symbol: "t" +display-symbol: "t" +alternate-symbols: + - "t" +description: |- + A unit of mass defined as 1000 kg, with kilogram defined according to the 2019 SI units. + + The International System of Units (SI), 1st ed. (1970) defines the tonne as "1 t = 10³ kg" with the footnote "The symbol and the unit was defined in resolution 7 at the 9th meeting of the C.G.P.M. (1948)." + + In the 2019 implicit redefinition of the tonne, the kilogram in the definition refers to the 2019 kilogram SI base unit (https://schema.optimade.org/units/si/2019/named/kilogram). + + - The International System of Units (SI), 1st ed. (1970) categorizes the unit as "Units used with the International System" + - The International System of Units (SI), 3rd ed. (19) changes the reference of the definition to the 1879 meeting of the CIPM page 41. + - The International System of Units (SI), 6th ed. (1991) further adds "In some English-speaking countries this unit is called ≪metric ton≫." +resources: + - relation: "Definition in the International System of Units (SI), 9th Edition" + resource-id: "https://www.bipm.org/en/publications/si-brochure" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Tonne" +defining-relation: + base-units: + - symbol: "kg" + id: "https://schemas.optimade.org/defs/v1.2/units/si/2019/base/kilogram" + base-units-expression: "kg" + scale: + exponent: 3 +x-optimade-definition: + label: "tonne_si_2019_accepted" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "tonne" diff --git a/schemas/src/defs/v1.2/units/si/2019/base/ampere.yaml b/schemas/src/defs/v1.2/units/si/2019/base/ampere.yaml new file mode 100644 index 000000000..64474d080 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/2019/base/ampere.yaml @@ -0,0 +1,29 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/2019/base/ampere" +title: "ampere" +symbol: "A" +display-symbol: "A" +description: |- + The SI base unit of electric current defined by fixing the value of the elementary charge as defined at the 26th CGPM Meeting (2018) and adopted into SI in 2019. + + "The ampere, symbol A, is the SI unit of electric current. It is defined by taking the fixed numerical value of the elementary charge \(e\) to be 1.602176634×10â»Â¹â¹ when expressed in the unit C, which is equal to Aâ‹…s, where the second is defined in terms of \(\Delta \nu_\textrm{Cs}\)." [26th CGPM Meeting (2018), resolution 1]. + + This definition references the 1976 SI base second unit (https://schemas.optimade.org/defs/v1.2/units/si/1976/base/second). +resources: + - relation: "Definition in the 26th CGPM Meeting in 2018, resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/26-2018/resolution-1" + - relation: "Definition in the International System of Units (SI), 9th Edition" + resource-id: "https://www.bipm.org/en/publications/si-brochure" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Ampere" +standard: + name: "si" + year: 2019 + category: "base" + symbol: "A" +x-optimade-definition: + label: "ampere_si_2019_base" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "ampere" diff --git a/schemas/src/defs/v1.2/units/si/2019/base/candela.yaml b/schemas/src/defs/v1.2/units/si/2019/base/candela.yaml new file mode 100644 index 000000000..f624b7019 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/2019/base/candela.yaml @@ -0,0 +1,35 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/2019/base/candela" +title: "candela" +symbol: "cd" +display-symbol: "cd" +description: |- + The SI base unit of luminous intensity in a given direction defined by fixing the value of the luminous efficacy of radiation of a specific frequency precisely matching the definition at the 16th CGPM Meeting in 1979 using the 2019 SI units. + + "The candela is the luminous intensity, in a given direction, of a source that emits monochromatic radiation of frequency 540×10¹² hertz and that has a radiant intensity in that direction of 1/683 watt per steradian." [16th CGPM Meeting (1979), resolution 3]. + + At the 26th CGPM Meeting in 2018, resolution 1 the definition was rephrased to: "The candela, symbol cd, is the SI unit of luminous intensity in a given direction. It is defined by taking the fixed numerical value of the luminous efficacy of monochromatic radiation of frequency 540×10¹² Hz, \(K_\mathrm{cd}\), to be 683 when expressed in the unit lmâ‹…Wâ»Â¹, which is equal to cdâ‹…srâ‹…Wâ»Â¹, or cdâ‹…srâ‹…kgâ»Â¹â‹…mâ»Â²â‹…s³, where the kilogram, metre and second are defined in terms of \(h\), \(c\) and \(\Delta \nu_\textrm{Cs}\)." [26th CGPM Meeting (2018), resolution 1]. + + Following the redefinition of the metre at the 17th CGPM Meeting in 1983, resolution 1, and the redefinition of the kilogram at the 26th CGPM Meeting (2018), resolution 1, the implicitly redefined candela references: + + - the SI 1967 derived hertz unit (https://schemas.optimade.org/defs/v1.2/units/si/1967/named/hertz) equal to secondâ»Â¹, referencing the SI 1967 base unit second (https://schemas.optimade.org/defs/v1.2/units/si/1967/base/second). + - the SI 2019 derived watt unit (https://schemas.optimade.org/defs/v1.2/units/si/2019/named/watt) equal to kilogram·meter²·secondâ»Â³, referencing the SI 2019 base unit kilogram (https://schemas.optimade.org/defs/v1.2/units/si/2019/base/kilogram), the SI 1983 base unit metre (https://schemas.optimade.org/defs/v1.2/units/si/1983/base/metre); and the 1967 base unit second (https://schemas.optimade.org/defs/v1.2/units/si/1967/base/second). + - the SI 1960 supplementary unit steradian (https://schemas.optimade.org/defs/v1.2/units/si/1960/supplementary/steradian). +resources: + - relation: "Definition in the 26th CGPM Meeting in 2018, resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/26-2018/resolution-1" + - relation: "Definition in the International System of Units (SI), 9th Edition" + resource-id: "https://www.bipm.org/en/publications/si-brochure" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Candela" +standard: + name: "si" + year: 2019 + category: "base" + symbol: "cd" +x-optimade-definition: + label: "candela_si_2019_base" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "candela" diff --git a/schemas/src/defs/v1.2/units/si/2019/base/kelvin.yaml b/schemas/src/defs/v1.2/units/si/2019/base/kelvin.yaml new file mode 100644 index 000000000..b810a5cb6 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/2019/base/kelvin.yaml @@ -0,0 +1,29 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/2019/base/kelvin" +title: "kelvin" +symbol: "K" +display-symbol: "K" +description: |- + The SI base unit of thermodynamic temperature defined by fixing the value of the Boltzmann constant as defined at the 26th CGPM Meeting (2018) and adopted into SI in 2019. + + "The kelvin, symbol K, is the SI unit of thermodynamic temperature. It is defined by taking the fixed numerical value of the Boltzmann constant k to be 1.380649×10â»Â²Â³ when expressed in the unit Jâ‹…Kâ»Â¹, which is equal to kgâ‹…m²⋅sâ»Â²â‹…Kâ»Â¹, where the kilogram, metre and second are defined in terms of \(h\), \(c\) and \(\Delta \nu_\textrm{Cs}\)." [26th CGPM Meeting (2018), resolution 1]. + + This definition references the 2019 SI derived joule unit (https://schemas.optimade.org/defs/v1.2/units/si/2019/named/joule). +resources: + - relation: "Definition in the 26th CGPM Meeting in 2018, resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/26-2018/resolution-1" + - relation: "Definition in the International System of Units (SI), 9th Edition" + resource-id: "https://www.bipm.org/en/publications/si-brochure" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Kelvin" +standard: + name: "si" + year: 2019 + category: "base" + symbol: "K" +x-optimade-definition: + label: "kelvin_si_2019_base" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "kelvin" diff --git a/schemas/src/defs/v1.2/units/si/2019/base/kilogram.yaml b/schemas/src/defs/v1.2/units/si/2019/base/kilogram.yaml new file mode 100644 index 000000000..7ef78a41a --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/2019/base/kilogram.yaml @@ -0,0 +1,32 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/2019/base/kilogram" +title: "kilogram" +symbol: "kg" +display-symbol: "kg" +description: |- + The SI base unit of mass defined by fixing the value of the Planck constant as defined at the 26th CGPM Meeting (2018) and adopted into SI in 2019. + + "The kilogram, symbol kg, is the SI unit of mass. It is defined by taking the fixed numerical value of the Planck constant \(h\) to be 6.62607015×10â»Â³â´ when expressed in the unit Jâ‹…s, which is equal to kgâ‹…m²⋅sâ»Â¹, where the metre and the second are defined in terms of \(c\) and \(\Delta \nu_\textrm{Cs}\)." [26th CGPM Meeting (2018), resolution 1]. + + This definition references: + + - The 2019 SI derived joule unit (https://schemas.optimade.org/defs/v1.2/units/si/2019/named/joule). + - The 1967 SI base second unit (https://schemas.optimade.org/defs/v1.2/units/si/1967/base/second). +resources: + - relation: "Definition in the 26th CGPM Meeting in 2018, resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/26-2018/resolution-1" + - relation: "Definition in the International System of Units (SI), 9th Edition" + resource-id: "https://www.bipm.org/en/publications/si-brochure" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Kilogram" +standard: + name: "si" + year: 2019 + category: "base" + symbol: "kg" +x-optimade-definition: + label: "kilogram_si_2019_base" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "kilogram" diff --git a/schemas/src/defs/v1.2/units/si/2019/base/mole.yaml b/schemas/src/defs/v1.2/units/si/2019/base/mole.yaml new file mode 100644 index 000000000..d31ebd56c --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/2019/base/mole.yaml @@ -0,0 +1,27 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/2019/base/mole" +title: "mole" +symbol: "mol" +display-symbol: "mol" +description: |- + The SI base unit of amount of substance defined by fixing the value of Avogadro constant as defined at the 26th CGPM Meeting (2018) and adopted into SI in 2019. + + "The mole, symbol mol, is the SI unit of amount of substance. One mole contains exactly 6.02214076×10²³ elementary entities. This number is the fixed numerical value of the Avogadro constant, \(N_A\), when expressed in the unit molâ»Â¹ and is called the Avogadro number. The amount of substance, symbol \(n\), of a system is a measure of the number of specified elementary entities. An elementary entity may be an atom, a molecule, an ion, an electron, any other particle or specified group of particles." [26th CGPM Meeting (2018), resolution 1]. +resources: + - relation: "Definition in the 26th CGPM Meeting in 2018, resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/26-2018/resolution-1" + - relation: "Definition in the International System of Units (SI), 9th Edition" + resource-id: "https://www.bipm.org/en/publications/si-brochure" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Mole_(unit)" +standard: + name: "si" + year: 2019 + category: "base" + symbol: "mol" +x-optimade-definition: + label: "mole_si_2019_base" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "mole" diff --git a/schemas/src/defs/v1.2/units/si/2019/named/coulomb.yaml b/schemas/src/defs/v1.2/units/si/2019/named/coulomb.yaml new file mode 100644 index 000000000..06004f565 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/2019/named/coulomb.yaml @@ -0,0 +1,40 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/2019/named/coulomb" +title: "coulomb" +symbol: "C" +display-symbol: "C" +description: |- + A derived SI unit for electric charge equal to s·A in the 1983 SI base units. + + "The coulomb is the amount of electricity transported in one second by a current of one ampere." [9th CGPM meeting in 1946] + + The coulomb was defined at the 9th CGPM Meeting in 1946, included in SI at the 11th CGPM meeting in 1960, resolution 12, implicitly redefined via the redefinitions of the second at the 13th CGPM Meeting in 1967, resolution 1; the metre at the 17th CGPM meeting (1983), resolution 1; and the kilogram at the 26th CGPM Meeting (2018), resolution 1. +resources: + - relation: "Definition at the 9th CGPM meeting (1948)" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/9-1948" + - relation: "Definition and establishment of the SI unit system at the 11th CGPM meeting (1960), resolution 12." + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/11-1960/resolution-12" + - relation: "Redefinition of the second in the 13th CGPM Meeting (1967), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/13-1967/resolution-1" + - relation: "Redefinition of the kilogram in the 26th CGPM Meeting (2018), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/26-2018/resolution-1" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Coulomb" +defining-relation: + base-units: + - symbol: "s" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1967/base/second" + - symbol: "A" + id: "https://schemas.optimade.org/defs/v1.2/units/si/2019/base/ampere" + base-units-expression: "A*s" +standard: + name: "si" + year: 2019 + category: "named" + symbol: "C" +x-optimade-definition: + label: "coulomb_si_2019_named" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "coulomb" diff --git a/schemas/src/defs/v1.2/units/si/2019/named/degcelsius.yaml b/schemas/src/defs/v1.2/units/si/2019/named/degcelsius.yaml new file mode 100644 index 000000000..b950444a1 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/2019/named/degcelsius.yaml @@ -0,0 +1,41 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/2019/named/degcelsius" +title: "degree Celsius" +symbol: "degC" +display-symbol: "°C" +alternate-symbols: + - "degreecelsius" +description: |- + A derived SI unit of temperature, defined as kelvin offset with +273.15 in the 2019 SI units. + + "If we add to the practical international Celsius temperatures defined above Tâ‚€ = 273.15 degrees, we obtain the practical international Kelvin temperatures. By subtracting Tâ‚€ from the thermodynamic temperatures, we obtain the thermodynamic Celsius temperatures." [11th CGPM meeting (1960)] + + The degree Celsius was defined and included in SI at the 11th CGPM meeting in 1960, resolution 12 and implicitly redefined via the redefinitions of the kelvin at the 13th CGPM Meeting in 1967, resolution 4 and at the 26th CGPM Meeting (2018), resolution 1. +resources: + - relation: "Definition at the 11th CGPM meeting (1960)" + resource-id: "https://www.bipm.og/en/committees/cg/cgpm/11-1960" + - relation: "Redefinition of the kelvin at the 13th CGPM meeting (1967), resolution 4" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/13-1967/resolution-4" + - relation: "Redefinition of the kelvin at the 26th CGPM meeting (2018), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/26-2018/resolution-1" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Celsius" +defining-relation: + base-units: + - symbol: "K" + id: "https://schemas.optimade.org/defs/v1.2/units/si/2019/base/kelvin" + base-units-expression: "K" + offset: + numerator: 27315 + denominator: 100 +standard: + name: "si" + year: 2019 + category: "named" + symbol: "degC" +x-optimade-definition: + label: "degcelsius_si_2019_named" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "degcelsius" diff --git a/schemas/src/defs/v1.2/units/si/2019/named/farad.yaml b/schemas/src/defs/v1.2/units/si/2019/named/farad.yaml new file mode 100644 index 000000000..fd6eb76ac --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/2019/named/farad.yaml @@ -0,0 +1,42 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/2019/named/farad" +title: "farad" +symbol: "F" +display-symbol: "F" +description: |- + A derived SI unit for electrical capacitance equal to kgâ»Â¹Â·mâ»Â²Â·sâ´Â·A² in the 2019 SI units. + + "The farad is the capacitance of an electric capacitor between whose plates an electric potential difference of one volt appears when it is charged with an amount of electricity equal to one coulomb." [9th CGPM meeting in 1946] + + The farad was defined at the 9th CGPM Meeting in 1946, included in SI at the 11th CGPM meeting in 1960, resolution 12 and implicitly redefined via the redefinitions of the second at the 13th CGPM Meeting in 1967, resolution 1, and the redefinitions of the ampere and kilogram at the 26th CGPM Meeting in 2018, resolution 1. +resources: + - relation: "Definition and establishment of the SI unit system at the 11th CGPM meeting (1960), resolution 12." + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/11-1960/resolution-12" + - relation: "Redefinition of the second in the 13th CGPM Meeting (1967), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/13-1967/resolution-1" + - relation: "Redefinition of the kilogram and ampere in the 26th CGPM Meeting (2018), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/26-2018/resolution-1" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Farad" +defining-relation: + base-units: + - symbol: "A" + id: "https://schemas.optimade.org/defs/v1.2/units/si/2019/base/ampere" + - symbol: "kg" + id: "https://schemas.optimade.org/defs/v1.2/units/si/2019/base/kilogram" + - symbol: "m" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1983/base/metre" + - symbol: "s" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1967/base/second" + base-units-expression: "A^2*kg^-1*m^-2*s^4" +standard: + name: "si" + year: 2019 + category: "named" + symbol: "F" +x-optimade-definition: + label: "farad_si_2019_named" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "farad" diff --git a/schemas/src/defs/v1.2/units/si/2019/named/henry.yaml b/schemas/src/defs/v1.2/units/si/2019/named/henry.yaml new file mode 100644 index 000000000..ec9b36e67 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/2019/named/henry.yaml @@ -0,0 +1,44 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/2019/named/henry" +title: "henry" +symbol: "H" +display-symbol: "H" +description: |- + A derived SI unit for inductance equal to kg·m²·sâ»Â²Â·Aâ»Â² in the 1983 SI units. + + "The henry is the inductance of a closed circuit in which an electromotive force of one volt is produced when the electric current passing through the circuit varies uniformly at a rate of one ampere per second." [9th CGPM meeting in 1946] + + The henry was defined at the 9th CGPM Meeting in 1946, included in SI at the 11th CGPM meeting in 1960, resolution 12, and implicitly redefined via the redefinitions of the second at the 13th CGPM Meeting in 1967, resolution 1, the metre at the 17th CGPM meeting (1983), resolution 1, and the kilogram and ampere at the 26th CGPM Meeting (2018), resolution 1. +resources: + - relation: "Definition and establishment of the SI unit system at the 11th CGPM meeting (1960), resolution 12." + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/11-1960/resolution-12" + - relation: "Redefinition of the metre at the 17th CGPM meeting (1983), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/17-1983/resolution-1" + - relation: "Redefinition of the second at the 13th CGPM Meeting (1967), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/13-1967/resolution-1" + - relation: "Redefinition of the kilogram and ampere at the 26th CGPM Meeting (2018), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/26-2018/resolution-1" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Henry_(unit)" +defining-relation: + base-units: + - symbol: "A" + id: "https://schemas.optimade.org/defs/v1.2/units/si/2019/base/ampere" + - symbol: "kg" + id: "https://schemas.optimade.org/defs/v1.2/units/si/2019/base/kilogram" + - symbol: "m" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1983/base/metre" + - symbol: "s" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1967/base/second" + base-units-expression: "A^-2*kg*m^2*s^-2" +standard: + name: "si" + year: 2019 + category: "named" + symbol: "H" +x-optimade-definition: + label: "henry_si_2019_named" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "henry" diff --git a/schemas/src/defs/v1.2/units/si/2019/named/joule.yaml b/schemas/src/defs/v1.2/units/si/2019/named/joule.yaml new file mode 100644 index 000000000..162cfe4ab --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/2019/named/joule.yaml @@ -0,0 +1,44 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/2019/named/joule" +title: "joule" +symbol: "J" +display-symbol: "J" +description: |- + A derived SI unit for energy, work, and heat equal to kg·m²·sâ»Â² in the 1983 SI units. + + "The joule is the work produced by a newton whose point of application moves one meter in the direction of the force." [9th CGPM meeting in 1946] + + The joule was defined at the 9th CGPM Meeting in 1946, included in SI at the 11th CGPM meeting in 1960, resolution 12, implicitly redefined via the redefinitions of the second at the 13th CGPM Meeting in 1967, resolution 1, the metre at the 17th CGPM meeting (1983), resolution 1, and the kilogram at the 26th CGPM Meeting (2018), resolution 1. +resources: + - relation: "Definition at the 9th CGPM meeting (1948)" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/9-1948" + - relation: "Definition and establishment of the SI unit system at the 11th CGPM meeting (1960), resolution 12." + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/11-1960/resolution-12" + - relation: "Redefinition of the metre at the 17th CGPM meeting (1983), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/17-1983/resolution-1" + - relation: "Redefinition of the second in the 13th CGPM Meeting (1967), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/13-1967/resolution-1" + - relation: "Redefinition of the kilogram at the 26th CGPM Meeting (2018), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/26-2018/resolution-1" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Joule" +defining-relation: + base-units: + - symbol: "kg" + id: "https://schemas.optimade.org/defs/v1.2/units/si/2019/base/kilogram" + - symbol: "m" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1983/base/metre" + - symbol: "s" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1967/base/second" + base-units-expression: "kg*m^2*s^-2" +standard: + name: "si" + year: 2019 + category: "named" + symbol: "J" +x-optimade-definition: + label: "joule_si_2019_named" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "joule" diff --git a/schemas/src/defs/v1.2/units/si/2019/named/katal.yaml b/schemas/src/defs/v1.2/units/si/2019/named/katal.yaml new file mode 100644 index 000000000..5602522c8 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/2019/named/katal.yaml @@ -0,0 +1,32 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/2019/named/katal" +title: "katal" +symbol: "kat" +display-symbol: "kat" +description: |- + A derived SI unit for catalytic activity, defined as mol·sâ»Â¹ using the 2019 SI units. + + "The 21st Conférence Générale des Poids et Mesures, [...] decides to adopt the special name katal, symbol kat, for the SI unit mole per second to express catalytic activity, especially in the fields of medicine and biochemistry, and recommends that when the katal is used, the measurand be specified by reference to the measurement procedure; the measurement procedure must identify the indicator reaction." [21st CGPM meeting (1999), resolution 12] + + The katal unit was implicitly redefined via the redefinition of the mole at the 26th CGPM Meeting (2018), resolution 1. +resources: + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Katal" +defining-relation: + base-units: + - symbol: "mol" + id: "https://schemas.optimade.org/defs/v1.2/units/si/2019/base/mole" + - symbol: "s" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1967/base/second" + base-units-expression: "mol*s^-1" +standard: + name: "si" + year: 2019 + category: "named" + symbol: "kat" +x-optimade-definition: + label: "katal_si_2019_named" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "katal" diff --git a/schemas/src/defs/v1.2/units/si/2019/named/lumen.yaml b/schemas/src/defs/v1.2/units/si/2019/named/lumen.yaml new file mode 100644 index 000000000..ce0db90ce --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/2019/named/lumen.yaml @@ -0,0 +1,42 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/2019/named/lumen" +title: "lumen" +symbol: "lm" +display-symbol: "lm" +description: |- + A derived SI unit for luminous flux equal to cd·sr using the 1983 SI units. + + "The lumen is the luminous flux emitted in a steradian by a uniform point source with a luminous intensity of one candela." [9th CGPM meeting in 1946] + + The lumen was defined at the 9th CGPM meeting in 1946, implicitly redefined via the redefinitions of the second at the 13th CGPM Meeting in 1967, resolution 1, the candela at the 16th CGPM Meeting in 1979, resolution 3, the metre at the 17th CGPM Meeting in 1983, resolution 1, and the candela (implicitly redefined via the kilogram) at the 26th CGPM Meeting (2018), resolution 1. +resources: + - relation: "Definition and establishment of the SI unit system at the 11th CGPM meeting (1960), resolution 12." + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/11-1960/resolution-12" + - relation: "Redefinition of the candela at the 16th CGPM Meeting in 1979, resolution 3." + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/16-1979/resolution-3" + - relation: "Redefinition of the second in the 13th CGPM Meeting in 1967, resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/13-1967/resolution-1" + - relation: "Redefinition of the metre at the 17th CGPM meeting in 1983, resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/17-1983/resolution-1" + - relation: "Redefinition of the kilogram at the 26th CGPM Meeting (2018), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/26-2018/resolution-1" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Lumen_(unit)" +defining-relation: + base-units: + - symbol: "cd" + id: "https://schemas.optimade.org/defs/v1.2/units/si/2019/base/candela" + - symbol: "sr" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/supplementary/steradian" + base-units-expression: "cd*sr" +standard: + name: "si" + year: 2019 + category: "named" + symbol: "lm" +x-optimade-definition: + label: "lumen_si_2019_named" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "lumen" diff --git a/schemas/src/defs/v1.2/units/si/2019/named/lux.yaml b/schemas/src/defs/v1.2/units/si/2019/named/lux.yaml new file mode 100644 index 000000000..5594fcd8b --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/2019/named/lux.yaml @@ -0,0 +1,46 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/2019/named/lux" +title: "lux" +symbol: "lx" +display-symbol: "lx" +description: |- + A derived SI unit for illuminance equal to cdâ‹…srâ‹…mâ»Â² in 2019 SI units. + + "The lux is the illuminance of a surface that receives a uniformly distributed luminous flux of one lumen per square meter." [9th CGPM meeting in 1946] + + The lux was defined at the 9th CGPM meeting in 1946, and implicitly redefined via the redefinitions of the second at the 13th CGPM Meeting in 1967, resolution 1, the candela at the 16th CGPM Meeting in 1979, resolution 3, the metre at the 17th CGPM meeting (1983), resolution 1, and the candela (implicitly redefined via the kilogram) at the 26th CGPM Meeting (2018), resolution 1. +resources: + - relation: "Definition at the 9th CGPM meeting (1948)" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/9-1948" + - relation: "Definition and establishment of the SI unit system at the 11th CGPM meeting (1960), resolution 12." + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/11-1960/resolution-12" + - relation: "Redefinition of the candela at the 16th CGPM Meeting in 1979, resolution 3." + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/16-1979/resolution-3" + - relation: "Redefinition of the metre at the 17th CGPM meeting (1983), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/17-1983/resolution-1" + - relation: "Redefinition of the second in the 13th CGPM Meeting (1967), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/13-1967/resolution-1" + - relation: "Redefinition of the kilogram at the 26th CGPM Meeting (2018), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/26-2018/resolution-1" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Lux" +defining-relation: + base-units: + - symbol: "cd" + id: "https://schemas.optimade.org/defs/v1.2/units/si/2019/base/candela" + - symbol: "sr" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/supplementary/steradian" + - symbol: "m" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1983/base/metre" + base-units-expression: "cd*m^-2*sr" +standard: + name: "si" + year: 2019 + category: "named" + symbol: "lx" +x-optimade-definition: + label: "lux_si_2019_named" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "lux" diff --git a/schemas/src/defs/v1.2/units/si/2019/named/newton.yaml b/schemas/src/defs/v1.2/units/si/2019/named/newton.yaml new file mode 100644 index 000000000..134786d82 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/2019/named/newton.yaml @@ -0,0 +1,42 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/2019/named/newton" +title: "newton" +symbol: "N" +display-symbol: "N" +description: |- + A derived SI unit for force and weight equal to kg·m·sâ»Â² in 2019 SI units. + + "The newton is the force that, in one second, imparts to a mass equal to one kilogram an increase in speed of one meter per second." [9th CGPM meeting in 1946] + + The newton was defined at the 9th CGPM Meeting in 1946, included in SI at the 11th CGPM meeting in 1960, resolution 12, implicitly redefined via the redefinitions of the second at the 13th CGPM Meeting in 1967, resolution 1, the metre at the 17th CGPM meeting (1983), resolution 1, and the kilogram at the 26th CGPM Meeting (2018), resolution 1. +resources: + - relation: "Definition and establishment of the SI unit system at the 11th CGPM meeting (1960), resolution 12." + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/11-1960/resolution-12" + - relation: "Redefinition of the second in the 13th CGPM Meeting (1967), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/13-1967/resolution-1" + - relation: "Redefinition of the metre at the 17th CGPM meeting (1983), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/17-1983/resolution-1" + - relation: "Redefinition of the kilogram at the 26th CGPM Meeting (2018), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/26-2018/resolution-1" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Newton_(unit)" +defining-relation: + base-units: + - symbol: "kg" + id: "https://schemas.optimade.org/defs/v1.2/units/si/2019/base/kilogram" + - symbol: "m" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1983/base/metre" + - symbol: "s" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1967/base/second" + base-units-expression: "kg*m*s^-2" +standard: + name: "si" + year: 2019 + category: "named" + symbol: "N" +x-optimade-definition: + label: "newton_si_2019_named" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "newton" diff --git a/schemas/src/defs/v1.2/units/si/2019/named/ohm.yaml b/schemas/src/defs/v1.2/units/si/2019/named/ohm.yaml new file mode 100644 index 000000000..9bd78e94c --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/2019/named/ohm.yaml @@ -0,0 +1,46 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/2019/named/ohm" +title: "ohm" +symbol: "ohm" +display-symbol: "Ω" +description: |- + A derived SI unit for electrical resistance equal to kg·m²·sâ»Â³Â·Aâ»Â² in the 2019 SI units. + + "The ohm is the electrical resistance that exists between two points of a conductor when a constant potential difference of one volt, applied between these two points, produces a current of one ampere in the conductor, provided that the conductor is not the seat of any electromotive force." [9th CGPM meeting in 1946] + + The ohm was defined at the 9th CGPM Meeting in 1946, included in SI at the 11th CGPM meeting in 1960, resolution 12, implicitly redefined via the redefinitions of the second at the 13th CGPM Meeting in 1967, resolution 1, the metre at the 17th CGPM meeting (1983), resolution 1, and the kilogram and ampere at the 26th CGPM Meeting (2018), resolution 1. +resources: + - relation: "Definition at the 9th CGPM meeting (1948)" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/9-1948" + - relation: "Definition and establishment of the SI unit system at the 11th CGPM meeting (1960), resolution 12." + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/11-1960/resolution-12" + - relation: "Redefinition of the metre at the 17th CGPM meeting (1983), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/17-1983/resolution-1" + - relation: "Redefinition of the second in the 13th CGPM Meeting (1967), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/13-1967/resolution-1" + - relation: "Redefinition of the kilogram and the ampere at the 26th CGPM Meeting (2018), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/26-2018/resolution-1" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Ohm" +defining-relation: + base-units: + - symbol: "A" + id: "https://schemas.optimade.org/defs/v1.2/units/si/2019/base/ampere" + - symbol: "kg" + id: "https://schemas.optimade.org/defs/v1.2/units/si/2019/base/kilogram" + - symbol: "m" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1983/base/metre" + - symbol: "s" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1967/base/second" + base-units-expression: "A^-2*kg*m^2*s^-3" +standard: + name: "si" + year: 2019 + category: "named" + symbol: "ohm" +x-optimade-definition: + label: "ohm_si_2019_named" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "ohm" diff --git a/schemas/src/defs/v1.2/units/si/2019/named/pascal.yaml b/schemas/src/defs/v1.2/units/si/2019/named/pascal.yaml new file mode 100644 index 000000000..0335641cd --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/2019/named/pascal.yaml @@ -0,0 +1,40 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/2019/named/pascal" +title: "pascal" +symbol: "Pa" +display-symbol: "Pa" +description: |- + A derived SI unit for pressure and stress equal to kg·mâ»Â¹Â·sâ»Â² using the 2019 SI units. + + "The International Committee will ask the General Conference to approve two special names: pascal (symbol Pa) for the SI unit of pressure (N/m²), [...]" [14th CGPM Meeting (1971)]. + + The pascal was defined at the 14th CGPM Meeting in 1971 and implicitly redefined via the redefinitions of the metre at the 17th CGPM Meeting in 1983, resolution 1, and the kilogram at the 26th CGPM Meeting (2018), resolution 1. +resources: + - relation: "Definition at the 14th CGPM Meeting (1971)" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/14-1971" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Pascal_(unit)" + - relation: "Redefinition of the metre at the 17th CGPM meeting (1983), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/17-1983/resolution-1" + - relation: "Redefinition of the kilogram at the 26th CGPM Meeting (2018), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/26-2018/resolution-1" +defining-relation: + base-units: + - symbol: "kg" + id: "https://schemas.optimade.org/defs/v1.2/units/si/2019/base/kilogram" + - symbol: "m" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1983/base/metre" + - symbol: "s" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1967/base/second" + base-units-expression: "kg*m^-1*s^-2" +standard: + name: "si" + year: 2019 + category: "named" + symbol: "Pa" +x-optimade-definition: + label: "pascal_si_2019_named" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "pascal" diff --git a/schemas/src/defs/v1.2/units/si/2019/named/siemens.yaml b/schemas/src/defs/v1.2/units/si/2019/named/siemens.yaml new file mode 100644 index 000000000..18d956e44 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/2019/named/siemens.yaml @@ -0,0 +1,42 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/2019/named/siemens" +title: "siemens" +symbol: "S" +display-symbol: "S" +description: |- + A derived SI unit for electrical conductance equal to kgâ»Â¹Â·mâ»Â²Â·s³·A² using the 2019 SI base units. + + "The International Committee will ask the General Conference to approve two special names: [...] siemens (symbol S) for the SI unit of conductance (Ωâ»Â¹)." [14th CGPM Meeting (1971)]. + + The siemens was defined at the 14th CGPM Meeting in 1971 and implicitly redefined via the redefinitions of the meter at the 17th CGPM Meeting in 1983, resolution 1 and the kilogram at the 26th CGPM Meeting (2018), resolution 1. +resources: + - relation: "Definition at the 14th CGPM Meeting (1971)" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/14-1971" + - relation: "Redefinition of the metre at the 17th CGPM meeting (1983), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/17-1983/resolution-1" + - relation: "Redefinition of the kilogram at the 26th CGPM Meeting (2018), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/26-2018/resolution-1" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Siemens_(unit)" +defining-relation: + base-units: + - symbol: "A" + id: "https://schemas.optimade.org/defs/v1.2/units/si/2019/base/ampere" + - symbol: "kg" + id: "https://schemas.optimade.org/defs/v1.2/units/si/2019/base/kilogram" + - symbol: "m" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1983/base/metre" + - symbol: "s" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1967/base/second" + base-units-expression: "A^2*kg^-1*m^-2*s^3" +standard: + name: "si" + year: 2019 + category: "named" + symbol: "S" +x-optimade-definition: + label: "siemens_si_2019_named" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "siemens" diff --git a/schemas/src/defs/v1.2/units/si/2019/named/tesla.yaml b/schemas/src/defs/v1.2/units/si/2019/named/tesla.yaml new file mode 100644 index 000000000..1b2296550 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/2019/named/tesla.yaml @@ -0,0 +1,38 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/2019/named/tesla" +title: "tesla" +symbol: "T" +display-symbol: "T" +description: |- + A derived SI unit for magnetic flux density equal to kg·sâ»Â²Â·Aâ»Â¹ in the 2019 SI units. + + The tesla was defined as 1 Wb/m in the introduction of the SI unit system the 11th CGPM Meeting in 1960, resolution 12, implicitly redefined via the redefinitions of the second at the 13th CGPM Meeting in 1967, resolution 1, the ampere (implicitly via the redefinition of the metre) at the 17th CGPM Meeting in 1983, resolution 1, and the kilogram and ampere at the 26th CGPM Meeting (2018), resolution 1. +resources: + - relation: "Definition and establishment of the SI unit system at the 11th CGPM meeting (1960), resolution 12." + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/11-1960/resolution-12" + - relation: "Redefinition of the metre at the 17th CGPM meeting (1983), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/17-1983/resolution-1" + - relation: "Redefinition of the kilogram and the ampere at the 26th CGPM Meeting (2018), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/26-2018/resolution-1" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Tesla_(unit)" +defining-relation: + base-units: + - symbol: "A" + id: "https://schemas.optimade.org/defs/v1.2/units/si/2019/base/ampere" + - symbol: "kg" + id: "https://schemas.optimade.org/defs/v1.2/units/si/2019/base/kilogram" + - symbol: "s" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1967/base/second" + base-units-expression: "A^-1*kg*s^-2" +standard: + name: "si" + year: 2019 + category: "named" + symbol: "T" +x-optimade-definition: + label: "tesla_si_2019_named" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "tesla" diff --git a/schemas/src/defs/v1.2/units/si/2019/named/volt.yaml b/schemas/src/defs/v1.2/units/si/2019/named/volt.yaml new file mode 100644 index 000000000..d65d8acde --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/2019/named/volt.yaml @@ -0,0 +1,44 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/2019/named/volt" +title: "volt" +symbol: "V" +display-symbol: "V" +description: |- + A derived SI unit for electric potential, voltage, and electromotive force equal to kg·m²·sâ»Â³Â·Aâ»Â¹ in the 2019 SI units. + + "The volt is the electric potential difference that exists between two points of a conducting wire carrying a constant current of one ampere when the power dissipated between these points is equal to one watt." [9th CGPM meeting in 1946] + + The volt was defined at the 9th CGPM Meeting in 1946, included in SI at the 11th CGPM meeting in 1960, resolution 12 and implicitly redefined via the redefinitions of the second at the 13th CGPM Meeting in 1967, resolution 1, the metre at the 17th CGPM Meeting in 1983, resolution 1, and the kilogram at the 26th CGPM Meeting (2018), resolution 1. +resources: + - relation: "Definition and establishment of the SI unit system at the 11th CGPM meeting (1960), resolution 12." + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/11-1960/resolution-12" + - relation: "Redefinition of the metre at the 17th CGPM meeting (1983), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/17-1983/resolution-1" + - relation: "Redefinition of the second in the 13th CGPM Meeting (1967), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/13-1967/resolution-1" + - relation: "Redefinition of the kilogram at the 26th CGPM Meeting (2018), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/26-2018/resolution-1" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Volt" +defining-relation: + base-units: + - symbol: "kg" + id: "https://schemas.optimade.org/defs/v1.2/units/si/2019/base/kilogram" + - symbol: "m" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1983/base/metre" + - symbol: "s" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1967/base/second" + - symbol: "A" + id: "https://schemas.optimade.org/defs/v1.2/units/si/2019/base/ampere" + base-units-expression: "A^-1*kg*m^2*s^-3" +standard: + name: "si" + year: 2019 + category: "named" + symbol: "V" +x-optimade-definition: + label: "volt_si_2019_named" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "volt" diff --git a/schemas/src/defs/v1.2/units/si/2019/named/watt.yaml b/schemas/src/defs/v1.2/units/si/2019/named/watt.yaml new file mode 100644 index 000000000..ae10aaed5 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/2019/named/watt.yaml @@ -0,0 +1,42 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/2019/named/watt" +title: "watt" +symbol: "W" +display-symbol: "W" +description: |- + A derived SI unit for power and radiant flux equal to kg·m²·sâ»Â³ in the 1983 SI units. + + "The watt is the power that produces one joule per second." [9th CGPM meeting in 1946] + + The watt was defined at the 9th CGPM Meeting in 1946, included in SI at the 11th CGPM meeting in 1960, resolution 12, implicitly redefined via the redefinitions of the second at the 13th CGPM Meeting in 1967, resolution 1; the metre at the 17th CGPM meeting (1983), resolution 1; and the kilogram at the 26th CGPM Meeting (2018), resolution 1. +resources: + - relation: "Definition and establishment of the SI unit system at the 11th CGPM meeting (1960), resolution 12." + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/11-1960/resolution-12" + - relation: "Redefinition of the metre at the 17th CGPM meeting (1983), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/17-1983/resolution-1" + - relation: "Redefinition of the second in the 13th CGPM Meeting (1967), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/13-1967/resolution-1" + - relation: "Redefinition of the metre at the 17th CGPM meeting (1983), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/17-1983/resolution-1" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Watt" +defining-relation: + base-units: + - symbol: "kg" + id: "https://schemas.optimade.org/defs/v1.2/units/si/2019/base/kilogram" + - symbol: "m" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1983/base/metre" + - symbol: "s" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1967/base/second" + base-units-expression: "kg*m^2*s^-3" +standard: + name: "si" + year: 2019 + category: "named" + symbol: "W" +x-optimade-definition: + label: "watt_si_2019_named" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "watt" diff --git a/schemas/src/defs/v1.2/units/si/2019/named/weber.yaml b/schemas/src/defs/v1.2/units/si/2019/named/weber.yaml new file mode 100644 index 000000000..02a451d81 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/2019/named/weber.yaml @@ -0,0 +1,42 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/2019/named/weber" +title: "weber" +symbol: "Wb" +display-symbol: "Wb" +description: |- + A derived SI unit for magnetic flux equal to kg·m²·sâ»Â³Â·Aâ»Â¹ in the 2019 SI units. + + "The weber is the magnetic induction flux that, passing through a single-turn circuit, produces an electromotive force of one volt if it is reduced to zero in one second by uniform decay." [9th CGPM meeting in 1946] + + The weber was defined at the 9th CGPM Meeting in 1946, included in SI at the 11th CGPM meeting in 1960, resolution 12, implicitly redefined via the redefinitions of the second at the 13th CGPM Meeting in 1967, resolution 1; the metre at the 17th CGPM meeting (1983), resolution 1; and the kilogram at the 26th CGPM Meeting (2018), resolution 1. +resources: + - relation: "Definition at the 9th CGPM meeting (1948)" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/9-1948" + - relation: "Definition and establishment of the SI unit system at the 11th CGPM meeting (1960), resolution 12." + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/11-1960/resolution-12" + - relation: "Redefinition of the kilogram in the 26th CGPM Meeting (2018), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/26-2018/resolution-1" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Weber_(unit)" +defining-relation: + base-units: + - symbol: "A" + id: "https://schemas.optimade.org/defs/v1.2/units/si/2019/base/ampere" + - symbol: "kg" + id: "https://schemas.optimade.org/defs/v1.2/units/si/2019/base/kilogram" + - symbol: "m" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1983/base/metre" + - symbol: "s" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1967/base/second" + base-units-expression: "A^-1*kg*m^2*s^-3" +standard: + name: "si" + year: 2019 + category: "named" + symbol: "Wb" +x-optimade-definition: + label: "weber_si_2019_named" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "weber" diff --git a/schemas/src/defs/v1.2/units/si/general/ampere.yaml b/schemas/src/defs/v1.2/units/si/general/ampere.yaml new file mode 100644 index 000000000..e60bb0337 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/general/ampere.yaml @@ -0,0 +1,32 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/general/ampere" +title: "ampere" +symbol: "A" +display-symbol: "A" +description: |- + A unit of electric current defined according to the current, or one of the historical, definitions of the SI units. + + The current definition at the 26th CGPM Meeting (2018), resolution 1 is: "The ampere, symbol A, is the SI unit of electric current. It is defined by taking the fixed numerical value of the elementary charge \(e\) to be 1.602176634×10â»Â¹â¹ when expressed in the unit C, which is equal to Aâ‹…s, where the second is defined in terms of \(\Delta \nu_\textrm{Cs}\)." + + The earlier definition from the 41st CIPM meeting (1946), Resolution 2: "The ampere is that constant current which, if maintained in two straight parallel conductors of infinite length, of negligible circular cross-section, and placed 1 metre apart in vacuum, would produce between these conductors a force equal to 2×10â»â· MKS unit of force per metre of length." + + This is a generalized definition taken to reference the current, or one of the historical, SI unit definitions. + This definition is intended for situations when it is not possible to be more precise, e.g., in contexts where data have been collected that uses different historical SI definitions. +compatibility: + - "https://schemas.optimade.org/defs/v1.2/units/si/1960/base/ampere" + - "https://schemas.optimade.org/defs/v1.2/units/si/1967/base/ampere" + - "https://schemas.optimade.org/defs/v1.2/units/si/1983/base/ampere" + - "https://schemas.optimade.org/defs/v1.2/units/si/2019/base/ampere" +resources: + - relation: "Definition in the 26th CGPM Meeting in 2018, resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/26-2018/resolution-1" + - relation: "Definition in the International System of Units (SI), 9th Edition" + resource-id: "https://www.bipm.org/en/publications/si-brochure" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Ampere" +x-optimade-definition: + label: "ampere_si_general" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "ampere" diff --git a/schemas/src/defs/v1.2/units/si/general/angstrom.yaml b/schemas/src/defs/v1.2/units/si/general/angstrom.yaml new file mode 100644 index 000000000..c7e93ae29 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/general/angstrom.yaml @@ -0,0 +1,42 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/general/angstrom" +title: "Ã¥ngström" +symbol: "angstrom" +display-symbol: "Ã…" +description: |- + A unit of length equal to 10â»Â¹â° meter, using the current, or one of the historical, definitions of the SI units. + + The Ã¥ngström unit appears in the International System of Units (SI), 1st ed. (1970) defined as "1 Ã… = 0.1 nm = 10â»Â¹â° m". + + The Ã¥ngström unit was implicitly redefined via the redefinition of the metre at the 17th CGPM meeting (1983), resolution 1. + + - The International System of Units (SI), 1st ed. (1970) categorizes the unit as "temporarily admitted" for use with the SI units. + - The International System of Units (SI), 7th ed. (1998) changes the categorization to "Other non-SI units currently accepted for use with the International System." + - The International System of Units (SI), 8th ed. (2006) changes the categorization to "Other non-SI units" and adds as a clarifying footnote "The Ã¥ngström is widely used by x-ray crystallographers and structural chemists because all chemical bonds lie in the range 1 to 3 Ã¥ngströms. However it has no official sanction from the CIPM or the CGPM." + - The Ã¥ngström is omitted in the International System of Units (SI), 9th Edition (2019). + + This is a generalized definition taken to reference the current, or one of the historical, SI unit definitions. + This definition is intended for situations when it is not possible to be more precise, e.g., in contexts where data have been collected that uses different historical SI definitions. +compatibility: + - "https://schemas.optimade.org/defs/v1.2/units/si/1970/temporary/angstrom" + - "https://schemas.optimade.org/defs/v1.2/units/si/1983/temporary/angstrom" +resources: + - relation: "Definition in the International System of Units (SI), 1st Edition" + resource-id: "https://www.bipm.org/en/publications/si-brochure" + - relation: "Redefinition of the metre at the 17th CGPM meeting (1983), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/17-1983/resolution-1" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Angstrom" +defining-relation: + base-units: + - symbol: "m" + id: "https://schemas.optimade.org/defs/v1.2/units/si/general/metre" + base-units-expression: "m" + scale: + exponent: -10 +x-optimade-definition: + label: "angstrom_si_general" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "angstrom" diff --git a/schemas/src/defs/v1.2/units/si/general/arcminute.yaml b/schemas/src/defs/v1.2/units/si/general/arcminute.yaml new file mode 100644 index 000000000..a0629dc10 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/general/arcminute.yaml @@ -0,0 +1,51 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/general/arcminute" +title: "arcminute" +symbol: "arcmin" +display-symbol: "′" +alternate-symbols: + - "minute of arc" + - "minute of angle" + - "MOA" + - "'" +description: |- + A unit of plane and phase angle equal to 1/60 of a degree representing 1/21600 of a circle, equal to Ï€/10800 rad, using the current, or one of the historical, definitions of the SI units. + + This definition uses "arcminute" as the unit name to distinguish it from the time unit named minute. + A footnote in the International System of Units, 9th ed. (2019) note that "arcsecond is an alternative name for second of plane angle". + However, "arcminute" and "arcmin" have so far not been mentioned in any of the editions of the International System of Units. + They are defined in the GNU Units 3.15 unit database as 1/60 degree. + + The unit appear under the name minute (with symbol ′) in the International System of Units (SI), 1st ed. (1970) defined as "1′ = (1/60)° = (Ï€/10800) rad". + + - The International System of Units (SI), 1st ed. (1970) categorizes the unit as "Units in use with the International System." + - The International System of Units (SI), 7th ed. (1998) adds as a footnote: "ISO 31 recommends that the degree be subdivided decimally rather than using the minute and second." + - The International System of Units (SI), 8th ed. (2006) further adds to that footnote: "For navigation and surveying, however, the minute has the advantage that one minute of latitude on the surface of the Earth corresponds (approximately) to one nautical mile." + - The International System of Units (SI), 9th ed. (2019) replaces the footnote with: "For some applications such as in astronomy, small angles are measured in arcseconds (i.e. seconds of plane angle), denoted as or ′′, or milliarcseconds, microarcseconds and picoarcseconds, denoted mas, μas and pas, respectively, where arcsecond is an alternative name for second of plane angle." + The formulation "denoted as or ″" is reproduced here faithfully from the source and suggests an alternate symbol may have been omitted due to a typographical error. + It is not clear what alternate symbol was intended to be referenced. + + This is a generalized definition taken to reference the current, or one of the historical, SI unit definitions. + This definition is intended for situations when it is not possible to be more precise, e.g., in contexts where data have been collected that uses different historical SI definitions. +compatibility: + - "https://schemas.optimade.org/defs/v1.2/units/si/1970/accepted/arcminute" +resources: + - relation: "Definition in the International System of Units (SI), 1st Edition" + resource-id: "https://www.bipm.org/en/publications/si-brochure" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Minute_and_second_of_arc" +defining-relation: + base-units: + - symbol: "pi" + id: "https://schemas.optimade.org/defs/v1.2/constants/math/basic/pi" + - symbol: "rad" + id: "https://schemas.optimade.org/defs/v1.2/units/si/general/radian" + base-units-expression: "pi*rad" + scale: + denominator: 10800 +x-optimade-definition: + label: "arcminute_si_general" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "arcminute" diff --git a/schemas/src/defs/v1.2/units/si/general/arcsecond.yaml b/schemas/src/defs/v1.2/units/si/general/arcsecond.yaml new file mode 100644 index 000000000..891ca6991 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/general/arcsecond.yaml @@ -0,0 +1,46 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/general/arcsecond" +title: "arcsecond" +symbol: "arcsec" +display-symbol: "″" +alternate-symbols: + - "second of plane angle" + - "second of arc" + - "\"" +description: |- + A unit of plane and phase angle equal to 1/60 of an arcminute representing 1/1296000 of a circle, equal to Ï€/648000 rad, using the current, or one of the historical, definitions of the SI units. + + This definition uses "arcsecond" as the unit name to distingush it from the time unit named minute. + The unit appear under the name second (with symbol ″) in the International System of Units (SI), 1st ed. (1970) defined as "1″ = (1/60)′ = (Ï€/648 000) rad." + + - The International System of Units (SI), 1st ed. (1970) categorizes the unit as "Units in use with the International System." + - The International System of Units (SI), 7th ed. (1998) adds as a footnote: "ISO 31 recommends that the degree be subdivided decimally rather than using the minute and second." + - The International System of Units (SI), 8th ed. (2006) further adds to that footnote: "For navigation and surveying, however, the minute has the advantage that one minute of latitude on the surface of the Earth corresponds (approximately) to one nautical mile." + - The International System of Units (SI), 9th ed. (2019) replaces the footnote with: "For some applications such as in astronomy, small angles are measured in arcseconds (i.e. seconds of plane angle), denoted as or ′′, or milliarcseconds, microarcseconds and picoarcseconds, denoted mas, μas and pas, respectively, where arcsecond is an alternative name for second of plane angle." + The formulation "denoted as or ″" is reproduced here faithfully from the source and suggests an alternate symbol may have been omitted due to a typographical error. + It is not clear what alternate symbol was intended to be referenced. + + This is a generalized definition taken to reference the current, or one of the historical, SI unit definitions. + This definition is intended for situations when it is not possible to be more precise, e.g., in contexts where data have been collected that uses different historical SI definitions. +compatibility: + - "https://schemas.optimade.org/defs/v1.2/units/si/1970/accepted/arcsecond" +resources: + - relation: "Definition in the International System of Units (SI), 1st Edition" + resource-id: "https://www.bipm.org/en/publications/si-brochure" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Minute_and_second_of_arc" +defining-relation: + base-units: + - symbol: "pi" + id: "https://schemas.optimade.org/defs/v1.2/constants/math/basic/pi" + - symbol: "rad" + id: "https://schemas.optimade.org/defs/v1.2/units/si/general/radian" + base-units-expression: "pi*rad" + scale: + denominator: 648000 +x-optimade-definition: + label: "arcsecond_si_general" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "arcsecond" diff --git a/schemas/src/defs/v1.2/units/si/general/are.yaml b/schemas/src/defs/v1.2/units/si/general/are.yaml new file mode 100644 index 000000000..377e4bea0 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/general/are.yaml @@ -0,0 +1,40 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/general/are" +title: "are" +symbol: "a" +display-symbol: "a" +description: |- + A unit of area equal to 100 square meters (10² m²) using the current, or one of the historical, definitions of the SI units. + + The are unit appears in the International System of Units (SI), 1st ed. (1970) defined as "1 a = 1 dam² = 10² m²" with the footnote "This unit and its symbol were adopted by the International Committee in 1879 (Proces-Verbaux C.I.P.M., 1879, p. 41)." + + - The International System of Units (SI), 1st ed. (1970) categorizes the unit as "units in use temporarily". + - The International System of Units (SI), 5th ed. (1985) adds the clarification that the unit is "used to express agrarian areas." + - The International System of Units (SI), 7th ed. (1998) changes the categorization to "Other non-SI units currently accepted for use with the International System." + - The International System of Units (SI), 8th ed. (2006) completely removes the unit (but still defines the hectare). + + The are unit was implicitly redefined via the redefinition of the metre at the 17th CGPM meeting (1983), resolution 1. + + This is a generalized definition taken to reference the current, or one of the historical, SI unit definitions. + This definition is intended for situations when it is not possible to be more precise, e.g., in contexts where data have been collected that uses different historical SI definitions. +compatibility: + - "https://schemas.optimade.org/defs/v1.2/units/si/1970/temporary/are" + - "https://schemas.optimade.org/defs/v1.2/units/si/1983/temporary/are" +resources: + - relation: "Definition in the International System of Units (SI), 1st Edition" + resource-id: "https://www.bipm.org/en/publications/si-brochure" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Hectare#Are" +defining-relation: + base-units: + - symbol: "m" + id: "https://schemas.optimade.org/defs/v1.2/units/si/general/metre" + base-units-expression: "m^2" + scale: + exponent: 4 +x-optimade-definition: + label: "are_si_general" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "are" diff --git a/schemas/src/defs/v1.2/units/si/general/astronomicalunit.yaml b/schemas/src/defs/v1.2/units/si/general/astronomicalunit.yaml new file mode 100644 index 000000000..e99ffc921 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/general/astronomicalunit.yaml @@ -0,0 +1,46 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/general/astronomicalunit" +title: "astronomical unit" +symbol: "au" +display-symbol: "au" +description: |- + A unit of length representing the mean distance between the Earth and the Sun, using the current, or one of the historical, definitions given in the editions of the International System of Units (SI). + + The current definition in the International System of Units (SI), 9th ed. (2019) is: "1 au = 149 597 870 700 m" with the footnote "As decided at the XXVIII General Assembly of the International Astronomical Union (Resolution B2, 2012)." + + The prior definition in the International System of Units (SI), 1st ed. (1970) appears in a footnote: "The astronomical unit of distance is the length of the unperturbed circular orbit about the Sun of a body of infinitesimal mass in motion around the Sun with an angular sidereal velocity of 0.017202098950 radians per ephemeris day of 86,400 seconds. In the System of Astronomical Constants of the International Astronomical Union, the adopted value is: 1 AU = 149,600 x 10ⶠm." + + This definition interprets the definition to be the expression in radians and seconds, with the meter value regarded only as an approximation. + + - The International System of Units (SI), 1st ed. (1970) categorizes the unit as "Units for use with the SI in specific domains." + - The International System of Units (SI), 2nd ed. (1973) categorizes the unit as "Non-SI units accepted for use with the International System, whose values in SI units are obtained experimentally" and prefixes the footnote with: "This unit does not have an international symbol; abbreviations are used, for example, UA in French, AU in English, AG in German, а.е. in Russian, etc." + - The International System of Units (SI), 4th ed. (1981) omits the unit. + - The International System of Units (SI), 7th ed. (1998) reintroduces the unit in the category "Non-SI units accepted for use with the International System, whose values in SI units are obtained experimentally." with the experimental relationship "1 au = 1.49597870691(30)×10¹¹ m" with the footnote: "The astronomical unit is a unit of length approximatively equal to the mean Earth-Sun distance. Its value is such that, when used to describe the motion of bodies in the Solar System, the heliocentric gravitational constant is (0.01720209895)² ua³⋅dâ»Â²." + - The International System of Units (SI), 8th ed. (2006) notes the experimental relationship "1 au = 1.49597870691(6)×10¹¹ m" and changes the footnote to: "The astronomical unit is approximately equal to the mean Earth-Sun distance. It is the radius of an unperturbed circular Newtonian orbit about the Sun of a particle having infinitesimal mass, moving with a mean motion of 0.01720209895 radians per day (known as the Gaussian constant). The value given for the astronomical unit is quoted from the IERS Conventions 2003 (D.D. McCarthy and G. Petit eds., IERS Technical Note 32, Frankfurt am Main: Verlag des Bundesamts für Kartographie und Geodäsie, 2004, 12). The value of the astronomical unit in metres comes from the JPL ephemerides DE403 (Standish E.M., Report of the IAU WGAS Sub-Group on Numerical Standards, Highlights of Astronomy, Appenzeller ed., Dordrecht: Kluwer Academic Publishers, 1995, 180-184)." + - The International System of Units (SI), 9th ed. (2019) categorizes the astronomical unit as a "non-SI unit accepted for use with the SI units" and redefines it to have an exact relationship to the meter with the footnote: "As decided at the XXVIII General Assembly of the International Astronomical Union (Resolution B2, 2012)." + + This is a generalized definition taken to reference the current, or one of the historical, SI unit definitions. + This definition is intended for situations when it is not possible to be more precise, e.g., in contexts where data have been collected that uses different historical SI definitions. +compatibility: + - "https://schemas.optimade.org/defs/v1.2/units/si/1970/accepted/astronomicalunit" + - "https://schemas.optimade.org/defs/v1.2/units/si/2019/accepted/astronomicalunit" +resources: + - relation: "Definition in the International System of Units (SI), 9th Edition" + resource-id: "https://www.bipm.org/en/publications/si-brochure" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Astronomical_unit" +$comment: |- + While the approximate relation given is exact in the current definition of the SI system, this unit definition is a generalized definition that may also reference prior definitions of the astronomical unit, for which this relationship is only approximate. +approximate-relations: + - base-units: + - symbol: "m" + id: "https://schemas.optimade.org/defs/v1.2/units/si/1960/base/metre" + base-units-expression: "m" + scale: + value: 149597870700 +x-optimade-definition: + label: "astronomicalunit_si_general" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "astronomicalunit" diff --git a/schemas/src/defs/v1.2/units/si/general/atmosphere.yaml b/schemas/src/defs/v1.2/units/si/general/atmosphere.yaml new file mode 100644 index 000000000..348b339f9 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/general/atmosphere.yaml @@ -0,0 +1,45 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/general/atmosphere" +title: "standard atmosphere" +symbol: "atm" +display-symbol: "atm" +description: |- + A unit for pressure approximately equal to the average atmospheric pressure at sea level on Earth using the current, or one of the historical, definitions of the SI units. + + The standard atmosphere unit appears in the International System of Units (SI), 1st ed. (1970) defined as "1 atm = 101325 Pa" with the footnote "Resolution 4 at the 10th C.G.P.M. (1954)." + (While the pascal unit appears in the 1st ed. as a symbol for N·s/m², it was adopted into SI at the 14th CGPM meeting in 1971.) + + - In the International System of Units (SI), 1st ed. (1970) it is categorized as "temporarily admitted" for use with the SI units. + - The International System of Units (SI), 4th ed. (1981) changes the categorization to "Other units generally deprecated" and adds to the footnote that: "The designation "standard atmosphere" for a reference pressure of 101 325 Pa is still acceptable." + - The International System of Units (SI), 7th ed. (1998) changes the categorization to "Examples of other non-SI units." + - The International System of Units (SI), 8th ed. (2006) omits the unit, but uses the term in a footnote to the definition of the unit bar to clarify that prior to 1982 the standard pressure used to tabulate thermodynamical data was the standard atmosphere. + - The International System of Units (SI), 9th ed. (2006) no longer references the unit or the designation "standard atmosphere". + + This is a generalized definition taken to reference the current, or one of the historical, SI unit definitions. + This definition is intended for situations when it is not possible to be more precise, e.g., in contexts where data have been collected that uses different historical SI definitions. +compatibility: + - "https://schemas.optimade.org/defs/v1.2/units/si/1970/accepted/atmosphere" +resources: + - relation: "Definition in the International System of Units (SI), 9th Edition" + resource-id: "https://www.bipm.org/en/publications/si-brochure" + - relation: "Definition of pascal at the 14th CGPM Meeting (1971)" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/14-1971" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Standard_atmosphere_(unit)" +defining-relation: + base-units: + - symbol: "kg" + id: "https://schemas.optimade.org/defs/v1.2/units/si/general/kilogram" + - symbol: "m" + id: "https://schemas.optimade.org/defs/v1.2/units/si/general/metre" + - symbol: "s" + id: "https://schemas.optimade.org/defs/v1.2/units/si/general/second" + base-units-expression: "kg*m^-1*s^-2" + scale: + numerator: 101325 +x-optimade-definition: + label: "atmosphere_si_general" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "atmosphere" diff --git a/schemas/src/defs/v1.2/units/si/general/atomicmassunit.yaml b/schemas/src/defs/v1.2/units/si/general/atomicmassunit.yaml new file mode 100644 index 000000000..f34b4c7b2 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/general/atomicmassunit.yaml @@ -0,0 +1,49 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/general/atomicmassunit" +title: "atomic mass unit" +symbol: "u" +display-symbol: "u" +alternate-symbols: + - "dalton" + - "Da" +description: |- + A unit of mass representing 1/12 of the mass of a free carbon 12 atom (i.e., a typical value of the mass of a nucleon in an atom) using the current, or one of the historical, definitions given in the editions of the International System of Units (SI). + + The International System of Units (SI), 1st ed. (1970) defines the atomic mass unit in the section "Units used with the International System" (known as "Non-SI units accepted for use with the SI units" in later editions). + The unit is defined in a footnote as: "The atomic mass unit (unified) is equal to 1/12 of the mass of an atom of the nuclide ¹²C; 1 u = 1.66053 x 10â»Â²â· kg approximately." + + The definition is retained in the International System of Units up to the 7th edition (1998), where the conditions are slightly clarified and dalton (Da) is introduced as an alternative name: "The unified atomic mass unit is equal to 1/12 of the mass of an unbound atom of the nuclide ¹²C, at rest, and in its ground state. In the field of biochemistry, the unified atomic mass unit is also called the dalton, symbol Da." + In the 8th ed. (2006) the definition is slightly adjusted, replacing "unbound" with "free": "The dalton (Da) and the unified atomic mass unit (u) are alternative names (and symbols) for the same unit, equal to 1/12 times the mass of a free carbon 12 atom, at rest and in its ground state." + + All editions of the International System of Units note approximate relationships to the kilogram. + The 9th ed. states "1 Da = 1.660 539 066 60(50)×10â»Â²â· kg", where the 2018 CODATA value has been used and the 2019 SI kilogram is referenced (https://schemas.optimade.org/defs/v1.2/units/si/2019/base/kilogram). + + In the 2019 redefinition of the SI units, the atomic mass unit is the only unit listed as accepted for use with SI that has a value in SI units which is determined experimentally. + + This is a generalized definition taken to reference the current, or one of the historical, SI unit definitions. + This definition is intended for situations when it is not possible to be more precise, e.g., in contexts where data have been collected that uses different historical SI definitions. +compatibility: + - "https://schemas.optimade.org/defs/v1.2/units/si/1970/accepted/atomicmassunit" + - "https://schemas.optimade.org/defs/v1.2/units/si/1998/accepted/dalton" + - "https://schemas.optimade.org/defs/v1.2/units/si/general/dalton" +resources: + - relation: "Definition in the International System of Units (SI), 9th Edition" + resource-id: "https://www.bipm.org/en/publications/si-brochure" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Dalton_(unit)" + - relation: "CODATA unified atomic mass unit fundamental physical constant: source for relationship to kg" + resource-id: "https://physics.nist.gov/cgi-bin/cuu/Value?ukg" +approximate-relations: + - base-units: + - symbol: "kg" + id: "https://schemas.optimade.org/defs/v1.2/units/si/general/kilogram" + base-units-expression: "kg" + scale: + value: 1.66053906660E-27 + standard_uncertainty: 0.00000000050E-27 +x-optimade-definition: + label: "atomicmassunit_si_general" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "atomicmassunit" diff --git a/schemas/src/defs/v1.2/units/si/general/bar.yaml b/schemas/src/defs/v1.2/units/si/general/bar.yaml new file mode 100644 index 000000000..5d59e8097 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/general/bar.yaml @@ -0,0 +1,45 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/general/bar" +title: "bar" +symbol: "bar" +display-symbol: "bar" +description: |- + A unit of pressure equal to 10âµ N/m using the current, or one of the historical, definitions of the SI units. + + The bar unit appears in the International System of Units (SI), 1st ed. (1970) defined as "1 bar = 0,1 MPa = 10âµ Pa" with the footnote "This unit and its symbol are included in Resolution 7 of the 9th C.G.P.M. (1948)." + (While the pascal unit appears in the 1st ed. as a symbol for N·s/m², it was adopted into SI at the 14th CGPM meeting in 1971.) + + - The International System of Units (SI), 1st ed. (1970) categorizes the unit as "Units in use temporarily with the International System." + - The International System of Units (SI), 7th ed. (1998) changes the categorization to "Other non-SI units currently accepted for use with the International System." + - The International System of Units (SI), 8th ed. (2006) changes the categorization to "Other non-SI units" and updates the footnote to: "The bar and its symbol are included in Resolution 7 of the 9th CGPM (1948; CR, 70). Since 1982 one bar has been used as the standard pressure for tabulating all thermodynamic data. Prior to 1982 the standard pressure used to be the standard atmosphere, equal to 1.013 25 bar, or 101 325 Pa." + - The bar is omitted in the International System of Units (SI), 9th Edition (2019) (except appearing as an example in the context of typesetting of units). + + The bar unit was implicitly redefined via the redefinition of the metre at the 17th CGPM meeting (1983), resolution 1. + + This is a generalized definition taken to reference the current, or one of the historical, SI unit definitions. + This definition is intended for situations when it is not possible to be more precise, e.g., in contexts where data have been collected that uses different historical SI definitions. +compatibility: + - "https://schemas.optimade.org/defs/v1.2/units/si/1970/temporary/bar" + - "https://schemas.optimade.org/defs/v1.2/units/si/1983/temporary/bar" +resources: + - relation: "Definition in the International System of Units (SI), 9th Edition" + resource-id: "https://www.bipm.org/en/publications/si-brochure" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Bar_(unit)" +defining-relation: + base-units: + - symbol: "kg" + id: "https://schemas.optimade.org/defs/v1.2/units/si/general/kilogram" + - symbol: "m" + id: "https://schemas.optimade.org/defs/v1.2/units/si/general/metre" + - symbol: "s" + id: "https://schemas.optimade.org/defs/v1.2/units/si/general/second" + base-units-expression: "kg*m^-1*s^-2" + scale: + exponent: 5 +x-optimade-definition: + label: "bar_si_general" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "bar" diff --git a/schemas/src/defs/v1.2/units/si/general/barn.yaml b/schemas/src/defs/v1.2/units/si/general/barn.yaml new file mode 100644 index 000000000..f38f6246f --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/general/barn.yaml @@ -0,0 +1,43 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/general/barn" +title: "barn" +symbol: "b" +display-symbol: "b" +description: |- + A unit of area used in nuclear physics to express cross sections equal to 100 fm² using the current, or one of the historical, definitions of the SI units. + + The International System of Units (SI), 1st ed. (1970) states: "1 b = 100 fm² = 10â»Â²â¸ m" with a footnote "The barn is a special unit used in nuclear physics to express cross sections." + + - The International System of Units (SI), 1st ed. (1970) categorizes the unit as "Units in use temporarily with the International System." + - The International System of Units (SI), 8th ed. (2006) categorizes the unit as "Other non-SI units currently accepted for use with the International System." + - The International System of Units (SI), 9th ed. (2019) categorizes the unit as "Other non-SI units." + + The barn unit was implicitly redefined via the redefinition of the metre at the 17th CGPM meeting (1983), resolution 1. + + This is a generalized definition taken to reference the current, or one of the historical, SI unit definitions. + This definition is intended for situations when it is not possible to be more precise, e.g., in contexts where data have been collected that uses different historical SI definitions. +compatibility: + - "https://schemas.optimade.org/defs/v1.2/units/si/1970/temporary/barn" + - "https://schemas.optimade.org/defs/v1.2/units/si/1983/temporary/barn" +resources: + - relation: "Definition in the International System of Units (SI), 9th Edition" + resource-id: "https://www.bipm.org/en/publications/si-brochure" + - relation: "Redefinition of the metre at the 17th CGPM meeting (1983), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/17-1983/resolution-1" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Barn_(unit)" +defining-relation: + base-units: + - symbol: "m" + id: "https://schemas.optimade.org/defs/v1.2/units/si/general/metre" + scale: + - exponent: -28 + base-units-expression: "m^2" + scale: + exponent: 4 +x-optimade-definition: + label: "barn_si_general" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "barn" diff --git a/schemas/src/defs/v1.2/units/si/general/becquerel.yaml b/schemas/src/defs/v1.2/units/si/general/becquerel.yaml new file mode 100644 index 000000000..5fbf3165b --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/general/becquerel.yaml @@ -0,0 +1,30 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/general/becquerel" +title: "becquerel" +symbol: "Bq" +display-symbol: "Bq" +description: |- + A unit for radioactivity, defined as sâ»Â¹ using the current, or one of the historical, definitions of the SI units. + + "The 15th Conférence Générale des Poids et Mesures, [...] adopts the following special name for the SI unit of activity: becquerel, symbol Bq, equal to one reciprocal second." [15th CGPM Meeting (1975)] + + This is a generalized definition taken to reference the current, or one of the historical, SI unit definitions. + This definition is intended for situations when it is not possible to be more precise, e.g., in contexts where data have been collected that uses different historical SI definitions. +compatibility: + - "https://schemas.optimade.org/defs/v1.2/units/si/1975/named/becquerel" +resources: + - relation: "Definition at the 15th CGPM Meeting (1975)" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/15-1975" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Becquerel" +defining-relation: + base-units: + - symbol: "s" + id: "https://schemas.optimade.org/defs/v1.2/units/si/general/second" + base-units-expression: "s^-1" +x-optimade-definition: + label: "becquerel_si_general" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "becquerel" diff --git a/schemas/src/defs/v1.2/units/si/general/candela.yaml b/schemas/src/defs/v1.2/units/si/general/candela.yaml new file mode 100644 index 000000000..d1826a1f6 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/general/candela.yaml @@ -0,0 +1,38 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/general/candela" +title: "candela" +symbol: "cd" +display-symbol: "cd" +description: |- + A unit of luminous intensity in a given direction defined according to the current, or one of the historical, definitions of the SI units. + + The current definition in its most recent phrasing at the 26th CGPM Meeting in 2018, resolution 1 is: "The candela, symbol cd, is the SI unit of luminous intensity in a given direction. It is defined by taking the fixed numerical value of the luminous efficacy of monochromatic radiation of frequency 540×10¹² Hz, \(K_\mathrm{cd}\), to be 683 when expressed in the unit lmâ‹…Wâ»Â¹, which is equal to cdâ‹…srâ‹…Wâ»Â¹, or cdâ‹…srâ‹…kgâ»Â¹â‹…mâ»Â²â‹…s³, where the kilogram, metre and second are defined in terms of \(h\), \(c\) and \(\Delta \nu_\textrm{Cs}\)." + + This is a rephrasing of a definition at the 16th CGPM Meeting (1979), resolution 3: "The candela is the luminous intensity, in a given direction, of a source that emits monochromatic radiation of frequency 540×10¹² hertz and that has a radiant intensity in that direction of 1/683 watt per steradian." + + Earlier different definitions of the candela were: + + - "The candela is the luminous intensity, in a given direction, of a source that emits monochromatic radiation of frequency 540×10¹² hertz and that has a radiant intensity in that direction of 1/683 watt per steradian." [16th CGPM Meeting (1979), resolution 3]. + - "The candela is the sixtieth of the luminous intensity emitted perpendicularly by one square centimeter of a perfect radiator (black body) at the solidification temperature of platinum." [9th CGPM meeting (1948)] (this definition was adopted into the SI system at the 11th CGPM Meeting in 1960, resolution 12). + + This is a generalized definition taken to reference the current, or one of the historical, SI unit definitions. + This definition is intended for situations when it is not possible to be more precise, e.g., in contexts where data have been collected that uses different historical SI definitions. +compatibility: + - "https://schemas.optimade.org/defs/v1.2/units/si/1960/base/candela" + - "https://schemas.optimade.org/defs/v1.2/units/si/1967/base/candela" + - "https://schemas.optimade.org/defs/v1.2/units/si/1979/base/candela" + - "https://schemas.optimade.org/defs/v1.2/units/si/1983/base/candela" + - "https://schemas.optimade.org/defs/v1.2/units/si/2019/base/candela" +resources: + - relation: "Definition in the 26th CGPM Meeting in 2018, resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/26-2018/resolution-1" + - relation: "Definition in the International System of Units (SI), 9th Edition" + resource-id: "https://www.bipm.org/en/publications/si-brochure" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Candela" +x-optimade-definition: + label: "candela_si_general" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "candela" diff --git a/schemas/src/defs/v1.2/units/si/general/coulomb.yaml b/schemas/src/defs/v1.2/units/si/general/coulomb.yaml new file mode 100644 index 000000000..1a9232774 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/general/coulomb.yaml @@ -0,0 +1,43 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/general/coulomb" +title: "coulomb" +symbol: "C" +display-symbol: "C" +description: |- + A unit for electric charge equal to s·A using the current, or one of the historical, definitions of the SI units. + + "The coulomb is the amount of electricity transported in one second by a current of one ampere." [9th CGPM meeting in 1946] + + The coulomb was defined at the 9th CGPM Meeting in 1946, included in SI at the 11th CGPM meeting in 1960, resolution 12, implicitly redefined via the redefinitions of the second at the 13th CGPM Meeting in 1967, resolution 1; the metre at the 17th CGPM meeting (1983), resolution 1; and the kilogram at the 26th CGPM Meeting (2018), resolution 1. + + This is a generalized definition taken to reference the current, or one of the historical, SI unit definitions. + This definition is intended for situations when it is not possible to be more precise, e.g., in contexts where data have been collected that uses different historical SI definitions. +compatibility: + - "https://schemas.optimade.org/defs/v1.2/units/si/1960/named/coulomb" + - "https://schemas.optimade.org/defs/v1.2/units/si/1967/named/coulomb" + - "https://schemas.optimade.org/defs/v1.2/units/si/1983/named/coulomb" + - "https://schemas.optimade.org/defs/v1.2/units/si/2019/named/coulomb" +resources: + - relation: "Definition at the 9th CGPM meeting (1948)" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/9-1948" + - relation: "Definition and establishment of the SI unit system at the 11th CGPM meeting (1960), resolution 12." + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/11-1960/resolution-12" + - relation: "Redefinition of the second in the 13th CGPM Meeting (1967), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/13-1967/resolution-1" + - relation: "Redefinition of the kilogram in the 26th CGPM Meeting (2018), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/26-2018/resolution-1" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Coulomb" +defining-relation: + base-units: + - symbol: "s" + id: "https://schemas.optimade.org/defs/v1.2/units/si/general/second" + - symbol: "A" + id: "https://schemas.optimade.org/defs/v1.2/units/si/general/ampere" + base-units-expression: "A*s" +x-optimade-definition: + label: "coulomb_si_general" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "coulomb" diff --git a/schemas/src/defs/v1.2/units/si/general/curie.yaml b/schemas/src/defs/v1.2/units/si/general/curie.yaml new file mode 100644 index 000000000..060d5a8f9 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/general/curie.yaml @@ -0,0 +1,43 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/general/curie" +title: "curie" +symbol: "Ci" +display-symbol: "Ci" +description: |- + A unit of activity with the value 3.7·10â»Â¹â° sâ»Â¹ using the current, or one of the historical, definitions of the SI units. + + Defined as outside the SI at the 12th CGPM meeting in 1964, resolution 7. + Implicitly redefined via the redefinition of the second at the 13th CGPM Meeting in 1967, resolution 1. + + - The International System of Units (SI), 1st ed. (1970) categorizes the unit as "Units in use temporarily with the International System." + - The International System of Units (SI), 7th ed. (1998) changes the categorization to "Other non-SI units". + - The curie is omitted in the International System of Units (SI), 8th Edition (2006). + + This is a generalized definition taken to reference the current, or one of the historical, SI unit definitions. + This definition is intended for situations when it is not possible to be more precise, e.g., in contexts where data have been collected that uses different historical SI definitions. +compatibility: + - "https://schemas.optimade.org/defs/v1.2/units/si/1964/temporary/curie" + - "https://schemas.optimade.org/defs/v1.2/units/si/1967/temporary/curie" +resources: + - relation: "Definition at the 12th CGPM meeting (1964), resolution 3" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/12-1964/resolution-3" + - relation: "Redefinition of the second in the 13th CGPM Meeting (1967), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/13-1967/resolution-1" + - relation: "Le Système International d'Unités (SI) (1970)" + resource-id: "https://www.bipm.org/en/publications/si-brochure" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Curie_(unit)" +defining-relation: + base-units: + - symbol: "s" + id: "https://schemas.optimade.org/defs/v1.2/units/si/general/second" + base-units-expression: "s^-1" + scale: + numerator: 37 + exponent: -11 +x-optimade-definition: + label: "curie_si_general" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "curie" diff --git a/schemas/src/defs/v1.2/units/si/general/dalton.yaml b/schemas/src/defs/v1.2/units/si/general/dalton.yaml new file mode 100644 index 000000000..bc0e3459f --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/general/dalton.yaml @@ -0,0 +1,51 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/general/dalton" +title: "dalton" +symbol: "Da" +display-symbol: "Da" +alternate-symbols: + - "u" +description: |- + A unit of mass intended to represent a typical mass of a nucleon in an atom using the current, or one of the historical, definitions given in the editions of the International System of Units (SI). + + The name dalton as an alternative name to *atomic mass unit* is defined in the International System of Units (SI), 7th ed. (1998) in a footnote to a table labeled "Non-SI units accepted for use with the International System, whose values in SI units are obtained experimentally" in the section "Units outside the international system". + The definition given is: "The unified atomic mass unit is equal to 1/12 of the mass of an unbound atom of the nuclide ¹²C, at rest, and in its ground state. In the field of biochemistry, the unified atomic mass unit is also called the dalton, symbol Da." + + This definition makes the dalton equivalent to the atomic mass unit defined in the International System of Units (SI), 1st ed. (1970) (https://schemas.optimade.org/defs/v1.2/units/si/general/atomicmassunit) + + In the International System of Units (SI) 8th ed. (2006) the definition is slightly adjusted, replacing "unbound" with "free": "The dalton (Da) and the unified atomic mass unit (u) are alternative names (and symbols) for the same unit, equal to 1/12 times the mass of a free carbon 12 atom, at rest and in its ground state." + + All editions of the International System of Units (SI) note approximate relationships to the kilogram. + The 9th ed. states "1 Da = 1.660 539 066 60(50)×10â»Â²â· kg", where the 2018 CODATA value has been used and the 2019 SI kilogram is referenced (https://schemas.optimade.org/defs/v1.2/units/si/2019/base/kilogram). + + Note: in the 2019 redefinition of the SI units, the dalton is the only unit listed as accepted for use with SI that does not have an exact relation to the base SI units. + + This is a generalized definition taken to reference the current, or one of the historical, SI unit definitions. + This definition is intended for situations when it is not possible to be more precise, e.g., in contexts where data have been collected that uses different historical SI definitions. +compatibility: + - "https://schemas.optimade.org/defs/v1.2/units/si/1998/accepted/dalton" + - "https://schemas.optimade.org/defs/v1.2/units/si/1970/accepted/atomicmassunit" + - "https://schemas.optimade.org/defs/v1.2/units/si/general/atomicmassunit" +resources: + - relation: "Definition in the International System of Units (SI), 9th Edition" + resource-id: "https://www.bipm.org/en/publications/si-brochure" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Dalton_(unit)" + - relation: "CODATA unified atomic mass unit fundamental physical constant: source for relationship to kg" + resource-id: "https://physics.nist.gov/cgi-bin/cuu/Value?ukg" +compatibility: + - "https://schemas.optimade.org/defs/v1.2/units/si/general/atomicmassunit" +approximate-relations: + - base-units: + - symbol: "kg" + id: "https://schemas.optimade.org/defs/v1.2/units/si/general/kilogram" + base-units-expression: "kg" + scale: + value: 1.66053906660E-27 + standard_uncertainty: 0.00000000050E-27 +x-optimade-definition: + label: "dalton_si_general" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "dalton" diff --git a/schemas/src/defs/v1.2/units/si/general/day.yaml b/schemas/src/defs/v1.2/units/si/general/day.yaml new file mode 100644 index 000000000..980dec0ec --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/general/day.yaml @@ -0,0 +1,37 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/general/day" +title: "day" +symbol: "day" +display-symbol: "day" +alternate-symbols: + - "d" +description: |- + A unit of time equal to 86 400 seconds using the current, or one of the historical, definitions of the SI units. + + The day unit appears in the International System of Units (SI), 1st ed. (1970) defined as "1 d = 24 h = 86400 s". + + - The International System of Units (SI), 1st ed. (1970) categorizes the unit as "Units in use with the International System." + - The International System of Units (SI), 7th ed. (1998) changes the categorization to "Non-SI units accepted for use with the International System." + + This is a generalized definition taken to reference the current, or one of the historical, SI unit definitions. + This definition is intended for situations when it is not possible to be more precise, e.g., in contexts where data have been collected that uses different historical SI definitions. +compatibility: + - "https://schemas.optimade.org/defs/v1.2/units/si/1970/accepted/day" +resources: + - relation: "Definition in the International System of Units (SI), 1st Edition" + resource-id: "https://www.bipm.org/en/publications/si-brochure" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Day" +defining-relation: + base-units: + - symbol: "s" + id: "https://schemas.optimade.org/defs/v1.2/units/si/general/second" + base-units-expression: "s" + scale: + numerator: 86400 +x-optimade-definition: + label: "day_si_general" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "day" diff --git a/schemas/src/defs/v1.2/units/si/general/degcelsius.yaml b/schemas/src/defs/v1.2/units/si/general/degcelsius.yaml new file mode 100644 index 000000000..032b865d4 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/general/degcelsius.yaml @@ -0,0 +1,43 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/general/degcelsius" +title: "degree Celsius" +symbol: "degC" +display-symbol: "°C" +alternate-symbols: + - "degreecelsius" +description: |- + A unit of temperature, defined as kelvin offset with +273.15 using the current, or one of the historical, definitions of the SI units. + + "If we add to the practical international Celsius temperatures defined above Tâ‚€ = 273.15 degrees, we obtain the practical international Kelvin temperatures. By subtracting Tâ‚€ from the thermodynamic temperatures, we obtain the thermodynamic Celsius temperatures." [11th CGPM meeting (1960)] + + The degree Celsius was defined and included in SI at the 11th CGPM meeting in 1960, resolution 12 and implicitly redefined via the redefinitions of the kelvin at the 13th CGPM Meeting in 1967, resolution 4 and at the 26th CGPM Meeting (2018), resolution 1. + + This is a generalized definition taken to reference the current, or one of the historical, SI unit definitions. + This definition is intended for situations when it is not possible to be more precise, e.g., in contexts where data have been collected that uses different historical SI definitions. +compatibility: + - "https://schemas.optimade.org/defs/v1.2/units/si/1960/named/degcelsius" + - "https://schemas.optimade.org/defs/v1.2/units/si/1967/named/degcelsius" + - "https://schemas.optimade.org/defs/v1.2/units/si/2019/named/degcelsius" +resources: + - relation: "Definition at the 11th CGPM meeting (1960)" + resource-id: "https://www.bipm.og/en/committees/cg/cgpm/11-1960" + - relation: "Redefinition of the kelvin at the 13th CGPM meeting (1967), resolution 4" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/13-1967/resolution-4" + - relation: "Redefinition of the kelvin at the 26th CGPM meeting (2018), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/26-2018/resolution-1" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Celsius" +defining-relation: + base-units: + - symbol: "K" + id: "https://schemas.optimade.org/defs/v1.2/units/si/general/kelvin" + base-units-expression: "K" + offset: + numerator: 27315 + denominator: 100 +x-optimade-definition: + label: "degcelsius_si_general" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "degcelsius" diff --git a/schemas/src/defs/v1.2/units/si/general/degree.yaml b/schemas/src/defs/v1.2/units/si/general/degree.yaml new file mode 100644 index 000000000..68e461f27 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/general/degree.yaml @@ -0,0 +1,43 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/general/degree" +title: "degree" +symbol: "degree" +display-symbol: "°" +description: |- + A unit of plane and phase angle representing 1/360 of a full circle, equal to Ï€/180 rad using the current, or one of the historical, definitions of the SI units. + + With the current definition of raidan in the SI system, the degree is equal to 1/360 of a circle. + + The degree unit appears in the International System of Units (SI), 1st ed. (1970) defined as "1° = (pi/180) rad". + + - The International System of Units (SI), 1st ed. (1970) categorizes the unit as "Units in use with the International System." + - The International System of Units (SI), 7th ed. (1998) adds as a footnote: "ISO 31 recommends that the degree be subdivided decimally rather than using the minute and second." + - The International System of Units (SI), 8th ed. (2006) further adds to that footnote: "For navigation and surveying, however, the minute has the advantage that one minute of latitude on the surface of the Earth corresponds (approximately) to one nautical mile." + - The International System of Units (SI), 9th ed. (2019) replaces the footnote with: "For some applications such as in astronomy, small angles are measured in arcseconds (i.e. seconds of plane angle), denoted as or ′′, or milliarcseconds, microarcseconds and picoarcseconds, denoted mas, μas and pas, respectively, where arcsecond is an alternative name for second of plane angle." + The formulation "denoted as or ″" is reproduced here faithfully from the source and suggests an alternate symbol may have been omitted due to a typographical error. + It is not clear what alternate symbol was intended to be referenced. + + This is a generalized definition taken to reference the current, or one of the historical, SI unit definitions. + This definition is intended for situations when it is not possible to be more precise, e.g., in contexts where data have been collected that uses different historical SI definitions. +compatibility: + - "https://schemas.optimade.org/defs/v1.2/units/si/1970/accepted/degree" +resources: + - relation: "Definition in the International System of Units (SI), 9th Edition" + resource-id: "https://www.bipm.org/en/publications/si-brochure" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Degree_(angle)" +defining-relation: + base-units: + - symbol: "pi" + id: "https://schemas.optimade.org/defs/v1.2/constants/math/basic/pi" + - symbol: "rad" + id: "https://schemas.optimade.org/defs/v1.2/units/si/general/radian" + base-units-expression: "pi*rad" + scale: + denominator: 180 +x-optimade-definition: + label: "degree_si_general" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "degree" diff --git a/schemas/src/defs/v1.2/units/si/general/electronvolt.yaml b/schemas/src/defs/v1.2/units/si/general/electronvolt.yaml new file mode 100644 index 000000000..fade0569a --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/general/electronvolt.yaml @@ -0,0 +1,39 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/general/electronvolt" +title: "electron volt" +symbol: "eV" +display-symbol: "eV" +description: |- + A unit of energy that representing the kinetic energy acquired by an electron as it accelerates through a 1 volt potential difference in a vacuum using the current, or one of the historical, definitions given in the editions of the International System of Units (SI). + + The electronvolt unit appears in the International System of Units (SI), 1st ed. (1970) defined as "1 electronvolt is the energy acquired by an electron after traversing a potential difference of 1 V in a vacuum; 1 eV = 1.60219×10â»Â¹â¹ J approximately." + This definition makes the unit equal to 1 volt times the value of the elementary charge. + In the 2019 redefinition of the SI units the elementary charge is exactly 1.602176634·10â»Â¹â¹ C, making the electron volt exactly equal to 1.602176634·10â»Â¹â¹ J. + The International System of Units (SI), 9th ed. (2019) accordingly notes the exact relationship with the SI 2019 derived unit joule as "1 eV = 1.602176634·10â»Â¹â¹ J" but retains the definition from 1970 in a footnote. + + The unit is categorized in the International System of Units (SI), 9th ed. (2019) as "Non-SI units accepted for use with the SI units". + + This is a generalized definition taken to reference the current, or one of the historical, SI unit definitions. + This definition is intended for situations when it is not possible to be more precise, e.g., in contexts where data have been collected that uses different historical SI definitions. +compatibility: + - "https://schemas.optimade.org/defs/v1.2/units/si/1970/accepted/electronvolt" + - "https://schemas.optimade.org/defs/v1.2/units/si/1983/accepted/electronvolt" + - "https://schemas.optimade.org/defs/v1.2/units/si/2019/accepted/electronvolt" +resources: + - relation: "Definition in the International System of Units (SI), 9th Edition" + resource-id: "https://www.bipm.org/en/publications/si-brochure" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Electronvolt" +approximate-relations: + - base-units: + - symbol: "V" + id: "https://schemas.optimade.org/defs/v1.2/units/si/general/volt" + - symbol: "e" + id: "https://schemas.optimade.org/defs/v1.2/constants/codata/2018/electromagnetic/elementarycharge" + base-units-expression: "e*V" +x-optimade-definition: + label: "electronvolt_si_general" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "electronvolt" diff --git a/schemas/src/defs/v1.2/units/si/general/farad.yaml b/schemas/src/defs/v1.2/units/si/general/farad.yaml new file mode 100644 index 000000000..1952c0e2a --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/general/farad.yaml @@ -0,0 +1,45 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/general/farad" +title: "farad" +symbol: "F" +display-symbol: "F" +description: |- + A unit for electrical capacitance equal to kgâ»Â¹Â·mâ»Â²Â·sâ´Â·A² using the current, or one of the historical, definitions of the SI units. + + "The farad is the capacitance of an electric capacitor between whose plates an electric potential difference of one volt appears when it is charged with an amount of electricity equal to one coulomb." [9th CGPM meeting in 1946] + + The farad was defined at the 9th CGPM Meeting in 1946, included in SI at the 11th CGPM meeting in 1960, resolution 12 and implicitly redefined via the redefinitions of the second at the 13th CGPM Meeting in 1967, resolution 1, and the redefinitions of the ampere and kilogram at the 26th CGPM Meeting in 2018, resolution 1 + + This is a generalized definition taken to reference the current, or one of the historical, SI unit definitions. + This definition is intended for situations when it is not possible to be more precise, e.g., in contexts where data have been collected that uses different historical SI definitions. +compatibility: + - "https://schemas.optimade.org/defs/v1.2/units/si/1960/named/farad" + - "https://schemas.optimade.org/defs/v1.2/units/si/1967/named/farad" + - "https://schemas.optimade.org/defs/v1.2/units/si/1983/named/farad" + - "https://schemas.optimade.org/defs/v1.2/units/si/2019/named/farad" +resources: + - relation: "Definition and establishment of the SI unit system at the 11th CGPM meeting (1960), resolution 12." + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/11-1960/resolution-12" + - relation: "Redefinition of the second in the 13th CGPM Meeting (1967), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/13-1967/resolution-1" + - relation: "Redefinition of the kilogram and ampere in the 26th CGPM Meeting (2018), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/26-2018/resolution-1" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Farad" +defining-relation: + base-units: + - symbol: "A" + id: "https://schemas.optimade.org/defs/v1.2/units/si/general/ampere" + - symbol: "kg" + id: "https://schemas.optimade.org/defs/v1.2/units/si/general/kilogram" + - symbol: "m" + id: "https://schemas.optimade.org/defs/v1.2/units/si/general/metre" + - symbol: "s" + id: "https://schemas.optimade.org/defs/v1.2/units/si/general/second" + base-units-expression: "A^2*kg^-1*m^-2*s^4" +x-optimade-definition: + label: "farad_si_general" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "farad" diff --git a/schemas/src/defs/v1.2/units/si/general/gal.yaml b/schemas/src/defs/v1.2/units/si/general/gal.yaml new file mode 100644 index 000000000..ccbd666f4 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/general/gal.yaml @@ -0,0 +1,44 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/general/gal" +title: "gal" +symbol: "Gal" +display-symbol: "Gal" +description: |- + A unit of acceleration equal to 1 centimeter per second squared (1 cm/s²), using the current, or one of the historical, definitions of the SI units. + + The gal unit appears in the International System of Units (SI), 1st ed. (1970) defined as "1 Gal = 1 cm/s² = 10â»Â² m/s²" with the footnote "The gal is a special unit of acceleration employed in geodesy and geophysics to express acceleration due to gravity." + + - The International System of Units (SI), 1st ed. (1970) categorizes the unit as "units in use temporarily". + - The International System of Units (SI), 7th ed. (1998) changes the categorization to "derived CGS units with special names". + - The International System of Units (SI), 9th ed. (2019) moves the unit definition to the margin aside the table for Non-SI units accepted for use with the SI units. + It is not clear how to interpret the categorization intended with this placement of the unit. + + The galileo unit was implicitly redefined via the redefinition of the metre at the 17th CGPM meeting (1983), resolution 1. + + This is a generalized definition taken to reference the current, or one of the historical, SI unit definitions. + This definition is intended for situations when it is not possible to be more precise, e.g., in contexts where data have been collected that uses different historical SI definitions. +compatibility: + - "https://schemas.optimade.org/defs/v1.2/units/si/1970/temporary/gal" + - "https://schemas.optimade.org/defs/v1.2/units/si/1983/temporary/gal" +resources: + - relation: "Definition in the International System of Units (SI), 1st Edition" + resource-id: "https://www.bipm.org/en/publications/si-brochure" + - relation: "Redefinition of the metre at the 17th CGPM meeting (1983), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/17-1983/resolution-1" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Gal_(unit)" +defining-relation: + base-units: + - symbol: "m" + id: "https://schemas.optimade.org/defs/v1.2/units/si/general/metre" + - symbol: "s" + id: "https://schemas.optimade.org/defs/v1.2/units/si/general/second" + base-units-expression: "m*s^-2" + scale: + exponent: -2 +x-optimade-definition: + label: "gal_si_general" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "gal" diff --git a/schemas/src/defs/v1.2/units/si/general/gray.yaml b/schemas/src/defs/v1.2/units/si/general/gray.yaml new file mode 100644 index 000000000..bc5dcb77b --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/general/gray.yaml @@ -0,0 +1,37 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/general/gray" +title: "gray" +symbol: "Gy" +display-symbol: "Gy" +description: |- + A unit for absorbed dose of ionizing radiation equal to m²·sâ»Â² using the current, or one of the historical, definitions of the SI units. + + "The 15th Conférence Générale des Poids et Mesures, [...] adopts the following special name for the SI unit of ionizing radiation: gray, symbol Gy, equal to one joule per kilogram." [15th CGPM Meeting (1975)] + + The gray was defined at the 15th CGPM Meeting in 1975, and implicitly redefined via the redefinition of the meter at the 17th CGPM Meeting in 1983, resolution 1. + + This is a generalized definition taken to reference the current, or one of the historical, SI unit definitions. + This definition is intended for situations when it is not possible to be more precise, e.g., in contexts where data have been collected that uses different historical SI definitions. +compatibility: + - "https://schemas.optimade.org/defs/v1.2/units/si/1975/named/gray" + - "https://schemas.optimade.org/defs/v1.2/units/si/1983/named/gray" +resources: + - relation: "Definition at the 15th CGPM Meeting (1975)" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/15-1975" + - relation: "Redefinition of the metre at the 17th CGPM meeting (1983), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/17-1983/resolution-1" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Gray_(unit)" +defining-relation: + base-units: + - symbol: "m" + id: "https://schemas.optimade.org/defs/v1.2/units/si/general/metre" + - symbol: "s" + id: "https://schemas.optimade.org/defs/v1.2/units/si/general/second" + base-units-expression: "m^2*s^-2" +x-optimade-definition: + label: "gray_si_general" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "gray" diff --git a/schemas/src/defs/v1.2/units/si/general/hectare.yaml b/schemas/src/defs/v1.2/units/si/general/hectare.yaml new file mode 100644 index 000000000..0de216ae7 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/general/hectare.yaml @@ -0,0 +1,41 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/general/hectare" +title: "hectare" +symbol: "ha" +display-symbol: "ha" +description: |- + A unit of area equal to 1000 square meters (1 hm²), using the current, or one of the historical, definitions of the SI units. + + The hectare unit appears in the International System of Units (SI), 1st ed. (1970) defined as "1 ha = 1 hm² = 10â´ m²" with the footnote "This unit and its symbol were adopted by the International Committee in 1879 (Proces-Verbaux C.I.P.M., 1879, p. 41)." + + - The International System of Units (SI), 1st ed. (1970) categorizes the unit as "units in use temporarily". + - The International System of Units (SI), 5th ed. (1985) add the clarification that the unit is "used to express agrarian areas." + - The International System of Units (SI), 7th ed. (1998) changes the categorization to "Other non-SI units currently accepted for use with the International System." + + The hectare unit was implicitly redefined via the redefinition of the metre at the 17th CGPM meeting (1983), resolution 1. + + This is a generalized definition taken to reference the current, or one of the historical, SI unit definitions. + This definition is intended for situations when it is not possible to be more precise, e.g., in contexts where data have been collected that uses different historical SI definitions. +compatibility: + - "https://schemas.optimade.org/defs/v1.2/units/si/1970/temporary/hectare" + - "https://schemas.optimade.org/defs/v1.2/units/si/1983/temporary/hectare" +resources: + - relation: "Definition in the International System of Units (SI), 9th Edition" + resource-id: "https://www.bipm.org/en/publications/si-brochure" + - relation: "Redefinition of the metre at the 17th CGPM meeting (1983), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/17-1983/resolution-1" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Hectare" +defining-relation: + base-units: + - symbol: "m" + id: "https://schemas.optimade.org/defs/v1.2/units/si/general/metre" + base-units-expression: "m^2" + scale: + exponent: 4 +x-optimade-definition: + label: "hectare_si_general" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "hectare" diff --git a/schemas/src/defs/v1.2/units/si/general/henry.yaml b/schemas/src/defs/v1.2/units/si/general/henry.yaml new file mode 100644 index 000000000..5f93b55be --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/general/henry.yaml @@ -0,0 +1,47 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/general/henry" +title: "henry" +symbol: "H" +display-symbol: "H" +description: |- + A unit for inductance equal to kg·m²·sâ»Â²Â·Aâ»Â² using the current, or one of the historical, definitions of the SI units. + + "The henry is the inductance of a closed circuit in which an electromotive force of one volt is produced when the electric current passing through the circuit varies uniformly at a rate of one ampere per second." [9th CGPM meeting in 1946] + + The henry was defined at the 9th CGPM Meeting in 1946, included in SI at the 11th CGPM meeting in 1960, resolution 12, and implicitly redefined via the redefinitions of the second at the 13th CGPM Meeting in 1967, resolution 1, the metre at the 17th CGPM meeting (1983), resolution 1, and the kilogram and ampere at the 26th CGPM Meeting (2018), resolution 1. + + This is a generalized definition taken to reference the current, or one of the historical, SI unit definitions. + This definition is intended for situations when it is not possible to be more precise, e.g., in contexts where data have been collected that uses different historical SI definitions. +compatibility: + - "https://schemas.optimade.org/defs/v1.2/units/si/1960/named/henry" + - "https://schemas.optimade.org/defs/v1.2/units/si/1967/named/henry" + - "https://schemas.optimade.org/defs/v1.2/units/si/1983/named/henry" + - "https://schemas.optimade.org/defs/v1.2/units/si/2019/named/henry" +resources: + - relation: "Definition and establishment of the SI unit system at the 11th CGPM meeting (1960), resolution 12." + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/11-1960/resolution-12" + - relation: "Redefinition of the metre at the 17th CGPM meeting (1983), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/17-1983/resolution-1" + - relation: "Redefinition of the second at the 13th CGPM Meeting (1967), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/13-1967/resolution-1" + - relation: "Redefinition of the kilogram and ampere at the 26th CGPM Meeting (2018), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/26-2018/resolution-1" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Henry_(unit)" +defining-relation: + base-units: + - symbol: "A" + id: "https://schemas.optimade.org/defs/v1.2/units/si/general/ampere" + - symbol: "kg" + id: "https://schemas.optimade.org/defs/v1.2/units/si/general/kilogram" + - symbol: "m" + id: "https://schemas.optimade.org/defs/v1.2/units/si/general/metre" + - symbol: "s" + id: "https://schemas.optimade.org/defs/v1.2/units/si/general/second" + base-units-expression: "A^-2*kg*m^2*s^-2" +x-optimade-definition: + label: "henry_si_general" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "henry" diff --git a/schemas/src/defs/v1.2/units/si/general/hertz.yaml b/schemas/src/defs/v1.2/units/si/general/hertz.yaml new file mode 100644 index 000000000..30400e567 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/general/hertz.yaml @@ -0,0 +1,37 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/general/hertz" +title: "hertz" +symbol: "Hz" +display-symbol: "Hz" +description: |- + A unit for frequency equal to sâ»Â¹ using the current, or one of the historical, definitions of the SI units. + + "The frequency of a periodic phenomenon is expressed in hertz, as the inverse of its period expressed in seconds." [9th CGPM meeting in 1946] + + The hertz was defined at the 9th CGPM Meeting in 1946, included in SI at the 11th CGPM meeting in 1960, resolution 12 and implicitly redefined via the redefinition of the second at the 13th CGPM Meeting in 1967, resolution 1. + + This is a generalized definition taken to reference the current, or one of the historical, SI unit definitions. + This definition is intended for situations when it is not possible to be more precise, e.g., in contexts where data have been collected that uses different historical SI definitions. +compatibility: + - "https://schemas.optimade.org/defs/v1.2/units/si/1960/named/hertz" + - "https://schemas.optimade.org/defs/v1.2/units/si/1967/named/hertz" +resources: + - relation: "Definition at the 9th CGPM meeting (1948)" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/9-1948" + - relation: "Definition and establishment of the SI unit system at the 11th CGPM meeting (1960), resolution 12." + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/11-1960/resolution-12" + - relation: "Redefinition of the second in the 13th CGPM Meeting (1967), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/13-1967/resolution-1" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Hertz" +defining-relation: + base-units: + - symbol: "s" + id: "https://schemas.optimade.org/defs/v1.2/units/si/general/second" + base-units-expression: "s^-1" +x-optimade-definition: + label: "hertz_si_general" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "hertz" diff --git a/schemas/src/defs/v1.2/units/si/general/hour.yaml b/schemas/src/defs/v1.2/units/si/general/hour.yaml new file mode 100644 index 000000000..4ae59c757 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/general/hour.yaml @@ -0,0 +1,35 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/general/hour" +title: "hour" +symbol: "h" +display-symbol: "h" +description: |- + A unit of time equal to 60 minutes, or 3600 seconds, using the current, or one of the historical, definitions of the SI units. + + The hour unit appears in the International System of Units (SI), 1st ed. (1970) defined as "1 h = 60 min = 3600 s". + + - The International System of Units (SI), 1st ed. (1970) categorizes the unit as "Units in use with the International System." + - The International System of Units (SI), 7th ed. (1998) changes the categorization to "Non-SI units accepted for use with the International System." + + This is a generalized definition taken to reference the current, or one of the historical, SI unit definitions. + This definition is intended for situations when it is not possible to be more precise, e.g., in contexts where data have been collected that uses different historical SI definitions. +compatibility: + - "https://schemas.optimade.org/defs/v1.2/units/si/1970/accepted/hour" +resources: + - relation: "Definition in the International System of Units (SI), 1st Edition" + resource-id: "https://www.bipm.org/en/publications/si-brochure" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Hour" +defining-relation: + base-units: + - symbol: "s" + id: "https://schemas.optimade.org/defs/v1.2/units/si/general/second" + base-units-expression: "s" + scale: + numerator: 3600 +x-optimade-definition: + label: "hour_si_general" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "hour" diff --git a/schemas/src/defs/v1.2/units/si/general/joule.yaml b/schemas/src/defs/v1.2/units/si/general/joule.yaml new file mode 100644 index 000000000..dbd5ac0ac --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/general/joule.yaml @@ -0,0 +1,47 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/general/joule" +title: "joule" +symbol: "J" +display-symbol: "J" +description: |- + A derived SI unit for energy, work, and heat equal to kg·m²·sâ»Â² using the current, or one of the historical, definitions of the SI units. + + "The joule is the work produced by a newton whose point of application moves one meter in the direction of the force." [9th CGPM meeting in 1946] + + The joule was defined at the 9th CGPM Meeting in 1946, included in SI at the 11th CGPM meeting in 1960, resolution 12, implicitly redefined via the redefinitions of the second at the 13th CGPM Meeting in 1967, resolution 1, the metre at the 17th CGPM meeting (1983), resolution 1, and the kilogram at the 26th CGPM Meeting (2018), resolution 1. + + This is a generalized definition taken to reference the current, or one of the historical, SI unit definitions. + This definition is intended for situations when it is not possible to be more precise, e.g., in contexts where data have been collected that uses different historical SI definitions. +compatibility: + - "https://schemas.optimade.org/defs/v1.2/units/si/1960/named/joule" + - "https://schemas.optimade.org/defs/v1.2/units/si/1967/named/joule" + - "https://schemas.optimade.org/defs/v1.2/units/si/1983/named/joule" + - "https://schemas.optimade.org/defs/v1.2/units/si/2019/named/joule" +resources: + - relation: "Definition at the 9th CGPM meeting (1948)" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/9-1948" + - relation: "Definition and establishment of the SI unit system at the 11th CGPM meeting (1960), resolution 12." + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/11-1960/resolution-12" + - relation: "Redefinition of the metre at the 17th CGPM meeting (1983), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/17-1983/resolution-1" + - relation: "Redefinition of the second in the 13th CGPM Meeting (1967), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/13-1967/resolution-1" + - relation: "Redefinition of the kilogram at the 26th CGPM Meeting (2018), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/26-2018/resolution-1" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Joule" +defining-relation: + base-units: + - symbol: "kg" + id: "https://schemas.optimade.org/defs/v1.2/units/si/general/kilogram" + - symbol: "m" + id: "https://schemas.optimade.org/defs/v1.2/units/si/general/metre" + - symbol: "s" + id: "https://schemas.optimade.org/defs/v1.2/units/si/general/second" + base-units-expression: "kg*m^2*s^-2" +x-optimade-definition: + label: "joule_si_general" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "joule" diff --git a/schemas/src/defs/v1.2/units/si/general/katal.yaml b/schemas/src/defs/v1.2/units/si/general/katal.yaml new file mode 100644 index 000000000..26a559310 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/general/katal.yaml @@ -0,0 +1,33 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/general/katal" +title: "katal" +symbol: "kat" +display-symbol: "kat" +description: |- + A derived SI unit for catalytic activity, defined as mol·sâ»Â¹ using the current, or one of the historical, definitions of the SI units. + + "The 21st Conférence Générale des Poids et Mesures, [...] decides to adopt the special name katal, symbol kat, for the SI unit mole per second to express catalytic activity, especially in the fields of medicine and biochemistry, and recommends that when the katal is used, the measurand be specified by reference to the measurement procedure; the measurement procedure must identify the indicator reaction." [21st CGPM meeting (1999), resolution 12] + + The katal unit was implicitly redefined via the redefinition of the mole at the 26th CGPM Meeting (2018), resolution 1. + + This is a generalized definition taken to reference the current, or one of the historical, SI unit definitions. + This definition is intended for situations when it is not possible to be more precise, e.g., in contexts where data have been collected that uses different historical SI definitions. +compatibility: + - "https://schemas.optimade.org/defs/v1.2/units/si/1999/named/katal" + - "https://schemas.optimade.org/defs/v1.2/units/si/2019/named/katal" +resources: + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Katal" +defining-relation: + base-units: + - symbol: "mol" + id: "https://schemas.optimade.org/defs/v1.2/units/si/general/mole" + - symbol: "s" + id: "https://schemas.optimade.org/defs/v1.2/units/si/general/second" + base-units-expression: "mol*s^-1" +x-optimade-definition: + label: "katal_si_general" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "katal" diff --git a/schemas/src/defs/v1.2/units/si/general/kelvin.yaml b/schemas/src/defs/v1.2/units/si/general/kelvin.yaml new file mode 100644 index 000000000..3bb06bcaf --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/general/kelvin.yaml @@ -0,0 +1,32 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/general/kelvin" +title: "kelvin" +symbol: "K" +display-symbol: "K" +description: |- + A unit of thermodynamic temperature using the current, or one of the historical, definitions of the SI units. + + The current definition at the 26th CGPM Meeting in 2018, resolution 1 is: "The kelvin, symbol K, is the SI unit of thermodynamic temperature. It is defined by taking the fixed numerical value of the Boltzmann constant k to be 1.380649×10â»Â²Â³ when expressed in the unit Jâ‹…Kâ»Â¹, which is equal to kgâ‹…m²⋅sâ»Â²â‹…Kâ»Â¹, where the kilogram, metre and second are defined in terms of \(h\), \(c\) and \(\Delta \nu_\textrm{Cs}\)." [26th CGPM Meeting (2018), resolution 1]. + + The prior definition at the 13th CGPM Meeting in 1967, resolution 4, was: "The kelvin, unit of thermodynamic temperature, is the fraction 1/273.16 of the thermodynamic temperature of the triple point of water." + This definition changed the symbol and rephrased the definition of the unit "degree Kelvin" from the 10th CGPM meeting in 1954: "The 10th Conférence Générale des Poids et Mesures decides to define the thermodynamic temperature scale by choosing the triple point of water as the fundamental fixed point, and assigning to it the temperature 273.16 degrees Kelvin, exactly." + + This is a generalized definition taken to reference the current, or one of the historical, SI unit definitions. + This definition is intended for situations when it is not possible to be more precise, e.g., in contexts where data have been collected that uses different historical SI definitions. +compatibility: + - "https://schemas.optimade.org/defs/v1.2/units/si/1967/base/kelvin" + - "https://schemas.optimade.org/defs/v1.2/units/si/2019/base/kelvin" + - "https://schemas.optimade.org/defs/v1.2/units/si/1960/base/degreekelvin" +resources: + - relation: "Definition in the 26th CGPM Meeting in 2018, resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/26-2018/resolution-1" + - relation: "Definition in the International System of Units (SI), 9th Edition" + resource-id: "https://www.bipm.org/en/publications/si-brochure" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Kelvin" +x-optimade-definition: + label: "kelvin_si_general" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "kelvin" diff --git a/schemas/src/defs/v1.2/units/si/general/kilogram.yaml b/schemas/src/defs/v1.2/units/si/general/kilogram.yaml new file mode 100644 index 000000000..316c21516 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/general/kilogram.yaml @@ -0,0 +1,30 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/general/kilogram" +title: "kilogram" +symbol: "kg" +display-symbol: "kg" +description: |- + A unit of mass using the current, or one of the historical, definitions of the SI units. + + The current definition at the 26th CGPM Meeting in 2018, resolution 1 is: "The kilogram, symbol kg, is the SI unit of mass. It is defined by taking the fixed numerical value of the Planck constant \(h\) to be 6.62607015×10â»Â³â´ when expressed in the unit Jâ‹…s, which is equal to kgâ‹…m²⋅sâ»Â¹, where the metre and the second are defined in terms of \(c\) and \(\Delta \nu_\textrm{Cs}\)." + + The prior definition at the 1st CGPM Meeting (1889) was: "The prototype of the kilogram adopted by the International Committee; This prototype will henceforth be considered as the unit of mass;", referring to the international prototype of the kilogram made of platinum-iridium. + + This is a generalized definition taken to reference the current, or one of the historical, SI unit definitions. + This definition is intended for situations when it is not possible to be more precise, e.g., in contexts where data have been collected that uses different historical SI definitions. +compatibility: + - "https://schemas.optimade.org/defs/v1.2/units/si/1960/base/kilogram" + - "https://schemas.optimade.org/defs/v1.2/units/si/2019/base/kilogram" +resources: + - relation: "Definition in the 26th CGPM Meeting in 2018, resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/26-2018/resolution-1" + - relation: "Definition in the International System of Units (SI), 9th Edition" + resource-id: "https://www.bipm.org/en/publications/si-brochure" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Kilogram" +x-optimade-definition: + label: "kilogram_si_general" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "kilogram" diff --git a/schemas/src/defs/v1.2/units/si/general/knot.yaml b/schemas/src/defs/v1.2/units/si/general/knot.yaml new file mode 100644 index 000000000..3cc1b96b4 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/general/knot.yaml @@ -0,0 +1,45 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/general/knot" +title: "knot" +symbol: "knot" +display-symbol: "knot" +description: |- + A unit of speed primarily used in navigation defined as 1 nautical mile per hour which is equal to (1852/3600) m/s using the current, or one of the historical, definitions of the SI units. + + The knot unit appears in the International System of Units (SI), 1st ed. (1970) defined as "1 nautical mile per hour = (1852/3600) m/s." + + - The International System of Units (SI), 1st ed. (1970) categorizes the unit as "Units in use temporarily with the International System." + - The International System of Units (SI), 7th ed. (1998) changes the categorization to "Other non-SI units currently accepted for use with the International System." + - The International System of Units (SI), 8th ed. (2006) changes the categorization to "Other non-SI units." + - The knot is omitted in the International System of Units (SI), 9th Edition (2019). + + The knot unit was implicitly redefined via the redefinition of the metre at the 17th CGPM meeting (1983), resolution 1. + + This is a generalized definition taken to reference the current, or one of the historical, SI unit definitions. + This definition is intended for situations when it is not possible to be more precise, e.g., in contexts where data have been collected that uses different historical SI definitions. +compatibility: + - "https://schemas.optimade.org/defs/v1.2/units/si/1970/temporary/knot" + - "https://schemas.optimade.org/defs/v1.2/units/si/1983/temporary/knot" +resources: + - relation: "Definition in the International System of Units (SI), 1st Edition" + resource-id: "https://www.bipm.org/en/publications/si-brochure" + - relation: "Redefinition of the metre at the 17th CGPM meeting (1983), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/17-1983/resolution-1" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Knot_(unit)" +defining-relation: + base-units: + - symbol: "m" + id: "https://schemas.optimade.org/defs/v1.2/units/si/general/metre" + - symbol: "s" + id: "https://schemas.optimade.org/defs/v1.2/units/si/general/second" + base-units-expression: "ms^-1" + scale: + numerator: 1852 + denominator: 3600 +x-optimade-definition: + label: "knot_si_general" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "knot" diff --git a/schemas/src/defs/v1.2/units/si/general/litre.yaml b/schemas/src/defs/v1.2/units/si/general/litre.yaml new file mode 100644 index 000000000..121323183 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/general/litre.yaml @@ -0,0 +1,40 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/general/litre" +title: "litre" +symbol: "l" +display-symbol: "l" +alternate-symbols: + - "L" + - "liter" +description: |- + The litre, or liter is a unit of volume equal to a cubic decimetre (1 dm³) using the current, or one of the historical, definitions of the SI units. + + "The 12th Conférence Générale des Poids et Mesures (CGPM) [...] declares that the word 'litre' may be employed as a special name for the cubic decimetre" [12th CGPM meeting (1964), resolution 6]. + + The litre was defined at the 12th CGPM meeting in 1964, resolution 6, and implicitly redefined with the redefinition of the metre at the 17th CGPM Meeting in 1983, resolution 1. + + This is a generalized definition taken to reference the current, or one of the historical, SI unit definitions. + This definition is intended for situations when it is not possible to be more precise, e.g., in contexts where data have been collected that uses different historical SI definitions. +compatibility: + - "https://schemas.optimade.org/defs/v1.2/units/si/1964/accepted/litre" + - "https://schemas.optimade.org/defs/v1.2/units/si/1983/accepted/litre" +resources: + - relation: "Definition at the 12th CGPM meeting (1964), resolution 6" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/12-1964/resolution-6" + - relation: "Redefinition of the metre at the 17th CGPM meeting (1983), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/17-1983/resolution-1" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Litre" +defining-relation: + base-units: + - symbol: "m" + id: "https://schemas.optimade.org/defs/v1.2/units/si/general/metre" + base-units-expression: "m^3" + scale: + exponent: -3 +x-optimade-definition: + label: "litre_si_general" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "litre" diff --git a/schemas/src/defs/v1.2/units/si/general/lumen.yaml b/schemas/src/defs/v1.2/units/si/general/lumen.yaml new file mode 100644 index 000000000..60ea7403a --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/general/lumen.yaml @@ -0,0 +1,46 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/general/lumen" +title: "lumen" +symbol: "lm" +display-symbol: "lm" +description: |- + A derived SI unit for luminous flux equal to cd·sr using the current, or one of the historical, definitions of the SI units. + + "The lumen is the luminous flux emitted in a steradian by a uniform point source with a luminous intensity of one candela." [9th CGPM meeting in 1946] + + The lumen was defined at the 9th CGPM meeting in 1946, implicitly redefined via the redefinitions of the second at the 13th CGPM Meeting in 1967, resolution 1, the candela at the 16th CGPM Meeting in 1979, resolution 3, the metre at the 17th CGPM Meeting in 1983, resolution 1, and the candela (implicitly redefined via the kilogram) at the 26th CGPM Meeting (2018), resolution 1. + + This is a generalized definition taken to reference the current, or one of the historical, SI unit definitions. + This definition is intended for situations when it is not possible to be more precise, e.g., in contexts where data have been collected that uses different historical SI definitions. +compatibility: + - "https://schemas.optimade.org/defs/v1.2/units/si/1960/named/lumen" + - "https://schemas.optimade.org/defs/v1.2/units/si/1967/named/lumen" + - "https://schemas.optimade.org/defs/v1.2/units/si/1979/named/lumen" + - "https://schemas.optimade.org/defs/v1.2/units/si/1983/named/lumen" + - "https://schemas.optimade.org/defs/v1.2/units/si/2019/named/lumen" +resources: + - relation: "Definition and establishment of the SI unit system at the 11th CGPM meeting (1960), resolution 12." + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/11-1960/resolution-12" + - relation: "Redefinition of the candela at the 16th CGPM Meeting in 1979, resolution 3." + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/16-1979/resolution-3" + - relation: "Redefinition of the second in the 13th CGPM Meeting in 1967, resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/13-1967/resolution-1" + - relation: "Redefinition of the metre at the 17th CGPM meeting in 1983, resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/17-1983/resolution-1" + - relation: "Redefinition of the kilogram at the 26th CGPM Meeting (2018), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/26-2018/resolution-1" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Lumen_(unit)" +defining-relation: + base-units: + - symbol: "cd" + id: "https://schemas.optimade.org/defs/v1.2/units/si/general/candela" + - symbol: "sr" + id: "https://schemas.optimade.org/defs/v1.2/units/si/general/steradian" + base-units-expression: "cd*sr" +x-optimade-definition: + label: "lumen_si_general" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "lumen" diff --git a/schemas/src/defs/v1.2/units/si/general/lux.yaml b/schemas/src/defs/v1.2/units/si/general/lux.yaml new file mode 100644 index 000000000..90f116375 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/general/lux.yaml @@ -0,0 +1,50 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/general/lux" +title: "lux" +symbol: "lx" +display-symbol: "lx" +description: |- + A derived SI unit for illuminance equal to cdâ‹…srâ‹…mâ»Â² using the current, or one of the historical, definitions of the SI units. + + "The lux is the illuminance of a surface that receives a uniformly distributed luminous flux of one lumen per square meter." [9th CGPM meeting in 1946] + + The lux was defined at the 9th CGPM meeting in 1946, and implicitly redefined via the redefinitions of the second at the 13th CGPM Meeting in 1967, resolution 1, the candela at the 16th CGPM Meeting in 1979, resolution 3, the metre at the 17th CGPM meeting (1983), resolution 1, and the candela (implicitly redefined via the kilogram) at the 26th CGPM Meeting (2018), resolution 1. + + This is a generalized definition taken to reference the current, or one of the historical, SI unit definitions. + This definition is intended for situations when it is not possible to be more precise, e.g., in contexts where data have been collected that uses different historical SI definitions. +compatibility: + - "https://schemas.optimade.org/defs/v1.2/units/si/1960/named/lux" + - "https://schemas.optimade.org/defs/v1.2/units/si/1967/named/lux" + - "https://schemas.optimade.org/defs/v1.2/units/si/1979/named/lux" + - "https://schemas.optimade.org/defs/v1.2/units/si/1983/named/lux" + - "https://schemas.optimade.org/defs/v1.2/units/si/2019/named/lux" +resources: + - relation: "Definition at the 9th CGPM meeting (1948)" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/9-1948" + - relation: "Definition and establishment of the SI unit system at the 11th CGPM meeting (1960), resolution 12." + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/11-1960/resolution-12" + - relation: "Redefinition of the candela at the 16th CGPM Meeting in 1979, resolution 3." + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/16-1979/resolution-3" + - relation: "Redefinition of the metre at the 17th CGPM meeting (1983), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/17-1983/resolution-1" + - relation: "Redefinition of the second in the 13th CGPM Meeting (1967), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/13-1967/resolution-1" + - relation: "Redefinition of the kilogram at the 26th CGPM Meeting (2018), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/26-2018/resolution-1" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Lux" +defining-relation: + base-units: + - symbol: "cd" + id: "https://schemas.optimade.org/defs/v1.2/units/si/general/candela" + - symbol: "sr" + id: "https://schemas.optimade.org/defs/v1.2/units/si/general/steradian" + - symbol: "m" + id: "https://schemas.optimade.org/defs/v1.2/units/si/general/metre" + base-units-expression: "cd*m^-2*sr" +x-optimade-definition: + label: "lux_si_general" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "lux" diff --git a/schemas/src/defs/v1.2/units/si/general/metre.yaml b/schemas/src/defs/v1.2/units/si/general/metre.yaml new file mode 100644 index 000000000..6d3a49a04 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/general/metre.yaml @@ -0,0 +1,35 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/general/metre" +title: "metre" +symbol: "m" +display-symbol: "m" +alternate-symbols: + - "metre" + - "meter" +description: |- + The metre, or meter, is a unit of length using the current, or one of the historical, definitions of the SI units. + + The current definition in its most recent phrasing at the 26th CGPM Meeting in 2018, resolution 1 is: "The metre, symbol m, is the SI unit of length. It is defined by taking the fixed numerical value of the speed of light in vacuum \(c\) to be 299792458 when expressed in the unit mâ‹…sâ»Â¹, where the second is defined in terms of the caesium frequency \(\Delta \nu_\textrm{Cs}\)." + + This is a rephrasing of a definition at the 17th CGPM Meeting (1983), resolution 1: "The metre is the length of the path travelled by light in vacuum during a time interval of 1/299792458 of a second." [17th CGPM Meeting (1983), resolution 1]. + + The prior definition at the 11th CGPM meeting (1960), resolution 6 was: "The metre is the length equal to 1650763.73 wavelengths in vacuum of the radiation corresponding to the transition between the levels 2pâ‚â‚€ and 5dâ‚… of the krypton 86 atom." + + This is a generalized definition taken to reference the current, or one of the historical, SI unit definitions. + This definition is intended for situations when it is not possible to be more precise, e.g., in contexts where data have been collected that uses different historical SI definitions. +compatibility: + - "https://schemas.optimade.org/defs/v1.2/units/si/1960/base/metre" + - "https://schemas.optimade.org/defs/v1.2/units/si/1983/base/metre" +resources: + - relation: "Definition at the 17th CGPM meeting (1983), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/17-1983/resolution-1" + - relation: "Definition at the 11th CGPM meeting (1960), resolution 6." + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/11-1960/resolution-6" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Metre" +x-optimade-definition: + label: "metre_si_general" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "metre" diff --git a/schemas/src/defs/v1.2/units/si/general/minute.yaml b/schemas/src/defs/v1.2/units/si/general/minute.yaml new file mode 100644 index 000000000..b4b053d8d --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/general/minute.yaml @@ -0,0 +1,35 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/general/minute" +title: "minute" +symbol: "min" +display-symbol: "min" +description: |- + A unit of time that is equal to 60 seconds, using the current, or one of the historical, definitions of the SI units. + + The minute unit appears in the International System of Units (SI), 1st ed. (1970) defined as "1 min = 60 s". + + - The International System of Units (SI), 1st ed. (1970) categorizes the unit as "Units in use with the International System." + - The International System of Units (SI), 7th ed. (1998) changes the categorization to "Non-SI units accepted for use with the International System." + + This is a generalized definition taken to reference the current, or one of the historical, SI unit definitions. + This definition is intended for situations when it is not possible to be more precise, e.g., in contexts where data have been collected that uses different historical SI definitions. +compatibility: + - "https://schemas.optimade.org/defs/v1.2/units/si/1970/accepted/minute" +resources: + - relation: "Definition in the International System of Units (SI), 1st Edition" + resource-id: "https://www.bipm.org/en/publications/si-brochure" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Minute" +defining-relation: + base-units: + - symbol: "s" + id: "https://schemas.optimade.org/defs/v1.2/units/si/general/second" + base-units-expression: "s" + scale: + numerator: 60 +x-optimade-definition: + label: "minute_si_general" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "minute" diff --git a/schemas/src/defs/v1.2/units/si/general/mole.yaml b/schemas/src/defs/v1.2/units/si/general/mole.yaml new file mode 100644 index 000000000..a2091f8e4 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/general/mole.yaml @@ -0,0 +1,34 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/general/mole" +title: "mole" +symbol: "mol" +display-symbol: "mol" +description: |- + A unit of amount of substance using the current, or one of the historical, definitions of the SI units. + + The current definition at the 26th CGPM Meeting in 2018, resolution 1 is: "The mole, symbol mol, is the SI unit of amount of substance. One mole contains exactly 6.02214076×10²³ elementary entities. This number is the fixed numerical value of the Avogadro constant, \(N_A\), when expressed in the unit molâ»Â¹ and is called the Avogadro number. The amount of substance, symbol \(n\), of a system is a measure of the number of specified elementary entities. An elementary entity may be an atom, a molecule, an ion, an electron, any other particle or specified group of particles." + + The prior definition at the 14th CGPM Meeting (1971), resolution 3 was: "1. The mole is the amount of substance of a system which contains as many elementary entities as there are atoms in 0.012 kilogram of carbon 12. 2. When the mole is used, the elementary entities must be specified and may be atoms, molecules, ions, electrons, other particles, or specified groups of such particles." This definition was clarified at the 69th CIPM meeting in 1980 by appending: "In this definition, it is understood that unbound atoms of carbon 12, at rest and in their ground state, are referred to." + + This is a generalized definition taken to reference the current, or one of the historical, SI unit definitions. + This definition is intended for situations when it is not possible to be more precise, e.g., in contexts where data have been collected that uses different historical SI definitions. +compatibility: + - "https://schemas.optimade.org/defs/v1.2/units/si/1971/base/mole" + - "https://schemas.optimade.org/defs/v1.2/units/si/2019/base/mole" +resources: + - relation: "Definition in the 26th CGPM Meeting in 2018, resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/26-2018/resolution-1" + - relation: "Definition in the 14th CGPM Meeting in 1971, resolution 3" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/14-1971/resolution-3" + - relation: "Clarification in the 96th meeting of the CIPM" + resource-id: "https://www.bipm.org/en/committees/ci/cipm/69-1980" + - relation: "Definition in the International System of Units (SI), 9th Edition" + resource-id: "https://www.bipm.org/en/publications/si-brochure" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Mole_(unit)" +x-optimade-definition: + label: "mole_si_general" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "mole" diff --git a/schemas/src/defs/v1.2/units/si/general/nauticalmile.yaml b/schemas/src/defs/v1.2/units/si/general/nauticalmile.yaml new file mode 100644 index 000000000..f691026a5 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/general/nauticalmile.yaml @@ -0,0 +1,47 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/general/nauticalmile" +title: "nautical mile" +symbol: "M" +display-symbol: "M" +alternate-symbols: + - "NM" + - "Nm" + - "nmi" +description: |- + A unit of length primarily used in navigation defined as 1852 m using the current, or one of the historical, definitions of the SI units. + + The nautical mile unit appears in the International System of Units (SI), 1st ed. (1970) defined as "1 nautical mile = 1852 m" with the footnote "The nautical mile is a special unit employed for marine and aerial navigation to express distance. The conventional value given above was adopted by the First International Extraordinary Hydrographic Conference, Monaco, 1929, under the name 'International nautical mile'." + Historically, the nautical mile was defined as the meridian arc length corresponding to one arcminute of latitude. + + - The International System of Units (SI), 1st ed. (1970) categorizes the unit as "Units in use temporarily with the International System." + - The International System of Units (SI), 7th ed. (1998) changes the categorization to "Other non-SI units currently accepted for use with the International System" and adds to the footnote that: "As yet there is no internationally agreed symbol. This unit was originally chosen because one nautical mile on the surface of the Earth subtends approximately one minute of angle at the centre." + - The International System of Units (SI), 8th ed. (2006) changes the categorization to "Other non-SI units" and adjusts the footnote to say: "As yet there is no internationally agreed symbol, but the symbols M, NM, Nm, and nmi are all used; in the table the symbol M is used. The unit was originally chosen, and continues to be used, because one nautical mile on the surface of the Earth subtends approximately one minute of angle at the centre of the Earth, which is convenient when latitude and longitude are measured in degrees and minutes of angle." + - The nautical mile is omitted in the International System of Units (SI), 9th Edition (2019). + + The nautical mile unit was implicitly redefined via the redefinition of the metre at the 17th CGPM meeting (1983), resolution 1. + + This is a generalized definition taken to reference the current, or one of the historical, SI unit definitions. + This definition is intended for situations when it is not possible to be more precise, e.g., in contexts where data have been collected that uses different historical SI definitions. +compatibility: + - "https://schemas.optimade.org/defs/v1.2/units/si/1970/temporary/nauticalmile" + - "https://schemas.optimade.org/defs/v1.2/units/si/1983/temporary/nauticalmile" +resources: + - relation: "Definition in the International System of Units (SI), 1st Edition" + resource-id: "https://www.bipm.org/en/publications/si-brochure" + - relation: "Redefinition of the metre at the 17th CGPM meeting (1983), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/17-1983/resolution-1" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Nautical_mile" +defining-relation: + base-units: + - symbol: "m" + id: "https://schemas.optimade.org/defs/v1.2/units/si/general/metre" + base-units-expression: "m" + scale: + numerator: 1852 +x-optimade-definition: + label: "nauticalmile_si_general" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "nauticalmile" diff --git a/schemas/src/defs/v1.2/units/si/general/newton.yaml b/schemas/src/defs/v1.2/units/si/general/newton.yaml new file mode 100644 index 000000000..fff37ac0c --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/general/newton.yaml @@ -0,0 +1,45 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/general/newton" +title: "newton" +symbol: "N" +display-symbol: "N" +description: |- + A unit for force and weight equal to kg·m·sâ»Â² using the current, or one of the historical, definitions of the SI units. + + "The newton is the force that, in one second, imparts to a mass equal to one kilogram an increase in speed of one meter per second." [9th CGPM meeting in 1946] + + The newton was defined at the 9th CGPM Meeting in 1946, included in SI at the 11th CGPM meeting in 1960, resolution 12, implicitly redefined via the redefinitions of the second at the 13th CGPM Meeting in 1967, resolution 1, the metre at the 17th CGPM meeting (1983), resolution 1, and the kilogram at the 26th CGPM Meeting (2018), resolution 1. + + This is a generalized definition taken to reference the current, or one of the historical, SI unit definitions. + This definition is intended for situations when it is not possible to be more precise, e.g., in contexts where data have been collected that uses different historical SI definitions. +compatibility: + - "https://schemas.optimade.org/defs/v1.2/units/si/1960/named/newton" + - "https://schemas.optimade.org/defs/v1.2/units/si/1967/named/newton" + - "https://schemas.optimade.org/defs/v1.2/units/si/1983/named/newton" + - "https://schemas.optimade.org/defs/v1.2/units/si/2019/named/newton" +resources: + - relation: "Definition and establishment of the SI unit system at the 11th CGPM meeting (1960), resolution 12." + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/11-1960/resolution-12" + - relation: "Redefinition of the second in the 13th CGPM Meeting (1967), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/13-1967/resolution-1" + - relation: "Redefinition of the metre at the 17th CGPM meeting (1983), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/17-1983/resolution-1" + - relation: "Redefinition of the kilogram at the 26th CGPM Meeting (2018), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/26-2018/resolution-1" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Newton_(unit)" +defining-relation: + base-units: + - symbol: "kg" + id: "https://schemas.optimade.org/defs/v1.2/units/si/general/kilogram" + - symbol: "m" + id: "https://schemas.optimade.org/defs/v1.2/units/si/general/metre" + - symbol: "s" + id: "https://schemas.optimade.org/defs/v1.2/units/si/general/second" + base-units-expression: "kg*m*s^-2" +x-optimade-definition: + label: "newton_si_general" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "newton" diff --git a/schemas/src/defs/v1.2/units/si/general/ohm.yaml b/schemas/src/defs/v1.2/units/si/general/ohm.yaml new file mode 100644 index 000000000..d26023558 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/general/ohm.yaml @@ -0,0 +1,49 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/general/ohm" +title: "ohm" +symbol: "ohm" +display-symbol: "Ω" +description: |- + A unit for electrical resistance equal to kg·m²·sâ»Â³Â·Aâ»Â² using the current, or one of the historical, definitions of the SI units. + + "The ohm is the electrical resistance that exists between two points of a conductor when a constant potential difference of one volt, applied between these two points, produces a current of one ampere in the conductor, provided that the conductor is not the seat of any electromotive force." [9th CGPM meeting in 1946] + + The ohm was defined at the 9th CGPM Meeting in 1946, included in SI at the 11th CGPM meeting in 1960, resolution 12, implicitly redefined via the redefinitions of the second at the 13th CGPM Meeting in 1967, resolution 1, the metre at the 17th CGPM meeting (1983), resolution 1, and the kilogram and ampere at the 26th CGPM Meeting (2018), resolution 1. + + This is a generalized definition taken to reference the current, or one of the historical, SI unit definitions. + This definition is intended for situations when it is not possible to be more precise, e.g., in contexts where data have been collected that uses different historical SI definitions. +compatibility: + - "https://schemas.optimade.org/defs/v1.2/units/si/1960/named/ohm" + - "https://schemas.optimade.org/defs/v1.2/units/si/1967/named/ohm" + - "https://schemas.optimade.org/defs/v1.2/units/si/1983/named/ohm" + - "https://schemas.optimade.org/defs/v1.2/units/si/2019/named/ohm" +resources: + - relation: "Definition at the 9th CGPM meeting (1948)" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/9-1948" + - relation: "Definition and establishment of the SI unit system at the 11th CGPM meeting (1960), resolution 12." + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/11-1960/resolution-12" + - relation: "Redefinition of the metre at the 17th CGPM meeting (1983), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/17-1983/resolution-1" + - relation: "Redefinition of the second in the 13th CGPM Meeting (1967), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/13-1967/resolution-1" + - relation: "Redefinition of the kilogram and the ampere at the 26th CGPM Meeting (2018), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/26-2018/resolution-1" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Ohm" +defining-relation: + base-units: + - symbol: "A" + id: "https://schemas.optimade.org/defs/v1.2/units/si/general/ampere" + - symbol: "kg" + id: "https://schemas.optimade.org/defs/v1.2/units/si/general/kilogram" + - symbol: "m" + id: "https://schemas.optimade.org/defs/v1.2/units/si/general/metre" + - symbol: "s" + id: "https://schemas.optimade.org/defs/v1.2/units/si/general/second" + base-units-expression: "A^-2*kg*m^2*s^-3" +x-optimade-definition: + label: "ohm_si_general" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "ohm" diff --git a/schemas/src/defs/v1.2/units/si/general/parsec.yaml b/schemas/src/defs/v1.2/units/si/general/parsec.yaml new file mode 100644 index 000000000..266d846e5 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/general/parsec.yaml @@ -0,0 +1,35 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/general/parsec" +title: "parsec" +symbol: "pc" +display-symbol: "pc" +description: |- + A unit of length representing the distance at which 1 astronomical unit subtends an angle of 1 arcsecond using the current, or one of the historical, definitions of the SI units. + + The parsec unit appears in the International System of Units (SI), 1st ed. (1970) defined in a footnote as "1 parsec is the distance at which 1 astronomical unit subtends an angle of 1 arcsecond; therefore, approximately, 1 pc = 206 265 AU = 30 857 x 10¹² m." + + - The International System of Units (SI), 1st ed. (1970) categorizes the unit as "Units for use with the SI in specific domains." + - The International System of Units (SI), 2nd ed. (1973) categorizes the unit as "Non-SI units accepted for use with the International System, whose values in SI units are obtained experimentally." + - The International System of Units (SI), 4th ed. (1981) and later editions omit the unit. + + This is a generalized definition taken to reference the current, or one of the historical, SI unit definitions. + This definition is intended for situations when it is not possible to be more precise, e.g., in contexts where data have been collected that uses different historical SI definitions. +compatibility: + - "https://schemas.optimade.org/defs/v1.2/units/si/1970/accepted/parsec" +resources: + - relation: "Definition in the International System of Units (SI), 1st Edition" + resource-id: "https://www.bipm.org/en/publications/si-brochure" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Parsec" +approximate-relations: + - base-units: + - symbol: "m" + id: "https://schemas.optimade.org/defs/v1.2/units/si/general/metre" + scale: + value: 3.0857E+16 +x-optimade-definition: + label: "parsec_si_general" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "parsec" diff --git a/schemas/src/defs/v1.2/units/si/general/pascal.yaml b/schemas/src/defs/v1.2/units/si/general/pascal.yaml new file mode 100644 index 000000000..b21489564 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/general/pascal.yaml @@ -0,0 +1,42 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/general/pascal" +title: "pascal" +symbol: "Pa" +display-symbol: "Pa" +description: |- + A unit for pressure and stress equal to kg·mâ»Â¹Â·sâ»Â² using the current, or one of the historical, definitions of the SI units. + + "The International Committee will ask the General Conference to approve two special names: pascal (symbol Pa) for the SI unit of pressure (N/m²), [...]" [14th CGPM Meeting (1971)]. + + The pascal was defined at the 14th CGPM Meeting in 1971 and implicitly redefined via the redefinitions of the metre at the 17th CGPM Meeting in 1983, resolution 1, and the kilogram at the 26th CGPM Meeting (2018), resolution 1. + + This is a generalized definition taken to reference the current, or one of the historical, SI unit definitions. + This definition is intended for situations when it is not possible to be more precise, e.g., in contexts where data have been collected that uses different historical SI definitions. +compatibility: + - "https://schemas.optimade.org/defs/v1.2/units/si/1971/named/pascal" + - "https://schemas.optimade.org/defs/v1.2/units/si/1983/named/pascal" + - "https://schemas.optimade.org/defs/v1.2/units/si/2019/named/pascal" +resources: + - relation: "Definition at the 14th CGPM Meeting (1971)" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/14-1971" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Pascal_(unit)" + - relation: "Redefinition of the metre at the 17th CGPM meeting (1983), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/17-1983/resolution-1" + - relation: "Redefinition of the kilogram at the 26th CGPM Meeting (2018), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/26-2018/resolution-1" +defining-relation: + base-units: + - symbol: "kg" + id: "https://schemas.optimade.org/defs/v1.2/units/si/general/kilogram" + - symbol: "m" + id: "https://schemas.optimade.org/defs/v1.2/units/si/general/metre" + - symbol: "s" + id: "https://schemas.optimade.org/defs/v1.2/units/si/general/second" + base-units-expression: "kg*m^-1*s^-2" +x-optimade-definition: + label: "pascal_si_general" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "pascal" diff --git a/schemas/src/defs/v1.2/units/si/general/radian.yaml b/schemas/src/defs/v1.2/units/si/general/radian.yaml new file mode 100644 index 000000000..51c76eb62 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/general/radian.yaml @@ -0,0 +1,38 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/general/radian" +title: "radian" +symbol: "rad" +display-symbol: "rad" +alternate-symbols: + - "radian" +description: |- + A unit of plane angle representing the relation of the arc length on a circle intercepted at a given radius so that the full circle has an angle of 4Ï€ radians using the current, or one of the historical, definitions of the SI units. + + The radian is defined at the 9th CGPM Meeting in 1948 as: "The radian is the angle with its vertex at the center of a circle that intercepts an arc of length equal to the radius on the circumference of that circle." + + The International System of Units (SI), 9th ed. (2019) has a longer but equivalent definition: "The plane angle, expressed in radian, between two lines originating from a common point is the length of circular arc \(s\), swept out between the lines by a radius vector of length \(r\) from the common point divided by the length of the radius vector, \(\theta\) = \(s/r\) rad. The phase angle (often just referred to as the “phaseâ€) is the argument of any complex number. It is the angle between the positive real axis and the radius of the polar representation of the complex number in the complex plane. One radian corresponds to the angle for which \(s = r\), thus 1 rad = 1. The measure of the right angle is exactly equal to the number Ï€/2." + + The radian is categorized in the International System of Units (SI), 1st Edition as a supplementary SI unit. + At the 20th CGPM meeting in 1995, resolution 8 the categorization was changed to a dimensionless derived SI unit. + + This is a generalized definition taken to reference the current, or one of the historical, SI unit definitions. + This definition is intended for situations when it is not possible to be more precise, e.g., in contexts where data have been collected that uses different historical SI definitions. +compatibility: + - "https://schemas.optimade.org/defs/v1.2/units/si/1960/supplementary/radian" +resources: + - relation: "Definition at the 9th CGPM meeting (1948)" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/9-1948" + - relation: "Definition in the International System of Units (SI), 9th Edition" + resource-id: "https://www.bipm.org/en/publications/si-brochure" + - relation: "Establishment of the SI unit system at the 11th CGPM meeting (1960), resolution 12." + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/11-1960/resolution-12" + - relation: "Reclassification at the 20th CGPM meeting (1995)" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/20-1995/resolution-8" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Radian" +x-optimade-definition: + label: "radian_si_general" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "radian" diff --git a/schemas/src/defs/v1.2/units/si/general/radiationunit.yaml b/schemas/src/defs/v1.2/units/si/general/radiationunit.yaml new file mode 100644 index 000000000..66fdce512 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/general/radiationunit.yaml @@ -0,0 +1,46 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/general/radiationunit" +title: "radiation unit" +symbol: "radiationunit" +display-symbol: "rad" +description: |- + A unit used to express the absorbed dose of ionizing radiation defined as 10â»Â² J/kg using the current, or one of the historical, definitions of the SI units. + + This unit definition uses "radiationunit" as the symbol for this unit despite "rad" being in common use, to distinguish it from the radian, which is an SI unit with rad as its symbol. + + The radiation unit appears in the International System of Units (SI), 1st ed. (1970) defined as "1 rad = 10â»Â² J/kg" with the footnote: "The rad is a special unit employed to express absorbed dose of ionizing radiation. When there is risk of confusion with the symbol for radian, rd may be used as the symbol for rad." + + - The International System of Units (SI), 1st ed. (1970) categorizes the unit as "Units in use temporarily with the International System." + - The International System of Units (SI), 3rd ed. (1977) changes the definition to use the unit gray: "1 rad = cGy = 10â»Â² Gy." + - The International System of Units (SI), 7th ed. (1998) changes the categorization to "Examples of other non-SI units" and adds the additional footnote: "Note that this non-SI unit is exactly equivalent to an SI unit with an appropriate submultiple prefix." + - The International System of Units (SI), 8th ed. (2006) omits the unit. + + The roentgen unit was implicitly redefined via the redefinition of the metre at the 17th CGPM meeting (1983), resolution 1. + + This is a generalized definition taken to reference the current, or one of the historical, SI unit definitions. + This definition is intended for situations when it is not possible to be more precise, e.g., in contexts where data have been collected that uses different historical SI definitions. +compatibility: + - "https://schemas.optimade.org/defs/v1.2/units/si/1970/temporary/radiationunit" + - "https://schemas.optimade.org/defs/v1.2/units/si/1983/temporary/radiationunit" +resources: + - relation: "Definition in the International System of Units (SI), 1st Edition" + resource-id: "https://www.bipm.org/en/publications/si-brochure" + - relation: "Redefinition of the metre at the 17th CGPM meeting (1983), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/17-1983/resolution-1" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Rad_(radiation_unit)" +defining-relation: + base-units: + - symbol: "J" + id: "https://schemas.optimade.org/defs/v1.2/units/si/general/joule" + - symbol: "kg" + id: "https://schemas.optimade.org/defs/v1.2/units/si/general/kilogram" + base-units-expression: "J*kg^-1" + scale: + exponent: -2 +x-optimade-definition: + label: "radiationunit_si_general" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "radiationunit" diff --git a/schemas/src/defs/v1.2/units/si/general/rem.yaml b/schemas/src/defs/v1.2/units/si/general/rem.yaml new file mode 100644 index 000000000..93c8708dc --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/general/rem.yaml @@ -0,0 +1,36 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/general/rem" +title: "roentgen equivalent man" +symbol: "rem" +display-symbol: "rem" +description: |- + The "roentgen equivalent man" (rem) is a unit used in radioprotection meant to represent a dose of any ionizing radiation comparable in effect to one roentgen of high-voltage x-radiation, taken to be equal to 10â»Â² Sv using the current, or one of the historical, definitions of the SI units. + + The rem unit appears in the International System of Units (SI), 4th ed. (1981) defined as "1 rem = 1 cSv = 10â»Â² Sv" with the footnote: "The rem is a special unit used in radioprotection to express the equivalent dose." + + This is a generalized definition taken to reference the current, or one of the historical, SI unit definitions. + This definition is intended for situations when it is not possible to be more precise, e.g., in contexts where data have been collected that uses different historical SI definitions. +compatibility: + - "https://schemas.optimade.org/defs/v1.2/units/si/1981/temporary/rem" +resources: + - relation: "Definition in the International System of Units (SI), 4th Edition" + resource-id: "https://www.bipm.org/en/publications/si-brochure" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Roentgen_equivalent_man" +defining-relation: + base-units: + - symbol: "kg" + id: "https://schemas.optimade.org/defs/v1.2/units/si/general/kilogram" + - symbol: "m" + id: "https://schemas.optimade.org/defs/v1.2/units/si/general/metre" + - symbol: "s" + id: "https://schemas.optimade.org/defs/v1.2/units/si/general/second" + base-units-expression: "kg*m^2*s^-2" + scale: + exponent: -2 +x-optimade-definition: + label: "rem_si_general" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "rem" diff --git a/schemas/src/defs/v1.2/units/si/general/roentgen.yaml b/schemas/src/defs/v1.2/units/si/general/roentgen.yaml new file mode 100644 index 000000000..232d01c21 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/general/roentgen.yaml @@ -0,0 +1,45 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/general/roentgen" +title: "roentgen" +symbol: "R" +display-symbol: "R" +description: |- + A unit used to express the exposure of ionizing radiation defined as 2.58 x 10â»â´ C/kg using the current, or one of the historical, definitions of the SI units. + + The roentgen unit appears in the International System of Units (SI), 1st ed. (1970) defined as "1 R = 2.58 x 10â»â´ C/kg" with the footnote: "The roentgen is a special unit used to express the ionization exposure of ionizing radiation." + + - The International System of Units (SI), 1st ed. (1970) categorizes the unit as "Units in use temporarily with the International System." + - The International System of Units (SI), 2nd ed. (1973) rephrases the footnote to: "The roentgen is a special unit used to express the exposure of X or gamma radiation." + - The International System of Units (SI), 7th ed. (1998) changes the categorization to "Examples of other non-SI units". + - The International System of Units (SI), 8th ed. (2006) omits the unit. + + The roentgen unit was implicitly redefined via the redefinition of the metre at the 17th CGPM meeting (1983), resolution 1. + + This is a generalized definition taken to reference the current, or one of the historical, SI unit definitions. + This definition is intended for situations when it is not possible to be more precise, e.g., in contexts where data have been collected that uses different historical SI definitions. +compatibility: + - "https://schemas.optimade.org/defs/v1.2/units/si/1970/temporary/roentgen" + - "https://schemas.optimade.org/defs/v1.2/units/si/1983/temporary/roentgen" +resources: + - relation: "Definition in the International System of Units (SI), 1st Edition" + resource-id: "https://www.bipm.org/en/publications/si-brochure" + - relation: "Redefinition of the metre at the 17th CGPM meeting (1983), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/17-1983/resolution-1" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Roentgen_(unit)" +defining-relation: + base-units: + - symbol: "C" + id: "https://schemas.optimade.org/defs/v1.2/units/si/general/coulomb" + - symbol: "kg" + id: "https://schemas.optimade.org/defs/v1.2/units/si/general/kilogram" + base-units-expression: "C*kg^-1" + scale: + numerator: 258 + exponent: -6 +x-optimade-definition: + label: "roentgen_si_general" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "roentgen" diff --git a/schemas/src/defs/v1.2/units/si/general/second.yaml b/schemas/src/defs/v1.2/units/si/general/second.yaml new file mode 100644 index 000000000..f96b7f4b6 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/general/second.yaml @@ -0,0 +1,34 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/general/second" +title: "second" +symbol: "s" +display-symbol: "s" +description: |- + A unit of time using the current, or one of the historical, definitions of the SI units. + + The current definition in its most recent phrasing at the 26th CGPM Meeting in 2018, resolution 1 is: "The second, symbol s, is the SI unit of time. It is defined by taking the fixed numerical value of the caesium frequency, \(\Delta \nu_\textrm{Cs}\), the unperturbed ground-state hyperfine transition frequency of the caesium 133 atom, to be 9192631770 when expressed in the unit Hz, which is equal to sâ»Â¹." + + This is a rephrasing of a definition at the 13th CGPM Meeting (1967), resolution 1: "The second is the duration of 9192631770 periods of the radiation corresponding to the transition between the two hyperfine levels of the ground state of the caesium 133 atom." + + The earlier definition at the 11th CGPM Meeting in 1960, resolution 9 was: "The second is the fraction 1/31556925.9747 of the tropical year for 1900 January 0 at 12 hours ephemeris time." + + This is a generalized definition taken to reference the current, or one of the historical, SI unit definitions. + This definition is intended for situations when it is not possible to be more precise, e.g., in contexts where data have been collected that uses different historical SI definitions. +compatibility: + - "https://schemas.optimade.org/defs/v1.2/units/si/1960/base/second" + - "https://schemas.optimade.org/defs/v1.2/units/si/1967/base/second" +resources: + - relation: "Definition in the 13th CGPM Meeting (1967), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/13-1967/resolution-1" + - relation: "Rephrased definition in the 26th CGPM Meeting (2018), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/26-2018/resolution-1" + - relation: "Definition at the 11th CGPM meeting (1960), resolution 6." + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/11-1960/resolution-6" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Second" +x-optimade-definition: + label: "second_si_general" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "second" diff --git a/schemas/src/defs/v1.2/units/si/general/siemens.yaml b/schemas/src/defs/v1.2/units/si/general/siemens.yaml new file mode 100644 index 000000000..a545ee2f2 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/general/siemens.yaml @@ -0,0 +1,44 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/general/siemens" +title: "siemens" +symbol: "S" +display-symbol: "S" +description: |- + A unit for electrical conductance equal to kgâ»Â¹Â·mâ»Â²Â·s³·A² using the current, or one of the historical, definitions of the SI units. + + "The International Committee will ask the General Conference to approve two special names: [...] siemens (symbol S) for the SI unit of conductance (Ωâ»Â¹)." [14th CGPM Meeting (1971)]. + + The siemens was defined at the 14th CGPM Meeting in 1971 and implicitly redefined via the redefinitions of the meter at the 17th CGPM Meeting in 1983, resolution 1 and the kilogram at the 26th CGPM Meeting (2018), resolution 1. + + This is a generalized definition taken to reference the current, or one of the historical, SI unit definitions. + This definition is intended for situations when it is not possible to be more precise, e.g., in contexts where data have been collected that uses different historical SI definitions. +compatibility: + - "https://schemas.optimade.org/defs/v1.2/units/si/1971/named/siemens" + - "https://schemas.optimade.org/defs/v1.2/units/si/1983/named/siemens" + - "https://schemas.optimade.org/defs/v1.2/units/si/2019/named/siemens" +resources: + - relation: "Definition at the 14th CGPM Meeting (1971)" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/14-1971" + - relation: "Redefinition of the metre at the 17th CGPM meeting (1983), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/17-1983/resolution-1" + - relation: "Redefinition of the kilogram at the 26th CGPM Meeting (2018), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/26-2018/resolution-1" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Siemens_(unit)" +defining-relation: + base-units: + - symbol: "A" + id: "https://schemas.optimade.org/defs/v1.2/units/si/general/ampere" + - symbol: "kg" + id: "https://schemas.optimade.org/defs/v1.2/units/si/general/kilogram" + - symbol: "m" + id: "https://schemas.optimade.org/defs/v1.2/units/si/general/metre" + - symbol: "s" + id: "https://schemas.optimade.org/defs/v1.2/units/si/general/second" + base-units-expression: "A^2*kg^-1*m^-2*s^3" +x-optimade-definition: + label: "siemens_si_general" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "siemens" diff --git a/schemas/src/defs/v1.2/units/si/general/sievert.yaml b/schemas/src/defs/v1.2/units/si/general/sievert.yaml new file mode 100644 index 000000000..5b3f0c301 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/general/sievert.yaml @@ -0,0 +1,37 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/general/sievert" +title: "sievert" +symbol: "Sv" +display-symbol: "Sv" +description: |- + A unit for equivalent dose of ionizing radiation equal to m²·sâ»Â² using the current, or one of the historical, definitions of the SI units. + + "The 16th Conférence Générale des Poids et Mesures, [...] adopts the special name sievert, symbol Sv, for the SI unit of dose equivalent in the field of radioprotection. The sievert is equal to the joule per kilogram." [16th CGPM meeting (1979), resolution 5] + + The sievert was defined at the 16th CGPM meeting in 1979 and implicitly redefined via the redefinition of the meter at the 17th CGPM Meeting in 1983, resolution 1. + + This is a generalized definition taken to reference the current, or one of the historical, SI unit definitions. + This definition is intended for situations when it is not possible to be more precise, e.g., in contexts where data have been collected that uses different historical SI definitions. +compatibility: + - "https://schemas.optimade.org/defs/v1.2/units/si/1979/named/sievert" + - "https://schemas.optimade.org/defs/v1.2/units/si/1983/named/sievert" +resources: + - relation: "Definition at the 16th CGPM meeting (1979), resolution 5" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/16-1979/resolution-5" + - relation: "Redefinition of the metre at the 17th CGPM meeting (1983), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/17-1983/resolution-1" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Sievert" +defining-relation: + base-units: + - symbol: "m" + id: "https://schemas.optimade.org/defs/v1.2/units/si/general/metre" + - symbol: "s" + id: "https://schemas.optimade.org/defs/v1.2/units/si/general/second" + base-units-expression: "m^2*s^-2" +x-optimade-definition: + label: "sievert_si_general" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "sievert" diff --git a/schemas/src/defs/v1.2/units/si/general/steradian.yaml b/schemas/src/defs/v1.2/units/si/general/steradian.yaml new file mode 100644 index 000000000..bc2a555cd --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/general/steradian.yaml @@ -0,0 +1,36 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/general/steradian" +title: "steradian" +symbol: "sr" +display-symbol: "sr" +alternate-symbols: + - "sterad" +description: |- + A unit of solid angle representing the relation of the area cut out on a sphere at a given radius so that the entire sphere has a solid angle of 4Ï€ steradians using the current, or one of the historical, definitions of the SI units. + + The radian is defined at the 9th CGPM Meeting in 1948 as: "The unit of solid angle is the steradian. The steradian is the solid angle with its vertex at the center of a sphere with a radius of one meter, which cuts out an area of one square meter on the surface of that sphere." + + The International System of Units (SI), 9th Edition give a rephrased but equivalent definition: "The solid angle, expressed in steradian, corresponds to the ratio between an area \(A\) of the surface of a sphere of radius \(r\) and the squared radius, \(\Omega = A/r^2\) sr. One steradian corresponds to the solid angle for which \(A = r^2\), thus 1 sr = 1." + + The steradian is categorized in the International System of Units (SI), 1st Edition as a supplementary SI unit. + At the 20th CGPM meeting in 1995, resolution 8 the categorization was changed to a dimensionless derived SI unit. + + This is a generalized definition taken to reference the current, or one of the historical, SI unit definitions. + This definition is intended for situations when it is not possible to be more precise, e.g., in contexts where data have been collected that uses different historical SI definitions. +compatibility: + - "https://schemas.optimade.org/defs/v1.2/units/si/1960/supplementary/steradian" +resources: + - relation: "Definition at the 9th CGPM meeting (1948)" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/9-1948" + - relation: "Establishment of the SI unit system at the 11th CGPM meeting (1960), resolution 12." + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/11-1960/resolution-12" + - relation: "Reclassification at the 20th CGPM meeting (1995)" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/20-1995/resolution-8" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Steradian" +x-optimade-definition: + label: "steradian_si_general" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "steradian" diff --git a/schemas/src/defs/v1.2/units/si/general/tesla.yaml b/schemas/src/defs/v1.2/units/si/general/tesla.yaml new file mode 100644 index 000000000..8fc3429f9 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/general/tesla.yaml @@ -0,0 +1,41 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/general/tesla" +title: "tesla" +symbol: "T" +display-symbol: "T" +description: |- + A unit for magnetic flux density equal to kg·sâ»Â²Â·Aâ»Â¹ using the current, or one of the historical, definitions of the SI units. + + The tesla was defined as 1 Wb/m in the introduction of the SI unit system the 11th CGPM Meeting in 1960, resolution 12, implicitly redefined via the redefinitions of the second at the 13th CGPM Meeting in 1967, resolution 1, the ampere (implicitly via the redefinition of the metre) at the 17th CGPM Meeting in 1983, resolution 1, and the kilogram and ampere at the 26th CGPM Meeting (2018), resolution 1. + + This is a generalized definition taken to reference the current, or one of the historical, SI unit definitions. + This definition is intended for situations when it is not possible to be more precise, e.g., in contexts where data have been collected that uses different historical SI definitions. +compatibility: + - "https://schemas.optimade.org/defs/v1.2/units/si/1960/named/tesla" + - "https://schemas.optimade.org/defs/v1.2/units/si/1967/named/tesla" + - "https://schemas.optimade.org/defs/v1.2/units/si/1983/named/tesla" + - "https://schemas.optimade.org/defs/v1.2/units/si/2019/named/tesla" +resources: + - relation: "Definition and establishment of the SI unit system at the 11th CGPM meeting (1960), resolution 12." + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/11-1960/resolution-12" + - relation: "Redefinition of the metre at the 17th CGPM meeting (1983), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/17-1983/resolution-1" + - relation: "Redefinition of the kilogram and the ampere at the 26th CGPM Meeting (2018), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/26-2018/resolution-1" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Tesla_(unit)" +defining-relation: + base-units: + - symbol: "A" + id: "https://schemas.optimade.org/defs/v1.2/units/si/general/ampere" + - symbol: "kg" + id: "https://schemas.optimade.org/defs/v1.2/units/si/general/kilogram" + - symbol: "s" + id: "https://schemas.optimade.org/defs/v1.2/units/si/general/second" + base-units-expression: "A^-1*kg*s^-2" +x-optimade-definition: + label: "tesla_si_general" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "tesla" diff --git a/schemas/src/defs/v1.2/units/si/general/tonne.yaml b/schemas/src/defs/v1.2/units/si/general/tonne.yaml new file mode 100644 index 000000000..e07b259f8 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/general/tonne.yaml @@ -0,0 +1,41 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/general/tonne" +title: "tonne" +symbol: "t" +display-symbol: "t" +alternate-symbols: + - "t" +description: |- + A unit of mass equal to 1000 kg using the current, or one of the historical, definitions of the SI units. + + The International System of Units (SI), 1st ed. (1970) defines the tonne as "1 t = 10³ kg" with the footnote "The symbol and the unit was defined in resolution 7 at the 9th meeting of the C.G.P.M. (1948)." + + In the 2019 implicit redefinition of the tonne, the kilogram in the definition refers to the 2019 kilogram SI base unit (https://schema.optimade.org/units/si/2019/named/kilogram). + + - The International System of Units (SI), 1st ed. (1970) categorizes the unit as "Units used with the International System" + - The International System of Units (SI), 3rd ed. (19) changes the reference of the definition to the 1879 meeting of the CIPM page 41. + - The International System of Units (SI), 6th ed. (1991) further adds "In some English-speaking countries this unit is called ≪metric ton≫." + + This is a generalized definition taken to reference the current, or one of the historical, SI unit definitions. + This definition is intended for situations when it is not possible to be more precise, e.g., in contexts where data have been collected that uses different historical SI definitions. +compatibility: + - "https://schemas.optimade.org/defs/v1.2/units/si/1970/accepted/tonne" + - "https://schemas.optimade.org/defs/v1.2/units/si/2019/accepted/tonne" +resources: + - relation: "Definition in the International System of Units (SI), 9th Edition" + resource-id: "https://www.bipm.org/en/publications/si-brochure" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Tonne" +defining-relation: + base-units: + - symbol: "kg" + id: "https://schemas.optimade.org/defs/v1.2/units/si/general/kilogram" + base-units-expression: "kg" + scale: + exponent: 3 +x-optimade-definition: + label: "tonne_si_general" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "tonne" diff --git a/schemas/src/defs/v1.2/units/si/general/volt.yaml b/schemas/src/defs/v1.2/units/si/general/volt.yaml new file mode 100644 index 000000000..aa4429d2a --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/general/volt.yaml @@ -0,0 +1,47 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/general/volt" +title: "volt" +symbol: "V" +display-symbol: "V" +description: |- + A unit for electric potential, voltage, and electromotive force equal to kg·m²·sâ»Â³Â·Aâ»Â¹ using the current, or one of the historical, definitions of the SI units. + + "The volt is the electric potential difference that exists between two points of a conducting wire carrying a constant current of one ampere when the power dissipated between these points is equal to one watt." [9th CGPM meeting in 1946] + + The volt was defined at the 9th CGPM Meeting in 1946, included in SI at the 11th CGPM meeting in 1960, resolution 12 and implicitly redefined via the redefinitions of the second at the 13th CGPM Meeting in 1967, resolution 1, the metre at the 17th CGPM Meeting in 1983, resolution 1, and the kilogram at the 26th CGPM Meeting (2018), resolution 1. + + This is a generalized definition taken to reference the current, or one of the historical, SI unit definitions. + This definition is intended for situations when it is not possible to be more precise, e.g., in contexts where data have been collected that uses different historical SI definitions. +compatibility: + - "https://schemas.optimade.org/defs/v1.2/units/si/1960/named/volt" + - "https://schemas.optimade.org/defs/v1.2/units/si/1967/named/volt" + - "https://schemas.optimade.org/defs/v1.2/units/si/1983/named/volt" + - "https://schemas.optimade.org/defs/v1.2/units/si/2019/named/volt" +resources: + - relation: "Definition and establishment of the SI unit system at the 11th CGPM meeting (1960), resolution 12." + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/11-1960/resolution-12" + - relation: "Redefinition of the metre at the 17th CGPM meeting (1983), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/17-1983/resolution-1" + - relation: "Redefinition of the second in the 13th CGPM Meeting (1967), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/13-1967/resolution-1" + - relation: "Redefinition of the kilogram at the 26th CGPM Meeting (2018), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/26-2018/resolution-1" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Volt" +defining-relation: + base-units: + - symbol: "kg" + id: "https://schemas.optimade.org/defs/v1.2/units/si/general/kilogram" + - symbol: "m" + id: "https://schemas.optimade.org/defs/v1.2/units/si/general/metre" + - symbol: "s" + id: "https://schemas.optimade.org/defs/v1.2/units/si/general/second" + - symbol: "A" + id: "https://schemas.optimade.org/defs/v1.2/units/si/general/ampere" + base-units-expression: "A^-1*kg*m^2*s^-3" +x-optimade-definition: + label: "volt_si_general" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "volt" diff --git a/schemas/src/defs/v1.2/units/si/general/watt.yaml b/schemas/src/defs/v1.2/units/si/general/watt.yaml new file mode 100644 index 000000000..69dba4ce4 --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/general/watt.yaml @@ -0,0 +1,45 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/general/watt" +title: "watt" +symbol: "W" +display-symbol: "W" +description: |- + A unit for power and radiant flux equal to kg·m²·sâ»Â³ using the current, or one of the historical, definitions of the SI units. + + "The watt is the power that produces one joule per second." [9th CGPM meeting in 1946] + + The watt was defined at the 9th CGPM Meeting in 1946, included in SI at the 11th CGPM meeting in 1960, resolution 12, implicitly redefined via the redefinitions of the second at the 13th CGPM Meeting in 1967, resolution 1; the metre at the 17th CGPM meeting (1983), resolution 1; and the kilogram at the 26th CGPM Meeting (2018), resolution 1. + + This is a generalized definition taken to reference the current, or one of the historical, SI unit definitions. + This definition is intended for situations when it is not possible to be more precise, e.g., in contexts where data have been collected that uses different historical SI definitions. +compatibility: + - "https://schemas.optimade.org/defs/v1.2/units/si/1960/named/watt" + - "https://schemas.optimade.org/defs/v1.2/units/si/1967/named/watt" + - "https://schemas.optimade.org/defs/v1.2/units/si/1983/named/watt" + - "https://schemas.optimade.org/defs/v1.2/units/si/2019/named/watt" +resources: + - relation: "Definition and establishment of the SI unit system at the 11th CGPM meeting (1960), resolution 12." + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/11-1960/resolution-12" + - relation: "Redefinition of the metre at the 17th CGPM meeting (1983), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/17-1983/resolution-1" + - relation: "Redefinition of the second in the 13th CGPM Meeting (1967), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/13-1967/resolution-1" + - relation: "Redefinition of the metre at the 17th CGPM meeting (1983), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/17-1983/resolution-1" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Watt" +defining-relation: + base-units: + - symbol: "kg" + id: "https://schemas.optimade.org/defs/v1.2/units/si/general/kilogram" + - symbol: "m" + id: "https://schemas.optimade.org/defs/v1.2/units/si/general/metre" + - symbol: "s" + id: "https://schemas.optimade.org/defs/v1.2/units/si/general/second" + base-units-expression: "kg*m^2*s^-3" +x-optimade-definition: + label: "watt_si_general" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "watt" diff --git a/schemas/src/defs/v1.2/units/si/general/weber.yaml b/schemas/src/defs/v1.2/units/si/general/weber.yaml new file mode 100644 index 000000000..3fcc5050e --- /dev/null +++ b/schemas/src/defs/v1.2/units/si/general/weber.yaml @@ -0,0 +1,45 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +$id: "https://schemas.optimade.org/defs/v1.2/units/si/general/weber" +title: "weber" +symbol: "Wb" +display-symbol: "Wb" +description: |- + A unit for magnetic flux equal to kg·m²·sâ»Â³Â·Aâ»Â¹ using the current, or one of the historical, definitions of the SI units. + + "The weber is the magnetic induction flux that, passing through a single-turn circuit, produces an electromotive force of one volt if it is reduced to zero in one second by uniform decay." [9th CGPM meeting in 1946] + + The weber was defined at the 9th CGPM Meeting in 1946, included in SI at the 11th CGPM meeting in 1960, resolution 12, implicitly redefined via the redefinitions of the second at the 13th CGPM Meeting in 1967, resolution 1; the metre at the 17th CGPM meeting (1983), resolution 1; and the kilogram at the 26th CGPM Meeting (2018), resolution 1. + + This is a generalized definition taken to reference the current, or one of the historical, SI unit definitions. + This definition is intended for situations when it is not possible to be more precise, e.g., in contexts where data have been collected that uses different historical SI definitions. +compatibility: + - "https://schemas.optimade.org/defs/v1.2/units/si/1960/named/weber" + - "https://schemas.optimade.org/defs/v1.2/units/si/1967/named/weber" + - "https://schemas.optimade.org/defs/v1.2/units/si/1983/named/weber" + - "https://schemas.optimade.org/defs/v1.2/units/si/2019/named/weber" +resources: + - relation: "Definition at the 9th CGPM meeting (1948)" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/9-1948" + - relation: "Definition and establishment of the SI unit system at the 11th CGPM meeting (1960), resolution 12." + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/11-1960/resolution-12" + - relation: "Redefinition of the kilogram in the 26th CGPM Meeting (2018), resolution 1" + resource-id: "https://www.bipm.org/en/committees/cg/cgpm/26-2018/resolution-1" + - relation: "Wikipedia article describing the unit" + resource-id: "https://en.wikipedia.org/wiki/Weber_(unit)" +defining-relation: + base-units: + - symbol: "A" + id: "https://schemas.optimade.org/defs/v1.2/units/si/general/ampere" + - symbol: "kg" + id: "https://schemas.optimade.org/defs/v1.2/units/si/general/kilogram" + - symbol: "m" + id: "https://schemas.optimade.org/defs/v1.2/units/si/general/metre" + - symbol: "s" + id: "https://schemas.optimade.org/defs/v1.2/units/si/general/second" + base-units-expression: "A^-1*kg*m^2*s^-3" +x-optimade-definition: + label: "weber_si_general" + kind: "unit" + format: "1.2" + version: "1.2.0" + name: "weber" diff --git a/schemas/src/defs/v1.2/unitsystems/optimade/optimade.yaml b/schemas/src/defs/v1.2/unitsystems/optimade/optimade.yaml new file mode 100644 index 000000000..c49ac5327 --- /dev/null +++ b/schemas/src/defs/v1.2/unitsystems/optimade/optimade.yaml @@ -0,0 +1,19 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/unitsystem_definition" +$id: "https://schemas.optimade.org/defs/v1.2/unitsystems/optimade/optimade" +title: "OPTIMADE" +description: |- + A combination of SI and non-SI units in common use suitable for use with OPTIMADE. + + This unit system combines SI units (including units accepted for use with the SI), the bit, and the byte unit. +$$inherit: "/v1.2/unitsystems/si/si_general" +x-optimade-definition: + label: "optimade_unitsystem" + kind: "unitsystem" + format: "1.2" + version: "1.2.0" + name: "optimade" +units: + bit: + $$inherit: "/v1.2/units/independent/1948/information/bit" + byte: + $$inherit: "/v1.2/units/iso-iec-80000/2008/information_science_and_technology/byte" diff --git a/schemas/src/defs/v1.2/unitsystems/si/si_1970.yaml b/schemas/src/defs/v1.2/unitsystems/si/si_1970.yaml new file mode 100644 index 000000000..129f36ba5 --- /dev/null +++ b/schemas/src/defs/v1.2/unitsystems/si/si_1970.yaml @@ -0,0 +1,88 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/unitsystem_definition" +$id: "https://schemas.optimade.org/defs/v1.2/unitsystems/si/si_1970" +title: "SI 1970" +description: |- + The SI unit system as represented in the 1st edition of the International System of Units. + + The International System of Units (SI) is established and maintained by the General Conference on Weights and Measures (CGPM). + This represents the SI unit system described in the 1st edition of the International System of Units in 1970. +x-optimade-definition: + label: "si_1970_unitsystem" + kind: "unitsystem" + format: "1.2" + version: "1.2.0" + name: "si_1970" +units: + s: + $$inherit: "/v1.2/units/si/1960/base/second" + m: + $$inherit: "/v1.2/units/si/1960/base/metre" + kg: + $$inherit: "/v1.2/units/si/1960/base/kilogram" + A: + $$inherit: "/v1.2/units/si/1967/base/ampere" + K: + $$inherit: "/v1.2/units/si/1967/base/kelvin" + cd: + $$inherit: "/v1.2/units/si/1967/base/candela" + rad: + $$inherit: "/v1.2/units/si/1960/supplementary/radian" + sr: + $$inherit: "/v1.2/units/si/1960/supplementary/steradian" + Hz: + $$inherit: "/v1.2/units/si/1967/named/hertz" + N: + $$inherit: "/v1.2/units/si/1967/named/newton" + J: + $$inherit: "/v1.2/units/si/1967/named/joule" + W: + $$inherit: "/v1.2/units/si/1967/named/watt" + C: + $$inherit: "/v1.2/units/si/1967/named/coulomb" + V: + $$inherit: "/v1.2/units/si/1967/named/volt" + F: + $$inherit: "/v1.2/units/si/1967/named/farad" + ohm: + $$inherit: "/v1.2/units/si/1967/named/ohm" + Wb: + $$inherit: "/v1.2/units/si/1967/named/weber" + T: + $$inherit: "/v1.2/units/si/1967/named/tesla" + H: + $$inherit: "/v1.2/units/si/1967/named/henry" + degC: + $$inherit: "/v1.2/units/si/1967/named/degcelsius" + lm: + $$inherit: "/v1.2/units/si/1967/named/lumen" + lx: + $$inherit: "/v1.2/units/si/1967/named/lux" +prefixes: + T: + $$inherit: "/v1.2/prefixes/si/tera" + G: + $$inherit: "/v1.2/prefixes/si/giga" + M: + $$inherit: "/v1.2/prefixes/si/mega" + k: + $$inherit: "/v1.2/prefixes/si/kilo" + h: + $$inherit: "/v1.2/prefixes/si/hecto" + da: + $$inherit: "/v1.2/prefixes/si/deca" + d: + $$inherit: "/v1.2/prefixes/si/deci" + c: + $$inherit: "/v1.2/prefixes/si/centi" + m: + $$inherit: "/v1.2/prefixes/si/milli" + mc: + $$inherit: "/v1.2/prefixes/si/micro" + n: + $$inherit: "/v1.2/prefixes/si/nano" + p: + $$inherit: "/v1.2/prefixes/si/pico" + f: + $$inherit: "/v1.2/prefixes/si/femto" + a: + $$inherit: "/v1.2/prefixes/si/atto" diff --git a/schemas/src/defs/v1.2/unitsystems/si/si_1973.yaml b/schemas/src/defs/v1.2/unitsystems/si/si_1973.yaml new file mode 100644 index 000000000..260f4f4be --- /dev/null +++ b/schemas/src/defs/v1.2/unitsystems/si/si_1973.yaml @@ -0,0 +1,94 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/unitsystem_definition" +$id: "https://schemas.optimade.org/defs/v1.2/unitsystems/si/si_1973" +title: "SI 1973" +description: |- + The SI unit system as represented in the 2nd edition of the International System of Units. + + The International System of Units (SI) is established and maintained by the General Conference on Weights and Measures (CGPM). + This represents the SI unit system described in the 2nd edition of the International System of Units in 1973. +x-optimade-definition: + label: "si_1973_unitsystem" + kind: "unitsystem" + format: "1.2" + version: "1.2.0" + name: "si_1973" +units: + s: + $$inherit: "/v1.2/units/si/1960/base/second" + m: + $$inherit: "/v1.2/units/si/1960/base/metre" + kg: + $$inherit: "/v1.2/units/si/1960/base/kilogram" + A: + $$inherit: "/v1.2/units/si/1967/base/ampere" + K: + $$inherit: "/v1.2/units/si/1967/base/kelvin" + cd: + $$inherit: "/v1.2/units/si/1967/base/candela" + mol: + $$inherit: "/v1.2/units/si/1971/base/mole" + rad: + $$inherit: "/v1.2/units/si/1960/supplementary/radian" + sr: + $$inherit: "/v1.2/units/si/1960/supplementary/steradian" + Hz: + $$inherit: "/v1.2/units/si/1967/named/hertz" + N: + $$inherit: "/v1.2/units/si/1967/named/newton" + Pa: + $$inherit: "/v1.2/units/si/1971/named/pascal" + J: + $$inherit: "/v1.2/units/si/1967/named/joule" + W: + $$inherit: "/v1.2/units/si/1967/named/watt" + C: + $$inherit: "/v1.2/units/si/1967/named/coulomb" + V: + $$inherit: "/v1.2/units/si/1967/named/volt" + F: + $$inherit: "/v1.2/units/si/1967/named/farad" + ohm: + $$inherit: "/v1.2/units/si/1967/named/ohm" + S: + $$inherit: "/v1.2/units/si/1971/named/siemens" + Wb: + $$inherit: "/v1.2/units/si/1967/named/weber" + T: + $$inherit: "/v1.2/units/si/1967/named/tesla" + H: + $$inherit: "/v1.2/units/si/1967/named/henry" + degC: + $$inherit: "/v1.2/units/si/1967/named/degcelsius" + lm: + $$inherit: "/v1.2/units/si/1967/named/lumen" + lx: + $$inherit: "/v1.2/units/si/1967/named/lux" +prefixes: + T: + $$inherit: "/v1.2/prefixes/si/tera" + G: + $$inherit: "/v1.2/prefixes/si/giga" + M: + $$inherit: "/v1.2/prefixes/si/mega" + k: + $$inherit: "/v1.2/prefixes/si/kilo" + h: + $$inherit: "/v1.2/prefixes/si/hecto" + da: + $$inherit: "/v1.2/prefixes/si/deca" + d: + $$inherit: "/v1.2/prefixes/si/deci" + c: + $$inherit: "/v1.2/prefixes/si/centi" + m: + $$inherit: "/v1.2/prefixes/si/milli" + mc: + $$inherit: "/v1.2/prefixes/si/micro" + n: + $$inherit: "/v1.2/prefixes/si/nano" + p: + $$inherit: "/v1.2/prefixes/si/pico" + f: + $$inherit: "/v1.2/prefixes/si/femto" + a: + $$inherit: "/v1.2/prefixes/si/atto" diff --git a/schemas/src/defs/v1.2/unitsystems/si/si_1977.yaml b/schemas/src/defs/v1.2/unitsystems/si/si_1977.yaml new file mode 100644 index 000000000..deefd63e9 --- /dev/null +++ b/schemas/src/defs/v1.2/unitsystems/si/si_1977.yaml @@ -0,0 +1,102 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/unitsystem_definition" +$id: "https://schemas.optimade.org/defs/v1.2/unitsystems/si/si_1977" +title: "SI 1977" +description: |- + The SI unit system as represented in the 3rd edition of the International System of Units. + + The International System of Units (SI) is established and maintained by the General Conference on Weights and Measures (CGPM). + This represents the SI unit system described in the 3rd edition of the International System of Units in 1977. +x-optimade-definition: + label: "si_1977_unitsystem" + kind: "unitsystem" + format: "1.2" + version: "1.2.0" + name: "si_1977" +units: + s: + $$inherit: "/v1.2/units/si/1967/base/second" + m: + $$inherit: "/v1.2/units/si/1960/base/metre" + kg: + $$inherit: "/v1.2/units/si/1960/base/kilogram" + A: + $$inherit: "/v1.2/units/si/1967/base/ampere" + K: + $$inherit: "/v1.2/units/si/1967/base/kelvin" + mol: + $$inherit: "/v1.2/units/si/1971/base/mole" + cd: + $$inherit: "/v1.2/units/si/1967/base/candela" + rad: + $$inherit: "/v1.2/units/si/1960/supplementary/radian" + sr: + $$inherit: "/v1.2/units/si/1960/supplementary/steradian" + Hz: + $$inherit: "/v1.2/units/si/1967/named/hertz" + N: + $$inherit: "/v1.2/units/si/1967/named/newton" + Pa: + $$inherit: "/v1.2/units/si/1971/named/pascal" + J: + $$inherit: "/v1.2/units/si/1967/named/joule" + W: + $$inherit: "/v1.2/units/si/1967/named/watt" + C: + $$inherit: "/v1.2/units/si/1967/named/coulomb" + V: + $$inherit: "/v1.2/units/si/1967/named/volt" + F: + $$inherit: "/v1.2/units/si/1967/named/farad" + ohm: + $$inherit: "/v1.2/units/si/1967/named/ohm" + S: + $$inherit: "/v1.2/units/si/1971/named/siemens" + Wb: + $$inherit: "/v1.2/units/si/1967/named/weber" + T: + $$inherit: "/v1.2/units/si/1967/named/tesla" + H: + $$inherit: "/v1.2/units/si/1967/named/henry" + degC: + $$inherit: "/v1.2/units/si/1967/named/degcelsius" + lm: + $$inherit: "/v1.2/units/si/1967/named/lumen" + lx: + $$inherit: "/v1.2/units/si/1967/named/lux" + Bq: + $$inherit: "/v1.2/units/si/1975/named/becquerel" + Gy: + $$inherit: "/v1.2/units/si/1975/named/gray" +prefixes: + E: + $$inherit: "/v1.2/prefixes/si/exa" + P: + $$inherit: "/v1.2/prefixes/si/peta" + T: + $$inherit: "/v1.2/prefixes/si/tera" + G: + $$inherit: "/v1.2/prefixes/si/giga" + M: + $$inherit: "/v1.2/prefixes/si/mega" + k: + $$inherit: "/v1.2/prefixes/si/kilo" + h: + $$inherit: "/v1.2/prefixes/si/hecto" + da: + $$inherit: "/v1.2/prefixes/si/deca" + d: + $$inherit: "/v1.2/prefixes/si/deci" + c: + $$inherit: "/v1.2/prefixes/si/centi" + m: + $$inherit: "/v1.2/prefixes/si/milli" + mc: + $$inherit: "/v1.2/prefixes/si/micro" + n: + $$inherit: "/v1.2/prefixes/si/nano" + p: + $$inherit: "/v1.2/prefixes/si/pico" + f: + $$inherit: "/v1.2/prefixes/si/femto" + a: + $$inherit: "/v1.2/prefixes/si/atto" diff --git a/schemas/src/defs/v1.2/unitsystems/si/si_1981.yaml b/schemas/src/defs/v1.2/unitsystems/si/si_1981.yaml new file mode 100644 index 000000000..8c5673e2b --- /dev/null +++ b/schemas/src/defs/v1.2/unitsystems/si/si_1981.yaml @@ -0,0 +1,104 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/unitsystem_definition" +$id: "https://schemas.optimade.org/defs/v1.2/unitsystems/si/si_1981" +title: "SI 1981" +description: |- + The SI unit system as represented in the 4th edition of the International System of Units. + + The International System of Units (SI) is established and maintained by the General Conference on Weights and Measures (CGPM). + This represents the SI unit system described in the 4th edition of the International System of Units in 1981. +x-optimade-definition: + label: "si_1981_unitsystem" + kind: "unitsystem" + format: "1.2" + version: "1.2.0" + name: "si_1981" +units: + s: + $$inherit: "/v1.2/units/si/1967/base/second" + m: + $$inherit: "/v1.2/units/si/1960/base/metre" + kg: + $$inherit: "/v1.2/units/si/1960/base/kilogram" + A: + $$inherit: "/v1.2/units/si/1967/base/ampere" + K: + $$inherit: "/v1.2/units/si/1967/base/kelvin" + mol: + $$inherit: "/v1.2/units/si/1971/base/mole" + cd: + $$inherit: "/v1.2/units/si/1967/base/candela" + rad: + $$inherit: "/v1.2/units/si/1960/supplementary/radian" + sr: + $$inherit: "/v1.2/units/si/1960/supplementary/steradian" + Hz: + $$inherit: "/v1.2/units/si/1967/named/hertz" + N: + $$inherit: "/v1.2/units/si/1967/named/newton" + Pa: + $$inherit: "/v1.2/units/si/1971/named/pascal" + J: + $$inherit: "/v1.2/units/si/1967/named/joule" + W: + $$inherit: "/v1.2/units/si/1967/named/watt" + C: + $$inherit: "/v1.2/units/si/1967/named/coulomb" + V: + $$inherit: "/v1.2/units/si/1967/named/volt" + F: + $$inherit: "/v1.2/units/si/1967/named/farad" + ohm: + $$inherit: "/v1.2/units/si/1967/named/ohm" + S: + $$inherit: "/v1.2/units/si/1971/named/siemens" + Wb: + $$inherit: "/v1.2/units/si/1967/named/weber" + T: + $$inherit: "/v1.2/units/si/1967/named/tesla" + H: + $$inherit: "/v1.2/units/si/1967/named/henry" + degC: + $$inherit: "/v1.2/units/si/1967/named/degcelsius" + lm: + $$inherit: "/v1.2/units/si/1979/named/lumen" + lx: + $$inherit: "/v1.2/units/si/1967/named/lux" + Bq: + $$inherit: "/v1.2/units/si/1975/named/becquerel" + Gy: + $$inherit: "/v1.2/units/si/1975/named/gray" + Sv: + $$inherit: "/v1.2/units/si/1979/named/sievert" +prefixes: + E: + $$inherit: "/v1.2/prefixes/si/exa" + P: + $$inherit: "/v1.2/prefixes/si/peta" + T: + $$inherit: "/v1.2/prefixes/si/tera" + G: + $$inherit: "/v1.2/prefixes/si/giga" + M: + $$inherit: "/v1.2/prefixes/si/mega" + k: + $$inherit: "/v1.2/prefixes/si/kilo" + h: + $$inherit: "/v1.2/prefixes/si/hecto" + da: + $$inherit: "/v1.2/prefixes/si/deca" + d: + $$inherit: "/v1.2/prefixes/si/deci" + c: + $$inherit: "/v1.2/prefixes/si/centi" + m: + $$inherit: "/v1.2/prefixes/si/milli" + mc: + $$inherit: "/v1.2/prefixes/si/micro" + n: + $$inherit: "/v1.2/prefixes/si/nano" + p: + $$inherit: "/v1.2/prefixes/si/pico" + f: + $$inherit: "/v1.2/prefixes/si/femto" + a: + $$inherit: "/v1.2/prefixes/si/atto" diff --git a/schemas/src/defs/v1.2/unitsystems/si/si_1985.yaml b/schemas/src/defs/v1.2/unitsystems/si/si_1985.yaml new file mode 100644 index 000000000..038c22c76 --- /dev/null +++ b/schemas/src/defs/v1.2/unitsystems/si/si_1985.yaml @@ -0,0 +1,104 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/unitsystem_definition" +$id: "https://schemas.optimade.org/defs/v1.2/unitsystems/si/si_1985" +title: "SI 1985" +description: |- + The SI unit system as represented in the 5th edition of the International System of Units. + + The International System of Units (SI) is established and maintained by the General Conference on Weights and Measures (CGPM). + This represents the SI unit system described in the 5th edition of the International System of Units in 1995. +x-optimade-definition: + label: "si_1985_unitsystem" + kind: "unitsystem" + format: "1.2" + version: "1.2.0" + name: "si_1985" +units: + s: + $$inherit: "/v1.2/units/si/1967/base/second" + m: + $$inherit: "/v1.2/units/si/1983/base/metre" + kg: + $$inherit: "/v1.2/units/si/1960/base/kilogram" + A: + $$inherit: "/v1.2/units/si/1983/base/ampere" + K: + $$inherit: "/v1.2/units/si/1967/base/kelvin" + mol: + $$inherit: "/v1.2/units/si/1971/base/mole" + cd: + $$inherit: "/v1.2/units/si/1983/base/candela" + rad: + $$inherit: "/v1.2/units/si/1960/supplementary/radian" + sr: + $$inherit: "/v1.2/units/si/1960/supplementary/steradian" + Hz: + $$inherit: "/v1.2/units/si/1967/named/hertz" + N: + $$inherit: "/v1.2/units/si/1983/named/newton" + Pa: + $$inherit: "/v1.2/units/si/1983/named/pascal" + J: + $$inherit: "/v1.2/units/si/1967/named/joule" + W: + $$inherit: "/v1.2/units/si/1967/named/watt" + C: + $$inherit: "/v1.2/units/si/1967/named/coulomb" + V: + $$inherit: "/v1.2/units/si/1983/named/volt" + F: + $$inherit: "/v1.2/units/si/1983/named/farad" + ohm: + $$inherit: "/v1.2/units/si/1983/named/ohm" + S: + $$inherit: "/v1.2/units/si/1983/named/siemens" + Wb: + $$inherit: "/v1.2/units/si/1983/named/weber" + T: + $$inherit: "/v1.2/units/si/1967/named/tesla" + H: + $$inherit: "/v1.2/units/si/1983/named/henry" + degC: + $$inherit: "/v1.2/units/si/1967/named/degcelsius" + lm: + $$inherit: "/v1.2/units/si/1979/named/lumen" + lx: + $$inherit: "/v1.2/units/si/1983/named/lux" + Bq: + $$inherit: "/v1.2/units/si/1975/named/becquerel" + Gy: + $$inherit: "/v1.2/units/si/1983/named/gray" + Sv: + $$inherit: "/v1.2/units/si/1983/named/sievert" +prefixes: + E: + $$inherit: "/v1.2/prefixes/si/exa" + P: + $$inherit: "/v1.2/prefixes/si/peta" + T: + $$inherit: "/v1.2/prefixes/si/tera" + G: + $$inherit: "/v1.2/prefixes/si/giga" + M: + $$inherit: "/v1.2/prefixes/si/mega" + k: + $$inherit: "/v1.2/prefixes/si/kilo" + h: + $$inherit: "/v1.2/prefixes/si/hecto" + da: + $$inherit: "/v1.2/prefixes/si/deca" + d: + $$inherit: "/v1.2/prefixes/si/deci" + c: + $$inherit: "/v1.2/prefixes/si/centi" + m: + $$inherit: "/v1.2/prefixes/si/milli" + mc: + $$inherit: "/v1.2/prefixes/si/micro" + n: + $$inherit: "/v1.2/prefixes/si/nano" + p: + $$inherit: "/v1.2/prefixes/si/pico" + f: + $$inherit: "/v1.2/prefixes/si/femto" + a: + $$inherit: "/v1.2/prefixes/si/atto" diff --git a/schemas/src/defs/v1.2/unitsystems/si/si_1991.yaml b/schemas/src/defs/v1.2/unitsystems/si/si_1991.yaml new file mode 100644 index 000000000..d5931cbdf --- /dev/null +++ b/schemas/src/defs/v1.2/unitsystems/si/si_1991.yaml @@ -0,0 +1,112 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/unitsystem_definition" +$id: "https://schemas.optimade.org/defs/v1.2/unitsystems/si/si_1991" +title: "SI 1991" +description: |- + The SI unit system as represented in the 6th edition of the International System of Units. + + The International System of Units (SI) is established and maintained by the General Conference on Weights and Measures (CGPM). + This represents the SI unit system described in the 6th edition of the International System of Units in 1991. +x-optimade-definition: + label: "si_1991_unitsystem" + kind: "unitsystem" + format: "1.2" + version: "1.2.0" + name: "si_1991" +units: + s: + $$inherit: "/v1.2/units/si/1967/base/second" + m: + $$inherit: "/v1.2/units/si/1983/base/metre" + kg: + $$inherit: "/v1.2/units/si/1960/base/kilogram" + A: + $$inherit: "/v1.2/units/si/1983/base/ampere" + K: + $$inherit: "/v1.2/units/si/1967/base/kelvin" + mol: + $$inherit: "/v1.2/units/si/1971/base/mole" + cd: + $$inherit: "/v1.2/units/si/1983/base/candela" + rad: + $$inherit: "/v1.2/units/si/1960/supplementary/radian" + sr: + $$inherit: "/v1.2/units/si/1960/supplementary/steradian" + Hz: + $$inherit: "/v1.2/units/si/1967/named/hertz" + N: + $$inherit: "/v1.2/units/si/1983/named/newton" + Pa: + $$inherit: "/v1.2/units/si/1983/named/pascal" + J: + $$inherit: "/v1.2/units/si/1967/named/joule" + W: + $$inherit: "/v1.2/units/si/1967/named/watt" + C: + $$inherit: "/v1.2/units/si/1967/named/coulomb" + V: + $$inherit: "/v1.2/units/si/1983/named/volt" + F: + $$inherit: "/v1.2/units/si/1983/named/farad" + ohm: + $$inherit: "/v1.2/units/si/1983/named/ohm" + S: + $$inherit: "/v1.2/units/si/1983/named/siemens" + Wb: + $$inherit: "/v1.2/units/si/1983/named/weber" + T: + $$inherit: "/v1.2/units/si/1967/named/tesla" + H: + $$inherit: "/v1.2/units/si/1983/named/henry" + degC: + $$inherit: "/v1.2/units/si/1967/named/degcelsius" + lm: + $$inherit: "/v1.2/units/si/1979/named/lumen" + lx: + $$inherit: "/v1.2/units/si/1983/named/lux" + Bq: + $$inherit: "/v1.2/units/si/1975/named/becquerel" + Gy: + $$inherit: "/v1.2/units/si/1983/named/gray" + Sv: + $$inherit: "/v1.2/units/si/1983/named/sievert" +prefixes: + Y: + $$inherit: "/v1.2/prefixes/si/yotta" + Z: + $$inherit: "/v1.2/prefixes/si/zetta" + E: + $$inherit: "/v1.2/prefixes/si/exa" + P: + $$inherit: "/v1.2/prefixes/si/peta" + T: + $$inherit: "/v1.2/prefixes/si/tera" + G: + $$inherit: "/v1.2/prefixes/si/giga" + M: + $$inherit: "/v1.2/prefixes/si/mega" + k: + $$inherit: "/v1.2/prefixes/si/kilo" + h: + $$inherit: "/v1.2/prefixes/si/hecto" + da: + $$inherit: "/v1.2/prefixes/si/deca" + d: + $$inherit: "/v1.2/prefixes/si/deci" + c: + $$inherit: "/v1.2/prefixes/si/centi" + m: + $$inherit: "/v1.2/prefixes/si/milli" + mc: + $$inherit: "/v1.2/prefixes/si/micro" + n: + $$inherit: "/v1.2/prefixes/si/nano" + p: + $$inherit: "/v1.2/prefixes/si/pico" + f: + $$inherit: "/v1.2/prefixes/si/femto" + a: + $$inherit: "/v1.2/prefixes/si/atto" + z: + $$inherit: "/v1.2/prefixes/si/zepto" + y: + $$inherit: "/v1.2/prefixes/si/yocto" diff --git a/schemas/src/defs/v1.2/unitsystems/si/si_1998.yaml b/schemas/src/defs/v1.2/unitsystems/si/si_1998.yaml new file mode 100644 index 000000000..887de7dd4 --- /dev/null +++ b/schemas/src/defs/v1.2/unitsystems/si/si_1998.yaml @@ -0,0 +1,112 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/unitsystem_definition" +$id: "https://schemas.optimade.org/defs/v1.2/unitsystems/si/si_1998" +title: "SI 1998" +description: |- + The SI unit system as represented in the 7th edition of the International System of Units. + + The International System of Units (SI) is established and maintained by the General Conference on Weights and Measures (CGPM). + This represents the SI unit system described in the 7th edition of the International System of Units in 1998. +x-optimade-definition: + label: "si_1998_unitsystem" + kind: "unitsystem" + format: "1.2" + version: "1.2.0" + name: "si_1998" +units: + s: + $$inherit: "/v1.2/units/si/1967/base/second" + m: + $$inherit: "/v1.2/units/si/1983/base/metre" + kg: + $$inherit: "/v1.2/units/si/1960/base/kilogram" + A: + $$inherit: "/v1.2/units/si/1983/base/ampere" + K: + $$inherit: "/v1.2/units/si/1967/base/kelvin" + mol: + $$inherit: "/v1.2/units/si/1971/base/mole" + cd: + $$inherit: "/v1.2/units/si/1983/base/candela" + rad: + $$inherit: "/v1.2/units/si/1960/supplementary/radian" + sr: + $$inherit: "/v1.2/units/si/1960/supplementary/steradian" + Hz: + $$inherit: "/v1.2/units/si/1967/named/hertz" + N: + $$inherit: "/v1.2/units/si/1983/named/newton" + Pa: + $$inherit: "/v1.2/units/si/1983/named/pascal" + J: + $$inherit: "/v1.2/units/si/1967/named/joule" + W: + $$inherit: "/v1.2/units/si/1967/named/watt" + C: + $$inherit: "/v1.2/units/si/1967/named/coulomb" + V: + $$inherit: "/v1.2/units/si/1983/named/volt" + F: + $$inherit: "/v1.2/units/si/1983/named/farad" + ohm: + $$inherit: "/v1.2/units/si/1983/named/ohm" + S: + $$inherit: "/v1.2/units/si/1983/named/siemens" + Wb: + $$inherit: "/v1.2/units/si/1983/named/weber" + T: + $$inherit: "/v1.2/units/si/1967/named/tesla" + H: + $$inherit: "/v1.2/units/si/1983/named/henry" + degC: + $$inherit: "/v1.2/units/si/1967/named/degcelsius" + lm: + $$inherit: "/v1.2/units/si/1979/named/lumen" + lx: + $$inherit: "/v1.2/units/si/1983/named/lux" + Bq: + $$inherit: "/v1.2/units/si/1975/named/becquerel" + Gy: + $$inherit: "/v1.2/units/si/1983/named/gray" + Sv: + $$inherit: "/v1.2/units/si/1983/named/sievert" +prefixes: + Y: + $$inherit: "/v1.2/prefixes/si/yotta" + Z: + $$inherit: "/v1.2/prefixes/si/zetta" + E: + $$inherit: "/v1.2/prefixes/si/exa" + P: + $$inherit: "/v1.2/prefixes/si/peta" + T: + $$inherit: "/v1.2/prefixes/si/tera" + G: + $$inherit: "/v1.2/prefixes/si/giga" + M: + $$inherit: "/v1.2/prefixes/si/mega" + k: + $$inherit: "/v1.2/prefixes/si/kilo" + h: + $$inherit: "/v1.2/prefixes/si/hecto" + da: + $$inherit: "/v1.2/prefixes/si/deca" + d: + $$inherit: "/v1.2/prefixes/si/deci" + c: + $$inherit: "/v1.2/prefixes/si/centi" + m: + $$inherit: "/v1.2/prefixes/si/milli" + mc: + $$inherit: "/v1.2/prefixes/si/micro" + n: + $$inherit: "/v1.2/prefixes/si/nano" + p: + $$inherit: "/v1.2/prefixes/si/pico" + f: + $$inherit: "/v1.2/prefixes/si/femto" + a: + $$inherit: "/v1.2/prefixes/si/atto" + z: + $$inherit: "/v1.2/prefixes/si/zepto" + y: + $$inherit: "/v1.2/prefixes/si/yocto" diff --git a/schemas/src/defs/v1.2/unitsystems/si/si_2006.yaml b/schemas/src/defs/v1.2/unitsystems/si/si_2006.yaml new file mode 100644 index 000000000..eda4c2ef1 --- /dev/null +++ b/schemas/src/defs/v1.2/unitsystems/si/si_2006.yaml @@ -0,0 +1,114 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/unitsystem_definition" +$id: "https://schemas.optimade.org/defs/v1.2/unitsystems/si/si_2006" +title: "SI 2006" +description: |- + The SI unit system as represented in the 8th edition of the International System of Units. + + The International System of Units (SI) is established and maintained by the General Conference on Weights and Measures (CGPM). + This represents the SI unit system described in the 8th edition of the International System of Units in 2006. +x-optimade-definition: + label: "si_2006_unitsystem" + kind: "unitsystem" + format: "1.2" + version: "1.2.0" + name: "si_2006" +units: + s: + $$inherit: "/v1.2/units/si/1967/base/second" + m: + $$inherit: "/v1.2/units/si/1983/base/metre" + kg: + $$inherit: "/v1.2/units/si/1960/base/kilogram" + A: + $$inherit: "/v1.2/units/si/1983/base/ampere" + K: + $$inherit: "/v1.2/units/si/1967/base/kelvin" + mol: + $$inherit: "/v1.2/units/si/1971/base/mole" + cd: + $$inherit: "/v1.2/units/si/1983/base/candela" + rad: + $$inherit: "/v1.2/units/si/1960/supplementary/radian" + sr: + $$inherit: "/v1.2/units/si/1960/supplementary/steradian" + Hz: + $$inherit: "/v1.2/units/si/1967/named/hertz" + N: + $$inherit: "/v1.2/units/si/1983/named/newton" + Pa: + $$inherit: "/v1.2/units/si/1983/named/pascal" + J: + $$inherit: "/v1.2/units/si/1967/named/joule" + W: + $$inherit: "/v1.2/units/si/1967/named/watt" + C: + $$inherit: "/v1.2/units/si/1967/named/coulomb" + V: + $$inherit: "/v1.2/units/si/1983/named/volt" + F: + $$inherit: "/v1.2/units/si/1983/named/farad" + ohm: + $$inherit: "/v1.2/units/si/1983/named/ohm" + S: + $$inherit: "/v1.2/units/si/1983/named/siemens" + Wb: + $$inherit: "/v1.2/units/si/1983/named/weber" + T: + $$inherit: "/v1.2/units/si/1967/named/tesla" + H: + $$inherit: "/v1.2/units/si/1983/named/henry" + degC: + $$inherit: "/v1.2/units/si/1967/named/degcelsius" + lm: + $$inherit: "/v1.2/units/si/1979/named/lumen" + lx: + $$inherit: "/v1.2/units/si/1983/named/lux" + Bq: + $$inherit: "/v1.2/units/si/1975/named/becquerel" + Gy: + $$inherit: "/v1.2/units/si/1983/named/gray" + Sv: + $$inherit: "/v1.2/units/si/1983/named/sievert" + kat: + $$inherit: "/v1.2/units/si/1999/named/katal" +prefixes: + Y: + $$inherit: "/v1.2/prefixes/si/yotta" + Z: + $$inherit: "/v1.2/prefixes/si/zetta" + E: + $$inherit: "/v1.2/prefixes/si/exa" + P: + $$inherit: "/v1.2/prefixes/si/peta" + T: + $$inherit: "/v1.2/prefixes/si/tera" + G: + $$inherit: "/v1.2/prefixes/si/giga" + M: + $$inherit: "/v1.2/prefixes/si/mega" + k: + $$inherit: "/v1.2/prefixes/si/kilo" + h: + $$inherit: "/v1.2/prefixes/si/hecto" + da: + $$inherit: "/v1.2/prefixes/si/deca" + d: + $$inherit: "/v1.2/prefixes/si/deci" + c: + $$inherit: "/v1.2/prefixes/si/centi" + m: + $$inherit: "/v1.2/prefixes/si/milli" + mc: + $$inherit: "/v1.2/prefixes/si/micro" + n: + $$inherit: "/v1.2/prefixes/si/nano" + p: + $$inherit: "/v1.2/prefixes/si/pico" + f: + $$inherit: "/v1.2/prefixes/si/femto" + a: + $$inherit: "/v1.2/prefixes/si/atto" + z: + $$inherit: "/v1.2/prefixes/si/zepto" + y: + $$inherit: "/v1.2/prefixes/si/yocto" diff --git a/schemas/src/defs/v1.2/unitsystems/si/si_2019.yaml b/schemas/src/defs/v1.2/unitsystems/si/si_2019.yaml new file mode 100644 index 000000000..9444a30e0 --- /dev/null +++ b/schemas/src/defs/v1.2/unitsystems/si/si_2019.yaml @@ -0,0 +1,118 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/unitsystem_definition" +$id: "https://schemas.optimade.org/defs/v1.2/unitsystems/si/si_2019" +title: "SI 2019" +description: |- + The SI 2019 unit system as represented in the 9th edition (v1.06) of the International System of Units. + + The International System of Units (SI) is established and maintained by the General Conference on Weights and Measures (CGPM). + In the redefinition of the SI unit system in 2019 the magnitudes of all SI units are defined from declaring exact numerical values for seven defining constants when expressed in terms of their SI units. + + The SI 2019 unit system represents the original publication of the 9th edition of the International System of Units in March 2019 (marked v1.06). + The 9th edition was later updated in 2022 with new SI prefixes defined at the 27th CGPM meeting in 2022. + These prefixes are not included. +x-optimade-definition: + label: "si_2019_unitsystem" + kind: "unitsystem" + format: "1.2" + version: "1.2.0" + name: "si_2019" +units: + s: + $$inherit: "/v1.2/units/si/1967/base/second" + m: + $$inherit: "/v1.2/units/si/1983/base/metre" + kg: + $$inherit: "/v1.2/units/si/2019/base/kilogram" + A: + $$inherit: "/v1.2/units/si/2019/base/ampere" + K: + $$inherit: "/v1.2/units/si/2019/base/kelvin" + mol: + $$inherit: "/v1.2/units/si/2019/base/mole" + cd: + $$inherit: "/v1.2/units/si/2019/base/candela" + rad: + $$inherit: "/v1.2/units/si/1960/supplementary/radian" + sr: + $$inherit: "/v1.2/units/si/1960/supplementary/steradian" + Bq: + $$inherit: "/v1.2/units/si/1975/named/becquerel" + C: + $$inherit: "/v1.2/units/si/2019/named/coulomb" + degC: + $$inherit: "/v1.2/units/si/2019/named/degcelsius" + F: + $$inherit: "/v1.2/units/si/2019/named/farad" + Gy: + $$inherit: "/v1.2/units/si/1983/named/gray" + H: + $$inherit: "/v1.2/units/si/2019/named/henry" + Hz: + $$inherit: "/v1.2/units/si/1967/named/hertz" + J: + $$inherit: "/v1.2/units/si/2019/named/joule" + kat: + $$inherit: "/v1.2/units/si/2019/named/katal" + lm: + $$inherit: "/v1.2/units/si/2019/named/lumen" + lx: + $$inherit: "/v1.2/units/si/2019/named/lux" + N: + $$inherit: "/v1.2/units/si/2019/named/newton" + ohm: + $$inherit: "/v1.2/units/si/2019/named/ohm" + Pa: + $$inherit: "/v1.2/units/si/2019/named/pascal" + S: + $$inherit: "/v1.2/units/si/2019/named/siemens" + Sv: + $$inherit: "/v1.2/units/si/1983/named/sievert" + T: + $$inherit: "/v1.2/units/si/2019/named/tesla" + V: + $$inherit: "/v1.2/units/si/2019/named/volt" + W: + $$inherit: "/v1.2/units/si/2019/named/watt" + Wb: + $$inherit: "/v1.2/units/si/2019/named/weber" +prefixes: + Y: + $$inherit: "/v1.2/prefixes/si/yotta" + Z: + $$inherit: "/v1.2/prefixes/si/zetta" + E: + $$inherit: "/v1.2/prefixes/si/exa" + P: + $$inherit: "/v1.2/prefixes/si/peta" + T: + $$inherit: "/v1.2/prefixes/si/tera" + G: + $$inherit: "/v1.2/prefixes/si/giga" + M: + $$inherit: "/v1.2/prefixes/si/mega" + k: + $$inherit: "/v1.2/prefixes/si/kilo" + h: + $$inherit: "/v1.2/prefixes/si/hecto" + da: + $$inherit: "/v1.2/prefixes/si/deca" + d: + $$inherit: "/v1.2/prefixes/si/deci" + c: + $$inherit: "/v1.2/prefixes/si/centi" + m: + $$inherit: "/v1.2/prefixes/si/milli" + mc: + $$inherit: "/v1.2/prefixes/si/micro" + n: + $$inherit: "/v1.2/prefixes/si/nano" + p: + $$inherit: "/v1.2/prefixes/si/pico" + f: + $$inherit: "/v1.2/prefixes/si/femto" + a: + $$inherit: "/v1.2/prefixes/si/atto" + z: + $$inherit: "/v1.2/prefixes/si/zepto" + y: + $$inherit: "/v1.2/prefixes/si/yocto" diff --git a/schemas/src/defs/v1.2/unitsystems/si/si_accepted_2019.yaml b/schemas/src/defs/v1.2/unitsystems/si/si_accepted_2019.yaml new file mode 100644 index 000000000..f2559cfaf --- /dev/null +++ b/schemas/src/defs/v1.2/unitsystems/si/si_accepted_2019.yaml @@ -0,0 +1,42 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/unitsystem_definition" +$id: "https://schemas.optimade.org/defs/v1.2/unitsystems/si/si_accepted_2019" +title: "SI accepted 2019" +$$inherit: "/v1.2/unitsystems/si/si_2019" +description: |- + The SI 2019 unit system and units accepted to be used with the SI. + + The International System of Units (SI) is established and maintained by the General Conference on Weights and Measures (CGPM). + In the redefinition of the SI unit system in 2019 the magnitudes of all SI units are defined from declaring exact numerical values for seven defining constants when expressed in terms of their SI units. + The si_extra_2019 unit system includes the prefixes and the units designated in the International System of Units (SI), 9th ed. (2019) as "Non-SI units that are accepted for use with the SI." + (The general logarithmic ratio quantities, B and dB are not included.) +x-optimade-definition: + label: "si_accepted_2019_unitsystem" + kind: "unitsystem" + format: "1.2" + version: "1.2.0" + name: "si_accepted_2019" +units: + min: + $$inherit: "/v1.2/units/si/1970/accepted/minute" + h: + $$inherit: "/v1.2/units/si/1970/accepted/hour" + day: + $$inherit: "/v1.2/units/si/1970/accepted/day" + au: + $$inherit: "/v1.2/units/si/2019/accepted/astronomicalunit" + deg: + $$inherit: "/v1.2/units/si/1970/accepted/degree" + arcmin: + $$inherit: "/v1.2/units/si/1970/accepted/arcminute" + arcsec: + $$inherit: "/v1.2/units/si/1970/accepted/arcsecond" + ha: + $$inherit: "/v1.2/units/si/1983/temporary/hectare" + l: + $$inherit: "/v1.2/units/si/1983/accepted/litre" + t: + $$inherit: "/v1.2/units/si/2019/accepted/tonne" + da: + $$inherit: "/v1.2/units/si/1998/accepted/dalton" + eV: + $$inherit: "/v1.2/units/si/2019/accepted/electronvolt" diff --git a/schemas/src/defs/v1.2/unitsystems/si/si_general.yaml b/schemas/src/defs/v1.2/unitsystems/si/si_general.yaml new file mode 100644 index 000000000..bff98d684 --- /dev/null +++ b/schemas/src/defs/v1.2/unitsystems/si/si_general.yaml @@ -0,0 +1,190 @@ +$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/unitsystem_definition" +$id: "https://schemas.optimade.org/defs/v1.2/unitsystems/si/si_general" +title: "SI general" +description: |- + The SI unit system, using current or historical definitions of the SI units. + + The International System of Units (SI) is established and maintained by the General Conference on Weights and Measures (CGPM). + The si_general unit system includes all prefixes defined by SI (including the non-SI binary ones), and all units that have either been part of the SI unit system or categorized as accepted for use with the SI. +x-optimade-definition: + label: "si_general_unitsystem" + kind: "unitsystem" + format: "1.2" + version: "1.2.0" + name: "si_general" +units: + A: + $$inherit: "/v1.2/units/si/general/ampere" + angstrom: + $$inherit: "/v1.2/units/si/general/angstrom" + arcmin: + $$inherit: "/v1.2/units/si/general/arcminute" + arcsec: + $$inherit: "/v1.2/units/si/general/arcsecond" + are: + $$inherit: "/v1.2/units/si/general/are" + au: + $$inherit: "/v1.2/units/si/general/astronomicalunit" + atm: + $$inherit: "/v1.2/units/si/general/atmosphere" + u: + $$inherit: "/v1.2/units/si/general/atomicmassunit" + b: + $$inherit: "/v1.2/units/si/general/barn" + bar: + $$inherit: "/v1.2/units/si/general/bar" + Bq: + $$inherit: "/v1.2/units/si/general/becquerel" + cd: + $$inherit: "/v1.2/units/si/general/candela" + C: + $$inherit: "/v1.2/units/si/general/coulomb" + Ci: + $$inherit: "/v1.2/units/si/general/curie" + da: + $$inherit: "/v1.2/units/si/general/dalton" + day: + $$inherit: "/v1.2/units/si/general/day" + degC: + $$inherit: "/v1.2/units/si/general/degcelsius" + deg: + $$inherit: "/v1.2/units/si/general/degree" + eV: + $$inherit: "/v1.2/units/si/general/electronvolt" + F: + $$inherit: "/v1.2/units/si/general/farad" + Gal: + $$inherit: "/v1.2/units/si/general/gal" + Gy: + $$inherit: "/v1.2/units/si/general/gray" + ha: + $$inherit: "/v1.2/units/si/general/hectare" + H: + $$inherit: "/v1.2/units/si/general/henry" + Hz: + $$inherit: "/v1.2/units/si/general/hertz" + h: + $$inherit: "/v1.2/units/si/general/hour" + J: + $$inherit: "/v1.2/units/si/general/joule" + kat: + $$inherit: "/v1.2/units/si/general/katal" + K: + $$inherit: "/v1.2/units/si/general/kelvin" + kg: + $$inherit: "/v1.2/units/si/general/kilogram" + knot: + $$inherit: "/v1.2/units/si/general/knot" + l: + $$inherit: "/v1.2/units/si/general/litre" + lm: + $$inherit: "/v1.2/units/si/general/lumen" + lx: + $$inherit: "/v1.2/units/si/general/lux" + m: + $$inherit: "/v1.2/units/si/general/metre" + min: + $$inherit: "/v1.2/units/si/general/minute" + mol: + $$inherit: "/v1.2/units/si/general/mole" + nauticalmile: + $$inherit: "/v1.2/units/si/general/nauticalmile" + N: + $$inherit: "/v1.2/units/si/general/newton" + ohm: + $$inherit: "/v1.2/units/si/general/ohm" + pc: + $$inherit: "/v1.2/units/si/general/parsec" + Pa: + $$inherit: "/v1.2/units/si/general/pascal" + rad: + $$inherit: "/v1.2/units/si/general/radian" + radiationunit: + $$inherit: "/v1.2/units/si/general/radiationunit" + rem: + $$inherit: "/v1.2/units/si/general/rem" + R: + $$inherit: "/v1.2/units/si/general/roentgen" + s: + $$inherit: "/v1.2/units/si/general/second" + S: + $$inherit: "/v1.2/units/si/general/siemens" + Sv: + $$inherit: "/v1.2/units/si/general/sievert" + sr: + $$inherit: "/v1.2/units/si/general/steradian" + T: + $$inherit: "/v1.2/units/si/general/tesla" + t: + $$inherit: "/v1.2/units/si/general/tonne" + V: + $$inherit: "/v1.2/units/si/general/volt" + W: + $$inherit: "/v1.2/units/si/general/watt" + Wb: + $$inherit: "/v1.2/units/si/general/weber" +prefixes: + Y: + $$inherit: "/v1.2/prefixes/si/yotta" + Z: + $$inherit: "/v1.2/prefixes/si/zetta" + E: + $$inherit: "/v1.2/prefixes/si/exa" + P: + $$inherit: "/v1.2/prefixes/si/peta" + T: + $$inherit: "/v1.2/prefixes/si/tera" + G: + $$inherit: "/v1.2/prefixes/si/giga" + M: + $$inherit: "/v1.2/prefixes/si/mega" + k: + $$inherit: "/v1.2/prefixes/si/kilo" + h: + $$inherit: "/v1.2/prefixes/si/hecto" + da: + $$inherit: "/v1.2/prefixes/si/deca" + d: + $$inherit: "/v1.2/prefixes/si/deci" + c: + $$inherit: "/v1.2/prefixes/si/centi" + m: + $$inherit: "/v1.2/prefixes/si/milli" + mc: + $$inherit: "/v1.2/prefixes/si/micro" + n: + $$inherit: "/v1.2/prefixes/si/nano" + p: + $$inherit: "/v1.2/prefixes/si/pico" + f: + $$inherit: "/v1.2/prefixes/si/femto" + a: + $$inherit: "/v1.2/prefixes/si/atto" + z: + $$inherit: "/v1.2/prefixes/si/zepto" + y: + $$inherit: "/v1.2/prefixes/si/yocto" + Q: + $$inherit: "/v1.2/prefixes/si/quetta" + R: + $$inherit: "/v1.2/prefixes/si/ronna" + r: + $$inherit: "/v1.2/prefixes/si/ronto" + q: + $$inherit: "/v1.2/prefixes/si/quecto" + Ei: + $$inherit: "/v1.2/prefixes/si/exbi" + Gi: + $$inherit: "/v1.2/prefixes/si/gibi" + Ki: + $$inherit: "/v1.2/prefixes/si/kibi" + Mi: + $$inherit: "/v1.2/prefixes/si/mebi" + Pi: + $$inherit: "/v1.2/prefixes/si/pebi" + Ti: + $$inherit: "/v1.2/prefixes/si/tebi" + Yi: + $$inherit: "/v1.2/prefixes/si/yobi" + Zi: + $$inherit: "/v1.2/prefixes/si/zebi" diff --git a/schemas/src/json-ld/v1.2/nodetypes/optimade/files.yaml b/schemas/src/json-ld/v1.2/nodetypes/optimade/files.yaml new file mode 100644 index 000000000..c7a4eace4 --- /dev/null +++ b/schemas/src/json-ld/v1.2/nodetypes/optimade/files.yaml @@ -0,0 +1,18 @@ +'@context': + + id: "https://schemas.optimade.org/defs/v1.2/properties/core/id" + type: "https://schemas.optimade.org/defs/v1.2/properties/core/type" + immutable_id: "https://schemas.optimade.org/defs/v1.2/properties/core/immutable_id" + last_modified: "https://schemas.optimade.org/defs/v1.2/properties/core/last_modified" + url: "https://schemas.optimade.org/defs/v1.2/properties/core/last_modified" + url_stable_until: "https://schemas.optimade.org/defs/v1.2/properties/optimade/files/url_stable_until" + name: "https://schemas.optimade.org/defs/v1.2/properties/optimade/files/name" + size: "https://schemas.optimade.org/defs/v1.2/properties/optimade/files/size" + media_type: "https://schemas.optimade.org/defs/v1.2/properties/optimade/files/media_type" + version: "https://schemas.optimade.org/defs/v1.2/properties/optimade/files/version" + modification_timestamp: "https://schemas.optimade.org/defs/v1.2/properties/optimade/files/modification_timestamp" + description: "https://schemas.optimade.org/defs/v1.2/properties/optimade/files/description" + checksums: "https://schemas.optimade.org/defs/v1.2/properties/optimade/files/checksums" + atime: "https://schemas.optimade.org/defs/v1.2/properties/optimade/files/checksums" + ctime: "https://schemas.optimade.org/defs/v1.2/properties/optimade/files/ctime" + mtime: "https://schemas.optimade.org/defs/v1.2/properties/optimade/files/mtime" diff --git a/schemas/src/json-ld/v1.2/nodetypes/optimade/references.yaml b/schemas/src/json-ld/v1.2/nodetypes/optimade/references.yaml new file mode 100644 index 000000000..d0b2429e6 --- /dev/null +++ b/schemas/src/json-ld/v1.2/nodetypes/optimade/references.yaml @@ -0,0 +1,32 @@ +'@context': + + id: "https://schemas.optimade.org/defs/v1.2/properties/core/id" + type: "https://schemas.optimade.org/defs/v1.2/properties/core/type" + immutable_id: "https://schemas.optimade.org/defs/v1.2/properties/core/immutable_id" + last_modified: "https://schemas.optimade.org/defs/v1.2/properties/core/last_modified" + address: "https://schemas.optimade.org/defs/v1.2/properties/optimade/references/address" + annote: "https://schemas.optimade.org/defs/v1.2/properties/optimade/references/annote" + booktitle: "https://schemas.optimade.org/defs/v1.2/properties/optimade/references/booktitle" + chapter: "https://schemas.optimade.org/defs/v1.2/properties/optimade/references/chapter" + crossref: "https://schemas.optimade.org/defs/v1.2/properties/optimade/references/crossref" + edition: "https://schemas.optimade.org/defs/v1.2/properties/optimade/references/edition" + howpublished: "https://schemas.optimade.org/defs/v1.2/properties/optimade/references/howpublished" + institution: "https://schemas.optimade.org/defs/v1.2/properties/optimade/references/institution" + journal: "https://schemas.optimade.org/defs/v1.2/properties/optimade/references/journal" + key: "https://schemas.optimade.org/defs/v1.2/properties/optimade/references/key" + month: "https://schemas.optimade.org/defs/v1.2/properties/optimade/references/month" + note: "https://schemas.optimade.org/defs/v1.2/properties/optimade/references/note" + number: "https://schemas.optimade.org/defs/v1.2/properties/optimade/references/number" + organization: "https://schemas.optimade.org/defs/v1.2/properties/optimade/references/organization" + pages: "https://schemas.optimade.org/defs/v1.2/properties/optimade/references/pages" + publisher: "https://schemas.optimade.org/defs/v1.2/properties/optimade/references/publisher" + school: "https://schemas.optimade.org/defs/v1.2/properties/optimade/references/school" + series: "https://schemas.optimade.org/defs/v1.2/properties/optimade/references/series" + title: "https://schemas.optimade.org/defs/v1.2/properties/optimade/references/title" + volume: "https://schemas.optimade.org/defs/v1.2/properties/optimade/references/volume" + year: "https://schemas.optimade.org/defs/v1.2/properties/optimade/references/year" + bib_type: "https://schemas.optimade.org/defs/v1.2/properties/optimade/references/bib_type" + authors: "https://schemas.optimade.org/defs/v1.2/properties/optimade/references/authors" + editors: "https://schemas.optimade.org/defs/v1.2/properties/optimade/references/editors" + doi: "https://schemas.optimade.org/defs/v1.2/properties/optimade/references/doi" + url: "https://schemas.optimade.org/defs/v1.2/properties/optimade/references/url" diff --git a/schemas/src/json-ld/v1.2/nodetypes/optimade/structures.yaml b/schemas/src/json-ld/v1.2/nodetypes/optimade/structures.yaml new file mode 100644 index 000000000..f97a16292 --- /dev/null +++ b/schemas/src/json-ld/v1.2/nodetypes/optimade/structures.yaml @@ -0,0 +1,27 @@ +'@context': + + id: "https://schemas.optimade.org/defs/v1.2/properties/core/id" + type: "https://schemas.optimade.org/defs/v1.2/properties/core/type" + immutable_id: "https://schemas.optimade.org/defs/v1.2/properties/core/immutable_id" + last_modified: "https://schemas.optimade.org/defs/v1.2/properties/core/last_modified" + elements: "https://schemas.optimade.org/defs/v1.2/properties/optimade/structures/elements" + nelements: "https://schemas.optimade.org/defs/v1.2/properties/optimade/structures/nelements" + elements_ratios: "https://schemas.optimade.org/defs/v1.2/properties/optimade/structures/elements_ratios" + chemical_formula_descriptive: "https://schemas.optimade.org/defs/v1.2/properties/optimade/structures/chemical_formula_descriptive" + chemical_formula_reduced: "https://schemas.optimade.org/defs/v1.2/properties/optimade/structures/chemical_formula_reduced" + chemical_formula_hill: "https://schemas.optimade.org/defs/v1.2/properties/optimade/structures/chemical_formula_hill" + chemical_formula_anonymous: "https://schemas.optimade.org/defs/v1.2/properties/optimade/structures/chemical_formula_anonymous" + dimension_types: "https://schemas.optimade.org/defs/v1.2/properties/optimade/structures/dimension_types" + nperiodic_dimensions: "https://schemas.optimade.org/defs/v1.2/properties/optimade/structures/nperiodic_dimensions" + lattice_vectors: "https://schemas.optimade.org/defs/v1.2/properties/optimade/structures/lattice_vectors" + space_group_symmetry_operations_xyz: "https://schemas.optimade.org/defs/v1.2/properties/optimade/structures/space_group_symmetry_operations_xyz" + space_group_symbol_hall: "https://schemas.optimade.org/defs/v1.2/properties/optimade/structures/space_group_symbol_hall" + space_group_symbol_hermann_mauguin: "https://schemas.optimade.org/defs/v1.2/properties/optimade/structures/space_group_symbol_hermann_mauguin" + space_group_symbol_hermann_mauguin_extended: "https://schemas.optimade.org/defs/v1.2/properties/optimade/structures/space_group_symbol_hermann_mauguin_extended" + space_group_it_number: "https://schemas.optimade.org/defs/v1.2/properties/optimade/structures/space_group_it_number" + cartesian_site_positions: "https://schemas.optimade.org/defs/v1.2/properties/optimade/structures/cartesian_site_positions" + nsites: "https://schemas.optimade.org/defs/v1.2/properties/optimade/structures/nsites" + species_at_sites: "https://schemas.optimade.org/defs/v1.2/properties/optimade/structures/species_at_sites" + species: "https://schemas.optimade.org/defs/v1.2/properties/optimade/structures/species" + assemblies: "https://schemas.optimade.org/defs/v1.2/properties/optimade/structures/assemblies" + structure_features: "https://schemas.optimade.org/defs/v1.2/properties/optimade/structures/structure_features" diff --git a/schemas/src/json-ld/v1.2/optimade.yaml b/schemas/src/json-ld/v1.2/optimade.yaml new file mode 100644 index 000000000..39bda7c06 --- /dev/null +++ b/schemas/src/json-ld/v1.2/optimade.yaml @@ -0,0 +1,19 @@ +'@context': + + id: "@id" + type: "@type" + + data: "@graph" + attributes: "@nest" + + structures: + '@id': "https://schemas.optimade.org/json-ld/v1.2/nodetypes/optimade/structures" + '@context': "https://schemas.optimade.org/json-ld/v1.2/nodetypes/optimade/structures.json" + + files: + '@id': "https://schemas.optimade.org/json-ld/v1.2/nodetypes/optimade/files" + '@context': "https://schemas.optimade.org/json-ld/v1.2/nodetypes/optimade/files.json" + + references: + '@id': "https://schemas.optimade.org/json-ld/v1.2/nodetypes/optimade/references" + '@context': "https://schemas.optimade.org/json-ld/v1.2/nodetypes/optimade/references.json" diff --git a/schemas/src/json-schema/v1.2/jsonapi.json b/schemas/src/json-schema/v1.2/jsonapi.json new file mode 120000 index 000000000..fd01c82ad --- /dev/null +++ b/schemas/src/json-schema/v1.2/jsonapi.json @@ -0,0 +1 @@ +../../../../external/json-api/schema.json \ No newline at end of file diff --git a/schemas/src/json-schema/v1.2/optimade.yaml b/schemas/src/json-schema/v1.2/optimade.yaml new file mode 100644 index 000000000..61c73fe28 --- /dev/null +++ b/schemas/src/json-schema/v1.2/optimade.yaml @@ -0,0 +1,27 @@ +$schema: "https://json-schema.org/draft/2020-12/schema" +$$inherit: "jsonapi.json" +title: "OPTIMADE schema" +description: "This is a schema for responses in the JSON output format from the OPTIMADE API. It is directly based on the schema for JSON:API." +definitions: + resource: + oneOf: + - type: "object" + properties: + type: + const: "structures" + attributes: + $ref: "#endpoints/entrytypes/structures" + - type: "object" + properties: + type: + const: "files" + attributes: + $ref: "#endpoints/entrytypes/files" + - type: "object" + properties: + type: + const: "references" + attributes: + $ref: "#endpoints/entrytypes/references" +endpoints: + $$inherit: "/v1.2/standards/optimade" diff --git a/schemas/src/meta/v1.2/common/id_field.yaml b/schemas/src/meta/v1.2/common/id_field.yaml new file mode 100644 index 000000000..682311291 --- /dev/null +++ b/schemas/src/meta/v1.2/common/id_field.yaml @@ -0,0 +1,6 @@ +$schema: "https://json-schema.org/draft/2020-12/schema" +$id: "https://schemas.optimade.org/meta/v1.2/common/id_field" +title: "ID" +description: "An IRI that is an ID" +type: string +format: "iri" diff --git a/schemas/src/meta/v1.2/common/resource_list.yaml b/schemas/src/meta/v1.2/common/resource_list.yaml new file mode 100644 index 000000000..5552c90ba --- /dev/null +++ b/schemas/src/meta/v1.2/common/resource_list.yaml @@ -0,0 +1,23 @@ +$schema: "https://json-schema.org/draft/2020-12/schema" +$id: "https://schemas.optimade.org/meta/v1.2/common/resource_list" +title: "resource list" +description: "A list of dictionaries that describe and reference remote resources." +type: array +items: + patternProperties: + "^x-(?!optimade-)": {} + additionalProperties: False + properties: + relation: + description: |- + A human-readable description of the resource and what is being referenced in the resource, e.g., a "natural language description". + type: string + resource-id: + description: |- + An IRI of the external resource (which MAY be a resolvable URL). + type: string + format: "iri" + required: + - relation + - resource-id + type: object diff --git a/schemas/src/meta/v1.2/common/symbol_list.yaml b/schemas/src/meta/v1.2/common/symbol_list.yaml new file mode 100644 index 000000000..037b9b54f --- /dev/null +++ b/schemas/src/meta/v1.2/common/symbol_list.yaml @@ -0,0 +1,22 @@ +$schema: "https://json-schema.org/draft/2020-12/schema" +$id: "https://schemas.optimade.org/meta/v1.2/common/symbol_list" +title: "symbol list" +description: "A list of dictionaries that associate and id with a symbol" +items: + additionalProperties: False + patternProperties: + "^_": {} + properties: + id: + description: "The IRI of one of the referenced entity." + format: "uri" + type: string + symbol: + description: "The symbol used to reference this entity." + pattern: ^[a-zA-Z_][a-zA-Z_0-9]*$ + type: string + required: + - symbol + - id + type: object +type: array diff --git a/schemas/src/meta/v1.2/optimade/constant_definition.yaml b/schemas/src/meta/v1.2/optimade/constant_definition.yaml new file mode 100644 index 000000000..575383cca --- /dev/null +++ b/schemas/src/meta/v1.2/optimade/constant_definition.yaml @@ -0,0 +1,5 @@ +$schema: "https://json-schema.org/draft/2020-12/schema" +$id: "https://schemas.optimade.org/meta/v1.2/optimade/constant_definition" +title: "OPTIMADE constant definition schema" +description: "Meta-schema for OPTIMADE definitions of mathematical and physical constants." +$$inherit: unit_entity_definition diff --git a/schemas/src/meta/v1.2/optimade/entrytype_definition.yaml b/schemas/src/meta/v1.2/optimade/entrytype_definition.yaml new file mode 100644 index 000000000..42406e3d4 --- /dev/null +++ b/schemas/src/meta/v1.2/optimade/entrytype_definition.yaml @@ -0,0 +1,44 @@ +$schema: "https://json-schema.org/draft/2020-12/schema" +$id: "https://schemas.optimade.org/meta/v1.2/optimade/entrytype_definition" +title: "OPTIMADE entry type definition schema" +required: ["$id", "$schema", "x-optimade-definition", "title", "type", "properties"] +allOf: + - $ref: "#/$defs/entrytype_definition_field" + - required: ["$id", "$schema"] +$$inherit: "property_definition" +$$keep: ['$defs'] +$defs: + id_field: + $$inherit: "/v1.2/common/id_field" + entrytype_definition_field: + type: object + additionalProperties: false + required: ["type", "x-optimade-definition", "properties"] + properties: + "$id": + $ref: "#/$defs/id_field" + "$schema": + type: string + type: + type: [string, array] + enum: ["object", ["object"]] + x-optimade-definition: + $$inherit: "x-optimade-definition-field" + properties: + kind: + const: "entrytype" + x-optimade-requirements: + additionalProperties: False + properties: + support: + type: string + title: + type: string + description: + type: string + properties: + type: object + additionalProperties: + allOf: + - $ref: "#/$defs/property_definition_field" + - required: ["title", "description"] diff --git a/schemas/src/meta/v1.2/optimade/physical_unit_definition.yaml b/schemas/src/meta/v1.2/optimade/physical_unit_definition.yaml new file mode 100644 index 000000000..d971e07ff --- /dev/null +++ b/schemas/src/meta/v1.2/optimade/physical_unit_definition.yaml @@ -0,0 +1,5 @@ +$schema: "https://json-schema.org/draft/2020-12/schema" +$id: "https://schemas.optimade.org/meta/v1.2/optimade/physical_unit_definition" +title: "OPTIMADE physical unit definition schema" +description: "Meta-schema for OPTIMADE definitions of physical units." +$$inherit: unit_entity_definition diff --git a/schemas/src/meta/v1.2/optimade/prefix_definition.yaml b/schemas/src/meta/v1.2/optimade/prefix_definition.yaml new file mode 100644 index 000000000..a99ead93b --- /dev/null +++ b/schemas/src/meta/v1.2/optimade/prefix_definition.yaml @@ -0,0 +1,5 @@ +$schema: "https://json-schema.org/draft/2020-12/schema" +$id: "https://schemas.optimade.org/meta/v1.2/optimade/prefix_definition" +title: "OPTIMADE prefix definition schema" +description: "Meta-schema for OPTIMADE definitions of prefixes to be used with units." +$$inherit: unit_entity_definition diff --git a/schemas/src/meta/v1.2/optimade/property_definition.yaml b/schemas/src/meta/v1.2/optimade/property_definition.yaml new file mode 100644 index 000000000..7dd278c42 --- /dev/null +++ b/schemas/src/meta/v1.2/optimade/property_definition.yaml @@ -0,0 +1,432 @@ +$schema: "https://json-schema.org/draft/2020-12/schema" +$id: "https://schemas.optimade.org/meta/v1.2/optimade/property_definition" +title: "OPTIMADE property definition schema" +type: object +allOf: + - $ref: "#/$defs/property_definition_field" + - required: ["$id", "$schema", "title", "description", "x-optimade-definition"] +$$inherit: "physical_unit_definition" +$defs: + id_field: + $$inherit: "/v1.2/common/id_field" + property_definition_field: + required: ["type", "x-optimade-type", "x-optimade-unit"] + anyOf: + - type: object + required: ["properties"] + properties: + type: + enum: [["object"],["object", "null"]] + enum: + type: "array" + items: + type: "object" + examples: + type: "array" + items: + type: "object" + - type: object + required: ["type", "items"] + properties: + type: + enum: [["array"],["array", "null"]] + enum: + type: "array" + items: + type: "array" + examples: + type: "array" + items: + type: "array" + - type: object + required: ["type"] + properties: + type: + enum: [["integer"],["integer", "null"]] + multipleOf: + type: "integer" + maximum: + type: "integer" + exclusiveMaximum: + type: "integer" + minimum: + type: "integer" + exclusiveMinimum: + type: "integer" + enum: + type: "array" + items: + type: "integer" + examples: + type: "array" + items: + type: "integer" + - type: object + required: ["type"] + properties: + type: + enum: [["number"],["number", "null"]] + multipleOf: + type: "number" + maximum: + type: "number" + exclusiveMaximum: + type: "number" + minimum: + type: "number" + exclusiveMinimum: + type: "number" + enum: + type: "array" + items: + type: "number" + examples: + type: "array" + items: + type: "number" + - type: object + required: ["type"] + properties: + type: + enum: [["string"],["string", "null"]] + enum: + type: "array" + items: + type: "string" + examples: + type: "array" + items: + type: "string" + - type: object + required: ["type"] + properties: + type: + enum: [["boolean"],["boolean", "null"]] + enum: + type: "array" + items: + type: "boolean" + examples: + type: "array" + items: + type: "boolean" + properties: + type: + description: |- + Specifies the corresponding JSON type for this level of the defined property and whether the property can be `null` or not. + The value is directly correlated with `x-optimade-type` (cf. the `definition of the x-optimade-type field`). + + It MUST be a list of one or two elements where the first element is a string correlated with `x-optimade-type` as follows; if `x-optimade-type` is: + * `"boolean"`, `"string"`, or `"integer"` then `type` is the same string. + * `"dictionary"` then `type` is `"object"`. + * `"list"` then `type` is `"array"`. + * `"float"` then `type` is `"number"`. + * `"timestamp"` then `type` is `"string"`. + + If the second element is included, it MUST be the string `"null"`. + This two element form specifies that the defined property can be `null`. + type: array + enum: [["object"],["object", "null"],["array"],["array", "null"],["integer"],["integer", "null"],["number"],["number", "null"],["string"],["string", "null"],["boolean"],["boolean", "null"]] + items: + type: string + properties: + description: |- + Gives key-value pairs where each value is an inner Property Definition. + The defined property is a dictionary that can only contain keys present in this dictionary, and, if so, the corresponding value is described by the respective inner Property Definition. + (Or, if the type field is the list "object" and "null", it can also be null.) + type: object + additionalProperties: + $ref: '#/$defs/property_definition_field' + required: + description: |- + The defined property MUST have keys that match all the strings in this list. + Other keys present in the properties field are OPTIONAL in the defined property. + If not present or empty, all keys in properties are regarded as OPTIONAL. + type: "array" + items: + type: string + uniqueItems: true + maxProperties: + description: |- + The defined property is a dictionary where the number of keys MUST be less than or equal to the number given. + type: "integer" + minimum: 0 + minProperties: + description: |- + The defined property is a dictionary where the number of keys MUST be greater than or equal to the number given. + type: "integer" + minimum: 0 + dependentRequired: + description: |- + The dictionary keys are strings and the values are lists of unique strings. + If the defined property has a key that is equal to a key in the given dictionary, the defined property MUST also have keys that match each of the corresponding values. + No restriction is inferred from this field for keys in the defined property that do not match any key in the given dictionary. + type: "object" + additionalProperties: + type: "array" + items: + type: "string" + uniqueItems: true + enum: + description: "The defined property MUST take one of the values given in the provided list." + type: "array" + items: + $comment: "Must validate against the Property Definition itself, but there is no easy way to express that in the schema." + examples: + description: "A list of example values that the defined property can have." + type: "array" + items: + $comment: "Must validate against the Property Definition itself, but there is no easy way to express that in the schema." + items: + allOf: + - $ref: '#/$defs/property_definition_field' + - description: |- + The defined property is a list where each item MUST match this inner Property Definition. + uniqueItems: + description: "If TRUE, the defined property is an array that MUST only contain unique items. If FALSE, this field sets no limitation on the defined property." + type: "boolean" + multipleOf: + description: |- + An integer is strictly greater than 0. + The defined property MUST have a value that when divided by the given number results in an integer (i.e., it must be even divisible by this value without a fractional part). + type: ["integer", "number"] + exclusiveMinimum: 0 + maximum: + description: "The defined property MUST be less than or equal to the given value." + type: ["integer","number"] + exclusiveMaximum: + description: "The defined property MUST be strictly less than the given value; it cannot be equal." + type: ["integer","number"] + minimum: + description: "The defined property MUST be greater than or equal to the given value." + type: ["integer","number"] + exclusiveMinimum: + description: "The defined property MUST be strictly greater than the given value; it cannot be equal." + type: ["integer","number"] + maxLength: + description: |- + The defined property is a string that MUST have a length that is less than or equal to the given integer. + (The length of the string is the number of individual Unicode characters it is composed of.) + type: "integer" + minimum: 0 + minLength: + description: |- + The defined property is a string that MUST have a length that is less than or equal to the given integer. + (The length of the string is the number of individual Unicode characters it is composed of.) + type: "integer" + minimum: 0 + format: + description: |- + Choose one of the following values to indicate that the defined property is a string that MUST adhere to the specified format: + - "date-time": the date-time production in RFC 3339 section 5.6. + - "date": the full-date production in RFC 3339 section 5.6. + - "time": the full-time production in RFC 3339 section 5.6. + - "duration": the duration production in RFC 3339 Appendix A. + - "email": the "Mailbox" ABNF rule in RFC 5321 section 4.1.2. + - "uri": a string instance is valid against this attribute if it is a valid URI according to RFC 3986. + - "iri": a string instance is valid against this attribute if it is a valid IRI according to RFC 3987. + type: "string" + enum: ["date-time", "date", "time", "duration", "email", "uri", "iri"] + "$id": + allOf: + - $ref: '#/$defs/id_field' + - description: |- + A static IRI identifier that is a URN or URL representing the specific version of this level of the defined property. + (If it is a URL, clients SHOULD NOT assign any interpretation to the response when resolving that URL.) + It SHOULD NOT be changed as long as the property definition remains the same, and SHOULD be changed when the property definition changes. + Property Definitions SHOULD be regarded as the same if they only differ by: + - The inclusion or omission of "null" in the type in the outermost layer of the definition. + - Additions of annotating notes to end of the description field. + - Changes to the following specific fields at any level: deprecated, examples, $comment, x-optimade-implementation, and x-optimade-requirements. + "$schema": + description: |- + A normalized URI for a meta-schema that validates the Property Definition. + This SHOULD be https://schemas.optimade.org/meta/{OPTIMADE_VERSION}/optimade/physical_unit_definition.json + title: + description: |- + A short single-line human-readable explanation of the defined property appropriate to show as part of a user interface. + type: string + description: + description: |- + A human-readable multi-line description that explains the purpose, requirements, and conventions of the defined property. + The format SHOULD be a one-line description, followed by a new paragraph (two newlines), followed by a more detailed description of all the requirements and conventions of the defined property. + Formatting in the text SHOULD use Markdown in the CommonMark v0.3 format, with mathematical expressions written to render correctly with the LaTeX mode of Mathjax 3.2 . + When possible, it is preferable for mathematical expressions to use as straightforward notation as possible to make them readable also when not rendered. + + Additions appended to the end of the description field that are clearly marked as notes that clarify the definition without changing it are viewed as annotations to the Property Definition rather than an integral part of it. + Such annotations SHOULD only be added to the end of an otherwise unmodified description and MUST NOT change the meaning or interpretation of the text above them. + The purpose is to provide a way to add explanations and clarifications to a definition without having to regard it as a new definition. + For example, these annotations to the description MAY be used to explain why a definition has been deprecated. + type: string + x-optimade-definition: + $$inherit: "x-optimade-definition-field" + x-optimade-dimensions: + description: |- + Specification of the dimensions of one or multi-dimensional data represented as multiple levels of lists. + Each dimension is given a name and optionally a fixed size. + It was decided that OPTIMADE Property Definitions cannot use the JSON Schema validating fields minItems and maxItems since that would require reprocessing the schema to handle requests asking for only parts of the data in the lists. + Instead, list length information that an implementation can use to validate the length of lists is communicated in the `length` subfiled of this field (however, at this time, it can only specify a fixed length requirement.) + type: object + patternProperties: + "^x-(?!optimade-)": {} + properties: + names: + description: |- + A list of names of the dimensions of the underlying one or multi-dimensionsional data represented as mutiple levels of lists. + The order is that the first name applies to the outermost list, the next name to the lists embedded in that list, etc. + type: array + items: + type: string + sizes: + description: |- + A list of fixed length requirements on the underlying one or multi-dimensionsional data represented as mutiple levels of lists. + The order is that the first name applies to the outermost list, the next name to the lists embedded in that list, etc. + The data only validates if the respective level consists of lists of exactly this length. + A value of `null` allows arbitrary-length lists at the corresponding level. + type: array + items: + type: + - "integer" + - "null" + x-optimade-unit-definitions: + type: array + items: + allOf: + - $ref: "#/$defs/unit_entity_definition_field" + - required: ['title', 'symbol', 'display-symbol', 'description'] + x-optimade-type: + type: string + enum: + - string + - integer + - float + - boolean + - timestamp + - list + - dictionary + x-optimade-unit: + type: string + x-optimade-implementation: + patternProperties: + "^x-(?!optimade-)": {} + properties: + query-support: + enum: + - all mandatory + - equality only + - partial + - none + type: string + query-support-operators: + items: + enum: + - '<' + - '<=' + - '>' + - '>=' + - '=' + - '!=' + - 'CONTAINS' + - 'STARTS WITH' + - 'ENDS WITH' + - 'HAS' + - 'HAS ALL' + - 'HAS ANY' + - 'HAS ONLY' + - 'IS KNOWN' + - 'IS UNKNOWN' + type: string + type: array + response-level: + enum: + - "always" + - "yes" + - "no" + sortable: + type: boolean + "$comment": + type: string + type: object + x-optimade-requirements: + additionalProperties: false + properties: + patternProperties: + "^x-(?!optimade-)": {} + query-support: + enum: + - all mandatory + - equality only + - partial + - none + type: string + query-support-operators: + items: + enum: + - '<' + - '<=' + - '>' + - '>=' + - '=' + - '!=' + - 'CONTAINS' + - 'STARTS WITH' + - 'ENDS WITH' + - 'HAS' + - 'HAS ALL' + - 'HAS ANY' + - 'HAS ONLY' + - 'IS KNOWN' + - 'IS UNKNOWN' + type: string + type: array + response-level: + enum: + - always + - must + - should + - may + - should not + - must not + type: string + sortable: + type: boolean + support: + enum: + - must + - should + - may + type: string + "$comment": + type: string + type: object + x-optimade-metadata-definition: + description: |- + A dictionary that is a property definition of a dictionary-type property that defines all metadata properties. + allOf: + - $ref: '#/$defs/property_definition_field' + - properties: + type: + enum: + - ["object", "null"] + "$comment": + description: |- + A human-readable comment relevant in the context of the raw definition data. + These comments should normally not be shown to the end users. + Comments pertaining to the Property Definition that are relevant to end users should go into the field description. + Formatting in the text SHOULD use Markdown using the format described in the definition of the description field. + + This field is an annotation rather than an integral part of the Property Definition. + Property Definitions that only differ by fields that are considered annotations are to be considered the same, and as explained in the definition of the $id field SHOULD share the same $id. + type: string + deprecated: + description: |- + If TRUE, implementations SHOULD not use the defined property, and it MAY be removed in the future. + If FALSE, the defined property is not deprecated. The field not being present means FALSE. + + This field is an annotation rather than an integral part of the Property Definition. + Property Definitions that only differ by fields that are considered annotations are to be considered the same, and as explained in the definition of the $id field SHOULD share the same $id. + type: boolean + # Allow database-specific fields + patternProperties: + "^x-(?!optimade-)": {} + additionalProperties: false diff --git a/schemas/src/meta/v1.2/optimade/standard_definition.yaml b/schemas/src/meta/v1.2/optimade/standard_definition.yaml new file mode 100644 index 000000000..af81f6f7a --- /dev/null +++ b/schemas/src/meta/v1.2/optimade/standard_definition.yaml @@ -0,0 +1,34 @@ +$schema: "https://json-schema.org/draft/2020-12/schema" +$id: "https://schemas.optimade.org/meta/v1.2/optimade/standard_definition" +title: "OPTIMADE standard definition schema" +type: object +allOf: + - $ref: "#/$defs/standard_definition_field" + - required: ["$id", "$schema"] +$$inherit: "entrytype_definition" +$$keep: ["$defs"] +$defs: + id_field: + $$inherit: "/v1.2/common/id_field" + standard_definition_field: + type: object + additionalProperties: false + required: ["x-optimade-definition", "title", "entrytypes"] + properties: + "$id": + $ref: "#/$defs/id_field" + "$schema": + type: string + title: + type: string + description: + type: string + x-optimade-definition: + $$inherit: "x-optimade-definition-field" + properties: + kind: + const: "standard" + entrytypes: + type: object + additionalProperties: + $ref: "#/$defs/entrytype_definition_field" diff --git a/schemas/src/meta/v1.2/optimade/unit_entity_definition.yaml b/schemas/src/meta/v1.2/optimade/unit_entity_definition.yaml new file mode 100644 index 000000000..46188a916 --- /dev/null +++ b/schemas/src/meta/v1.2/optimade/unit_entity_definition.yaml @@ -0,0 +1,226 @@ +$schema: "https://json-schema.org/draft/2020-12/schema" +$id: "https://schemas.optimade.org/meta/v1.2/optimade/unit_entity_definition" +title: "OPTIMADE unit entity definition schema" +description: "Meta-schema for definitions of physical units, constants, and prefixes." +type: object +required: ['$id', '$schema', 'x-optimade-definition'] +allOf: + - $ref: "#/$defs/unit_entity_definition_field" +$defs: + id_field: + $$inherit: "/v1.2/common/id_field" + symbol_list: + $$inherit: "/v1.2/common/symbol_list" + resource_list: + $$inherit: "/v1.2/common/resource_list" + unit_entity_definition_field: + required: ['title', 'symbol', 'display-symbol','description'] + additionalProperties: False + patternProperties: + "^_": {} + properties: + "$id": + allOf: + - $ref: "#/$defs/id_field" + - description: |- + A static IRI identifier that is a URN or URL representing the specific version of the definition. + + (If it is a URL, clients SHOULD NOT assign any interpretation to the response when resolving that URL.) + It SHOULD NOT be changed as long as the definition functionally remains identical, and SHOULD be changed when the definition changes. + For example, definitions SHOULD be regarded as the same if they only differ by, e.g.: + + - Additions or corrections of clarifying or historical notes to the `description` field. + - Changes to the fields `deprecated` and `$comment` on any level. + + Note that this means that the version number part of the URL is *retained* even in newer releases of the OPTIMADE standard as long as the definition remains functionally identical. + "$comment": + type: string + "$schema": + description: |- + A normalized URI for a meta-schema that validates the definition. + approximate-relations: + items: + patternProperties: + "^_": {} + additionalProperties: False + properties: + base-units: + allOf: + - $ref: "#/$defs/symbol_list" + - items: + properties: + id: + description: "The IRI of one of the units referenced in the dimensional formula for the defining relation." + symbol: + description: "The symbol used to reference this unit in the dimensional formula." + base-units-expression: + type: string + offset: + patternProperties: + "^_": {} + additionalProperties: False + properties: + standard_uncertainty: + type: number + value: + type: number + required: + - value + type: object + scale: + patternProperties: + "^_": {} + additionalProperties: False + properties: + standard_uncertainty: + type: number + value: + type: number + required: + - value + type: object + type: object + type: array + compatibility: + type: array + items: + $ref: "#/$defs/id_field" + defining-relation: + description: |- + A dictionary that encodes a defining relation to a unit or set of units, with the primary intended use of reproduce the definition of the entity in SI units, if such a relationship exists. + Some units, e.g., the atomic mass unit (also known as dalton, commonly denoted `u`), only has an approximate relationship to SI units, in which case the `defining-relation` MUST be omitted or `null`. + + If the fields in `scale` are designated as `sn`, `sd`, and `se`; and the fields in `offset` are designated as `on`, `od`, and `oe`; and `base-units-expression` is designated as `b`, these fields state the following defining relation: a value `v` multiplied by the unit being defined is equal to the following expression `(v * (sn/sd) * 10**se + (on/od) * 10**oe)*b`, where `*` designates multiplication and `**` designates exponentiation. + additionalProperties: False + patternProperties: + "^_": {} + properties: + base-units: + allOf: + - $ref: "#/$defs/symbol_list" + - items: + properties: + id: + description: "The IRI of one of the units referenced in the dimensional formula for the defining relation." + symbol: + description: "The symbol used to reference this unit in the dimensional formula." + base-units-expression: + description: |- + A string expressing the base units part of the defining relation for the unit being defined. + + A compound unit expression is created by a sequence of constants, prefixes, and unit symbols separated by a single multiplication `*` symbol. + Each unit symbol can also be suffixed by a single `^` symbol followed by a positive or negative integer to indicate the power of the preceding unit, e.g., `m^3` for cubic meter, `m^-3` for inverse cubic meter. + (Positive integers MUST NOT be preceded by a plus sign.) + Furthermore: + + - No whitespace, parenthesis, or other symbols than specified above are permitted. + - The unit symbols MUST appear in alphabetical order. + type: string + scale: + description: |- + A dictionary specifying the scale in the defining relation. + + The four fields `numerator`, `denominator`, `base`, and `exponent` specify the value as the rational number `numerator` / `denominator`, multiplied by `base` to the power of `exponent`. + If omitted or `null`, the defaults for the `numerator`, `denominator`, `base` and `exponent` are respectively 1, 1, 10, and 0. + patternProperties: + "^_": {} + additionalProperties: False + properties: + denominator: + type: integer + numerator: + type: integer + exponent: + type: integer + base: + type: integer + standard_uncertainty: + type: number + type: object + offset: + description: |- + The four fields `numerator`, `denominator`, `base`, and `exponent` specify the value as the rational number `numerator` / `denominator`, multiplied by `base` to the power of `exponent`. + If omitted or `null`, the defaults for the `numerator`, `denominator`, `base` and `exponent` are respectively 0, 1, 10, and 0. + patternProperties: + "^_": {} + additionalProperties: False + properties: + denominator: + type: integer + exponent: + type: integer + numerator: + type: integer + base: + type: integer + standard_uncertainty: + type: number + type: object + type: object + description: + description: |- + A human-readable multiline detailed description of the defined entity. + type: string + resources: + $ref: "#/$defs/resource_list" + standard: + description: "This field is used to reference a preexisting standard for the defined entity." + patternProperties: + "^_": {} + additionalProperties: False + properties: + name: + description: "The abbreviated name of the standard being referenced." + enum: + - gnu units + - ucum + - qudt + - si + - codata + - iso-iec-80000 + type: string + symbol: + description: |- + The symbol to use from the referenced standard, expressed according to that standard. + The field MAY use mathematical expressions written to render correctly with the LaTeX mode of Mathjax 3.2. + This field MAY be different from the symbol being defined via the definition if the unit will be referenced in `x-optimade-unit` fields using a different symbol than the one used in the standard or if the symbol is expressed in the standard in a way that requires mathematical notation. + However, if possible, the `symbol` fields SHOULD be the same. + type: string + year: + description: |- + The year that the standards organization adopted the definition. + type: integer + category: + description: |- + The category that the standards organization have used for the definition. + type: string + version: + description: |- + A version string of the referenced standard. + type: string + required: + - name + - symbol + type: object + symbol: + description: "Specifies the symbol to be used in `x-optimade-unit` to reference the defined entity." + type: string + pattern: ^[a-zA-Z_][a-zA-Z_0-9]*$ + display-symbol: + description: |- + The suggested standard typographical symbolic representation of the defined entity. + Formatting in the text SHOULD use Markdown in the CommonMark v0.3 format, with mathematical expressions written to render correctly with the LaTeX mode of Mathjax 3.2. + type: string + alternate-symbols: + description: |- + A list of other symbols often used for the defined entity. + Formatting in the text SHOULD use Markdown in the CommonMark v0.3 format, with mathematical expressions written to render correctly with the LaTeX mode of Mathjax 3.2. + type: array + items: + type: string + title: + description: "The standard human-readable name of the defined entity." + type: string + x-optimade-definition: + $$inherit: "x-optimade-definition-field" + diff --git a/schemas/src/meta/v1.2/optimade/unitsystem_definition.yaml b/schemas/src/meta/v1.2/optimade/unitsystem_definition.yaml new file mode 100644 index 000000000..b59772f45 --- /dev/null +++ b/schemas/src/meta/v1.2/optimade/unitsystem_definition.yaml @@ -0,0 +1,36 @@ +$schema: "https://json-schema.org/draft/2020-12/schema" +$id: "https://schemas.optimade.org/meta/v1.2/optimade/unitsystem_definition" +title: "OPTIMADE unit system definition schema" +type: object +required: ["$id", "$schema", "x-optimade-definition", "title"] +$$inherit: "physical_unit_definition" +$$keep: ["$defs"] +$defs: + id_field: + $$inherit: "/v1.2/common/id_field" +properties: + "$id": + $ref: "#/$defs/id_field" + "$schema": + type: string + type: + type: [string, array] + enum: ["object", ["object"]] + x-optimade-definition: + $$inherit: "x-optimade-definition-field" + properties: + kind: + const: "unitsystem" + title: + type: string + description: + type: string + units: + type: object + additionalProperties: + $ref: "#/$defs/unit_entity_definition_field" + prefixes: + type: object + additionalProperties: + $ref: "#/$defs/unit_entity_definition_field" +additionalProperties: false diff --git a/schemas/src/meta/v1.2/optimade/x-optimade-definition-field.yaml b/schemas/src/meta/v1.2/optimade/x-optimade-definition-field.yaml new file mode 100644 index 000000000..5c2c836e1 --- /dev/null +++ b/schemas/src/meta/v1.2/optimade/x-optimade-definition-field.yaml @@ -0,0 +1,37 @@ +$schema: "https://json-schema.org/draft/2020-12/schema" +$id: "https://schemas.optimade.org/meta/v1.2/optimade/x-optimade-definition-field" +type: object +required: ["kind", "format", "name", "label"] +properties: + label: + type: string + description: |- + An expanded version of the name that clarifies its context sufficiently to be unique within definitions issued together as a set. + pattern: ^[a-z_][a-z_0-9]*$ + name: + type: string + description: |- + Gives the definition a short name. + pattern: ^[a-z_][a-z_0-9]*$ + kind: + type: string + description: |- + Specifies the kind of Property Definition. + enum: ["property", "unit", "constant", "prefix", "entrytype", "unitsystem", "standard"] + format: + description: |- + Specifies the minor version of the Property Definitions format that the definition is expressed in. + This field MUST be included in standalone definitions, i.e., when they are not embedded inside other definitions or contexts that already declares a Property Definitions format. + pattern: ^[0-9]+\.[0-9]+$ + version: + description: |- + The version string of the referenced standard. + The string SHOULD be in the format described by the [semantic versioning v2](https://semver.org/spec/v2.0.0.html) standard. + pattern: ^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$ + $comment: "This pattern is the suggested regular expression from: https://semver.org/spec/v2.0.0.html" + type: string + resources: + $$inherit: "/v1.2/common/resource_list" +patternProperties: + "^x-(?!optimade-)": {} +additionalProperties: false diff --git a/schemas/tests/example-structures.optimade b/schemas/tests/example-structures.optimade new file mode 100644 index 000000000..ce257da57 --- /dev/null +++ b/schemas/tests/example-structures.optimade @@ -0,0 +1,60 @@ +{ + "data": { + "attributes": { + "chemical_formula_descriptive": "As2Cd4I3P2", + "dimension_types": [ + 1, + 1, + 1 + ], + "elements": [ + "As", + "Cd", + "I", + "P" + ], + "lattice_vectors": [ + [ + 12.955, + 0.0, + 0.0 + ], + [ + 0.0, + 12.955, + 0.0 + ], + [ + 0.0, + 0.0, + 12.955 + ] + ], + "nelements": 4, + "nperiodic_dimensions": 3, + "structure_features": [] + }, + "id": "747", + "type": "structures" + }, + "meta": { + "api_version": "1.0.0", + "data_available": 68566, + "data_returned": 1, + "implementation": { + "homepage": "https://example.com/", + "name": "example", + "version": "1.0.0" + }, + "more_data_available": false, + "provider": { + "description": "Example provider", + "name": "exmpl", + "prefix": "exmpl" + }, + "query": { + "representation": "v1/structures/747" + }, + "time_stamp": "2023-03-16T22:44:00.531930" + } +} diff --git a/tests/makefiles/Makelocal-schemas b/tests/makefiles/Makelocal-schemas new file mode 100644 index 000000000..64cc42f89 --- /dev/null +++ b/tests/makefiles/Makelocal-schemas @@ -0,0 +1,212 @@ +#---*- Makefile -*------------------------------------------------------- + +# Use "make schemas schemas_html_pretty=true" to apply OPTIMADE styling to the html pages + +# Use "make schemas schemas_html_ext=true" to generate html files with .html extensions also for files meant to be served +# without extensions, which is useful for hosting, e.g., on github that automatically redirects URLs without extensions. + +# Dependencies from optimade-property-tools +PROCESS_SCHEMAS=dependencies/submodules/optimade-property-tools/bin/process_schemas +EXT_SCHEMAS := $(filter-out dependencies/submodules/optimade-property-tools/external/json-schema/LICENSE, $(wildcard dependencies/submodules/optimade-property-tools/external/json-schema/*)) + +BASEDIR = schemas/src/defs/ +BASEID = https://schemas.optimade.org/defs/ + +BASEDIR_META = schemas/src/meta/ +BASEID_META = https://schemas.optimade.org/meta/ + +ifeq ($(origin schemas_html_pretty), undefined) + OPTIMADE_HTML_HEADER ?= + OPTIMADE_HTML_TOP ?= +else + OPTIMADE_HTML_HEADER = + OPTIMADE_HTML_TOP =
+endif + +ALL_SCHEMAS := $(wildcard schemas/src/*/*/*/*/*/*/*.yaml schemas/src/*/*/*/*/*/*.yaml schemas/src/*/*/*/*/*.yaml schemas/src/*/*/*/*.yaml schemas/src/*/*/*.yaml) + +META_SCHEMAS := $(filter schemas/src/meta/%.yaml, $(ALL_SCHEMAS)) +META_SCHEMAS_JSON := $(patsubst schemas/src/%.yaml,schemas/output/%.json,$(META_SCHEMAS)) +META_SCHEMAS_ARGS := $(foreach schema,$(META_SCHEMAS_JSON),--schema $(schema)) + +DEFINITIONS := $(filter schemas/src/defs/%.yaml, $(ALL_SCHEMAS)) +DEFINITIONS_JSON := $(patsubst schemas/src/%.yaml,schemas/output/%.json,$(DEFINITIONS)) +DEFINITIONS_MD := $(patsubst schemas/src/%.yaml,schemas/output/%.md,$(DEFINITIONS)) + +OTHER_SCHEMAS := $(filter-out schemas/src/meta/%.yaml,$(filter-out schemas/src/defs/%,$(ALL_SCHEMAS))) +OTHER_SCHEMAS_JSON := $(patsubst schemas/src/%.yaml,schemas/output/%.json,$(OTHER_SCHEMAS)) +OTHER_SCHEMAS_MD := $(patsubst schemas/src/%.yaml,schemas/output/%.md,$(OTHER_SCHEMAS)) + +ifeq ($(origin schemas_html_ext), undefined) + DEFINITIONS_HTML := $(patsubst schemas/src/%.yaml,schemas/output/%,$(DEFINITIONS)) + DEFINITIONS_HTML_EXT = +else + DEFINITIONS_HTML := $(patsubst schemas/src/%.yaml,schemas/output/%.html,$(DEFINITIONS)) + DEFINITIONS_HTML_EXT = .html +endif + +EXT_SCHEMAS_ARGS := $(foreach schema,$(EXT_SCHEMAS),--schema $(schema)) + +DEF_INDEXES_HTML = schemas/output/defs/index.html +DEF_INDEXES_MD = schemas/output/defs/index.md +RELEASES_INDEXES_HTML = schemas/output/releases/latest/index.html +RELEASES_INDEXES_MD = schemas/output/releases/latest/index.md + +OPTIMADE_VERSION := $(shell awk 'NR==2 && /OPTIMADE API specification/ { sub(/~develop/, "", $$NF); print $$NF; exit }' optimade.rst) + +ifeq ($(OPTIMADE_VERSION),) + OPTIMADE_VERSION_MINOR := + OPTIMADE_VERSION_SUBST := +else + OPTIMADE_VERSION_MINOR := "$(basename $(OPTIMADE_VERSION))" + OPTIMADE_VERSION_SUBST := --sub '$$$${OPTIMADE_VERSION}' "$(OPTIMADE_VERSION)" +endif + +.PHONY: submodule-optimade-property-tools + +submodule-optimade-property-tools: + @if [ ! -e "dependencies/submodules/optimade-property-tools/bin/process_schemas" ] ; then \ + echo "*************************************************************************************************************************"; \ + echo "ERROR: The optimade-property-tools submodule is required to build the OPTIMADE schemas. Please run the following command:"; \ + echo "git submodule update --init dependencies/submodules/optimade-property-tools"; \ + echo "*************************************************************************************************************************"; \ + false; \ + elif git submodule status dependencies/submodules/optimade-property-tools | egrep -q '^[-+]' ; then \ + echo "********************************************************************************************************"; \ + echo "NOTE: The optimade-property-tools submodule is not in a clean state, if this is unintentional, consider:"; \ + echo "git submodule update --init dependencies/submodules/optimade-property-tools"; \ + echo "********************************************************************************************************"; \ + fi + +.PHONY: schemas schemas_meta schemas_json schemas_docs schemas_html schemas_symlinks schema_releases schemas_indexes_docs schemas_release_indexes_docs + +schemas: submodule-optimade-property-tools schemas_build schemas_releases schemas_release_indexes_docs +schemas_build: schemas_symlinks schemas_meta schemas_defs_json schemas_defs_docs schemas_defs_html schemas_other_json schemas_indexes_docs +schemas_meta: $(META_SCHEMAS_JSON) +schemas_defs_json: $(DEFINITIONS_JSON) schemas_meta +schemas_defs_docs: $(DEFINITIONS_MD) schemas_meta +schemas_defs_html: $(DEFINITIONS_HTML) schemas_meta +schemas_other_json: $(OTHER_SCHEMAS_JSON) schemas_defs_json +schemas_indexes_docs: $(DEF_INDEXES_HTML) $(DEF_INDEXES_MD) schemas_meta +schemas_release_indexes_docs: $(RELEASES_INDEXES_HTML) $(RELEASES_INDEXES_MD) schemas_meta + +# The 'schemas_symlinks' rule is run before schema builds to try to maintain a structure under '/output' that helps +# handling multiple parallel versions of schema definitions. Normally a build would go into a minor version directory (e.g., 'v1.2') +# since the source files have to be organized that way for versioned $$inherit to work. The 'schemas_symlinks' rule +# symlinks a full version directory (e.g., v1.2.0) to the corresponding minor version directory where the build then goes. +# The result is an 'output' that allows a straightforward: +# +# rsync -a output/ /path/to/arhive/of/versions/ +# +# to do the right thing, where previously generated historical versions remains maintained correctly under '/path/to/arhive/of/versions/' +# +# Note: output/defs is deliberatly not handled by this rule since updated property defintions with the same ids are meant to replace +# older versions in the /defs/ directories. + +schemas_symlinks: + mkdir -p schemas/output/; \ + cd schemas/output/; \ + for KIND in meta json-schema json-ld releases; do \ + if [ ! -e "$$KIND" ]; then \ + mkdir -p "$$KIND" ;\ + fi ;\ + if [ -n "$(OPTIMADE_VERSION)" ]; then \ + if [ ! -e "$$KIND/$(OPTIMADE_VERSION)" ]; then \ + mkdir "$$KIND/$(OPTIMADE_VERSION)" ;\ + fi ;\ + if [ ! -e "$$KIND/$(OPTIMADE_VERSION_MINOR)" -o -h "$$KIND/$(OPTIMADE_VERSION_MINOR)" ]; then \ + ln -nsf "$(OPTIMADE_VERSION)" "$$KIND/$(OPTIMADE_VERSION_MINOR)" ;\ + fi ;\ + if [ ! -e "$$KIND/latest" -o -h "$$KIND/latest" ]; then \ + ln -nsf "$(OPTIMADE_VERSION_MINOR)" "$$KIND/latest" ;\ + fi ;\ + fi \ + done + +# The releases directory aggregates this releases versions of all property definitions and is thus +# how one finds the definition file that was part of a specific relase. +schemas_releases: schemas_build + mkdir -p schemas/output/releases/latest + cd schemas/output/defs; \ + find . -type f -exec cp --parents \{\} ../releases/latest \; + +# Old version that keeps only the latest version of all definitions. We may want to go back to this in the future +# if these historical definition archives gets too large. +#schemas_releases: schemas_build +# mkdir -p schemas/output/releases/latest +# cd schemas/output/defs; \ +# for DIR in $$(ls -vrd v*); do \ +# ( cd "$$DIR"; \ +# find . -type f -exec cp --parents \{\} ../../releases/latest \; ;\ +# ) \ +# done + +# Meta schemas need a separate rule since the other rules depend on the meta schemas for validation (and the meta schemas cannot depend on themselves) +$(META_SCHEMAS_JSON): schemas/output/meta/%.json: schemas/src/meta/%.yaml | schemas_symlinks + mkdir -p "$(dir $@)" + $(PROCESS_SCHEMAS) --remove-null $(OPTIMADE_VERSION_SUBST) --basedir "$(BASEDIR_META)" --baseid "$(BASEID_META)" $(EXT_SCHEMAS_ARGS) --output "$@" "$<" + +$(DEFINITIONS_JSON) $(OTHER_SCHEMAS_JSON): schemas/output/%.json: schemas/src/%.yaml $(META_SCHEMAS_JSON) | schemas_symlinks + mkdir -p "$(dir $@)" + $(PROCESS_SCHEMAS) --remove-null $(OPTIMADE_VERSION_SUBST) --basedir "$(BASEDIR)" --baseid "$(BASEID)" $(META_SCHEMAS_ARGS) $(EXT_SCHEMAS_ARGS) --output "$@" "$<" + +$(DEFINITIONS_MD): schemas/output/%.md: schemas/src/%.yaml $(META_SCHEMAS_JSON) | schemas_symlinks + mkdir -p "$(dir $@)" + $(PROCESS_SCHEMAS) --remove-null -f md $(OPTIMADE_VERSION_SUBST) --basedir "$(BASEDIR)" --baseid "$(BASEID)" --output "$@" "$<" + +$(DEFINITIONS_HTML): schemas/output/%$(DEFINITIONS_HTML_EXT): schemas/src/%.yaml $(META_SCHEMAS_JSON) | schemas_symlinks + mkdir -p "$(dir $@)" + $(PROCESS_SCHEMAS) --remove-null -f html $(OPTIMADE_VERSION_SUBST) --basedir "$(BASEDIR)" --baseid "$(BASEID)" --html-header '$(OPTIMADE_HTML_HEADER)' --html-top '$(OPTIMADE_HTML_TOP)' --output "$@" "$<" + +$(DEF_INDEXES_MD): schemas/output/%/index.md: schemas/src/% $(META_SCHEMAS_JSON) | schemas_symlinks + mkdir -p "$(dir $@)" + $(PROCESS_SCHEMAS) --index --basedir "$(BASEDIR)" --baseid "$(BASEID)" -f md $(EXT_SCHEMAS_ARGS) --output "$@" "$<" + +$(RELEASES_INDEXES_MD): schemas/output/%/index.md: schemas/output/% $(META_SCHEMAS_JSON) | schemas_symlinks schemas_releases + mkdir -p "$(dir $@)" + $(PROCESS_SCHEMAS) --index --basedir "$(BASEDIR)" --baseid "$(BASEID)" -f md $(EXT_SCHEMAS_ARGS) --output "$@" "$<" + +$(DEF_INDEXES_HTML): schemas/output/%/index.html: schemas/src/% $(META_SCHEMAS_JSON) | schemas_symlinks + mkdir -p "$(dir $@)" + $(PROCESS_SCHEMAS) --index --basedir "$(BASEDIR)" --baseid "$(BASEID)" -f html --html-header '$(OPTIMADE_HTML_HEADER)' --html-top '$(OPTIMADE_HTML_TOP)' $(EXT_SCHEMAS_ARGS) --output "$@" "$<" + +$(RELEASES_INDEXES_HTML): schemas/output/%/index.html: schemas/output/% $(META_SCHEMAS_JSON) | schemas_symlinks schemas_releases + mkdir -p "$(dir $@)" + $(PROCESS_SCHEMAS) --index --basedir "$(BASEDIR)" --baseid "$(BASEID)" -f html --html-header '$(OPTIMADE_HTML_HEADER)' --html-top '$(OPTIMADE_HTML_TOP)' $(EXT_SCHEMAS_ARGS) --output "$@" "$<" + + +.PHONY: clean clean_schemas + +clean: clean_schemas + +clean_schemas: + rm -rf schemas/output + +.PHONY: validate_schemas + +validate_meta_schemas: schemas + tests/scripts/validate_json_schema.py schemas/output/meta/latest/optimade/property_definition.json dependencies/submodules/optimade-property-tools/external/json-schema/schema + tests/scripts/validate_json_schema.py schemas/output/meta/latest/optimade/physical_unit_definition.json dependencies/submodules/optimade-property-tools/external/json-schema/schema + +validate_schemas: schemas validate_meta_schemas + tests/scripts/validate_json_schema.py schemas/tests/example-structures.optimade schemas/output/json-schema/latest/optimade.json + +.PHONY: check_schemas_variables + +schemas_check_variables: + @echo "DEFINITIONS = $(DEFINITIONS)" + @echo "DEFINITIONS_JSON = $(DEFINITIONS_JSON)" + @echo "DEFINITIONS_HTML = $(DEFINITIONS_HTML)" + @echo "" + @echo "OTHER_SCHEMAS = $(OTHER_SCHEMAS)" + @echo "OTHER_SCHEMAS_JSON = $(OTHER_SCHEMAS_JSON)" + @echo "" + @echo "META_SCHEMAS = $(META_SCHEMAS)" + @echo "META_SCHEMAS_JSON = $(META_SCHEMAS_JSON)" + @echo "META_SCHEMAS_ARGS = $(META_SCHEMAS_ARGS)" + @echo "" + @echo "OPTIMADE_VERSION = $(OPTIMADE_VERSION)" + @echo "OPTIMADE_VERSION_SUBST = $(OPTIMADE_VERSION_SUBST)" + @echo "" + @echo "INDEXES_HTML = $(INDEXES_HTML)" + diff --git a/tests/makefiles/Makelocal-swagger b/tests/makefiles/Makelocal-swagger index 8954c483b..6157118cb 100644 --- a/tests/makefiles/Makelocal-swagger +++ b/tests/makefiles/Makelocal-swagger @@ -2,12 +2,12 @@ # Targets for validating the specification with swagger -.PHONY: validate_schemas - -validate_schemas: validate_schema validate_index_schema - -validate_schema: - ./tests/scripts/validate_swagger.sh ./schemas/openapi_schema.json - -validate_index_schema: - ./tests/scripts/validate_swagger.sh ./schemas/index_openapi_schema.json +#.PHONY: validate_schemas +# +#validate_schemas: validate_schema validate_index_schema +# +#validate_schema: +# ./tests/scripts/validate_swagger.sh ./schemas/openapi_schema.json +# +#validate_index_schema: +# ./tests/scripts/validate_swagger.sh ./schemas/index_openapi_schema.json diff --git a/tests/scripts/filter_rsync_itemize_output.sh b/tests/scripts/filter_rsync_itemize_output.sh new file mode 100755 index 000000000..cacc44a91 --- /dev/null +++ b/tests/scripts/filter_rsync_itemize_output.sh @@ -0,0 +1,17 @@ +#!/usr/bin/env python3 +# +# Pipe the output of rsync -ni into this script to simplify the output +# so that not all individual files in a new directory show up +# individually (just as a new directory) + +import sys + +pat = None +for line in sys.stdin: + stat,sep,f = line.partition(" ") + f = f.strip() + if pat is not None and f.startswith(pat): + continue + if stat.startswith("cd"): + pat = f + sys.stdout.write(line) diff --git a/tests/scripts/validate_json_schema.py b/tests/scripts/validate_json_schema.py new file mode 100755 index 000000000..12b01e983 --- /dev/null +++ b/tests/scripts/validate_json_schema.py @@ -0,0 +1,48 @@ +#!/usr/bin/env python3 +""" +This script validates a json file against a JSON Schema file using the jsonschema Python library. + +Usage: + validate_json_schema.py jsonfile schemafile + +Examples: + validate_json_schema.py file.json schema.json + +""" + +import argparse +import json + +import jsonschema +from jsonschema import validate + +arguments = [ + { + 'names': ['infile'], + 'help': 'The JSON file to process.', + 'type': str, + }, + { + 'names': ['schema'], + 'help': 'The JSON Schema file to process.', + 'type': str, + } +] + +if __name__ == "__main__": + + parser = argparse.ArgumentParser(description=__doc__, formatter_class=argparse.RawDescriptionHelpFormatter) + for arg in arguments: + names = arg.pop('names') + parser.add_argument(*names, **arg) + + args = parser.parse_args() + + with open(args.infile, "r") as f: + data=json.load(f) + with open(args.schema, "r") as f: + schema=json.load(f) + + validate(instance=data, schema=schema, format_checker=jsonschema.FormatChecker()) + + print("JSON file: "+str(args.infile)+" validated against JSON Schema: "+str(args.schema)+": OK")