Add machine-readable property definitions to repository

.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

.gitignore

@@ -5,3 +5,5 @@ Makeconf*
 .idea/
 .vscode/
 .DS_Store
+schemas/output
+schemas/example/output

.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

.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
  )$

.words.lst

@@ -215,6 +215,8 @@ xyz
 yacc
 yb
 zeo
-ångström
+zeolites
 ångström
 ångström
+ångström
+incrementing

GNUmakefile

@@ -19,6 +19,26 @@
 # - spell: runs an interactive spellchecker
 #
 #
+# Targets for generating schemas
+################################
+#
+# - schemas <schemas_html_pretty=true> <schemas_html_ext=true>
+#
+# 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
 ########################################################
 #

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:
 

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 \
+;

dependencies/installers/Debian-11

@@ -0,0 +1 @@
+Debian-10/

dependencies/installers/Debian-12

@@ -0,0 +1 @@
+Debian-10/

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.

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.