@mat3ra/esse 2025.7.29-0 → 2025.8.6-0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (29) hide show
  1. package/dist/js/example/materials_category_components/operations/core/combinations/stack.json +11 -1
  2. package/dist/js/schema/materials_category/compound_pristine_structures/two_dimensional/interface/configuration.json +174 -3687
  3. package/dist/js/schema/materials_category/defective_structures/one_dimensional/grain_boundary_linear/configuration.json +174 -3687
  4. package/dist/js/schema/materials_category/defective_structures/two_dimensional/adatom/configuration.json +46 -0
  5. package/dist/js/schema/materials_category/defective_structures/two_dimensional/grain_boundary_planar/configuration.json +174 -3687
  6. package/dist/js/schema/materials_category/defective_structures/two_dimensional/island/configuration.json +69 -0
  7. package/dist/js/schema/materials_category/defective_structures/two_dimensional/terrace/configuration.json +69 -0
  8. package/dist/js/schema/materials_category/pristine_structures/two_dimensional/nanoribbon.json +46 -0
  9. package/dist/js/schema/materials_category/pristine_structures/two_dimensional/nanotape.json +23 -0
  10. package/dist/js/schema/materials_category/pristine_structures/two_dimensional/slab.json +23 -0
  11. package/dist/js/schema/materials_category/pristine_structures/two_dimensional/slab_strained_supercell.json +23 -0
  12. package/dist/js/schema/materials_category_components/entities/reusable/{repetitions.json → three_dimensional/repetitions.json} +1 -1
  13. package/dist/js/schema/materials_category_components/entities/reusable/two_dimensional/slab_stack_configuration.json +46 -0
  14. package/dist/js/schema/materials_category_components/operations/core/combinations/stack.json +23 -0
  15. package/dist/js/schemas.json +1 -1
  16. package/dist/js/types.d.ts +6289 -12339
  17. package/example/materials_category_components/entities/reusable/three-dimensional/repetitions.json +3 -0
  18. package/example/materials_category_components/operations/core/combinations/stack.json +12 -2
  19. package/package.json +1 -1
  20. package/schema/materials_category/compound_pristine_structures/two-dimensional/interface/configuration.json +0 -6
  21. package/schema/materials_category/manifest.yaml +55 -133
  22. package/schema/materials_category_components/entities/reusable/{repetitions.json → three-dimensional/repetitions.json} +1 -1
  23. package/schema/materials_category_components/operations/core/combinations/stack.json +17 -0
  24. package/dist/js/example/materials_category/pristine_structures/two_dimensional/slab_strained_supercell_with_gap.json +0 -306
  25. package/dist/js/schema/materials_category/pristine_structures/two_dimensional/slab_strained_supercell_with_gap.json +0 -1815
  26. package/example/materials_category/pristine_structures/two-dimensional/slab_strained_supercell_with_gap.json +0 -56
  27. package/example/materials_category_components/entities/reusable/repetitions.json +0 -1
  28. package/schema/materials_category/pristine_structures/two-dimensional/slab_strained_supercell_with_gap.json +0 -18
  29. /package/dist/js/example/materials_category_components/entities/reusable/{repetitions.json → three_dimensional/repetitions.json} +0 -0
package/dist/js/schema/materials_category/compound_pristine_structures/two_dimensional/interface/configuration.json CHANGED
@@ -1778,3646 +1778,87 @@
1778
1778
  "y",
1779
1779
  "z"
1780
1780
  ]
1781
- }
1782
- }
1783
- },
1784
- {
1785
- "$schema": "http://json-schema.org/draft-07/schema#",
1786
- "title": "Slab Strained Supercell Configuration Schema",
1787
- "description": "A slab structure configuration with supercell transformation and strain matrix in the xy plane",
1788
- "required": [
1789
- "direction",
1790
- "stack_components",
1791
- "strain_matrix",
1792
- "xy_supercell_matrix"
1793
- ],
1794
- "type": "object",
1795
- "properties": {
1796
- "xy_supercell_matrix": {
1797
- "$schema": "http://json-schema.org/draft-07/schema#",
1798
- "title": "Supercell Matrix 2D Schema",
1799
- "description": "Supercell matrix for xy plane transformations",
1800
- "type": "array",
1801
- "minItems": 2,
1802
- "maxItems": 2,
1803
- "default": [
1804
- [
1805
- 1,
1806
- 0
1807
- ],
1808
- [
1809
- 0,
1810
- 1
1811
- ]
1812
- ],
1813
- "items": {
1814
- "type": "array",
1815
- "minItems": 2,
1816
- "maxItems": 2,
1817
- "items": {
1818
- "type": "integer"
1819
- }
1820
- }
1821
- },
1822
- "strain_matrix": {
1823
- "$schema": "http://json-schema.org/draft-07/schema#",
1824
- "title": "matrix 3x3 schema",
1825
- "type": "array",
1826
- "minItems": 3,
1827
- "maxItems": 3,
1828
- "items": {
1829
- "$schema": "http://json-schema.org/draft-07/schema#",
1830
- "title": "array of 3 number elements schema",
1831
- "type": "array",
1832
- "minItems": 3,
1833
- "maxItems": 3,
1834
- "items": {
1835
- "type": "number"
1836
- }
1837
- }
1838
- },
1839
- "stack_components": {
1840
- "type": "array",
1841
- "minItems": 2,
1842
- "maxItems": 2,
1843
- "items": [
1844
- {
1845
- "$schema": "http://json-schema.org/draft-07/schema#",
1846
- "title": "Atomic Layers Unique Repeated Schema",
1847
- "description": "Atomic layers unique with an integer number of repetitions, forming a full periodic structure with top layer specified by the termination",
1848
- "type": "object",
1849
- "required": [
1850
- "crystal",
1851
- "miller_indices",
1852
- "number_of_repetitions",
1853
- "termination_top"
1854
- ],
1855
- "properties": {
1856
- "termination_top": {
1857
- "$schema": "http://json-schema.org/draft-07/schema#",
1858
- "title": "Termination Schema",
1859
- "description": "Defines a specific termination of a slab",
1860
- "type": "object",
1861
- "required": [
1862
- "chemical_elements",
1863
- "space_group_symmetry_label"
1864
- ],
1865
- "properties": {
1866
- "chemical_elements": {
1867
- "title": "Chemical Elements",
1868
- "description": "Chemical elements at the termination. Can be a single element (e.g. 'Si') or a compound (e.g. 'SiO')",
1869
- "type": "string",
1870
- "anyOf": [
1871
- {
1872
- "enum": [
1873
- "H",
1874
- "He",
1875
- "Li",
1876
- "Be",
1877
- "B",
1878
- "C",
1879
- "N",
1880
- "O",
1881
- "F",
1882
- "Ne",
1883
- "Na",
1884
- "Mg",
1885
- "Al",
1886
- "Si",
1887
- "P",
1888
- "S",
1889
- "Cl",
1890
- "Ar",
1891
- "K",
1892
- "Ca",
1893
- "Sc",
1894
- "Ti",
1895
- "V",
1896
- "Cr",
1897
- "Mn",
1898
- "Fe",
1899
- "Co",
1900
- "Ni",
1901
- "Cu",
1902
- "Zn",
1903
- "Ga",
1904
- "Ge",
1905
- "As",
1906
- "Se",
1907
- "Br",
1908
- "Kr",
1909
- "Rb",
1910
- "Sr",
1911
- "Y",
1912
- "Zr",
1913
- "Nb",
1914
- "Mo",
1915
- "Tc",
1916
- "Ru",
1917
- "Rh",
1918
- "Pd",
1919
- "Ag",
1920
- "Cd",
1921
- "In",
1922
- "Sn",
1923
- "Sb",
1924
- "Te",
1925
- "I",
1926
- "Xe",
1927
- "Cs",
1928
- "Ba",
1929
- "La",
1930
- "Ce",
1931
- "Pr",
1932
- "Nd",
1933
- "Pm",
1934
- "Sm",
1935
- "Eu",
1936
- "Gd",
1937
- "Tb",
1938
- "Dy",
1939
- "Ho",
1940
- "Er",
1941
- "Tm",
1942
- "Yb",
1943
- "Lu",
1944
- "Hf",
1945
- "Ta",
1946
- "W",
1947
- "Re",
1948
- "Os",
1949
- "Ir",
1950
- "Pt",
1951
- "Au",
1952
- "Hg",
1953
- "Tl",
1954
- "Pb",
1955
- "Bi",
1956
- "Po",
1957
- "At",
1958
- "Rn",
1959
- "Fr",
1960
- "Ra",
1961
- "Ac",
1962
- "Th",
1963
- "Pa",
1964
- "U",
1965
- "Np",
1966
- "Pu",
1967
- "Am",
1968
- "Cm",
1969
- "Bk",
1970
- "Cf",
1971
- "Es",
1972
- "Fm",
1973
- "Md",
1974
- "No",
1975
- "Lr",
1976
- "Rf",
1977
- "Db",
1978
- "Sg",
1979
- "Bh",
1980
- "Hs",
1981
- "Mt",
1982
- "Ds",
1983
- "Rg",
1984
- "Cn",
1985
- "Nh",
1986
- "Fl",
1987
- "Mc",
1988
- "Lv",
1989
- "Ts",
1990
- "Og"
1991
- ]
1992
- },
1993
- {
1994
- "type": "string",
1995
- "description": "A string representing a stoichiometric formula for surface atoms of a plane, e.g. 'SrTiO', 'SrO', 'O2' or 'Hf2O'",
1996
- "pattern": "^([A-Z][a-z]?[0-9]*)+$"
1997
- }
1998
- ]
1999
- },
2000
- "space_group_symmetry_label": {
2001
- "title": "Space Group Symmetry Label",
2002
- "description": "Space group symmetry designation for the termination",
2003
- "type": "string"
2004
- }
2005
- }
2006
- },
2007
- "number_of_repetitions": {
2008
- "type": "integer",
2009
- "minimum": 1,
2010
- "description": "Number of repetitions of the unique atomic layers"
2011
- },
2012
- "miller_indices": {
2013
- "$schema": "http://json-schema.org/draft-07/schema#",
2014
- "title": "Miller Indices Schema",
2015
- "description": "Miller indices [h, k, l] defining crystallographic planes",
2016
- "default": [
2017
- 0,
2018
- 0,
2019
- 1
2020
- ],
2021
- "type": "array",
2022
- "minItems": 3,
2023
- "maxItems": 3,
2024
- "items": {
2025
- "type": "integer"
2026
- }
2027
- },
2028
- "crystal": {
2029
- "$schema": "http://json-schema.org/draft-07/schema#",
2030
- "title": "Crystal Schema",
2031
- "description": "A crystal structure, referencing the base material schema",
2032
- "type": "object",
2033
- "required": [
2034
- "basis",
2035
- "lattice"
2036
- ],
2037
- "properties": {
2038
- "formula": {
2039
- "description": "reduced chemical formula",
2040
- "type": "string"
2041
- },
2042
- "unitCellFormula": {
2043
- "description": "chemical formula based on the number of atoms of each element in the supercell",
2044
- "type": "string"
2045
- },
2046
- "basis": {
2047
- "$schema": "http://json-schema.org/draft-07/schema#",
2048
- "title": "basis schema",
2049
- "type": "object",
2050
- "required": [
2051
- "elements",
2052
- "coordinates"
2053
- ],
2054
- "properties": {
2055
- "elements": {
2056
- "$schema": "http://json-schema.org/draft-07/schema#",
2057
- "title": "atomic elements schema",
2058
- "description": "atomic elements schema",
2059
- "type": "array",
2060
- "items": {
2061
- "$schema": "http://json-schema.org/draft-07/schema#",
2062
- "title": "atomic element schema",
2063
- "description": "chemical element of an atom according to the periodic table",
2064
- "type": "object",
2065
- "required": [
2066
- "id",
2067
- "value"
2068
- ],
2069
- "properties": {
2070
- "value": {
2071
- "description": "All elements, including extra elements",
2072
- "anyOf": [
2073
- {
2074
- "enum": [
2075
- "H",
2076
- "He",
2077
- "Li",
2078
- "Be",
2079
- "B",
2080
- "C",
2081
- "N",
2082
- "O",
2083
- "F",
2084
- "Ne",
2085
- "Na",
2086
- "Mg",
2087
- "Al",
2088
- "Si",
2089
- "P",
2090
- "S",
2091
- "Cl",
2092
- "Ar",
2093
- "K",
2094
- "Ca",
2095
- "Sc",
2096
- "Ti",
2097
- "V",
2098
- "Cr",
2099
- "Mn",
2100
- "Fe",
2101
- "Co",
2102
- "Ni",
2103
- "Cu",
2104
- "Zn",
2105
- "Ga",
2106
- "Ge",
2107
- "As",
2108
- "Se",
2109
- "Br",
2110
- "Kr",
2111
- "Rb",
2112
- "Sr",
2113
- "Y",
2114
- "Zr",
2115
- "Nb",
2116
- "Mo",
2117
- "Tc",
2118
- "Ru",
2119
- "Rh",
2120
- "Pd",
2121
- "Ag",
2122
- "Cd",
2123
- "In",
2124
- "Sn",
2125
- "Sb",
2126
- "Te",
2127
- "I",
2128
- "Xe",
2129
- "Cs",
2130
- "Ba",
2131
- "La",
2132
- "Ce",
2133
- "Pr",
2134
- "Nd",
2135
- "Pm",
2136
- "Sm",
2137
- "Eu",
2138
- "Gd",
2139
- "Tb",
2140
- "Dy",
2141
- "Ho",
2142
- "Er",
2143
- "Tm",
2144
- "Yb",
2145
- "Lu",
2146
- "Hf",
2147
- "Ta",
2148
- "W",
2149
- "Re",
2150
- "Os",
2151
- "Ir",
2152
- "Pt",
2153
- "Au",
2154
- "Hg",
2155
- "Tl",
2156
- "Pb",
2157
- "Bi",
2158
- "Po",
2159
- "At",
2160
- "Rn",
2161
- "Fr",
2162
- "Ra",
2163
- "Ac",
2164
- "Th",
2165
- "Pa",
2166
- "U",
2167
- "Np",
2168
- "Pu",
2169
- "Am",
2170
- "Cm",
2171
- "Bk",
2172
- "Cf",
2173
- "Es",
2174
- "Fm",
2175
- "Md",
2176
- "No",
2177
- "Lr",
2178
- "Rf",
2179
- "Db",
2180
- "Sg",
2181
- "Bh",
2182
- "Hs",
2183
- "Mt",
2184
- "Ds",
2185
- "Rg",
2186
- "Cn",
2187
- "Nh",
2188
- "Fl",
2189
- "Mc",
2190
- "Lv",
2191
- "Ts",
2192
- "Og"
2193
- ]
2194
- },
2195
- {
2196
- "description": "Extra elements, used for convenience purposed",
2197
- "enum": [
2198
- "X",
2199
- "Vac"
2200
- ]
2201
- }
2202
- ],
2203
- "type": "string"
2204
- },
2205
- "id": {
2206
- "description": "integer id of this entry",
2207
- "type": "integer"
2208
- }
2209
- }
2210
- }
2211
- },
2212
- "coordinates": {
2213
- "$schema": "http://json-schema.org/draft-07/schema#",
2214
- "title": "atomic coordinates schema",
2215
- "description": "atomic coordinates schema",
2216
- "type": "array",
2217
- "items": {
2218
- "$schema": "http://json-schema.org/draft-07/schema#",
2219
- "title": "atomic coordinate schema",
2220
- "description": "coordinate of an atom",
2221
- "type": "object",
2222
- "required": [
2223
- "id",
2224
- "value"
2225
- ],
2226
- "properties": {
2227
- "value": {
2228
- "$schema": "http://json-schema.org/draft-07/schema#",
2229
- "title": "coordinate 3d schema",
2230
- "type": "array",
2231
- "minItems": 3,
2232
- "maxItems": 3,
2233
- "description": "value of this entry",
2234
- "items": {
2235
- "type": "number"
2236
- }
2237
- },
2238
- "id": {
2239
- "description": "integer id of this entry",
2240
- "type": "integer"
2241
- }
2242
- }
2243
- }
2244
- },
2245
- "units": {
2246
- "$schema": "http://json-schema.org/draft-07/schema#",
2247
- "title": "basis units enum",
2248
- "enum": [
2249
- "crystal",
2250
- "cartesian"
2251
- ],
2252
- "default": "crystal"
2253
- },
2254
- "labels": {
2255
- "$schema": "http://json-schema.org/draft-07/schema#",
2256
- "title": "atomic labels schema",
2257
- "description": "atomic labels schema",
2258
- "type": "array",
2259
- "items": {
2260
- "$schema": "http://json-schema.org/draft-07/schema#",
2261
- "title": "atomic label schema",
2262
- "description": "Optional label (e.g., 1, 2, as in Fe1, Fe2) to distinguish species, e.g. to have magnetic moment.",
2263
- "type": "object",
2264
- "required": [
2265
- "id",
2266
- "value"
2267
- ],
2268
- "properties": {
2269
- "value": {
2270
- "anyOf": [
2271
- {
2272
- "type": [
2273
- "integer",
2274
- "string",
2275
- "number"
2276
- ]
2277
- },
2278
- {
2279
- "$schema": "http://json-schema.org/draft-07/schema#",
2280
- "title": "integer positive single digit",
2281
- "type": "integer",
2282
- "minimum": 1,
2283
- "maximum": 9
2284
- }
2285
- ],
2286
- "description": "value of this entry"
2287
- },
2288
- "id": {
2289
- "description": "integer id of this entry",
2290
- "type": "integer"
2291
- }
2292
- }
2293
- }
2294
- }
2295
- }
2296
- },
2297
- "lattice": {
2298
- "$schema": "http://json-schema.org/draft-07/schema#",
2299
- "title": "lattice schema",
2300
- "type": "object",
2301
- "required": [
2302
- "a",
2303
- "b",
2304
- "c",
2305
- "alpha",
2306
- "beta",
2307
- "gamma"
2308
- ],
2309
- "properties": {
2310
- "a": {
2311
- "description": "length of the first lattice vector",
2312
- "type": "number"
2313
- },
2314
- "b": {
2315
- "description": "length of the second lattice vector",
2316
- "type": "number"
2317
- },
2318
- "c": {
2319
- "description": "length of the third lattice vector",
2320
- "type": "number"
2321
- },
2322
- "alpha": {
2323
- "description": "angle between first and second lattice vector",
2324
- "type": "number"
2325
- },
2326
- "beta": {
2327
- "description": "angle between second and third lattice vector",
2328
- "type": "number"
2329
- },
2330
- "gamma": {
2331
- "description": "angle between first and third lattice vector",
2332
- "type": "number"
2333
- },
2334
- "vectors": {
2335
- "$schema": "http://json-schema.org/draft-07/schema#",
2336
- "title": "lattice vectors schema",
2337
- "type": "object",
2338
- "required": [
2339
- "a",
2340
- "b",
2341
- "c"
2342
- ],
2343
- "properties": {
2344
- "a": {
2345
- "$schema": "http://json-schema.org/draft-07/schema#",
2346
- "title": "vector 3d schema",
2347
- "type": "array",
2348
- "minItems": 3,
2349
- "maxItems": 3,
2350
- "items": {
2351
- "type": "number"
2352
- }
2353
- },
2354
- "b": {
2355
- "$schema": "http://json-schema.org/draft-07/schema#",
2356
- "title": "vector 3d schema",
2357
- "type": "array",
2358
- "minItems": 3,
2359
- "maxItems": 3,
2360
- "items": {
2361
- "type": "number"
2362
- }
2363
- },
2364
- "c": {
2365
- "$schema": "http://json-schema.org/draft-07/schema#",
2366
- "title": "vector 3d schema",
2367
- "type": "array",
2368
- "minItems": 3,
2369
- "maxItems": 3,
2370
- "items": {
2371
- "type": "number"
2372
- }
2373
- },
2374
- "alat": {
2375
- "description": "lattice parameter for fractional coordinates",
2376
- "type": "number",
2377
- "default": 1
2378
- },
2379
- "units": {
2380
- "$schema": "http://json-schema.org/draft-07/schema#",
2381
- "title": "lattice vectors units enum",
2382
- "enum": [
2383
- "angstrom",
2384
- "bohr"
2385
- ],
2386
- "default": "angstrom"
2387
- }
2388
- }
2389
- },
2390
- "type": {
2391
- "$schema": "http://json-schema.org/draft-07/schema#",
2392
- "title": "lattice type enum",
2393
- "type": "string",
2394
- "enum": [
2395
- "CUB",
2396
- "BCC",
2397
- "FCC",
2398
- "TET",
2399
- "MCL",
2400
- "ORC",
2401
- "ORCC",
2402
- "ORCF",
2403
- "ORCI",
2404
- "HEX",
2405
- "BCT",
2406
- "TRI",
2407
- "MCLC",
2408
- "RHL"
2409
- ],
2410
- "default": "TRI"
2411
- },
2412
- "units": {
2413
- "$schema": "http://json-schema.org/draft-07/schema#",
2414
- "title": "Lattice units schema",
2415
- "type": "object",
2416
- "default": {
2417
- "length": "angstrom",
2418
- "angle": "degree"
2419
- },
2420
- "properties": {
2421
- "length": {
2422
- "$schema": "http://json-schema.org/draft-07/schema#",
2423
- "title": "lattice units length enum",
2424
- "enum": [
2425
- "angstrom",
2426
- "bohr"
2427
- ],
2428
- "default": "angstrom"
2429
- },
2430
- "angle": {
2431
- "$schema": "http://json-schema.org/draft-07/schema#",
2432
- "title": "lattice units angle enum",
2433
- "enum": [
2434
- "degree",
2435
- "radian"
2436
- ],
2437
- "default": "degree"
2438
- }
2439
- }
2440
- }
2441
- }
2442
- },
2443
- "derivedProperties": {
2444
- "$schema": "http://json-schema.org/draft-07/schema#",
2445
- "title": "derived properties schema",
2446
- "type": "array",
2447
- "items": {
2448
- "oneOf": [
2449
- {
2450
- "$schema": "http://json-schema.org/draft-07/schema#",
2451
- "title": "volume schema",
2452
- "type": "object",
2453
- "required": [
2454
- "value"
2455
- ],
2456
- "properties": {
2457
- "name": {
2458
- "enum": [
2459
- "volume"
2460
- ]
2461
- },
2462
- "units": {
2463
- "enum": [
2464
- "angstrom^3"
2465
- ]
2466
- },
2467
- "value": {
2468
- "type": "number"
2469
- }
2470
- }
2471
- },
2472
- {
2473
- "$schema": "http://json-schema.org/draft-07/schema#",
2474
- "title": "density schema",
2475
- "type": "object",
2476
- "required": [
2477
- "value"
2478
- ],
2479
- "properties": {
2480
- "name": {
2481
- "enum": [
2482
- "density"
2483
- ]
2484
- },
2485
- "units": {
2486
- "enum": [
2487
- "g/cm^3"
2488
- ]
2489
- },
2490
- "value": {
2491
- "type": "number"
2492
- }
2493
- }
2494
- },
2495
- {
2496
- "$schema": "http://json-schema.org/draft-07/schema#",
2497
- "title": "symmetry schema",
2498
- "type": "object",
2499
- "properties": {
2500
- "pointGroupSymbol": {
2501
- "description": "point group symbol in Schoenflies notation",
2502
- "type": "string"
2503
- },
2504
- "spaceGroupSymbol": {
2505
- "description": "space group symbol in Hermann–Mauguin notation",
2506
- "type": "string"
2507
- },
2508
- "tolerance": {
2509
- "type": "object",
2510
- "description": "tolerance used for symmetry calculation",
2511
- "$schema": "http://json-schema.org/draft-07/schema#",
2512
- "title": "scalar schema",
2513
- "required": [
2514
- "value"
2515
- ],
2516
- "properties": {
2517
- "units": {
2518
- "enum": [
2519
- "angstrom"
2520
- ]
2521
- },
2522
- "value": {
2523
- "type": "number"
2524
- }
2525
- }
2526
- },
2527
- "name": {
2528
- "enum": [
2529
- "symmetry"
2530
- ]
2531
- }
2532
- }
2533
- },
2534
- {
2535
- "$schema": "http://json-schema.org/draft-07/schema#",
2536
- "title": "elemental-ratio",
2537
- "description": "ration of this element in the compound",
2538
- "type": "object",
2539
- "required": [
2540
- "value"
2541
- ],
2542
- "properties": {
2543
- "name": {
2544
- "enum": [
2545
- "elemental_ratio"
2546
- ]
2547
- },
2548
- "value": {
2549
- "type": "number",
2550
- "minimum": 0,
2551
- "maximum": 1
2552
- },
2553
- "element": {
2554
- "type": "string",
2555
- "description": "the element this ratio is for"
2556
- }
2557
- }
2558
- },
2559
- {
2560
- "$schema": "http://json-schema.org/draft-07/schema#",
2561
- "title": "p_norm",
2562
- "description": "https://en.wikipedia.org/wiki/Norm_(mathematics)#p-norm",
2563
- "type": "object",
2564
- "required": [
2565
- "value"
2566
- ],
2567
- "properties": {
2568
- "name": {
2569
- "enum": [
2570
- "p-norm"
2571
- ]
2572
- },
2573
- "degree": {
2574
- "type": "integer",
2575
- "description": "degree of the dimensionality of the norm"
2576
- },
2577
- "value": {
2578
- "type": "number"
2579
- }
2580
- }
2581
- },
2582
- {
2583
- "$schema": "http://json-schema.org/draft-07/schema#",
2584
- "title": "InChI representation schema",
2585
- "type": "object",
2586
- "required": [
2587
- "value"
2588
- ],
2589
- "properties": {
2590
- "name": {
2591
- "enum": [
2592
- "inchi"
2593
- ]
2594
- },
2595
- "value": {
2596
- "type": "string"
2597
- }
2598
- }
2599
- },
2600
- {
2601
- "$schema": "http://json-schema.org/draft-07/schema#",
2602
- "title": "InChI key representation schema",
2603
- "type": "object",
2604
- "required": [
2605
- "value"
2606
- ],
2607
- "properties": {
2608
- "name": {
2609
- "enum": [
2610
- "inchi_key"
2611
- ]
2612
- },
2613
- "value": {
2614
- "type": "string"
2615
- }
2616
- }
2617
- }
2618
- ],
2619
- "discriminator": {
2620
- "propertyName": "name"
2621
- },
2622
- "required": [
2623
- "name"
2624
- ]
2625
- }
2626
- },
2627
- "external": {
2628
- "$schema": "http://json-schema.org/draft-07/schema#",
2629
- "title": "database source schema",
2630
- "description": "information about a database source",
2631
- "type": "object",
2632
- "required": [
2633
- "id",
2634
- "source",
2635
- "origin"
2636
- ],
2637
- "properties": {
2638
- "id": {
2639
- "description": "ID string for the materials uploaded from a third party source inside the third party source. For materialsproject.org an example ID is mp-32",
2640
- "oneOf": [
2641
- {
2642
- "type": "string"
2643
- },
2644
- {
2645
- "type": "number"
2646
- }
2647
- ]
2648
- },
2649
- "source": {
2650
- "description": "Third party source name, e.g. materials project, 2dmatpedia, ICSD, etc.",
2651
- "type": "string"
2652
- },
2653
- "origin": {
2654
- "description": "Deprecated. To be removed. A flag that is true when material is initially imported from a third party * (as opposed to being independently designed from scratch).",
2655
- "type": "boolean"
2656
- },
2657
- "data": {
2658
- "description": "Original response from external source.",
2659
- "type": "object"
2660
- },
2661
- "doi": {
2662
- "description": "Digital Object Identifier, e.g. 10.1088/0953-8984/25/10/105506",
2663
- "type": "string"
2664
- },
2665
- "url": {
2666
- "description": "The URL of the original record, e.g. https://next-gen.materialsproject.org/materials/mp-48; ToDo: update to use URI type per https://json-schema.org/understanding-json-schema/reference/string#resource-identifiers",
2667
- "type": "string"
2668
- }
2669
- }
2670
- },
2671
- "src": {
2672
- "$schema": "http://json-schema.org/draft-07/schema#",
2673
- "title": "file source schema",
2674
- "description": "file source with the information inside",
2675
- "type": "object",
2676
- "required": [
2677
- "filename",
2678
- "text",
2679
- "hash"
2680
- ],
2681
- "properties": {
2682
- "extension": {
2683
- "description": "file extension",
2684
- "type": "string"
2685
- },
2686
- "filename": {
2687
- "description": "file name without extension",
2688
- "type": "string"
2689
- },
2690
- "text": {
2691
- "description": "file content as raw text",
2692
- "type": "string"
2693
- },
2694
- "hash": {
2695
- "description": "MD5 hash based on file content",
2696
- "type": "string"
2697
- }
2698
- }
2699
- },
2700
- "scaledHash": {
2701
- "description": "Hash string for a scaled structure with lattice vector a set to 1 (eg. for materials under pressure).",
2702
- "type": "string"
2703
- },
2704
- "icsdId": {
2705
- "description": "Corresponding ICSD id of the material",
2706
- "type": "integer"
2707
- },
2708
- "isNonPeriodic": {
2709
- "description": "Whether to work in the finite molecular picture (usually with atomic orbital basis)",
2710
- "type": "boolean"
2711
- },
2712
- "consistencyChecks": {
2713
- "type": "array",
2714
- "items": {
2715
- "$schema": "http://json-schema.org/draft-07/schema#",
2716
- "title": "material consistency check schema",
2717
- "type": "object",
2718
- "description": "The output of consistency checks performed on data adhering to JSON schema, but inconsistent with scientific or logical rules, to show problems in UI.",
2719
- "required": [
2720
- "key",
2721
- "name",
2722
- "severity",
2723
- "message"
2724
- ],
2725
- "properties": {
2726
- "name": {
2727
- "type": "string",
2728
- "enum": [
2729
- "default",
2730
- "atomsTooClose",
2731
- "atomsOverlap"
2732
- ],
2733
- "description": "Name of the consistency check that is performed, which is listed in an enum."
2734
- },
2735
- "key": {
2736
- "type": "string",
2737
- "description": "Key of the property of the entity on which the consistency check is performed in Mongo dot notation, e.g. 'basis.coordinates.1'"
2738
- },
2739
- "severity": {
2740
- "enum": [
2741
- "info",
2742
- "warning",
2743
- "error"
2744
- ],
2745
- "description": "Severity level of the problem, which is used in UI to differentiate."
2746
- },
2747
- "message": {
2748
- "type": "string",
2749
- "description": "Message generated by the consistency check describing the problem."
2750
- }
2751
- }
2752
- }
2753
- },
2754
- "_id": {
2755
- "description": "entity identity",
2756
- "type": "string"
2757
- },
2758
- "slug": {
2759
- "description": "entity slug",
2760
- "type": "string"
2761
- },
2762
- "systemName": {
2763
- "type": "string"
2764
- },
2765
- "schemaVersion": {
2766
- "description": "entity's schema version. Used to distinct between different schemas.",
2767
- "type": "string",
2768
- "default": "2022.8.16"
2769
- },
2770
- "name": {
2771
- "description": "entity name",
2772
- "type": "string"
2773
- },
2774
- "isDefault": {
2775
- "description": "Identifies that entity is defaultable",
2776
- "type": "boolean",
2777
- "default": false
2778
- },
2779
- "metadata": {
2780
- "type": "object"
2781
- }
2782
- }
2783
- },
2784
- "use_conventional_cell": {
2785
- "type": "boolean",
2786
- "description": "Use the conventional cell for the crystal structure",
2787
- "default": true
2788
- }
2789
- }
2790
- },
2791
- {
2792
- "$schema": "http://json-schema.org/draft-07/schema#",
2793
- "title": "Vacuum Configuration Schema",
2794
- "description": "A vacuum slab that breaks periodicity in a specified direction",
2795
- "type": "object",
2796
- "required": [
2797
- "direction",
2798
- "size",
2799
- "crystal"
2800
- ],
2801
- "properties": {
2802
- "direction": {
2803
- "$schema": "http://json-schema.org/draft-07/schema#",
2804
- "title": "Axis Enum",
2805
- "type": "string",
2806
- "description": "Enum for axis types",
2807
- "enum": [
2808
- "x",
2809
- "y",
2810
- "z"
2811
- ]
2812
- },
2813
- "size": {
2814
- "type": "number",
2815
- "description": "Size of the vacuum slab in angstroms",
2816
- "minimum": 0,
2817
- "default": 10
2818
- },
2819
- "crystal": {
2820
- "$schema": "http://json-schema.org/draft-07/schema#",
2821
- "title": "Crystal Schema",
2822
- "description": "A crystal structure, referencing the base material schema",
2823
- "type": "object",
2824
- "required": [
2825
- "basis",
2826
- "lattice"
2827
- ],
2828
- "properties": {
2829
- "formula": {
2830
- "description": "reduced chemical formula",
2831
- "type": "string"
2832
- },
2833
- "unitCellFormula": {
2834
- "description": "chemical formula based on the number of atoms of each element in the supercell",
2835
- "type": "string"
2836
- },
2837
- "basis": {
2838
- "$schema": "http://json-schema.org/draft-07/schema#",
2839
- "title": "basis schema",
2840
- "type": "object",
2841
- "required": [
2842
- "elements",
2843
- "coordinates"
2844
- ],
2845
- "properties": {
2846
- "elements": {
2847
- "$schema": "http://json-schema.org/draft-07/schema#",
2848
- "title": "atomic elements schema",
2849
- "description": "atomic elements schema",
2850
- "type": "array",
2851
- "items": {
2852
- "$schema": "http://json-schema.org/draft-07/schema#",
2853
- "title": "atomic element schema",
2854
- "description": "chemical element of an atom according to the periodic table",
2855
- "type": "object",
2856
- "required": [
2857
- "id",
2858
- "value"
2859
- ],
2860
- "properties": {
2861
- "value": {
2862
- "description": "All elements, including extra elements",
2863
- "anyOf": [
2864
- {
2865
- "enum": [
2866
- "H",
2867
- "He",
2868
- "Li",
2869
- "Be",
2870
- "B",
2871
- "C",
2872
- "N",
2873
- "O",
2874
- "F",
2875
- "Ne",
2876
- "Na",
2877
- "Mg",
2878
- "Al",
2879
- "Si",
2880
- "P",
2881
- "S",
2882
- "Cl",
2883
- "Ar",
2884
- "K",
2885
- "Ca",
2886
- "Sc",
2887
- "Ti",
2888
- "V",
2889
- "Cr",
2890
- "Mn",
2891
- "Fe",
2892
- "Co",
2893
- "Ni",
2894
- "Cu",
2895
- "Zn",
2896
- "Ga",
2897
- "Ge",
2898
- "As",
2899
- "Se",
2900
- "Br",
2901
- "Kr",
2902
- "Rb",
2903
- "Sr",
2904
- "Y",
2905
- "Zr",
2906
- "Nb",
2907
- "Mo",
2908
- "Tc",
2909
- "Ru",
2910
- "Rh",
2911
- "Pd",
2912
- "Ag",
2913
- "Cd",
2914
- "In",
2915
- "Sn",
2916
- "Sb",
2917
- "Te",
2918
- "I",
2919
- "Xe",
2920
- "Cs",
2921
- "Ba",
2922
- "La",
2923
- "Ce",
2924
- "Pr",
2925
- "Nd",
2926
- "Pm",
2927
- "Sm",
2928
- "Eu",
2929
- "Gd",
2930
- "Tb",
2931
- "Dy",
2932
- "Ho",
2933
- "Er",
2934
- "Tm",
2935
- "Yb",
2936
- "Lu",
2937
- "Hf",
2938
- "Ta",
2939
- "W",
2940
- "Re",
2941
- "Os",
2942
- "Ir",
2943
- "Pt",
2944
- "Au",
2945
- "Hg",
2946
- "Tl",
2947
- "Pb",
2948
- "Bi",
2949
- "Po",
2950
- "At",
2951
- "Rn",
2952
- "Fr",
2953
- "Ra",
2954
- "Ac",
2955
- "Th",
2956
- "Pa",
2957
- "U",
2958
- "Np",
2959
- "Pu",
2960
- "Am",
2961
- "Cm",
2962
- "Bk",
2963
- "Cf",
2964
- "Es",
2965
- "Fm",
2966
- "Md",
2967
- "No",
2968
- "Lr",
2969
- "Rf",
2970
- "Db",
2971
- "Sg",
2972
- "Bh",
2973
- "Hs",
2974
- "Mt",
2975
- "Ds",
2976
- "Rg",
2977
- "Cn",
2978
- "Nh",
2979
- "Fl",
2980
- "Mc",
2981
- "Lv",
2982
- "Ts",
2983
- "Og"
2984
- ]
2985
- },
2986
- {
2987
- "description": "Extra elements, used for convenience purposed",
2988
- "enum": [
2989
- "X",
2990
- "Vac"
2991
- ]
2992
- }
2993
- ],
2994
- "type": "string"
2995
- },
2996
- "id": {
2997
- "description": "integer id of this entry",
2998
- "type": "integer"
2999
- }
3000
- }
3001
- }
3002
- },
3003
- "coordinates": {
3004
- "$schema": "http://json-schema.org/draft-07/schema#",
3005
- "title": "atomic coordinates schema",
3006
- "description": "atomic coordinates schema",
3007
- "type": "array",
3008
- "items": {
3009
- "$schema": "http://json-schema.org/draft-07/schema#",
3010
- "title": "atomic coordinate schema",
3011
- "description": "coordinate of an atom",
3012
- "type": "object",
3013
- "required": [
3014
- "id",
3015
- "value"
3016
- ],
3017
- "properties": {
3018
- "value": {
3019
- "$schema": "http://json-schema.org/draft-07/schema#",
3020
- "title": "coordinate 3d schema",
3021
- "type": "array",
3022
- "minItems": 3,
3023
- "maxItems": 3,
3024
- "description": "value of this entry",
3025
- "items": {
3026
- "type": "number"
3027
- }
3028
- },
3029
- "id": {
3030
- "description": "integer id of this entry",
3031
- "type": "integer"
3032
- }
3033
- }
3034
- }
3035
- },
3036
- "units": {
3037
- "$schema": "http://json-schema.org/draft-07/schema#",
3038
- "title": "basis units enum",
3039
- "enum": [
3040
- "crystal",
3041
- "cartesian"
3042
- ],
3043
- "default": "crystal"
3044
- },
3045
- "labels": {
3046
- "$schema": "http://json-schema.org/draft-07/schema#",
3047
- "title": "atomic labels schema",
3048
- "description": "atomic labels schema",
3049
- "type": "array",
3050
- "items": {
3051
- "$schema": "http://json-schema.org/draft-07/schema#",
3052
- "title": "atomic label schema",
3053
- "description": "Optional label (e.g., 1, 2, as in Fe1, Fe2) to distinguish species, e.g. to have magnetic moment.",
3054
- "type": "object",
3055
- "required": [
3056
- "id",
3057
- "value"
3058
- ],
3059
- "properties": {
3060
- "value": {
3061
- "anyOf": [
3062
- {
3063
- "type": [
3064
- "integer",
3065
- "string",
3066
- "number"
3067
- ]
3068
- },
3069
- {
3070
- "$schema": "http://json-schema.org/draft-07/schema#",
3071
- "title": "integer positive single digit",
3072
- "type": "integer",
3073
- "minimum": 1,
3074
- "maximum": 9
3075
- }
3076
- ],
3077
- "description": "value of this entry"
3078
- },
3079
- "id": {
3080
- "description": "integer id of this entry",
3081
- "type": "integer"
3082
- }
3083
- }
3084
- }
3085
- }
3086
- }
3087
- },
3088
- "lattice": {
3089
- "$schema": "http://json-schema.org/draft-07/schema#",
3090
- "title": "lattice schema",
3091
- "type": "object",
3092
- "required": [
3093
- "a",
3094
- "b",
3095
- "c",
3096
- "alpha",
3097
- "beta",
3098
- "gamma"
3099
- ],
3100
- "properties": {
3101
- "a": {
3102
- "description": "length of the first lattice vector",
3103
- "type": "number"
3104
- },
3105
- "b": {
3106
- "description": "length of the second lattice vector",
3107
- "type": "number"
3108
- },
3109
- "c": {
3110
- "description": "length of the third lattice vector",
3111
- "type": "number"
3112
- },
3113
- "alpha": {
3114
- "description": "angle between first and second lattice vector",
3115
- "type": "number"
3116
- },
3117
- "beta": {
3118
- "description": "angle between second and third lattice vector",
3119
- "type": "number"
3120
- },
3121
- "gamma": {
3122
- "description": "angle between first and third lattice vector",
3123
- "type": "number"
3124
- },
3125
- "vectors": {
3126
- "$schema": "http://json-schema.org/draft-07/schema#",
3127
- "title": "lattice vectors schema",
3128
- "type": "object",
3129
- "required": [
3130
- "a",
3131
- "b",
3132
- "c"
3133
- ],
3134
- "properties": {
3135
- "a": {
3136
- "$schema": "http://json-schema.org/draft-07/schema#",
3137
- "title": "vector 3d schema",
3138
- "type": "array",
3139
- "minItems": 3,
3140
- "maxItems": 3,
3141
- "items": {
3142
- "type": "number"
3143
- }
3144
- },
3145
- "b": {
3146
- "$schema": "http://json-schema.org/draft-07/schema#",
3147
- "title": "vector 3d schema",
3148
- "type": "array",
3149
- "minItems": 3,
3150
- "maxItems": 3,
3151
- "items": {
3152
- "type": "number"
3153
- }
3154
- },
3155
- "c": {
3156
- "$schema": "http://json-schema.org/draft-07/schema#",
3157
- "title": "vector 3d schema",
3158
- "type": "array",
3159
- "minItems": 3,
3160
- "maxItems": 3,
3161
- "items": {
3162
- "type": "number"
3163
- }
3164
- },
3165
- "alat": {
3166
- "description": "lattice parameter for fractional coordinates",
3167
- "type": "number",
3168
- "default": 1
3169
- },
3170
- "units": {
3171
- "$schema": "http://json-schema.org/draft-07/schema#",
3172
- "title": "lattice vectors units enum",
3173
- "enum": [
3174
- "angstrom",
3175
- "bohr"
3176
- ],
3177
- "default": "angstrom"
3178
- }
3179
- }
3180
- },
3181
- "type": {
3182
- "$schema": "http://json-schema.org/draft-07/schema#",
3183
- "title": "lattice type enum",
3184
- "type": "string",
3185
- "enum": [
3186
- "CUB",
3187
- "BCC",
3188
- "FCC",
3189
- "TET",
3190
- "MCL",
3191
- "ORC",
3192
- "ORCC",
3193
- "ORCF",
3194
- "ORCI",
3195
- "HEX",
3196
- "BCT",
3197
- "TRI",
3198
- "MCLC",
3199
- "RHL"
3200
- ],
3201
- "default": "TRI"
3202
- },
3203
- "units": {
3204
- "$schema": "http://json-schema.org/draft-07/schema#",
3205
- "title": "Lattice units schema",
3206
- "type": "object",
3207
- "default": {
3208
- "length": "angstrom",
3209
- "angle": "degree"
3210
- },
3211
- "properties": {
3212
- "length": {
3213
- "$schema": "http://json-schema.org/draft-07/schema#",
3214
- "title": "lattice units length enum",
3215
- "enum": [
3216
- "angstrom",
3217
- "bohr"
3218
- ],
3219
- "default": "angstrom"
3220
- },
3221
- "angle": {
3222
- "$schema": "http://json-schema.org/draft-07/schema#",
3223
- "title": "lattice units angle enum",
3224
- "enum": [
3225
- "degree",
3226
- "radian"
3227
- ],
3228
- "default": "degree"
3229
- }
3230
- }
3231
- }
3232
- }
3233
- },
3234
- "derivedProperties": {
3235
- "$schema": "http://json-schema.org/draft-07/schema#",
3236
- "title": "derived properties schema",
3237
- "type": "array",
3238
- "items": {
3239
- "oneOf": [
3240
- {
3241
- "$schema": "http://json-schema.org/draft-07/schema#",
3242
- "title": "volume schema",
3243
- "type": "object",
3244
- "required": [
3245
- "value"
3246
- ],
3247
- "properties": {
3248
- "name": {
3249
- "enum": [
3250
- "volume"
3251
- ]
3252
- },
3253
- "units": {
3254
- "enum": [
3255
- "angstrom^3"
3256
- ]
3257
- },
3258
- "value": {
3259
- "type": "number"
3260
- }
3261
- }
3262
- },
3263
- {
3264
- "$schema": "http://json-schema.org/draft-07/schema#",
3265
- "title": "density schema",
3266
- "type": "object",
3267
- "required": [
3268
- "value"
3269
- ],
3270
- "properties": {
3271
- "name": {
3272
- "enum": [
3273
- "density"
3274
- ]
3275
- },
3276
- "units": {
3277
- "enum": [
3278
- "g/cm^3"
3279
- ]
3280
- },
3281
- "value": {
3282
- "type": "number"
3283
- }
3284
- }
3285
- },
3286
- {
3287
- "$schema": "http://json-schema.org/draft-07/schema#",
3288
- "title": "symmetry schema",
3289
- "type": "object",
3290
- "properties": {
3291
- "pointGroupSymbol": {
3292
- "description": "point group symbol in Schoenflies notation",
3293
- "type": "string"
3294
- },
3295
- "spaceGroupSymbol": {
3296
- "description": "space group symbol in Hermann–Mauguin notation",
3297
- "type": "string"
3298
- },
3299
- "tolerance": {
3300
- "type": "object",
3301
- "description": "tolerance used for symmetry calculation",
3302
- "$schema": "http://json-schema.org/draft-07/schema#",
3303
- "title": "scalar schema",
3304
- "required": [
3305
- "value"
3306
- ],
3307
- "properties": {
3308
- "units": {
3309
- "enum": [
3310
- "angstrom"
3311
- ]
3312
- },
3313
- "value": {
3314
- "type": "number"
3315
- }
3316
- }
3317
- },
3318
- "name": {
3319
- "enum": [
3320
- "symmetry"
3321
- ]
3322
- }
3323
- }
3324
- },
3325
- {
3326
- "$schema": "http://json-schema.org/draft-07/schema#",
3327
- "title": "elemental-ratio",
3328
- "description": "ration of this element in the compound",
3329
- "type": "object",
3330
- "required": [
3331
- "value"
3332
- ],
3333
- "properties": {
3334
- "name": {
3335
- "enum": [
3336
- "elemental_ratio"
3337
- ]
3338
- },
3339
- "value": {
3340
- "type": "number",
3341
- "minimum": 0,
3342
- "maximum": 1
3343
- },
3344
- "element": {
3345
- "type": "string",
3346
- "description": "the element this ratio is for"
3347
- }
3348
- }
3349
- },
3350
- {
3351
- "$schema": "http://json-schema.org/draft-07/schema#",
3352
- "title": "p_norm",
3353
- "description": "https://en.wikipedia.org/wiki/Norm_(mathematics)#p-norm",
3354
- "type": "object",
3355
- "required": [
3356
- "value"
3357
- ],
3358
- "properties": {
3359
- "name": {
3360
- "enum": [
3361
- "p-norm"
3362
- ]
3363
- },
3364
- "degree": {
3365
- "type": "integer",
3366
- "description": "degree of the dimensionality of the norm"
3367
- },
3368
- "value": {
3369
- "type": "number"
3370
- }
3371
- }
3372
- },
3373
- {
3374
- "$schema": "http://json-schema.org/draft-07/schema#",
3375
- "title": "InChI representation schema",
3376
- "type": "object",
3377
- "required": [
3378
- "value"
3379
- ],
3380
- "properties": {
3381
- "name": {
3382
- "enum": [
3383
- "inchi"
3384
- ]
3385
- },
3386
- "value": {
3387
- "type": "string"
3388
- }
3389
- }
3390
- },
3391
- {
3392
- "$schema": "http://json-schema.org/draft-07/schema#",
3393
- "title": "InChI key representation schema",
3394
- "type": "object",
3395
- "required": [
3396
- "value"
3397
- ],
3398
- "properties": {
3399
- "name": {
3400
- "enum": [
3401
- "inchi_key"
3402
- ]
3403
- },
3404
- "value": {
3405
- "type": "string"
3406
- }
3407
- }
3408
- }
3409
- ],
3410
- "discriminator": {
3411
- "propertyName": "name"
3412
- },
3413
- "required": [
3414
- "name"
3415
- ]
3416
- }
3417
- },
3418
- "external": {
3419
- "$schema": "http://json-schema.org/draft-07/schema#",
3420
- "title": "database source schema",
3421
- "description": "information about a database source",
3422
- "type": "object",
3423
- "required": [
3424
- "id",
3425
- "source",
3426
- "origin"
3427
- ],
3428
- "properties": {
3429
- "id": {
3430
- "description": "ID string for the materials uploaded from a third party source inside the third party source. For materialsproject.org an example ID is mp-32",
3431
- "oneOf": [
3432
- {
3433
- "type": "string"
3434
- },
3435
- {
3436
- "type": "number"
3437
- }
3438
- ]
3439
- },
3440
- "source": {
3441
- "description": "Third party source name, e.g. materials project, 2dmatpedia, ICSD, etc.",
3442
- "type": "string"
3443
- },
3444
- "origin": {
3445
- "description": "Deprecated. To be removed. A flag that is true when material is initially imported from a third party * (as opposed to being independently designed from scratch).",
3446
- "type": "boolean"
3447
- },
3448
- "data": {
3449
- "description": "Original response from external source.",
3450
- "type": "object"
3451
- },
3452
- "doi": {
3453
- "description": "Digital Object Identifier, e.g. 10.1088/0953-8984/25/10/105506",
3454
- "type": "string"
3455
- },
3456
- "url": {
3457
- "description": "The URL of the original record, e.g. https://next-gen.materialsproject.org/materials/mp-48; ToDo: update to use URI type per https://json-schema.org/understanding-json-schema/reference/string#resource-identifiers",
3458
- "type": "string"
3459
- }
3460
- }
3461
- },
3462
- "src": {
3463
- "$schema": "http://json-schema.org/draft-07/schema#",
3464
- "title": "file source schema",
3465
- "description": "file source with the information inside",
3466
- "type": "object",
3467
- "required": [
3468
- "filename",
3469
- "text",
3470
- "hash"
3471
- ],
3472
- "properties": {
3473
- "extension": {
3474
- "description": "file extension",
3475
- "type": "string"
3476
- },
3477
- "filename": {
3478
- "description": "file name without extension",
3479
- "type": "string"
3480
- },
3481
- "text": {
3482
- "description": "file content as raw text",
3483
- "type": "string"
3484
- },
3485
- "hash": {
3486
- "description": "MD5 hash based on file content",
3487
- "type": "string"
3488
- }
3489
- }
3490
- },
3491
- "scaledHash": {
3492
- "description": "Hash string for a scaled structure with lattice vector a set to 1 (eg. for materials under pressure).",
3493
- "type": "string"
3494
- },
3495
- "icsdId": {
3496
- "description": "Corresponding ICSD id of the material",
3497
- "type": "integer"
3498
- },
3499
- "isNonPeriodic": {
3500
- "description": "Whether to work in the finite molecular picture (usually with atomic orbital basis)",
3501
- "type": "boolean"
3502
- },
3503
- "consistencyChecks": {
3504
- "type": "array",
3505
- "items": {
3506
- "$schema": "http://json-schema.org/draft-07/schema#",
3507
- "title": "material consistency check schema",
3508
- "type": "object",
3509
- "description": "The output of consistency checks performed on data adhering to JSON schema, but inconsistent with scientific or logical rules, to show problems in UI.",
3510
- "required": [
3511
- "key",
3512
- "name",
3513
- "severity",
3514
- "message"
3515
- ],
3516
- "properties": {
3517
- "name": {
3518
- "type": "string",
3519
- "enum": [
3520
- "default",
3521
- "atomsTooClose",
3522
- "atomsOverlap"
3523
- ],
3524
- "description": "Name of the consistency check that is performed, which is listed in an enum."
3525
- },
3526
- "key": {
3527
- "type": "string",
3528
- "description": "Key of the property of the entity on which the consistency check is performed in Mongo dot notation, e.g. 'basis.coordinates.1'"
3529
- },
3530
- "severity": {
3531
- "enum": [
3532
- "info",
3533
- "warning",
3534
- "error"
3535
- ],
3536
- "description": "Severity level of the problem, which is used in UI to differentiate."
3537
- },
3538
- "message": {
3539
- "type": "string",
3540
- "description": "Message generated by the consistency check describing the problem."
3541
- }
3542
- }
3543
- }
3544
- },
3545
- "_id": {
3546
- "description": "entity identity",
3547
- "type": "string"
3548
- },
3549
- "slug": {
3550
- "description": "entity slug",
3551
- "type": "string"
3552
- },
3553
- "systemName": {
3554
- "type": "string"
3555
- },
3556
- "schemaVersion": {
3557
- "description": "entity's schema version. Used to distinct between different schemas.",
3558
- "type": "string",
3559
- "default": "2022.8.16"
3560
- },
3561
- "name": {
3562
- "description": "entity name",
3563
- "type": "string"
3564
- },
3565
- "isDefault": {
3566
- "description": "Identifies that entity is defaultable",
3567
- "type": "boolean",
3568
- "default": false
3569
- },
3570
- "metadata": {
3571
- "type": "object"
3572
- }
3573
- }
3574
- }
3575
- }
3576
- }
3577
- ]
3578
- },
3579
- "direction": {
3580
- "default": "z",
3581
- "$schema": "http://json-schema.org/draft-07/schema#",
3582
- "title": "Axis Enum",
3583
- "type": "string",
3584
- "description": "Enum for axis types",
3585
- "enum": [
3586
- "x",
3587
- "y",
3588
- "z"
3589
- ]
3590
- }
3591
- }
3592
- },
3593
- {
3594
- "$schema": "http://json-schema.org/draft-07/schema#",
3595
- "title": "Slab Strained Supercell with Gap Configuration Schema",
3596
- "description": "A slab structure configuration with supercell transformation, strain matrix, and optional gap for film positioning",
3597
- "required": [
3598
- "direction",
3599
- "stack_components",
3600
- "strain_matrix",
3601
- "xy_supercell_matrix"
3602
- ],
3603
- "type": "object",
3604
- "properties": {
3605
- "gap": {
3606
- "type": "number",
3607
- "description": "If provided, the film is shifted to have it as smallest distance to the substrate",
3608
- "minimum": 0
3609
- },
3610
- "xy_supercell_matrix": {
3611
- "$schema": "http://json-schema.org/draft-07/schema#",
3612
- "title": "Supercell Matrix 2D Schema",
3613
- "description": "Supercell matrix for xy plane transformations",
3614
- "type": "array",
3615
- "minItems": 2,
3616
- "maxItems": 2,
3617
- "default": [
3618
- [
3619
- 1,
3620
- 0
3621
- ],
3622
- [
3623
- 0,
3624
- 1
3625
- ]
3626
- ],
3627
- "items": {
3628
- "type": "array",
3629
- "minItems": 2,
3630
- "maxItems": 2,
3631
- "items": {
3632
- "type": "integer"
3633
- }
3634
- }
3635
- },
3636
- "strain_matrix": {
3637
- "$schema": "http://json-schema.org/draft-07/schema#",
3638
- "title": "matrix 3x3 schema",
3639
- "type": "array",
3640
- "minItems": 3,
3641
- "maxItems": 3,
3642
- "items": {
3643
- "$schema": "http://json-schema.org/draft-07/schema#",
3644
- "title": "array of 3 number elements schema",
3645
- "type": "array",
3646
- "minItems": 3,
3647
- "maxItems": 3,
3648
- "items": {
3649
- "type": "number"
3650
- }
3651
- }
3652
- },
3653
- "stack_components": {
3654
- "type": "array",
3655
- "minItems": 2,
3656
- "maxItems": 2,
3657
- "items": [
3658
- {
3659
- "$schema": "http://json-schema.org/draft-07/schema#",
3660
- "title": "Atomic Layers Unique Repeated Schema",
3661
- "description": "Atomic layers unique with an integer number of repetitions, forming a full periodic structure with top layer specified by the termination",
3662
- "type": "object",
3663
- "required": [
3664
- "crystal",
3665
- "miller_indices",
3666
- "number_of_repetitions",
3667
- "termination_top"
3668
- ],
3669
- "properties": {
3670
- "termination_top": {
3671
- "$schema": "http://json-schema.org/draft-07/schema#",
3672
- "title": "Termination Schema",
3673
- "description": "Defines a specific termination of a slab",
3674
- "type": "object",
3675
- "required": [
3676
- "chemical_elements",
3677
- "space_group_symmetry_label"
3678
- ],
3679
- "properties": {
3680
- "chemical_elements": {
3681
- "title": "Chemical Elements",
3682
- "description": "Chemical elements at the termination. Can be a single element (e.g. 'Si') or a compound (e.g. 'SiO')",
3683
- "type": "string",
3684
- "anyOf": [
3685
- {
3686
- "enum": [
3687
- "H",
3688
- "He",
3689
- "Li",
3690
- "Be",
3691
- "B",
3692
- "C",
3693
- "N",
3694
- "O",
3695
- "F",
3696
- "Ne",
3697
- "Na",
3698
- "Mg",
3699
- "Al",
3700
- "Si",
3701
- "P",
3702
- "S",
3703
- "Cl",
3704
- "Ar",
3705
- "K",
3706
- "Ca",
3707
- "Sc",
3708
- "Ti",
3709
- "V",
3710
- "Cr",
3711
- "Mn",
3712
- "Fe",
3713
- "Co",
3714
- "Ni",
3715
- "Cu",
3716
- "Zn",
3717
- "Ga",
3718
- "Ge",
3719
- "As",
3720
- "Se",
3721
- "Br",
3722
- "Kr",
3723
- "Rb",
3724
- "Sr",
3725
- "Y",
3726
- "Zr",
3727
- "Nb",
3728
- "Mo",
3729
- "Tc",
3730
- "Ru",
3731
- "Rh",
3732
- "Pd",
3733
- "Ag",
3734
- "Cd",
3735
- "In",
3736
- "Sn",
3737
- "Sb",
3738
- "Te",
3739
- "I",
3740
- "Xe",
3741
- "Cs",
3742
- "Ba",
3743
- "La",
3744
- "Ce",
3745
- "Pr",
3746
- "Nd",
3747
- "Pm",
3748
- "Sm",
3749
- "Eu",
3750
- "Gd",
3751
- "Tb",
3752
- "Dy",
3753
- "Ho",
3754
- "Er",
3755
- "Tm",
3756
- "Yb",
3757
- "Lu",
3758
- "Hf",
3759
- "Ta",
3760
- "W",
3761
- "Re",
3762
- "Os",
3763
- "Ir",
3764
- "Pt",
3765
- "Au",
3766
- "Hg",
3767
- "Tl",
3768
- "Pb",
3769
- "Bi",
3770
- "Po",
3771
- "At",
3772
- "Rn",
3773
- "Fr",
3774
- "Ra",
3775
- "Ac",
3776
- "Th",
3777
- "Pa",
3778
- "U",
3779
- "Np",
3780
- "Pu",
3781
- "Am",
3782
- "Cm",
3783
- "Bk",
3784
- "Cf",
3785
- "Es",
3786
- "Fm",
3787
- "Md",
3788
- "No",
3789
- "Lr",
3790
- "Rf",
3791
- "Db",
3792
- "Sg",
3793
- "Bh",
3794
- "Hs",
3795
- "Mt",
3796
- "Ds",
3797
- "Rg",
3798
- "Cn",
3799
- "Nh",
3800
- "Fl",
3801
- "Mc",
3802
- "Lv",
3803
- "Ts",
3804
- "Og"
3805
- ]
3806
- },
3807
- {
3808
- "type": "string",
3809
- "description": "A string representing a stoichiometric formula for surface atoms of a plane, e.g. 'SrTiO', 'SrO', 'O2' or 'Hf2O'",
3810
- "pattern": "^([A-Z][a-z]?[0-9]*)+$"
3811
- }
3812
- ]
3813
- },
3814
- "space_group_symmetry_label": {
3815
- "title": "Space Group Symmetry Label",
3816
- "description": "Space group symmetry designation for the termination",
3817
- "type": "string"
3818
- }
3819
- }
3820
- },
3821
- "number_of_repetitions": {
3822
- "type": "integer",
3823
- "minimum": 1,
3824
- "description": "Number of repetitions of the unique atomic layers"
3825
- },
3826
- "miller_indices": {
3827
- "$schema": "http://json-schema.org/draft-07/schema#",
3828
- "title": "Miller Indices Schema",
3829
- "description": "Miller indices [h, k, l] defining crystallographic planes",
3830
- "default": [
3831
- 0,
3832
- 0,
3833
- 1
3834
- ],
3835
- "type": "array",
3836
- "minItems": 3,
3837
- "maxItems": 3,
3838
- "items": {
3839
- "type": "integer"
3840
- }
3841
- },
3842
- "crystal": {
3843
- "$schema": "http://json-schema.org/draft-07/schema#",
3844
- "title": "Crystal Schema",
3845
- "description": "A crystal structure, referencing the base material schema",
3846
- "type": "object",
3847
- "required": [
3848
- "basis",
3849
- "lattice"
3850
- ],
3851
- "properties": {
3852
- "formula": {
3853
- "description": "reduced chemical formula",
3854
- "type": "string"
3855
- },
3856
- "unitCellFormula": {
3857
- "description": "chemical formula based on the number of atoms of each element in the supercell",
3858
- "type": "string"
3859
- },
3860
- "basis": {
3861
- "$schema": "http://json-schema.org/draft-07/schema#",
3862
- "title": "basis schema",
3863
- "type": "object",
3864
- "required": [
3865
- "elements",
3866
- "coordinates"
3867
- ],
3868
- "properties": {
3869
- "elements": {
3870
- "$schema": "http://json-schema.org/draft-07/schema#",
3871
- "title": "atomic elements schema",
3872
- "description": "atomic elements schema",
3873
- "type": "array",
3874
- "items": {
3875
- "$schema": "http://json-schema.org/draft-07/schema#",
3876
- "title": "atomic element schema",
3877
- "description": "chemical element of an atom according to the periodic table",
3878
- "type": "object",
3879
- "required": [
3880
- "id",
3881
- "value"
3882
- ],
3883
- "properties": {
3884
- "value": {
3885
- "description": "All elements, including extra elements",
3886
- "anyOf": [
3887
- {
3888
- "enum": [
3889
- "H",
3890
- "He",
3891
- "Li",
3892
- "Be",
3893
- "B",
3894
- "C",
3895
- "N",
3896
- "O",
3897
- "F",
3898
- "Ne",
3899
- "Na",
3900
- "Mg",
3901
- "Al",
3902
- "Si",
3903
- "P",
3904
- "S",
3905
- "Cl",
3906
- "Ar",
3907
- "K",
3908
- "Ca",
3909
- "Sc",
3910
- "Ti",
3911
- "V",
3912
- "Cr",
3913
- "Mn",
3914
- "Fe",
3915
- "Co",
3916
- "Ni",
3917
- "Cu",
3918
- "Zn",
3919
- "Ga",
3920
- "Ge",
3921
- "As",
3922
- "Se",
3923
- "Br",
3924
- "Kr",
3925
- "Rb",
3926
- "Sr",
3927
- "Y",
3928
- "Zr",
3929
- "Nb",
3930
- "Mo",
3931
- "Tc",
3932
- "Ru",
3933
- "Rh",
3934
- "Pd",
3935
- "Ag",
3936
- "Cd",
3937
- "In",
3938
- "Sn",
3939
- "Sb",
3940
- "Te",
3941
- "I",
3942
- "Xe",
3943
- "Cs",
3944
- "Ba",
3945
- "La",
3946
- "Ce",
3947
- "Pr",
3948
- "Nd",
3949
- "Pm",
3950
- "Sm",
3951
- "Eu",
3952
- "Gd",
3953
- "Tb",
3954
- "Dy",
3955
- "Ho",
3956
- "Er",
3957
- "Tm",
3958
- "Yb",
3959
- "Lu",
3960
- "Hf",
3961
- "Ta",
3962
- "W",
3963
- "Re",
3964
- "Os",
3965
- "Ir",
3966
- "Pt",
3967
- "Au",
3968
- "Hg",
3969
- "Tl",
3970
- "Pb",
3971
- "Bi",
3972
- "Po",
3973
- "At",
3974
- "Rn",
3975
- "Fr",
3976
- "Ra",
3977
- "Ac",
3978
- "Th",
3979
- "Pa",
3980
- "U",
3981
- "Np",
3982
- "Pu",
3983
- "Am",
3984
- "Cm",
3985
- "Bk",
3986
- "Cf",
3987
- "Es",
3988
- "Fm",
3989
- "Md",
3990
- "No",
3991
- "Lr",
3992
- "Rf",
3993
- "Db",
3994
- "Sg",
3995
- "Bh",
3996
- "Hs",
3997
- "Mt",
3998
- "Ds",
3999
- "Rg",
4000
- "Cn",
4001
- "Nh",
4002
- "Fl",
4003
- "Mc",
4004
- "Lv",
4005
- "Ts",
4006
- "Og"
4007
- ]
4008
- },
4009
- {
4010
- "description": "Extra elements, used for convenience purposed",
4011
- "enum": [
4012
- "X",
4013
- "Vac"
4014
- ]
4015
- }
4016
- ],
4017
- "type": "string"
4018
- },
4019
- "id": {
4020
- "description": "integer id of this entry",
4021
- "type": "integer"
4022
- }
4023
- }
4024
- }
4025
- },
4026
- "coordinates": {
4027
- "$schema": "http://json-schema.org/draft-07/schema#",
4028
- "title": "atomic coordinates schema",
4029
- "description": "atomic coordinates schema",
4030
- "type": "array",
4031
- "items": {
4032
- "$schema": "http://json-schema.org/draft-07/schema#",
4033
- "title": "atomic coordinate schema",
4034
- "description": "coordinate of an atom",
4035
- "type": "object",
4036
- "required": [
4037
- "id",
4038
- "value"
4039
- ],
4040
- "properties": {
4041
- "value": {
4042
- "$schema": "http://json-schema.org/draft-07/schema#",
4043
- "title": "coordinate 3d schema",
4044
- "type": "array",
4045
- "minItems": 3,
4046
- "maxItems": 3,
4047
- "description": "value of this entry",
4048
- "items": {
4049
- "type": "number"
4050
- }
4051
- },
4052
- "id": {
4053
- "description": "integer id of this entry",
4054
- "type": "integer"
4055
- }
4056
- }
4057
- }
4058
- },
4059
- "units": {
4060
- "$schema": "http://json-schema.org/draft-07/schema#",
4061
- "title": "basis units enum",
4062
- "enum": [
4063
- "crystal",
4064
- "cartesian"
4065
- ],
4066
- "default": "crystal"
4067
- },
4068
- "labels": {
4069
- "$schema": "http://json-schema.org/draft-07/schema#",
4070
- "title": "atomic labels schema",
4071
- "description": "atomic labels schema",
4072
- "type": "array",
4073
- "items": {
4074
- "$schema": "http://json-schema.org/draft-07/schema#",
4075
- "title": "atomic label schema",
4076
- "description": "Optional label (e.g., 1, 2, as in Fe1, Fe2) to distinguish species, e.g. to have magnetic moment.",
4077
- "type": "object",
4078
- "required": [
4079
- "id",
4080
- "value"
4081
- ],
4082
- "properties": {
4083
- "value": {
4084
- "anyOf": [
4085
- {
4086
- "type": [
4087
- "integer",
4088
- "string",
4089
- "number"
4090
- ]
4091
- },
4092
- {
4093
- "$schema": "http://json-schema.org/draft-07/schema#",
4094
- "title": "integer positive single digit",
4095
- "type": "integer",
4096
- "minimum": 1,
4097
- "maximum": 9
4098
- }
4099
- ],
4100
- "description": "value of this entry"
4101
- },
4102
- "id": {
4103
- "description": "integer id of this entry",
4104
- "type": "integer"
4105
- }
4106
- }
4107
- }
4108
- }
4109
- }
4110
- },
4111
- "lattice": {
4112
- "$schema": "http://json-schema.org/draft-07/schema#",
4113
- "title": "lattice schema",
4114
- "type": "object",
4115
- "required": [
4116
- "a",
4117
- "b",
4118
- "c",
4119
- "alpha",
4120
- "beta",
4121
- "gamma"
4122
- ],
4123
- "properties": {
4124
- "a": {
4125
- "description": "length of the first lattice vector",
4126
- "type": "number"
4127
- },
4128
- "b": {
4129
- "description": "length of the second lattice vector",
4130
- "type": "number"
4131
- },
4132
- "c": {
4133
- "description": "length of the third lattice vector",
4134
- "type": "number"
4135
- },
4136
- "alpha": {
4137
- "description": "angle between first and second lattice vector",
4138
- "type": "number"
4139
- },
4140
- "beta": {
4141
- "description": "angle between second and third lattice vector",
4142
- "type": "number"
4143
- },
4144
- "gamma": {
4145
- "description": "angle between first and third lattice vector",
4146
- "type": "number"
4147
- },
4148
- "vectors": {
4149
- "$schema": "http://json-schema.org/draft-07/schema#",
4150
- "title": "lattice vectors schema",
4151
- "type": "object",
4152
- "required": [
4153
- "a",
4154
- "b",
4155
- "c"
4156
- ],
4157
- "properties": {
4158
- "a": {
4159
- "$schema": "http://json-schema.org/draft-07/schema#",
4160
- "title": "vector 3d schema",
4161
- "type": "array",
4162
- "minItems": 3,
4163
- "maxItems": 3,
4164
- "items": {
4165
- "type": "number"
4166
- }
4167
- },
4168
- "b": {
4169
- "$schema": "http://json-schema.org/draft-07/schema#",
4170
- "title": "vector 3d schema",
4171
- "type": "array",
4172
- "minItems": 3,
4173
- "maxItems": 3,
4174
- "items": {
4175
- "type": "number"
4176
- }
4177
- },
4178
- "c": {
4179
- "$schema": "http://json-schema.org/draft-07/schema#",
4180
- "title": "vector 3d schema",
4181
- "type": "array",
4182
- "minItems": 3,
4183
- "maxItems": 3,
4184
- "items": {
4185
- "type": "number"
4186
- }
4187
- },
4188
- "alat": {
4189
- "description": "lattice parameter for fractional coordinates",
4190
- "type": "number",
4191
- "default": 1
4192
- },
4193
- "units": {
4194
- "$schema": "http://json-schema.org/draft-07/schema#",
4195
- "title": "lattice vectors units enum",
4196
- "enum": [
4197
- "angstrom",
4198
- "bohr"
4199
- ],
4200
- "default": "angstrom"
4201
- }
4202
- }
4203
- },
4204
- "type": {
4205
- "$schema": "http://json-schema.org/draft-07/schema#",
4206
- "title": "lattice type enum",
4207
- "type": "string",
4208
- "enum": [
4209
- "CUB",
4210
- "BCC",
4211
- "FCC",
4212
- "TET",
4213
- "MCL",
4214
- "ORC",
4215
- "ORCC",
4216
- "ORCF",
4217
- "ORCI",
4218
- "HEX",
4219
- "BCT",
4220
- "TRI",
4221
- "MCLC",
4222
- "RHL"
4223
- ],
4224
- "default": "TRI"
4225
- },
4226
- "units": {
4227
- "$schema": "http://json-schema.org/draft-07/schema#",
4228
- "title": "Lattice units schema",
4229
- "type": "object",
4230
- "default": {
4231
- "length": "angstrom",
4232
- "angle": "degree"
4233
- },
4234
- "properties": {
4235
- "length": {
4236
- "$schema": "http://json-schema.org/draft-07/schema#",
4237
- "title": "lattice units length enum",
4238
- "enum": [
4239
- "angstrom",
4240
- "bohr"
4241
- ],
4242
- "default": "angstrom"
4243
- },
4244
- "angle": {
4245
- "$schema": "http://json-schema.org/draft-07/schema#",
4246
- "title": "lattice units angle enum",
4247
- "enum": [
4248
- "degree",
4249
- "radian"
4250
- ],
4251
- "default": "degree"
4252
- }
4253
- }
4254
- }
4255
- }
4256
- },
4257
- "derivedProperties": {
4258
- "$schema": "http://json-schema.org/draft-07/schema#",
4259
- "title": "derived properties schema",
4260
- "type": "array",
4261
- "items": {
4262
- "oneOf": [
4263
- {
4264
- "$schema": "http://json-schema.org/draft-07/schema#",
4265
- "title": "volume schema",
4266
- "type": "object",
4267
- "required": [
4268
- "value"
4269
- ],
4270
- "properties": {
4271
- "name": {
4272
- "enum": [
4273
- "volume"
4274
- ]
4275
- },
4276
- "units": {
4277
- "enum": [
4278
- "angstrom^3"
4279
- ]
4280
- },
4281
- "value": {
4282
- "type": "number"
4283
- }
4284
- }
4285
- },
4286
- {
4287
- "$schema": "http://json-schema.org/draft-07/schema#",
4288
- "title": "density schema",
4289
- "type": "object",
4290
- "required": [
4291
- "value"
4292
- ],
4293
- "properties": {
4294
- "name": {
4295
- "enum": [
4296
- "density"
4297
- ]
4298
- },
4299
- "units": {
4300
- "enum": [
4301
- "g/cm^3"
4302
- ]
4303
- },
4304
- "value": {
4305
- "type": "number"
4306
- }
4307
- }
4308
- },
4309
- {
4310
- "$schema": "http://json-schema.org/draft-07/schema#",
4311
- "title": "symmetry schema",
4312
- "type": "object",
4313
- "properties": {
4314
- "pointGroupSymbol": {
4315
- "description": "point group symbol in Schoenflies notation",
4316
- "type": "string"
4317
- },
4318
- "spaceGroupSymbol": {
4319
- "description": "space group symbol in Hermann–Mauguin notation",
4320
- "type": "string"
4321
- },
4322
- "tolerance": {
4323
- "type": "object",
4324
- "description": "tolerance used for symmetry calculation",
4325
- "$schema": "http://json-schema.org/draft-07/schema#",
4326
- "title": "scalar schema",
4327
- "required": [
4328
- "value"
4329
- ],
4330
- "properties": {
4331
- "units": {
4332
- "enum": [
4333
- "angstrom"
4334
- ]
4335
- },
4336
- "value": {
4337
- "type": "number"
4338
- }
4339
- }
4340
- },
4341
- "name": {
4342
- "enum": [
4343
- "symmetry"
4344
- ]
4345
- }
4346
- }
4347
- },
4348
- {
4349
- "$schema": "http://json-schema.org/draft-07/schema#",
4350
- "title": "elemental-ratio",
4351
- "description": "ration of this element in the compound",
4352
- "type": "object",
4353
- "required": [
4354
- "value"
4355
- ],
4356
- "properties": {
4357
- "name": {
4358
- "enum": [
4359
- "elemental_ratio"
4360
- ]
4361
- },
4362
- "value": {
4363
- "type": "number",
4364
- "minimum": 0,
4365
- "maximum": 1
4366
- },
4367
- "element": {
4368
- "type": "string",
4369
- "description": "the element this ratio is for"
4370
- }
4371
- }
4372
- },
4373
- {
4374
- "$schema": "http://json-schema.org/draft-07/schema#",
4375
- "title": "p_norm",
4376
- "description": "https://en.wikipedia.org/wiki/Norm_(mathematics)#p-norm",
4377
- "type": "object",
4378
- "required": [
4379
- "value"
4380
- ],
4381
- "properties": {
4382
- "name": {
4383
- "enum": [
4384
- "p-norm"
4385
- ]
4386
- },
4387
- "degree": {
4388
- "type": "integer",
4389
- "description": "degree of the dimensionality of the norm"
4390
- },
4391
- "value": {
4392
- "type": "number"
4393
- }
4394
- }
4395
- },
4396
- {
4397
- "$schema": "http://json-schema.org/draft-07/schema#",
4398
- "title": "InChI representation schema",
4399
- "type": "object",
4400
- "required": [
4401
- "value"
4402
- ],
4403
- "properties": {
4404
- "name": {
4405
- "enum": [
4406
- "inchi"
4407
- ]
4408
- },
4409
- "value": {
4410
- "type": "string"
4411
- }
4412
- }
4413
- },
4414
- {
4415
- "$schema": "http://json-schema.org/draft-07/schema#",
4416
- "title": "InChI key representation schema",
4417
- "type": "object",
4418
- "required": [
4419
- "value"
4420
- ],
4421
- "properties": {
4422
- "name": {
4423
- "enum": [
4424
- "inchi_key"
4425
- ]
4426
- },
4427
- "value": {
4428
- "type": "string"
4429
- }
4430
- }
4431
- }
4432
- ],
4433
- "discriminator": {
4434
- "propertyName": "name"
4435
- },
4436
- "required": [
4437
- "name"
4438
- ]
4439
- }
4440
- },
4441
- "external": {
4442
- "$schema": "http://json-schema.org/draft-07/schema#",
4443
- "title": "database source schema",
4444
- "description": "information about a database source",
4445
- "type": "object",
4446
- "required": [
4447
- "id",
4448
- "source",
4449
- "origin"
4450
- ],
4451
- "properties": {
4452
- "id": {
4453
- "description": "ID string for the materials uploaded from a third party source inside the third party source. For materialsproject.org an example ID is mp-32",
4454
- "oneOf": [
4455
- {
4456
- "type": "string"
4457
- },
4458
- {
4459
- "type": "number"
4460
- }
4461
- ]
4462
- },
4463
- "source": {
4464
- "description": "Third party source name, e.g. materials project, 2dmatpedia, ICSD, etc.",
4465
- "type": "string"
4466
- },
4467
- "origin": {
4468
- "description": "Deprecated. To be removed. A flag that is true when material is initially imported from a third party * (as opposed to being independently designed from scratch).",
4469
- "type": "boolean"
4470
- },
4471
- "data": {
4472
- "description": "Original response from external source.",
4473
- "type": "object"
4474
- },
4475
- "doi": {
4476
- "description": "Digital Object Identifier, e.g. 10.1088/0953-8984/25/10/105506",
4477
- "type": "string"
4478
- },
4479
- "url": {
4480
- "description": "The URL of the original record, e.g. https://next-gen.materialsproject.org/materials/mp-48; ToDo: update to use URI type per https://json-schema.org/understanding-json-schema/reference/string#resource-identifiers",
4481
- "type": "string"
4482
- }
4483
- }
4484
- },
4485
- "src": {
4486
- "$schema": "http://json-schema.org/draft-07/schema#",
4487
- "title": "file source schema",
4488
- "description": "file source with the information inside",
4489
- "type": "object",
4490
- "required": [
4491
- "filename",
4492
- "text",
4493
- "hash"
4494
- ],
4495
- "properties": {
4496
- "extension": {
4497
- "description": "file extension",
4498
- "type": "string"
4499
- },
4500
- "filename": {
4501
- "description": "file name without extension",
4502
- "type": "string"
4503
- },
4504
- "text": {
4505
- "description": "file content as raw text",
4506
- "type": "string"
4507
- },
4508
- "hash": {
4509
- "description": "MD5 hash based on file content",
4510
- "type": "string"
4511
- }
4512
- }
4513
- },
4514
- "scaledHash": {
4515
- "description": "Hash string for a scaled structure with lattice vector a set to 1 (eg. for materials under pressure).",
4516
- "type": "string"
4517
- },
4518
- "icsdId": {
4519
- "description": "Corresponding ICSD id of the material",
4520
- "type": "integer"
4521
- },
4522
- "isNonPeriodic": {
4523
- "description": "Whether to work in the finite molecular picture (usually with atomic orbital basis)",
4524
- "type": "boolean"
4525
- },
4526
- "consistencyChecks": {
4527
- "type": "array",
4528
- "items": {
4529
- "$schema": "http://json-schema.org/draft-07/schema#",
4530
- "title": "material consistency check schema",
4531
- "type": "object",
4532
- "description": "The output of consistency checks performed on data adhering to JSON schema, but inconsistent with scientific or logical rules, to show problems in UI.",
4533
- "required": [
4534
- "key",
4535
- "name",
4536
- "severity",
4537
- "message"
4538
- ],
4539
- "properties": {
4540
- "name": {
4541
- "type": "string",
4542
- "enum": [
4543
- "default",
4544
- "atomsTooClose",
4545
- "atomsOverlap"
4546
- ],
4547
- "description": "Name of the consistency check that is performed, which is listed in an enum."
4548
- },
4549
- "key": {
4550
- "type": "string",
4551
- "description": "Key of the property of the entity on which the consistency check is performed in Mongo dot notation, e.g. 'basis.coordinates.1'"
4552
- },
4553
- "severity": {
4554
- "enum": [
4555
- "info",
4556
- "warning",
4557
- "error"
4558
- ],
4559
- "description": "Severity level of the problem, which is used in UI to differentiate."
4560
- },
4561
- "message": {
4562
- "type": "string",
4563
- "description": "Message generated by the consistency check describing the problem."
4564
- }
4565
- }
4566
- }
4567
- },
4568
- "_id": {
4569
- "description": "entity identity",
4570
- "type": "string"
4571
- },
4572
- "slug": {
4573
- "description": "entity slug",
4574
- "type": "string"
4575
- },
4576
- "systemName": {
4577
- "type": "string"
4578
- },
4579
- "schemaVersion": {
4580
- "description": "entity's schema version. Used to distinct between different schemas.",
4581
- "type": "string",
4582
- "default": "2022.8.16"
4583
- },
4584
- "name": {
4585
- "description": "entity name",
4586
- "type": "string"
4587
- },
4588
- "isDefault": {
4589
- "description": "Identifies that entity is defaultable",
4590
- "type": "boolean",
4591
- "default": false
4592
- },
4593
- "metadata": {
4594
- "type": "object"
4595
- }
4596
- }
4597
- },
4598
- "use_conventional_cell": {
4599
- "type": "boolean",
4600
- "description": "Use the conventional cell for the crystal structure",
4601
- "default": true
4602
- }
4603
- }
4604
- },
4605
- {
4606
- "$schema": "http://json-schema.org/draft-07/schema#",
4607
- "title": "Vacuum Configuration Schema",
4608
- "description": "A vacuum slab that breaks periodicity in a specified direction",
4609
- "type": "object",
4610
- "required": [
4611
- "direction",
4612
- "size",
4613
- "crystal"
4614
- ],
4615
- "properties": {
4616
- "direction": {
4617
- "$schema": "http://json-schema.org/draft-07/schema#",
4618
- "title": "Axis Enum",
4619
- "type": "string",
4620
- "description": "Enum for axis types",
4621
- "enum": [
4622
- "x",
4623
- "y",
4624
- "z"
4625
- ]
4626
- },
4627
- "size": {
4628
- "type": "number",
4629
- "description": "Size of the vacuum slab in angstroms",
4630
- "minimum": 0,
4631
- "default": 10
4632
- },
4633
- "crystal": {
4634
- "$schema": "http://json-schema.org/draft-07/schema#",
4635
- "title": "Crystal Schema",
4636
- "description": "A crystal structure, referencing the base material schema",
4637
- "type": "object",
4638
- "required": [
4639
- "basis",
4640
- "lattice"
4641
- ],
4642
- "properties": {
4643
- "formula": {
4644
- "description": "reduced chemical formula",
4645
- "type": "string"
4646
- },
4647
- "unitCellFormula": {
4648
- "description": "chemical formula based on the number of atoms of each element in the supercell",
4649
- "type": "string"
4650
- },
4651
- "basis": {
4652
- "$schema": "http://json-schema.org/draft-07/schema#",
4653
- "title": "basis schema",
4654
- "type": "object",
4655
- "required": [
4656
- "elements",
4657
- "coordinates"
4658
- ],
4659
- "properties": {
4660
- "elements": {
4661
- "$schema": "http://json-schema.org/draft-07/schema#",
4662
- "title": "atomic elements schema",
4663
- "description": "atomic elements schema",
4664
- "type": "array",
4665
- "items": {
4666
- "$schema": "http://json-schema.org/draft-07/schema#",
4667
- "title": "atomic element schema",
4668
- "description": "chemical element of an atom according to the periodic table",
4669
- "type": "object",
4670
- "required": [
4671
- "id",
4672
- "value"
4673
- ],
4674
- "properties": {
4675
- "value": {
4676
- "description": "All elements, including extra elements",
4677
- "anyOf": [
4678
- {
4679
- "enum": [
4680
- "H",
4681
- "He",
4682
- "Li",
4683
- "Be",
4684
- "B",
4685
- "C",
4686
- "N",
4687
- "O",
4688
- "F",
4689
- "Ne",
4690
- "Na",
4691
- "Mg",
4692
- "Al",
4693
- "Si",
4694
- "P",
4695
- "S",
4696
- "Cl",
4697
- "Ar",
4698
- "K",
4699
- "Ca",
4700
- "Sc",
4701
- "Ti",
4702
- "V",
4703
- "Cr",
4704
- "Mn",
4705
- "Fe",
4706
- "Co",
4707
- "Ni",
4708
- "Cu",
4709
- "Zn",
4710
- "Ga",
4711
- "Ge",
4712
- "As",
4713
- "Se",
4714
- "Br",
4715
- "Kr",
4716
- "Rb",
4717
- "Sr",
4718
- "Y",
4719
- "Zr",
4720
- "Nb",
4721
- "Mo",
4722
- "Tc",
4723
- "Ru",
4724
- "Rh",
4725
- "Pd",
4726
- "Ag",
4727
- "Cd",
4728
- "In",
4729
- "Sn",
4730
- "Sb",
4731
- "Te",
4732
- "I",
4733
- "Xe",
4734
- "Cs",
4735
- "Ba",
4736
- "La",
4737
- "Ce",
4738
- "Pr",
4739
- "Nd",
4740
- "Pm",
4741
- "Sm",
4742
- "Eu",
4743
- "Gd",
4744
- "Tb",
4745
- "Dy",
4746
- "Ho",
4747
- "Er",
4748
- "Tm",
4749
- "Yb",
4750
- "Lu",
4751
- "Hf",
4752
- "Ta",
4753
- "W",
4754
- "Re",
4755
- "Os",
4756
- "Ir",
4757
- "Pt",
4758
- "Au",
4759
- "Hg",
4760
- "Tl",
4761
- "Pb",
4762
- "Bi",
4763
- "Po",
4764
- "At",
4765
- "Rn",
4766
- "Fr",
4767
- "Ra",
4768
- "Ac",
4769
- "Th",
4770
- "Pa",
4771
- "U",
4772
- "Np",
4773
- "Pu",
4774
- "Am",
4775
- "Cm",
4776
- "Bk",
4777
- "Cf",
4778
- "Es",
4779
- "Fm",
4780
- "Md",
4781
- "No",
4782
- "Lr",
4783
- "Rf",
4784
- "Db",
4785
- "Sg",
4786
- "Bh",
4787
- "Hs",
4788
- "Mt",
4789
- "Ds",
4790
- "Rg",
4791
- "Cn",
4792
- "Nh",
4793
- "Fl",
4794
- "Mc",
4795
- "Lv",
4796
- "Ts",
4797
- "Og"
4798
- ]
4799
- },
4800
- {
4801
- "description": "Extra elements, used for convenience purposed",
4802
- "enum": [
4803
- "X",
4804
- "Vac"
4805
- ]
4806
- }
4807
- ],
4808
- "type": "string"
4809
- },
4810
- "id": {
4811
- "description": "integer id of this entry",
4812
- "type": "integer"
4813
- }
4814
- }
4815
- }
4816
- },
4817
- "coordinates": {
4818
- "$schema": "http://json-schema.org/draft-07/schema#",
4819
- "title": "atomic coordinates schema",
4820
- "description": "atomic coordinates schema",
4821
- "type": "array",
4822
- "items": {
4823
- "$schema": "http://json-schema.org/draft-07/schema#",
4824
- "title": "atomic coordinate schema",
4825
- "description": "coordinate of an atom",
4826
- "type": "object",
4827
- "required": [
4828
- "id",
4829
- "value"
4830
- ],
4831
- "properties": {
4832
- "value": {
4833
- "$schema": "http://json-schema.org/draft-07/schema#",
4834
- "title": "coordinate 3d schema",
4835
- "type": "array",
4836
- "minItems": 3,
4837
- "maxItems": 3,
4838
- "description": "value of this entry",
4839
- "items": {
4840
- "type": "number"
4841
- }
4842
- },
4843
- "id": {
4844
- "description": "integer id of this entry",
4845
- "type": "integer"
4846
- }
4847
- }
4848
- }
4849
- },
4850
- "units": {
4851
- "$schema": "http://json-schema.org/draft-07/schema#",
4852
- "title": "basis units enum",
4853
- "enum": [
4854
- "crystal",
4855
- "cartesian"
4856
- ],
4857
- "default": "crystal"
4858
- },
4859
- "labels": {
4860
- "$schema": "http://json-schema.org/draft-07/schema#",
4861
- "title": "atomic labels schema",
4862
- "description": "atomic labels schema",
4863
- "type": "array",
4864
- "items": {
4865
- "$schema": "http://json-schema.org/draft-07/schema#",
4866
- "title": "atomic label schema",
4867
- "description": "Optional label (e.g., 1, 2, as in Fe1, Fe2) to distinguish species, e.g. to have magnetic moment.",
4868
- "type": "object",
4869
- "required": [
4870
- "id",
4871
- "value"
4872
- ],
4873
- "properties": {
4874
- "value": {
4875
- "anyOf": [
4876
- {
4877
- "type": [
4878
- "integer",
4879
- "string",
4880
- "number"
4881
- ]
4882
- },
4883
- {
4884
- "$schema": "http://json-schema.org/draft-07/schema#",
4885
- "title": "integer positive single digit",
4886
- "type": "integer",
4887
- "minimum": 1,
4888
- "maximum": 9
4889
- }
4890
- ],
4891
- "description": "value of this entry"
4892
- },
4893
- "id": {
4894
- "description": "integer id of this entry",
4895
- "type": "integer"
4896
- }
4897
- }
4898
- }
4899
- }
4900
- }
4901
- },
4902
- "lattice": {
4903
- "$schema": "http://json-schema.org/draft-07/schema#",
4904
- "title": "lattice schema",
4905
- "type": "object",
4906
- "required": [
4907
- "a",
4908
- "b",
4909
- "c",
4910
- "alpha",
4911
- "beta",
4912
- "gamma"
4913
- ],
4914
- "properties": {
4915
- "a": {
4916
- "description": "length of the first lattice vector",
4917
- "type": "number"
4918
- },
4919
- "b": {
4920
- "description": "length of the second lattice vector",
4921
- "type": "number"
4922
- },
4923
- "c": {
4924
- "description": "length of the third lattice vector",
4925
- "type": "number"
4926
- },
4927
- "alpha": {
4928
- "description": "angle between first and second lattice vector",
4929
- "type": "number"
4930
- },
4931
- "beta": {
4932
- "description": "angle between second and third lattice vector",
4933
- "type": "number"
4934
- },
4935
- "gamma": {
4936
- "description": "angle between first and third lattice vector",
4937
- "type": "number"
4938
- },
4939
- "vectors": {
4940
- "$schema": "http://json-schema.org/draft-07/schema#",
4941
- "title": "lattice vectors schema",
4942
- "type": "object",
4943
- "required": [
4944
- "a",
4945
- "b",
4946
- "c"
4947
- ],
4948
- "properties": {
4949
- "a": {
4950
- "$schema": "http://json-schema.org/draft-07/schema#",
4951
- "title": "vector 3d schema",
4952
- "type": "array",
4953
- "minItems": 3,
4954
- "maxItems": 3,
4955
- "items": {
4956
- "type": "number"
4957
- }
4958
- },
4959
- "b": {
4960
- "$schema": "http://json-schema.org/draft-07/schema#",
4961
- "title": "vector 3d schema",
4962
- "type": "array",
4963
- "minItems": 3,
4964
- "maxItems": 3,
4965
- "items": {
4966
- "type": "number"
4967
- }
4968
- },
4969
- "c": {
4970
- "$schema": "http://json-schema.org/draft-07/schema#",
4971
- "title": "vector 3d schema",
4972
- "type": "array",
4973
- "minItems": 3,
4974
- "maxItems": 3,
4975
- "items": {
4976
- "type": "number"
4977
- }
4978
- },
4979
- "alat": {
4980
- "description": "lattice parameter for fractional coordinates",
4981
- "type": "number",
4982
- "default": 1
4983
- },
4984
- "units": {
4985
- "$schema": "http://json-schema.org/draft-07/schema#",
4986
- "title": "lattice vectors units enum",
4987
- "enum": [
4988
- "angstrom",
4989
- "bohr"
4990
- ],
4991
- "default": "angstrom"
4992
- }
4993
- }
4994
- },
4995
- "type": {
4996
- "$schema": "http://json-schema.org/draft-07/schema#",
4997
- "title": "lattice type enum",
4998
- "type": "string",
4999
- "enum": [
5000
- "CUB",
5001
- "BCC",
5002
- "FCC",
5003
- "TET",
5004
- "MCL",
5005
- "ORC",
5006
- "ORCC",
5007
- "ORCF",
5008
- "ORCI",
5009
- "HEX",
5010
- "BCT",
5011
- "TRI",
5012
- "MCLC",
5013
- "RHL"
5014
- ],
5015
- "default": "TRI"
5016
- },
5017
- "units": {
5018
- "$schema": "http://json-schema.org/draft-07/schema#",
5019
- "title": "Lattice units schema",
5020
- "type": "object",
5021
- "default": {
5022
- "length": "angstrom",
5023
- "angle": "degree"
5024
- },
5025
- "properties": {
5026
- "length": {
5027
- "$schema": "http://json-schema.org/draft-07/schema#",
5028
- "title": "lattice units length enum",
5029
- "enum": [
5030
- "angstrom",
5031
- "bohr"
5032
- ],
5033
- "default": "angstrom"
5034
- },
5035
- "angle": {
5036
- "$schema": "http://json-schema.org/draft-07/schema#",
5037
- "title": "lattice units angle enum",
5038
- "enum": [
5039
- "degree",
5040
- "radian"
5041
- ],
5042
- "default": "degree"
5043
- }
5044
- }
5045
- }
5046
- }
5047
- },
5048
- "derivedProperties": {
5049
- "$schema": "http://json-schema.org/draft-07/schema#",
5050
- "title": "derived properties schema",
5051
- "type": "array",
5052
- "items": {
5053
- "oneOf": [
5054
- {
5055
- "$schema": "http://json-schema.org/draft-07/schema#",
5056
- "title": "volume schema",
5057
- "type": "object",
5058
- "required": [
5059
- "value"
5060
- ],
5061
- "properties": {
5062
- "name": {
5063
- "enum": [
5064
- "volume"
5065
- ]
5066
- },
5067
- "units": {
5068
- "enum": [
5069
- "angstrom^3"
5070
- ]
5071
- },
5072
- "value": {
5073
- "type": "number"
5074
- }
5075
- }
5076
- },
5077
- {
5078
- "$schema": "http://json-schema.org/draft-07/schema#",
5079
- "title": "density schema",
5080
- "type": "object",
5081
- "required": [
5082
- "value"
5083
- ],
5084
- "properties": {
5085
- "name": {
5086
- "enum": [
5087
- "density"
5088
- ]
5089
- },
5090
- "units": {
5091
- "enum": [
5092
- "g/cm^3"
5093
- ]
5094
- },
5095
- "value": {
5096
- "type": "number"
5097
- }
5098
- }
5099
- },
5100
- {
5101
- "$schema": "http://json-schema.org/draft-07/schema#",
5102
- "title": "symmetry schema",
5103
- "type": "object",
5104
- "properties": {
5105
- "pointGroupSymbol": {
5106
- "description": "point group symbol in Schoenflies notation",
5107
- "type": "string"
5108
- },
5109
- "spaceGroupSymbol": {
5110
- "description": "space group symbol in Hermann–Mauguin notation",
5111
- "type": "string"
5112
- },
5113
- "tolerance": {
5114
- "type": "object",
5115
- "description": "tolerance used for symmetry calculation",
5116
- "$schema": "http://json-schema.org/draft-07/schema#",
5117
- "title": "scalar schema",
5118
- "required": [
5119
- "value"
5120
- ],
5121
- "properties": {
5122
- "units": {
5123
- "enum": [
5124
- "angstrom"
5125
- ]
5126
- },
5127
- "value": {
5128
- "type": "number"
5129
- }
5130
- }
5131
- },
5132
- "name": {
5133
- "enum": [
5134
- "symmetry"
5135
- ]
5136
- }
5137
- }
5138
- },
5139
- {
5140
- "$schema": "http://json-schema.org/draft-07/schema#",
5141
- "title": "elemental-ratio",
5142
- "description": "ration of this element in the compound",
5143
- "type": "object",
5144
- "required": [
5145
- "value"
5146
- ],
5147
- "properties": {
5148
- "name": {
5149
- "enum": [
5150
- "elemental_ratio"
5151
- ]
5152
- },
5153
- "value": {
5154
- "type": "number",
5155
- "minimum": 0,
5156
- "maximum": 1
5157
- },
5158
- "element": {
5159
- "type": "string",
5160
- "description": "the element this ratio is for"
5161
- }
5162
- }
5163
- },
5164
- {
5165
- "$schema": "http://json-schema.org/draft-07/schema#",
5166
- "title": "p_norm",
5167
- "description": "https://en.wikipedia.org/wiki/Norm_(mathematics)#p-norm",
5168
- "type": "object",
5169
- "required": [
5170
- "value"
5171
- ],
5172
- "properties": {
5173
- "name": {
5174
- "enum": [
5175
- "p-norm"
5176
- ]
5177
- },
5178
- "degree": {
5179
- "type": "integer",
5180
- "description": "degree of the dimensionality of the norm"
5181
- },
5182
- "value": {
5183
- "type": "number"
5184
- }
5185
- }
5186
- },
5187
- {
5188
- "$schema": "http://json-schema.org/draft-07/schema#",
5189
- "title": "InChI representation schema",
5190
- "type": "object",
5191
- "required": [
5192
- "value"
5193
- ],
5194
- "properties": {
5195
- "name": {
5196
- "enum": [
5197
- "inchi"
5198
- ]
5199
- },
5200
- "value": {
5201
- "type": "string"
5202
- }
5203
- }
5204
- },
5205
- {
5206
- "$schema": "http://json-schema.org/draft-07/schema#",
5207
- "title": "InChI key representation schema",
5208
- "type": "object",
5209
- "required": [
5210
- "value"
5211
- ],
5212
- "properties": {
5213
- "name": {
5214
- "enum": [
5215
- "inchi_key"
5216
- ]
5217
- },
5218
- "value": {
5219
- "type": "string"
5220
- }
5221
- }
5222
- }
5223
- ],
5224
- "discriminator": {
5225
- "propertyName": "name"
5226
- },
5227
- "required": [
5228
- "name"
5229
- ]
5230
- }
5231
- },
5232
- "external": {
5233
- "$schema": "http://json-schema.org/draft-07/schema#",
5234
- "title": "database source schema",
5235
- "description": "information about a database source",
5236
- "type": "object",
5237
- "required": [
5238
- "id",
5239
- "source",
5240
- "origin"
5241
- ],
5242
- "properties": {
5243
- "id": {
5244
- "description": "ID string for the materials uploaded from a third party source inside the third party source. For materialsproject.org an example ID is mp-32",
5245
- "oneOf": [
5246
- {
5247
- "type": "string"
5248
- },
5249
- {
5250
- "type": "number"
5251
- }
5252
- ]
5253
- },
5254
- "source": {
5255
- "description": "Third party source name, e.g. materials project, 2dmatpedia, ICSD, etc.",
5256
- "type": "string"
5257
- },
5258
- "origin": {
5259
- "description": "Deprecated. To be removed. A flag that is true when material is initially imported from a third party * (as opposed to being independently designed from scratch).",
5260
- "type": "boolean"
5261
- },
5262
- "data": {
5263
- "description": "Original response from external source.",
5264
- "type": "object"
5265
- },
5266
- "doi": {
5267
- "description": "Digital Object Identifier, e.g. 10.1088/0953-8984/25/10/105506",
5268
- "type": "string"
5269
- },
5270
- "url": {
5271
- "description": "The URL of the original record, e.g. https://next-gen.materialsproject.org/materials/mp-48; ToDo: update to use URI type per https://json-schema.org/understanding-json-schema/reference/string#resource-identifiers",
5272
- "type": "string"
5273
- }
5274
- }
5275
- },
5276
- "src": {
5277
- "$schema": "http://json-schema.org/draft-07/schema#",
5278
- "title": "file source schema",
5279
- "description": "file source with the information inside",
5280
- "type": "object",
5281
- "required": [
5282
- "filename",
5283
- "text",
5284
- "hash"
5285
- ],
5286
- "properties": {
5287
- "extension": {
5288
- "description": "file extension",
5289
- "type": "string"
5290
- },
5291
- "filename": {
5292
- "description": "file name without extension",
5293
- "type": "string"
5294
- },
5295
- "text": {
5296
- "description": "file content as raw text",
5297
- "type": "string"
5298
- },
5299
- "hash": {
5300
- "description": "MD5 hash based on file content",
5301
- "type": "string"
5302
- }
5303
- }
5304
- },
5305
- "scaledHash": {
5306
- "description": "Hash string for a scaled structure with lattice vector a set to 1 (eg. for materials under pressure).",
5307
- "type": "string"
5308
- },
5309
- "icsdId": {
5310
- "description": "Corresponding ICSD id of the material",
5311
- "type": "integer"
5312
- },
5313
- "isNonPeriodic": {
5314
- "description": "Whether to work in the finite molecular picture (usually with atomic orbital basis)",
5315
- "type": "boolean"
5316
- },
5317
- "consistencyChecks": {
5318
- "type": "array",
5319
- "items": {
5320
- "$schema": "http://json-schema.org/draft-07/schema#",
5321
- "title": "material consistency check schema",
5322
- "type": "object",
5323
- "description": "The output of consistency checks performed on data adhering to JSON schema, but inconsistent with scientific or logical rules, to show problems in UI.",
5324
- "required": [
5325
- "key",
5326
- "name",
5327
- "severity",
5328
- "message"
5329
- ],
5330
- "properties": {
5331
- "name": {
5332
- "type": "string",
5333
- "enum": [
5334
- "default",
5335
- "atomsTooClose",
5336
- "atomsOverlap"
5337
- ],
5338
- "description": "Name of the consistency check that is performed, which is listed in an enum."
5339
- },
5340
- "key": {
5341
- "type": "string",
5342
- "description": "Key of the property of the entity on which the consistency check is performed in Mongo dot notation, e.g. 'basis.coordinates.1'"
5343
- },
5344
- "severity": {
5345
- "enum": [
5346
- "info",
5347
- "warning",
5348
- "error"
5349
- ],
5350
- "description": "Severity level of the problem, which is used in UI to differentiate."
5351
- },
5352
- "message": {
5353
- "type": "string",
5354
- "description": "Message generated by the consistency check describing the problem."
5355
- }
5356
- }
5357
- }
5358
- },
5359
- "_id": {
5360
- "description": "entity identity",
5361
- "type": "string"
5362
- },
5363
- "slug": {
5364
- "description": "entity slug",
5365
- "type": "string"
5366
- },
5367
- "systemName": {
5368
- "type": "string"
5369
- },
5370
- "schemaVersion": {
5371
- "description": "entity's schema version. Used to distinct between different schemas.",
5372
- "type": "string",
5373
- "default": "2022.8.16"
5374
- },
5375
- "name": {
5376
- "description": "entity name",
5377
- "type": "string"
5378
- },
5379
- "isDefault": {
5380
- "description": "Identifies that entity is defaultable",
5381
- "type": "boolean",
5382
- "default": false
5383
- },
5384
- "metadata": {
5385
- "type": "object"
5386
- }
5387
- }
5388
- }
1781
+ },
1782
+ "gaps": {
1783
+ "description": "Gap distances between stack components as an array of objects with id and value",
1784
+ "type": "array",
1785
+ "items": {
1786
+ "$schema": "http://json-schema.org/draft-07/schema#",
1787
+ "title": "object with id",
1788
+ "description": "object containing integer id",
1789
+ "type": "object",
1790
+ "required": [
1791
+ "id"
1792
+ ],
1793
+ "properties": {
1794
+ "value": {
1795
+ "type": "number",
1796
+ "minimum": 0
1797
+ },
1798
+ "id": {
1799
+ "description": "integer id of this entry",
1800
+ "type": "integer"
5389
1801
  }
5390
1802
  }
5391
- ]
5392
- },
5393
- "direction": {
5394
- "default": "z",
5395
- "$schema": "http://json-schema.org/draft-07/schema#",
5396
- "title": "Axis Enum",
5397
- "type": "string",
5398
- "description": "Enum for axis types",
5399
- "enum": [
5400
- "x",
5401
- "y",
5402
- "z"
5403
- ]
1803
+ }
5404
1804
  }
5405
1805
  }
5406
- }
5407
- ]
5408
- },
5409
- {
5410
- "anyOf": [
1806
+ },
5411
1807
  {
5412
1808
  "$schema": "http://json-schema.org/draft-07/schema#",
5413
- "title": "Slab Configuration Schema",
5414
- "description": "A slab unit cell consisting of repeated unique atomic layers and vacuum.",
5415
- "type": "object",
1809
+ "title": "Slab Strained Supercell Configuration Schema",
1810
+ "description": "A slab structure configuration with supercell transformation and strain matrix in the xy plane",
5416
1811
  "required": [
1812
+ "direction",
5417
1813
  "stack_components",
5418
- "direction"
1814
+ "strain_matrix",
1815
+ "xy_supercell_matrix"
5419
1816
  ],
1817
+ "type": "object",
5420
1818
  "properties": {
1819
+ "xy_supercell_matrix": {
1820
+ "$schema": "http://json-schema.org/draft-07/schema#",
1821
+ "title": "Supercell Matrix 2D Schema",
1822
+ "description": "Supercell matrix for xy plane transformations",
1823
+ "type": "array",
1824
+ "minItems": 2,
1825
+ "maxItems": 2,
1826
+ "default": [
1827
+ [
1828
+ 1,
1829
+ 0
1830
+ ],
1831
+ [
1832
+ 0,
1833
+ 1
1834
+ ]
1835
+ ],
1836
+ "items": {
1837
+ "type": "array",
1838
+ "minItems": 2,
1839
+ "maxItems": 2,
1840
+ "items": {
1841
+ "type": "integer"
1842
+ }
1843
+ }
1844
+ },
1845
+ "strain_matrix": {
1846
+ "$schema": "http://json-schema.org/draft-07/schema#",
1847
+ "title": "matrix 3x3 schema",
1848
+ "type": "array",
1849
+ "minItems": 3,
1850
+ "maxItems": 3,
1851
+ "items": {
1852
+ "$schema": "http://json-schema.org/draft-07/schema#",
1853
+ "title": "array of 3 number elements schema",
1854
+ "type": "array",
1855
+ "minItems": 3,
1856
+ "maxItems": 3,
1857
+ "items": {
1858
+ "type": "number"
1859
+ }
1860
+ }
1861
+ },
5421
1862
  "stack_components": {
5422
1863
  "type": "array",
5423
1864
  "minItems": 2,
@@ -7169,64 +3610,46 @@
7169
3610
  "y",
7170
3611
  "z"
7171
3612
  ]
3613
+ },
3614
+ "gaps": {
3615
+ "description": "Gap distances between stack components as an array of objects with id and value",
3616
+ "type": "array",
3617
+ "items": {
3618
+ "$schema": "http://json-schema.org/draft-07/schema#",
3619
+ "title": "object with id",
3620
+ "description": "object containing integer id",
3621
+ "type": "object",
3622
+ "required": [
3623
+ "id"
3624
+ ],
3625
+ "properties": {
3626
+ "value": {
3627
+ "type": "number",
3628
+ "minimum": 0
3629
+ },
3630
+ "id": {
3631
+ "description": "integer id of this entry",
3632
+ "type": "integer"
3633
+ }
3634
+ }
3635
+ }
7172
3636
  }
7173
3637
  }
7174
- },
3638
+ }
3639
+ ]
3640
+ },
3641
+ {
3642
+ "anyOf": [
7175
3643
  {
7176
3644
  "$schema": "http://json-schema.org/draft-07/schema#",
7177
- "title": "Slab Strained Supercell Configuration Schema",
7178
- "description": "A slab structure configuration with supercell transformation and strain matrix in the xy plane",
3645
+ "title": "Slab Configuration Schema",
3646
+ "description": "A slab unit cell consisting of repeated unique atomic layers and vacuum.",
3647
+ "type": "object",
7179
3648
  "required": [
7180
- "direction",
7181
3649
  "stack_components",
7182
- "strain_matrix",
7183
- "xy_supercell_matrix"
3650
+ "direction"
7184
3651
  ],
7185
- "type": "object",
7186
3652
  "properties": {
7187
- "xy_supercell_matrix": {
7188
- "$schema": "http://json-schema.org/draft-07/schema#",
7189
- "title": "Supercell Matrix 2D Schema",
7190
- "description": "Supercell matrix for xy plane transformations",
7191
- "type": "array",
7192
- "minItems": 2,
7193
- "maxItems": 2,
7194
- "default": [
7195
- [
7196
- 1,
7197
- 0
7198
- ],
7199
- [
7200
- 0,
7201
- 1
7202
- ]
7203
- ],
7204
- "items": {
7205
- "type": "array",
7206
- "minItems": 2,
7207
- "maxItems": 2,
7208
- "items": {
7209
- "type": "integer"
7210
- }
7211
- }
7212
- },
7213
- "strain_matrix": {
7214
- "$schema": "http://json-schema.org/draft-07/schema#",
7215
- "title": "matrix 3x3 schema",
7216
- "type": "array",
7217
- "minItems": 3,
7218
- "maxItems": 3,
7219
- "items": {
7220
- "$schema": "http://json-schema.org/draft-07/schema#",
7221
- "title": "array of 3 number elements schema",
7222
- "type": "array",
7223
- "minItems": 3,
7224
- "maxItems": 3,
7225
- "items": {
7226
- "type": "number"
7227
- }
7228
- }
7229
- },
7230
3653
  "stack_components": {
7231
3654
  "type": "array",
7232
3655
  "minItems": 2,
@@ -8978,13 +5401,36 @@
8978
5401
  "y",
8979
5402
  "z"
8980
5403
  ]
5404
+ },
5405
+ "gaps": {
5406
+ "description": "Gap distances between stack components as an array of objects with id and value",
5407
+ "type": "array",
5408
+ "items": {
5409
+ "$schema": "http://json-schema.org/draft-07/schema#",
5410
+ "title": "object with id",
5411
+ "description": "object containing integer id",
5412
+ "type": "object",
5413
+ "required": [
5414
+ "id"
5415
+ ],
5416
+ "properties": {
5417
+ "value": {
5418
+ "type": "number",
5419
+ "minimum": 0
5420
+ },
5421
+ "id": {
5422
+ "description": "integer id of this entry",
5423
+ "type": "integer"
5424
+ }
5425
+ }
5426
+ }
8981
5427
  }
8982
5428
  }
8983
5429
  },
8984
5430
  {
8985
5431
  "$schema": "http://json-schema.org/draft-07/schema#",
8986
- "title": "Slab Strained Supercell with Gap Configuration Schema",
8987
- "description": "A slab structure configuration with supercell transformation, strain matrix, and optional gap for film positioning",
5432
+ "title": "Slab Strained Supercell Configuration Schema",
5433
+ "description": "A slab structure configuration with supercell transformation and strain matrix in the xy plane",
8988
5434
  "required": [
8989
5435
  "direction",
8990
5436
  "stack_components",
@@ -8993,11 +5439,6 @@
8993
5439
  ],
8994
5440
  "type": "object",
8995
5441
  "properties": {
8996
- "gap": {
8997
- "type": "number",
8998
- "description": "If provided, the film is shifted to have it as smallest distance to the substrate",
8999
- "minimum": 0
9000
- },
9001
5442
  "xy_supercell_matrix": {
9002
5443
  "$schema": "http://json-schema.org/draft-07/schema#",
9003
5444
  "title": "Supercell Matrix 2D Schema",
@@ -10792,6 +7233,29 @@
10792
7233
  "y",
10793
7234
  "z"
10794
7235
  ]
7236
+ },
7237
+ "gaps": {
7238
+ "description": "Gap distances between stack components as an array of objects with id and value",
7239
+ "type": "array",
7240
+ "items": {
7241
+ "$schema": "http://json-schema.org/draft-07/schema#",
7242
+ "title": "object with id",
7243
+ "description": "object containing integer id",
7244
+ "type": "object",
7245
+ "required": [
7246
+ "id"
7247
+ ],
7248
+ "properties": {
7249
+ "value": {
7250
+ "type": "number",
7251
+ "minimum": 0
7252
+ },
7253
+ "id": {
7254
+ "description": "integer id of this entry",
7255
+ "type": "integer"
7256
+ }
7257
+ }
7258
+ }
10795
7259
  }
10796
7260
  }
10797
7261
  }
@@ -11611,6 +8075,29 @@
11611
8075
  "items": {
11612
8076
  "type": "number"
11613
8077
  }
8078
+ },
8079
+ "gaps": {
8080
+ "description": "Gap distances between stack components as an array of objects with id and value",
8081
+ "type": "array",
8082
+ "items": {
8083
+ "$schema": "http://json-schema.org/draft-07/schema#",
8084
+ "title": "object with id",
8085
+ "description": "object containing integer id",
8086
+ "type": "object",
8087
+ "required": [
8088
+ "id"
8089
+ ],
8090
+ "properties": {
8091
+ "value": {
8092
+ "type": "number",
8093
+ "minimum": 0
8094
+ },
8095
+ "id": {
8096
+ "description": "integer id of this entry",
8097
+ "type": "integer"
8098
+ }
8099
+ }
8100
+ }
11614
8101
  }
11615
8102
  }
11616
8103
  }