Specification of metadata sections

Each section in the amorphys metadata file(s) must have a certain specific format.

section

class section

Each section of amorphys has different properties of its own. But it can have an optional property, description to describe itself.

description

a human-readable string description of the section. It is recommended to include this property for every section, for increased understandability.

project

class project

The project section of amorphys is a subclass of section, and describes the organization of the project group.

A typical project would look like below:

in: “project.json”

{
    "$schema":      "https://raw.githubusercontent.com/gwappa/amorphys/master/schema/sections/project.json",

    "description": "the project organization for foraging experiment",

    "dataset": {
        "name": "HumanForagingBehavior_PostdocRoom",
        ...
    },

    "people": {
        "Keisuke": {
            "name": "Keisuke S.K. Sehara",
            ...
        },
        "Julien": {
            "name": "Julien Colomb",
            ...
        },
        ...
    },

    "affiliations": {
        "ChaosSoftware": {
            "name": "Chaos Software",
            ...
        },
        ...
    },

    "fundings": {
        "DFG": {
            "name": "Deutliche Forschungsgesellschaft",
            ...
        },
        ...
    },

    "data_published_by": [
        { "$ref": "../people/Keisuke" },
        { "$ref": "../people/Julien" }
    ]
}

It consists of several fields:

description

a recommended field that is equivalent to that in section.

dataset

a dataset object representing the metadata for this dataset itself.

people

a mapping to contributor instances representing the people involved in this project.

affiliations

a mapping to institution instances representing the affiliations of the people involved.

funded_by

a mapping to funding instances representing the funding sources for this project.

data_published_by

an array of references to an item or more in people, representing the people contributed to publish this dataset.