Structured Representation of Materials¶
We present an example of our approach towards defining and storing structured data for materials. The aspects presented herein complement the general introduction.
Example Representation¶
In the expandable section below, the user can find an example JSON representation of a face-centered cubic Silicon:
Expand to view
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 | { "allOf": [ { "schemaId": "system-bankable-entity", "allOf": [ { "description": "entity schema", "allOf": [ { "schemaId": "system-timestampable", "properties": { "createdAt": { "type": "string", "description": "entity creation time" }, "updatedAt": { "type": "string", "description": "entity last modification time" } }, "description": "entity timestampable schema", "title": "timestampable entity schema" }, { "schemaId": "system-soft-removable", "properties": { "removedAt": { "type": "string", "description": "Timestamp of the moment when entity was removed" }, "removed": { "type": "boolean", "description": "Identifies that entity was removed" } }, "description": "entity removable schema", "title": "soft removable entity schema" }, { "schemaId": "system-name", "properties": { "name": { "type": "string", "description": "entity name" }, "slug": { "type": "string", "description": "entity slug" } }, "description": "entity name schema", "title": "timestampable entity schema" }, { "schemaId": "system-tags", "properties": { "tags": { "items": { "type": "string" }, "type": "array", "description": "entity tags" } }, "description": "entity tags schema", "title": "entity tags schema" } ], "schemaId": "system-entity", "required": [ "_id", "schemaVersion", "owner", "creator" ], "title": "entity schema", "properties": { "owner": { "schemaId": "system-entity-reference", "required": [ "_id", "cls" ], "properties": { "_id": { "type": "string", "description": "entity identity" }, "slug": { "type": "string", "description": "entity slug" }, "cls": { "type": "string", "description": "entity class" } }, "description": "Subset of the full information about the account who owns the entity.", "title": "entity reference schema" }, "schemaVersion": { "type": "string", "description": "entity's schema version. Used to distinct between different schemas." }, "_id": { "type": "string", "description": "entity identity" }, "description": { "type": "string", "description": "entity description" }, "creator": { "schemaId": "system-entity-reference", "required": [ "_id", "cls" ], "properties": { "_id": { "type": "string", "description": "entity identity" }, "slug": { "type": "string", "description": "entity slug" }, "cls": { "type": "string", "description": "entity class" } }, "description": "Subset of the full information about the user who created the entity.", "title": "entity reference schema" } } }, { "schemaId": "system-bankable", "required": [ "exabyteId", "hash" ], "properties": { "exabyteId": { "type": "string", "description": "Identity of the corresponding bank entity" }, "hash": { "type": "string", "description": "Hash string which is calculated based on the meaningful fields of the entity. Used to identify equal entities." } }, "description": "bankable schema", "title": "bankable schema" } ], "description": "bankable entity schema", "title": "bankable entity schema" } ], "schemaId": "material", "required": [ "basis", "lattice" ], "title": "material schema", "$schema": "http://json-schema.org/draft-04/schema#", "properties": { "icsdId": { "type": "integer", "description": "Corresponding ICSD id of the material" }, "fileSource": { "description": "file source with the information inside", "title": "file source schema", "schemaId": "system-file-source", "required": [ "extension", "name", "text" ], "type": "object", "properties": { "text": { "type": "string", "description": "file content as raw text" }, "name": { "type": "string", "description": "file name without extension" }, "extension": { "type": "string", "description": "file extension" } } }, "basis": { "description": "object containing an array of elements and coordinates in the supercell", "title": "basis schema", "schemaId": "properties-directory-structural-basis", "required": [ "elements", "coordinates" ], "type": "object", "properties": { "elements": { "schemaId": "properties-directory-structural-basis-atomic-elements", "properties": { "values": { "items": { "properties": { "value": { "type": "string" } } }, "schemaId": "core-reusable-atomic-strings", "allOf": [ { "items": { "uniqueItems": true, "type": "object", "properties": { "id": { "type": "integer", "description": "integer id of this entry" } } }, "schemaId": "core-primitive-array-of-ids", "type": "array", "description": "array of objects containing integer id each", "title": "atomic ids" } ], "title": "atomic vectors schema" }, "name": { "enum": [ "atomic_elements" ] } }, "description": "elements of atoms by ids, string, unitless", "title": "atomic elements" }, "coordinates": { "schemaId": "properties-directory-structural-basis-atomic-coordinates", "properties": { "units": { "enum": [ "km", "m", "pm", "nm", "angstrom", "a.u.", "bohr", "fractional", "crystal", "cartesian", "alat" ] }, "values": { "items": { "properties": { "value": { "schemaId": "core-abstract-vector", "anyOf": [ { "title": "array of 3 number elements schema", "minItems": 3, "items": { "type": "number" }, "schemaId": "core-primitive-array-of-3-numbers", "maxItems": 3, "type": "array" }, { "title": "array of 3 boolean elements schema", "minItems": 3, "items": { "type": "boolean" }, "schemaId": "core-primitive-array-of-3-booleans", "maxItems": 3, "type": "array" } ], "title": "vector schema" } } }, "schemaId": "core-reusable-atomic-vectors", "allOf": [ { "items": { "uniqueItems": true, "type": "object", "properties": { "id": { "type": "integer", "description": "integer id of this entry" } } }, "schemaId": "core-primitive-array-of-ids", "type": "array", "description": "array of objects containing integer id each", "title": "atomic ids" } ], "title": "atomic vectors schema" }, "name": { "enum": [ "atomic_coordinates" ] } }, "description": "coordinates of atoms by ids, vector, unitless", "title": "atomic coordinates" }, "bonds": { "uniqueItems": true, "items": { "type": "object", "properties": { "bondType": { "enum": [ "single", "double", "triple", "quadruple", "aromatic", "tautomeric", "dative", "other" ], "type": "string" }, "atomPair": { "minItems": 2, "description": "indices of the two connected atoms", "maxItems": 2, "allOf": [ { "items": { "uniqueItems": true, "type": "object", "properties": { "id": { "type": "integer", "description": "integer id of this entry" } } }, "schemaId": "core-primitive-array-of-ids", "type": "array", "description": "array of objects containing integer id each", "title": "atomic ids" } ] } } }, "schemaId": "properties-directory-structural-basis-bonds", "type": "array", "title": "bonds schema" } } }, "scaledHash": { "type": "string", "description": "Hash string for a scaled structure with lattice vector a set to 1 (eg. for materials under pressure)." }, "derivedProperties": { "items": { "anyOf": [ { "schemaId": "properties-directory-structural-volume", "allOf": [ { "schemaId": "core-primitive-scalar", "required": [ "value" ], "type": "object", "properties": { "value": { "type": "number" } }, "title": "scalar schema" } ], "properties": { "units": { "enum": [ "angstrom^3" ] }, "name": { "enum": [ "volume" ] } }, "title": "volume schema" }, { "schemaId": "properties-directory-structural-density", "allOf": [ { "schemaId": "core-primitive-scalar", "required": [ "value" ], "type": "object", "properties": { "value": { "type": "number" } }, "title": "scalar schema" } ], "properties": { "units": { "enum": [ "g/cm^3" ] }, "name": { "enum": [ "density" ] } }, "title": "density schema" }, { "schemaId": "properties-directory-structural-symmetry", "properties": { "spaceGroupSymbol": { "type": "string", "description": "space group symbol in Hermann\u2013Mauguin notation" }, "tolerance": { "properties": { "units": { "enum": [ "angstrom" ] } }, "description": "tolerance used for symmetry calculation", "allOf": [ { "schemaId": "core-primitive-scalar", "required": [ "value" ], "type": "object", "properties": { "value": { "type": "number" } }, "title": "scalar schema" } ] }, "name": { "enum": [ "symmetry" ] }, "pointGroupSymbol": { "type": "string", "description": "point group symbol in Schoenflies notation" } }, "title": "symmetry schema" }, { "schemaId": "properties-directory-structural-elemental-ratio", "allOf": [ { "schemaId": "core-primitive-scalar", "required": [ "value" ], "type": "object", "properties": { "value": { "type": "number" } }, "title": "scalar schema" } ], "properties": { "name": { "enum": [ "elemental_ratio" ] }, "value": { "max": 1, "min": 0 }, "element": { "type": "string", "description": "the element this ratio is for" } }, "description": "ration of this element in the compound", "title": "elemental-ratio" }, { "schemaId": "properties-directory-structural-p-norm", "allOf": [ { "schemaId": "core-primitive-scalar", "required": [ "value" ], "type": "object", "properties": { "value": { "type": "number" } }, "title": "scalar schema" } ], "properties": { "name": { "enum": [ "p-norm" ] }, "degree": { "type": "integer", "description": "degree of the dimensionality of the norm" } }, "description": "https://en.wikipedia.org/wiki/Norm_(mathematics)#p-norm", "title": "p_norm" }, { "schemaId": "properties-directory-structural-inchi", "allOf": [ { "schemaId": "core-primitive-string", "required": [ "value" ], "type": "object", "properties": { "value": { "type": "string" } }, "title": "string" } ], "properties": { "name": { "enum": [ "inchi" ] } }, "title": "InChI representation schema" }, { "schemaId": "properties-directory-structural-inchi_key", "allOf": [ { "schemaId": "core-primitive-string", "required": [ "value" ], "type": "object", "properties": { "value": { "type": "string" } }, "title": "string" } ], "properties": { "name": { "enum": [ "inchi_key" ] } }, "title": "InChI representation schema" } ] }, "schemaId": "properties-directory-derived-properties", "type": "array", "description": "object defining the lattice cell size and shape", "title": "derived properties schema" }, "lattice": { "oneOf": [ { "required": [ "vectors" ], "properties": { "vectors": { "schemaId": "properties-directory-structural-lattice-lattice-vectors", "allOf": [ { "schemaId": "core-abstract-3d-vector-basis", "required": [ "a", "b", "c" ], "type": "object", "properties": { "a": { "description": "first vector", "title": "array of 3 number elements schema", "minItems": 3, "items": { "type": "number" }, "schemaId": "core-primitive-array-of-3-numbers", "maxItems": 3, "type": "array" }, "c": { "description": "third vector", "title": "array of 3 number elements schema", "minItems": 3, "items": { "type": "number" }, "schemaId": "core-primitive-array-of-3-numbers", "maxItems": 3, "type": "array" }, "b": { "description": "second vector", "title": "array of 3 number elements schema", "minItems": 3, "items": { "type": "number" }, "schemaId": "core-primitive-array-of-3-numbers", "maxItems": 3, "type": "array" } }, "title": "3 dimensional vector basis" } ], "properties": { "units": { "enum": [ "km", "m", "pm", "nm", "angstrom", "a.u.", "bohr", "fractional", "crystal", "cartesian", "alat" ] }, "alat": { "default": 1.0, "type": "number", "description": "lattice parameter for fractional coordinates" } }, "title": "lattice explicit unit" } } }, { "required": [ "type" ], "schemaId": "properties-directory-structural-lattice-lattice-bravais", "allOf": [ { "schemaId": "core-primitive-3d-lattice", "required": [ "a", "b", "c", "alpha", "beta", "gamma" ], "type": "object", "properties": { "a": { "type": "number", "description": "length of the first lattice vector" }, "c": { "type": "number", "description": "length of the third lattice vector" }, "b": { "type": "number", "description": "length of the second lattice vector" }, "beta": { "type": "number", "description": "angle between second and third lattice vector" }, "alpha": { "type": "number", "description": "angle between first and second lattice vector" }, "gamma": { "type": "number", "description": "angle between first and third lattice vector" } }, "title": "3 dimensional lattice schema" } ], "properties": { "units": { "type": "object", "properties": { "length": { "enum": [ "angstrom", "bohr" ], "type": "string" }, "angle": { "enum": [ "degree", "radian" ], "type": "string" } } }, "type": { "enum": [ "CUB", "BCC", "FCC", "TET", "MCL", "ORC", "ORCC", "ORCF", "ORCI", "HEX", "BCT", "TRI", "MCLC", "RHL" ], "type": "string", "description": "Bravais lattice type in short notation" } }, "title": "lattice implicit schema" } ], "description": "object defining the lattice cell size and shape", "title": "lattice schema", "schemaId": "properties-directory-structural-lattice", "type": "object", "properties": { "name": { "enum": [ "lattice" ] } } }, "external": { "items": { "description": "information about a database source", "title": "database source schema", "schemaId": "system-database-source", "required": [ "_id", "name" ], "type": "object", "properties": { "origin": { "type": "string", "description": "A flag that is true when material is initially imported from a third party * (as opposed to being independently designed from scratch)." }, "_id": { "type": "string", "description": "ID string for the materials uploaded from a third party source inside the third party source." }, "name": { "type": "string", "description": "Third party source name." } } }, "type": "array", "description": "information about external sources of this material" }, "unitCellFormula": { "type": "string", "description": "chemical formula based on the number of atoms of each element in the supercell" }, "formula": { "type": "string", "description": "reduced chemical formula" }, "isNonPeriodic": { "type": "boolean", "description": "Whether to work in the finite molecular picture (usually with atomic orbital basis)" } } } |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 | { "exabyteId": "RKiswuxHKkF3uvLyA", "hash": "4ac3fa057e3530628eb1295c77110eaa", "name": "Silicon FCC", "creator": { "_id": "HtxACY2wX4b2hS8Rv", "slug": "exadmin", "cls": "User" }, "scaledHash": "5bd4eb168e3530628eb1295d88221cbb", "derivedProperties": [ { "units": "angstrom^3", "name": "volume", "value": 131.1 }, { "units": "g/cm^3", "name": "density", "value": 2.33 }, { "tolerance": { "units": "angstrom", "value": 0.3 }, "name": "symmetry", "spaceGroupSymbol": "Fd-3m" }, { "value": 0.71, "name": "p-norm", "degree": 10 }, { "name": "elemental_ratio", "value": 0.71, "element": "Si" }, { "name": "inchi", "value": "" }, { "name": "inchi_key", "value": "" } ], "basis": { "units": "crystal", "elements": [ { "id": 1, "value": "Si" }, { "id": 2, "value": "Si" } ], "name": "basis", "coordinates": [ { "id": 1, "value": [ 0.0, 0.0, 0.0 ] }, { "id": 2, "value": [ 0.25, 0.25, 0.25 ] } ] }, "lattice": { "a": 5.0, "c": 5.0, "b": 5.0, "name": "lattice", "beta": 90.0, "alpha": 90.0, "type": "CUB", "gamma": 90.0 }, "isDefault": false, "updatedAt": "2016-04-04T17:58:42.867Z", "unitCellFormula": "Si2", "owner": { "_id": "HtxACY2wX4b2hS8Rv", "slug": "exabyte", "cls": "Account" }, "formula": "Si", "schemaVersion": "0.2.0", "_id": "LCthJ6E2QabYCZqf3", "slug": "silicon-fcc", "createdAt": "2016-04-03T05:25:37.430Z", "isNonPeriodic": false } |
Explanation of Keywords¶
Keyword | Short Description | Details |
---|---|---|
basis | Crystal basis with explicit identification per atom | The information about the atomic type and coordinates |
lattice | Crystal lattice in both Bravais and vector notations | Crystal lattice parameters - lattice constants and angles. Components of the corresponding lattice vectors are also included. |
derivedProperties | descriptive properties derived from lattice/basis (only one example shown above) | Additional properties of the crystal structure under investigation as explained in the section ensuing the present table. |
hash | Hash string calculated by the Bank Mapping Function | Structure-based hash string for the primitive standard representation of this material, calculated when checking this material against existing entries within the Materials Bank |
scaledHash | As above, but for the lattice axis scaled to 1.0 (i.e. to identify same structures under different uniform pressure) | This hash string is calculated by scaling all the dimensions of the primitive unit cell representation of the material by the a lattice constant |
isNonPeriodic | Boolean value used to describing whether a structure exists in a single unit or repeating units. | The isNonPeriodic Boolean value is assumed to be false by default, indicating that a material is periodic. The value of isNonPeriodic, determines which derivedProperties are calculated for a structure. For example: unit cell volume is calculated for periodic, but not non-periodic structures. Conversely, International Chemical Identifier (InChI)[^1] are calculated for non-periodic, but not periodic structures. |
Derived Properties¶
As seen above, we use the crystal lattice and basis JSON objects as the main identifying properties. Based upon them, we calculate the derivedProperties, that may include such information as:
- the unit cell volume,
- density,
- chemical formula,
- and a large number of other possibilities.
For every material imported/uploaded to our platform, we pre-calculate a set of such descriptors, and store them inside this "derivedProperties" section. This information can be further used during data analysis or the construction of statistical predictive models.
Links¶
[^1] Wikipedia: International Chemical Identifer (InChI) Website