Making a project description

TODO

  • add tutorial for the “project” section
  • make a nice object diagram for “organization” section

Organization of “project” section

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" }
    ]
}

In addition to the $schema and the description attributes, it consists of:

“dataset” subsection

The “dataset” subsection is a dataset object:

example “dataset” subsection
{
    "name":        "HumanForagingBehavior_PostdocRoom",
    "description": "Tracking data of human subjects performing a foraging task inside a post-doc room",
    "keywords":    ["foraging behavior", "human", "scientists"],
    "license":     {
        "name":    "CC0",
        "uri":     "http://creativecommons.org/publicdomain/zero/1.0",
        "year":    "2019",
        "authors": { "$ref": "/people" }
    },
    "references": [
        {
            "reference_type": "is-supplement-to",
            "name": "Sehara K, Colomb J, Larkum ME (2019) Dendritic mechanisms underlying foraging behavior of human subjects.",
            "uri": "doi:10.1101/000000"
        }
    ]
}

“people” subsection

The “people” subsection is a mapping from a name to a contributor, each looking like below:

example “people” subsection
{
    "Keisuke": {
        "name":       "Keisuke S.K. Sehara",
        "lastname":   "Sehara",
        "firstnames": "Keisuke S.K.",
        "uri":        "ORCID:0000-0000-0000-0000",
        "contact":    "kkkkkeeeeiiiissssuuuukkkkeeee@mail.chaos-software.cc",
        "affiliation": [
            { "$ref": "/affiliations/ChaosSoftware" }
        ],
        "roles": [
            "data-curation",
            "software"
        ]
    },
    ...
}

Note that “affiliation” points to the affiliations section described below.

“affiliations” subsection

The “affiliation” subsection is a mapping from a name to a institution, each looking like below:

example “affiliations” subsection
{
    "ChaosSoftware": {
        "name": "Chaos Software",
        "uri":  "https://www.chaos-software.cc"
    },
    ...
}

“fundings” subsection

The “fundings” subsection is a mapping from a name to a funding, each looking like below:

example “funded_by” subsection
{
    "DFG1": {
        "from": "Deutliche Forschungsgesellschaft",
        "to": [ { "$ref": "people/Keisuke" } ],
        "id": "000000000000"
    },
    ...
}

“data_published_by” subsection

The “data_published_by” subsection is an array of references to contributor instances defined in the “people” subsection.

example “data_published_by” subsection
[
    { "$ref": "../people/Keisuke" },
    { "$ref": "../people/Julien" }
]