metadata

adh.msosa.metadata

Shared node metadata, provenance, and fidelity models.

Classes:

• Author –

  Author or contributor to an ADH node.

• ExternalReference –

  Reference to an external file or document.

• FidelityLevel –

  L0-L4 fidelity taxonomy for ADH domain blocks.

• NodeMetaMixin –

  Shared top-level metadata for ADH node-like models.

• SourceInfo –

  Source and authorship metadata for an ADH node.

Author pydantic-model

Bases: BaseModel

Author or contributor to an ADH node.

Show JSON schema:

{
  "description": "Author or contributor to an ADH node.",
  "properties": {
    "name": {
      "description": "Full name of the author.",
      "title": "Name",
      "type": "string"
    },
    "organisation": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Organisation or affiliation.",
      "title": "Organisation"
    },
    "email": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Email address.",
      "title": "Email"
    }
  },
  "required": [
    "name"
  ],
  "title": "Author",
  "type": "object"
}

Fields:

• name (str)
• organisation (Optional[str])
• email (Optional[str])

email pydantic-field

email: Optional[str] = None

Email address.

name pydantic-field

name: str

Full name of the author.

organisation pydantic-field

organisation: Optional[str] = None

Organisation or affiliation.

ExternalReference pydantic-model

Bases: BaseModel

Reference to an external file or document.

Show JSON schema:

{
  "description": "Reference to an external file or document.",
  "properties": {
    "title": {
      "description": "Title or name of the referenced resource.",
      "title": "Title",
      "type": "string"
    },
    "path": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "File path or URI to the external resource.",
      "title": "Path"
    },
    "description": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Description of the reference and its relevance.",
      "title": "Description"
    },
    "classification": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Type classification of the reference (e.g. 'STEP file', 'CFD mesh', 'test report').",
      "title": "Classification"
    }
  },
  "required": [
    "title"
  ],
  "title": "ExternalReference",
  "type": "object"
}

Fields:

• title (str)
• path (Optional[str])
• description (Optional[str])
• classification (Optional[str])

classification pydantic-field

classification: Optional[str] = None

Type classification of the reference (e.g. 'STEP file', 'CFD mesh', 'test report').

description pydantic-field

description: Optional[str] = None

Description of the reference and its relevance.

path pydantic-field

path: Optional[str] = None

File path or URI to the external resource.

title pydantic-field

title: str

Title or name of the referenced resource.

FidelityLevel

Bases: str, Enum

L0-L4 fidelity taxonomy for ADH domain blocks.

Returned by:

• API Reference adh msosa
  •  msosa
    •  Behavior  fidelity_level
    •  Discipline  fidelity_level
  • behavior  behavior  Behavior  fidelity_level
  • performance  performance  Discipline  fidelity_level

NodeMetaMixin pydantic-model

Bases: BaseModel

Shared top-level metadata for ADH node-like models.

Show JSON schema:

{
  "$defs": {
    "Author": {
      "description": "Author or contributor to an ADH node.",
      "properties": {
        "name": {
          "description": "Full name of the author.",
          "title": "Name",
          "type": "string"
        },
        "organisation": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Organisation or affiliation.",
          "title": "Organisation"
        },
        "email": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Email address.",
          "title": "Email"
        }
      },
      "required": [
        "name"
      ],
      "title": "Author",
      "type": "object"
    },
    "ExternalReference": {
      "description": "Reference to an external file or document.",
      "properties": {
        "title": {
          "description": "Title or name of the referenced resource.",
          "title": "Title",
          "type": "string"
        },
        "path": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "File path or URI to the external resource.",
          "title": "Path"
        },
        "description": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Description of the reference and its relevance.",
          "title": "Description"
        },
        "classification": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Type classification of the reference (e.g. 'STEP file', 'CFD mesh', 'test report').",
          "title": "Classification"
        }
      },
      "required": [
        "title"
      ],
      "title": "ExternalReference",
      "type": "object"
    },
    "SourceInfo": {
      "description": "Source and authorship metadata for an ADH node.",
      "properties": {
        "authors": {
          "anyOf": [
            {
              "items": {
                "$ref": "#/$defs/Author"
              },
              "type": "array"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Authors or contributors.",
          "title": "Authors"
        },
        "creation_date": {
          "anyOf": [
            {
              "format": "date",
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Date this node was created.",
          "title": "Creation Date"
        },
        "modification_date": {
          "anyOf": [
            {
              "format": "date",
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Date this node was last modified.",
          "title": "Modification Date"
        },
        "version": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Version string.",
          "title": "Version"
        },
        "references": {
          "anyOf": [
            {
              "items": {
                "$ref": "#/$defs/ExternalReference"
              },
              "type": "array"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "References to external files or documents.",
          "title": "References"
        }
      },
      "title": "SourceInfo",
      "type": "object"
    }
  },
  "additionalProperties": true,
  "description": "Shared top-level metadata for ADH node-like models.",
  "properties": {
    "name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "A unique model name.",
      "title": "Name"
    },
    "description": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "A brief description of the model.",
      "title": "Description"
    },
    "source_info": {
      "anyOf": [
        {
          "$ref": "#/$defs/SourceInfo"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Source and authorship metadata."
    },
    "uuid": {
      "anyOf": [
        {
          "format": "uuid4",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "A globally unique identifier for the model.",
      "title": "Uuid"
    }
  },
  "title": "NodeMetaMixin",
  "type": "object"
}

Fields:

• name (Optional[str])
• description (Optional[str])
• source_info (Optional[SourceInfo])
• uuid (Optional[UUID4])

description pydantic-field

description: Optional[str] = None

A brief description of the model.

name pydantic-field

name: Optional[str] = None

A unique model name.

source_info pydantic-field

source_info: Optional[SourceInfo] = None

Source and authorship metadata.

uuid pydantic-field

uuid: Optional[UUID4] = None

A globally unique identifier for the model.

SourceInfo pydantic-model

Bases: BaseModel

Source and authorship metadata for an ADH node.

Show JSON schema:

{
  "$defs": {
    "Author": {
      "description": "Author or contributor to an ADH node.",
      "properties": {
        "name": {
          "description": "Full name of the author.",
          "title": "Name",
          "type": "string"
        },
        "organisation": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Organisation or affiliation.",
          "title": "Organisation"
        },
        "email": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Email address.",
          "title": "Email"
        }
      },
      "required": [
        "name"
      ],
      "title": "Author",
      "type": "object"
    },
    "ExternalReference": {
      "description": "Reference to an external file or document.",
      "properties": {
        "title": {
          "description": "Title or name of the referenced resource.",
          "title": "Title",
          "type": "string"
        },
        "path": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "File path or URI to the external resource.",
          "title": "Path"
        },
        "description": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Description of the reference and its relevance.",
          "title": "Description"
        },
        "classification": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Type classification of the reference (e.g. 'STEP file', 'CFD mesh', 'test report').",
          "title": "Classification"
        }
      },
      "required": [
        "title"
      ],
      "title": "ExternalReference",
      "type": "object"
    }
  },
  "description": "Source and authorship metadata for an ADH node.",
  "properties": {
    "authors": {
      "anyOf": [
        {
          "items": {
            "$ref": "#/$defs/Author"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Authors or contributors.",
      "title": "Authors"
    },
    "creation_date": {
      "anyOf": [
        {
          "format": "date",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Date this node was created.",
      "title": "Creation Date"
    },
    "modification_date": {
      "anyOf": [
        {
          "format": "date",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Date this node was last modified.",
      "title": "Modification Date"
    },
    "version": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Version string.",
      "title": "Version"
    },
    "references": {
      "anyOf": [
        {
          "items": {
            "$ref": "#/$defs/ExternalReference"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "References to external files or documents.",
      "title": "References"
    }
  },
  "title": "SourceInfo",
  "type": "object"
}

Fields:

• authors (Optional[list[Author]])
• creation_date (Optional[date])
• modification_date (Optional[date])
• version (Optional[str])
• references (Optional[list[ExternalReference]])

authors pydantic-field

authors: Optional[list[Author]] = None

Authors or contributors.

creation_date pydantic-field

creation_date: Optional[date] = None

Date this node was created.

modification_date pydantic-field

modification_date: Optional[date] = None

Date this node was last modified.

references pydantic-field

references: Optional[list[ExternalReference]] = None

References to external files or documents.

version pydantic-field

version: Optional[str] = None

Version string.