Skip to content

Structured Representation of Methods

In order to organize and store the information about Methods on our platform, we employ the Exabyte Data Convention, as explained elsewhere in the documentation.

Below, the user can find an example JSON structured representation of a Method.

{
    "$id": "method",
    "$schema": "http://json-schema.org/draft-07/schema#",
    "title": "base method",
    "type": "object",
    "properties": {
        "type": {
            "description": "general type of this method, eg. `pseudopotential`",
            "type": "string"
        },
        "subtype": {
            "description": "general subtype of this method, eg. `ultra-soft`",
            "type": "string"
        },
        "precision": {
            "description": "Object showing the actual possible precision based on theory and implementation",
            "type": "object"
        },
        "data": {
            "description": "additional data specific to method, eg. array of pseudopotentials",
            "type": "object"
        }
    },
    "required": [
        "type",
        "subtype"
    ]
}

{
    "data": {
        "pseudo": []
    },
    "subtype": "us",
    "type": "pseudopotential"
}