Source code for fairgraph.openminds.core.products.model_version

"""
Structured information on a computational model (version level).
"""

# this file was auto-generated

from datetime import date, datetime
from fairgraph.base_v3 import KGObjectV3, IRI
from fairgraph.fields import Field




[docs]class ModelVersion(KGObjectV3): """ Structured information on a computational model (version level). """ default_space = "model" type = ["https://openminds.ebrains.eu/core/ModelVersion"] context = { "schema": "http://schema.org/", "kg": "https://kg.ebrains.eu/api/instances/", "vocab": "https://openminds.ebrains.eu/vocab/", "terms": "https://openminds.ebrains.eu/controlledTerms/", "core": "https://openminds.ebrains.eu/core/" } fields = [ Field("developers", ["openminds.core.Organization", "openminds.core.Person"], "vocab:developer", multiple=True, required=False, doc="Legal person that creates or improves products or services (e.g., software, applications, etc.)."), Field("digital_identifier", ["openminds.core.DOI", "openminds.core.SWHID"], "vocab:digitalIdentifier", multiple=False, required=False, doc="Digital handle to identify objects or legal persons."), Field("format", "openminds.core.ContentType", "vocab:format", multiple=True, required=True, doc="Method of digitally organizing and structuring data or information."), Field("input_data", ["openminds.core.DOI", "openminds.core.File", "openminds.core.FileBundle"], "vocab:inputData", multiple=True, required=False, doc="Data that is put into a process or machine."), Field("is_alternative_version_of", "openminds.core.ModelVersion", "vocab:isAlternativeVersionOf", multiple=True, required=False, doc="Reference to an original form where the essence was preserved, but presented in an alternative form."), Field("is_new_version_of", "openminds.core.ModelVersion", "vocab:isNewVersionOf", multiple=False, required=False, doc="Reference to a previous (potentially outdated) particular form of something."), Field("licenses", "openminds.core.License", "vocab:license", multiple=True, required=True, doc="Grant by a party to another party as an element of an agreement between those parties that permits to do, use, or own something."), Field("output_data", ["openminds.core.DOI", "openminds.core.File", "openminds.core.FileBundle"], "vocab:outputData", multiple=True, required=False, doc="Data that comes out of, is delivered or produced by a process or machine."), Field("accessibility", "openminds.controlledterms.ProductAccessibility", "vocab:accessibility", multiple=False, required=True, doc="Level to which something is accessible to the model version."), Field("copyright", "openminds.core.Copyright", "vocab:copyright", multiple=False, required=False, doc="Exclusive and assignable legal right of an originator to reproduce, publish, sell, or distribute the matter and form of a creative work for a defined time period."), Field("custodians", ["openminds.core.Organization", "openminds.core.Person"], "vocab:custodian", multiple=True, required=False, doc="Legal person entrusted with guarding and maintaining property or records."), Field("description", str, "vocab:description", multiple=False, required=False, doc="Longer statement or account giving the characteristics of the model version."), Field("full_documentation", ["openminds.core.DOI", "openminds.core.File", "openminds.core.URL"], "vocab:fullDocumentation", multiple=False, required=True, doc="Non-abridged instructions, comments, and information for using a particular product."), Field("name", str, "vocab:fullName", multiple=False, required=True, doc="Whole, non-abbreviated name of the model version."), Field("funding", "openminds.core.Funding", "vocab:funding", multiple=True, required=False, doc="Money provided by a legal person for a particular purpose."), Field("homepage", "openminds.core.URL", "vocab:homepage", multiple=False, required=False, doc="Main website of the model version."), Field("how_to_cite", str, "vocab:howToCite", multiple=False, required=False, doc="Preferred format for citing a particular object or legal person."), Field("keywords", ["openminds.controlledterms.BiologicalOrder", "openminds.controlledterms.BiologicalSex", "openminds.controlledterms.CellType", "openminds.controlledterms.Disease", "openminds.controlledterms.DiseaseModel", "openminds.controlledterms.Handedness", "openminds.controlledterms.Organ", "openminds.controlledterms.Phenotype", "openminds.controlledterms.Species", "openminds.controlledterms.Strain", "openminds.controlledterms.TermSuggestion", "openminds.controlledterms.UBERONParcellation", "openminds.sands.CustomAnatomicalEntity", "openminds.sands.ParcellationEntity", "openminds.sands.ParcellationEntityVersion"], "vocab:keyword", multiple=True, required=False, doc="Significant word or concept that are representative of the model version."), Field("other_contributions", "openminds.core.Contribution", "vocab:otherContribution", multiple=True, required=False, doc="Giving or supplying of something (such as money or time) as a part or share other than what is covered elsewhere."), Field("related_publications", ["openminds.core.DOI", "openminds.core.ISBN"], "vocab:relatedPublication", multiple=True, required=False, doc="Reference to something that was made available for the general public to see or buy."), Field("release_date", date, "vocab:releaseDate", multiple=False, required=True, doc="Fixed date on which a product is due to become or was made available for the general public to see or buy"), Field("repository", "openminds.core.FileRepository", "vocab:repository", multiple=False, required=False, doc="Place, room, or container where something is deposited or stored."), Field("alias", str, "vocab:shortName", multiple=False, required=True, doc="Shortened or fully abbreviated name of the model version."), Field("support_channels", str, "vocab:supportChannel", multiple=True, required=False, doc="Way of communication used to interact with users or customers."), Field("version_identifier", str, "vocab:versionIdentifier", multiple=False, required=True, doc="Term or code used to identify the version of something."), Field("version_innovation", str, "vocab:versionInnovation", multiple=False, required=True, doc="Documentation on what changed in comparison to a previously published form of something."), ] existence_query_fields = ('name', 'version_identifier')