This is the repository of Materials Data Facility schemas (in JSONSchema format) and MDF Connect auxillary data (in JSON format).
Schemas and organization data can be accessed in a more human-friendly way via MDF Forge.
To install Forge with pip:
pip install mdf-forge
To fetch the details of a schema (the dataset schema, in this example):
from mdf_forge import Forge
mdf = Forge()
mdf.describe_field("dataset")To fetch the details of an organization (Center for Hierarchical Materials Design (CHiMaD) in this example):
from mdf_forge import Forge
mdf = Forge()
mdf.describe_organization("CHiMaD")More details on the .describe_field() and .describe_organization() methods can be found in the Forge documentation, which includes examples.
Usually, it is not necessary to read these files directly.
If you want to read the raw JSONSchemas, all of them are in the schemas directory. The primary schemas for MDF are dataset, record, and connect_submission, which link to the other schemas using $ref. The dataset and record schemas cover both types of metadata entry in MDF Search, while the connect_submission schema covers the JSON payload expected by the MDF Connect service (the Connect schema is built automatically with the web form or the MDF Connect Client).
If you want to read the raw auxillary data, the files are in connect_aux_data. The primary file is organizations.json, which contains information on the organizations registered with MDF Connect.
This work was performed under financial assistance award 70NANB14H012 from U.S. Department of Commerce, National Institute of Standards and Technology as part of the Center for Hierarchical Material Design (CHiMaD). This work was performed under the following financial assistance award 70NANB19H005 from U.S. Department of Commerce, National Institute of Standards and Technology as part of the Center for Hierarchical Materials Design (CHiMaD).