fairgraph 0.13.0__py3-none-any.whl

fairgraph/openminds/core/products/dataset_version.py

@@ -0,0 +1,240 @@
+"""
+Structured information on data originating from human/animal studies or simulations (version level).
+"""
+
+# this file was auto-generated
+
+from openminds.properties import Property
+from openminds.v4.core import DatasetVersion as OMDatasetVersion
+from fairgraph import KGObject
+
+from urllib.request import urlretrieve
+from pathlib import Path
+from ....utility import accepted_terms_of_use
+from datetime import date
+from openminds import IRI
+
+
+class DatasetVersion(KGObject, OMDatasetVersion):
+    """
+    Structured information on data originating from human/animal studies or simulations (version level).
+    """
+
+    type_ = "https://openminds.om-i.org/types/DatasetVersion"
+    default_space = "dataset"
+    # forward properties are defined in the parent class (in openMINDS-Python)
+    reverse_properties = [
+        Property(
+            "comments",
+            "openminds.v4.core.Comment",
+            "about",
+            reverse="about",
+            multiple=True,
+            description="reverse of 'about'",
+        ),
+        Property(
+            "has_parts",
+            [
+                "openminds.v4.core.ProtocolExecution",
+                "openminds.v4.ephys.CellPatching",
+                "openminds.v4.ephys.ElectrodePlacement",
+                "openminds.v4.ephys.RecordingActivity",
+                "openminds.v4.specimen_prep.CranialWindowPreparation",
+                "openminds.v4.specimen_prep.TissueCulturePreparation",
+                "openminds.v4.specimen_prep.TissueSampleSlicing",
+                "openminds.v4.stimulation.StimulationActivity",
+            ],
+            "isPartOf",
+            reverse="is_part_of",
+            multiple=True,
+            description="reverse of 'is_part_of'",
+        ),
+        Property(
+            "is_input_to",
+            "openminds.v4.computation.DataCopy",
+            "input",
+            reverse="inputs",
+            multiple=True,
+            description="reverse of 'inputs'",
+        ),
+        Property(
+            "is_old_version_of",
+            "openminds.v4.core.DatasetVersion",
+            "isNewVersionOf",
+            reverse="is_new_version_of",
+            multiple=True,
+            description="reverse of 'is_new_version_of'",
+        ),
+        Property(
+            "is_part_of",
+            ["openminds.v4.core.Project", "openminds.v4.core.ResearchProductGroup"],
+            "hasPart",
+            reverse="has_parts",
+            multiple=True,
+            description="reverse of 'has_parts'",
+        ),
+        Property(
+            "is_version_of",
+            "openminds.v4.core.Dataset",
+            "hasVersion",
+            reverse="has_versions",
+            multiple=True,
+            description="reverse of 'has_versions'",
+        ),
+        Property(
+            "learning_resources",
+            "openminds.v4.publications.LearningResource",
+            "about",
+            reverse="about",
+            multiple=True,
+            description="reverse of 'about'",
+        ),
+        Property(
+            "publication",
+            "openminds.v4.publications.LivePaperVersion",
+            "about",
+            reverse="about",
+            multiple=True,
+            description="reverse of 'about'",
+        ),
+    ]
+    aliases = {"name": "full_name", "alias": "short_name"}
+    existence_query_properties = ("short_name", "version_identifier")
+
+    def __init__(
+        self,
+        name=None,
+        alias=None,
+        accessibility=None,
+        authors=None,
+        behavioral_protocols=None,
+        comments=None,
+        copyright=None,
+        custodians=None,
+        data_types=None,
+        description=None,
+        digital_identifier=None,
+        ethics_assessment=None,
+        experimental_approaches=None,
+        full_documentation=None,
+        full_name=None,
+        funding=None,
+        has_parts=None,
+        homepage=None,
+        how_to_cite=None,
+        input_data=None,
+        is_alternative_version_of=None,
+        is_input_to=None,
+        is_new_version_of=None,
+        is_old_version_of=None,
+        is_part_of=None,
+        is_version_of=None,
+        keywords=None,
+        learning_resources=None,
+        license=None,
+        other_contributions=None,
+        preparation_designs=None,
+        protocols=None,
+        publication=None,
+        related_publications=None,
+        release_date=None,
+        repository=None,
+        short_name=None,
+        studied_specimens=None,
+        study_targets=None,
+        support_channels=None,
+        techniques=None,
+        version_identifier=None,
+        version_innovation=None,
+        id=None,
+        data=None,
+        space=None,
+        release_status=None,
+    ):
+        return KGObject.__init__(
+            self,
+            id=id,
+            space=space,
+            release_status=release_status,
+            data=data,
+            name=name,
+            alias=alias,
+            accessibility=accessibility,
+            authors=authors,
+            behavioral_protocols=behavioral_protocols,
+            comments=comments,
+            copyright=copyright,
+            custodians=custodians,
+            data_types=data_types,
+            description=description,
+            digital_identifier=digital_identifier,
+            ethics_assessment=ethics_assessment,
+            experimental_approaches=experimental_approaches,
+            full_documentation=full_documentation,
+            full_name=full_name,
+            funding=funding,
+            has_parts=has_parts,
+            homepage=homepage,
+            how_to_cite=how_to_cite,
+            input_data=input_data,
+            is_alternative_version_of=is_alternative_version_of,
+            is_input_to=is_input_to,
+            is_new_version_of=is_new_version_of,
+            is_old_version_of=is_old_version_of,
+            is_part_of=is_part_of,
+            is_version_of=is_version_of,
+            keywords=keywords,
+            learning_resources=learning_resources,
+            license=license,
+            other_contributions=other_contributions,
+            preparation_designs=preparation_designs,
+            protocols=protocols,
+            publication=publication,
+            related_publications=related_publications,
+            release_date=release_date,
+            repository=repository,
+            short_name=short_name,
+            studied_specimens=studied_specimens,
+            study_targets=study_targets,
+            support_channels=support_channels,
+            techniques=techniques,
+            version_identifier=version_identifier,
+            version_innovation=version_innovation,
+        )
+
+    def download(self, local_path, client, accept_terms_of_use=False):
+        if accepted_terms_of_use(client, accept_terms_of_use=accept_terms_of_use):
+            repo = self.repository.resolve(client, release_status=self.release_status or None)
+            if repo.iri.value.startswith("https://object.cscs.ch/v1/AUTH") or repo.iri.value.startswith(
+                "https://data-proxy.ebrains.eu/api/v1/public"
+            ):
+                zip_archive_url = f"https://data.kg.ebrains.eu/zip?container={repo.iri.value}"
+            else:
+                raise NotImplementedError("Download not yet implemented for this repository type")
+            if local_path.endswith(".zip"):
+                local_filename = Path(local_path)
+            else:
+                local_filename = Path(local_path) / (zip_archive_url.split("/")[-1] + ".zip")
+            local_filename.parent.mkdir(parents=True, exist_ok=True)
+            local_filename, headers = urlretrieve(zip_archive_url, local_filename)
+            return local_filename, repo.iri.value
+
+    def _get_inherited_property(self, property_name, client, release_status="released"):
+        value = getattr(self, property_name)
+        if value:
+            return value
+        else:
+            parent = self.is_version_of.resolve(client, release_status=release_status)
+            return getattr(parent, property_name)
+
+    def get_full_name(self, client, release_status="released"):
+        return self._get_inherited_property("full_name", client, release_status)
+
+    def get_short_name(self, client, release_status="released"):
+        return self._get_inherited_property("short_name", client, release_status)
+
+    def get_description(self, client, release_status="released"):
+        return self._get_inherited_property("description", client, release_status)
+
+    def get_authors(self, client, release_status="released"):
+        return self._get_inherited_property("authors", client, release_status)

fairgraph/openminds/core/products/meta_data_model.py

@@ -0,0 +1,95 @@
+"""
+<description not available>
+"""
+
+# this file was auto-generated
+
+from openminds.properties import Property
+from openminds.v4.core import MetaDataModel as OMMetaDataModel
+from fairgraph import KGObject
+
+
+from openminds import IRI
+
+
+class MetaDataModel(KGObject, OMMetaDataModel):
+    """
+    <description not available>
+    """
+
+    type_ = "https://openminds.om-i.org/types/MetaDataModel"
+    default_space = "metadatamodel"
+    # forward properties are defined in the parent class (in openMINDS-Python)
+    reverse_properties = [
+        Property(
+            "comments",
+            "openminds.v4.core.Comment",
+            "about",
+            reverse="about",
+            multiple=True,
+            description="reverse of 'about'",
+        ),
+        Property(
+            "is_part_of",
+            ["openminds.v4.core.Project", "openminds.v4.core.ResearchProductGroup"],
+            "hasPart",
+            reverse="has_parts",
+            multiple=True,
+            description="reverse of 'has_parts'",
+        ),
+        Property(
+            "learning_resources",
+            "openminds.v4.publications.LearningResource",
+            "about",
+            reverse="about",
+            multiple=True,
+            description="reverse of 'about'",
+        ),
+    ]
+    aliases = {"name": "full_name", "versions": "has_versions", "alias": "short_name"}
+    existence_query_properties = ("short_name",)
+
+    def __init__(
+        self,
+        name=None,
+        alias=None,
+        comments=None,
+        custodians=None,
+        description=None,
+        developers=None,
+        digital_identifier=None,
+        full_name=None,
+        has_versions=None,
+        homepage=None,
+        how_to_cite=None,
+        is_part_of=None,
+        learning_resources=None,
+        short_name=None,
+        versions=None,
+        id=None,
+        data=None,
+        space=None,
+        release_status=None,
+    ):
+        return KGObject.__init__(
+            self,
+            id=id,
+            space=space,
+            release_status=release_status,
+            data=data,
+            name=name,
+            alias=alias,
+            comments=comments,
+            custodians=custodians,
+            description=description,
+            developers=developers,
+            digital_identifier=digital_identifier,
+            full_name=full_name,
+            has_versions=has_versions,
+            homepage=homepage,
+            how_to_cite=how_to_cite,
+            is_part_of=is_part_of,
+            learning_resources=learning_resources,
+            short_name=short_name,
+            versions=versions,
+        )

fairgraph/openminds/core/products/meta_data_model_version.py

@@ -0,0 +1,168 @@
+"""
+<description not available>
+"""
+
+# this file was auto-generated
+
+from openminds.properties import Property
+from openminds.v4.core import MetaDataModelVersion as OMMetaDataModelVersion
+from fairgraph import KGObject
+
+
+from datetime import date
+from openminds import IRI
+
+
+class MetaDataModelVersion(KGObject, OMMetaDataModelVersion):
+    """
+    <description not available>
+    """
+
+    type_ = "https://openminds.om-i.org/types/MetaDataModelVersion"
+    default_space = "metadatamodel"
+    # forward properties are defined in the parent class (in openMINDS-Python)
+    reverse_properties = [
+        Property(
+            "comments",
+            "openminds.v4.core.Comment",
+            "about",
+            reverse="about",
+            multiple=True,
+            description="reverse of 'about'",
+        ),
+        Property(
+            "is_old_version_of",
+            "openminds.v4.core.MetaDataModelVersion",
+            "isNewVersionOf",
+            reverse="is_new_version_of",
+            multiple=True,
+            description="reverse of 'is_new_version_of'",
+        ),
+        Property(
+            "is_part_of",
+            ["openminds.v4.core.Project", "openminds.v4.core.ResearchProductGroup"],
+            "hasPart",
+            reverse="has_parts",
+            multiple=True,
+            description="reverse of 'has_parts'",
+        ),
+        Property(
+            "is_version_of",
+            "openminds.v4.core.MetaDataModel",
+            "hasVersion",
+            reverse="has_versions",
+            multiple=True,
+            description="reverse of 'has_versions'",
+        ),
+        Property(
+            "learning_resources",
+            "openminds.v4.publications.LearningResource",
+            "about",
+            reverse="about",
+            multiple=True,
+            description="reverse of 'about'",
+        ),
+    ]
+    aliases = {"name": "full_name", "alias": "short_name"}
+    existence_query_properties = ("short_name", "version_identifier")
+
+    def __init__(
+        self,
+        name=None,
+        alias=None,
+        accessibility=None,
+        comments=None,
+        copyright=None,
+        custodians=None,
+        description=None,
+        developers=None,
+        digital_identifier=None,
+        full_documentation=None,
+        full_name=None,
+        funding=None,
+        homepage=None,
+        how_to_cite=None,
+        is_alternative_version_of=None,
+        is_new_version_of=None,
+        is_old_version_of=None,
+        is_part_of=None,
+        is_version_of=None,
+        keywords=None,
+        learning_resources=None,
+        license=None,
+        other_contributions=None,
+        related_publications=None,
+        release_date=None,
+        repository=None,
+        serialization_formats=None,
+        short_name=None,
+        specification_formats=None,
+        support_channels=None,
+        type=None,
+        version_identifier=None,
+        version_innovation=None,
+        id=None,
+        data=None,
+        space=None,
+        release_status=None,
+    ):
+        return KGObject.__init__(
+            self,
+            id=id,
+            space=space,
+            release_status=release_status,
+            data=data,
+            name=name,
+            alias=alias,
+            accessibility=accessibility,
+            comments=comments,
+            copyright=copyright,
+            custodians=custodians,
+            description=description,
+            developers=developers,
+            digital_identifier=digital_identifier,
+            full_documentation=full_documentation,
+            full_name=full_name,
+            funding=funding,
+            homepage=homepage,
+            how_to_cite=how_to_cite,
+            is_alternative_version_of=is_alternative_version_of,
+            is_new_version_of=is_new_version_of,
+            is_old_version_of=is_old_version_of,
+            is_part_of=is_part_of,
+            is_version_of=is_version_of,
+            keywords=keywords,
+            learning_resources=learning_resources,
+            license=license,
+            other_contributions=other_contributions,
+            related_publications=related_publications,
+            release_date=release_date,
+            repository=repository,
+            serialization_formats=serialization_formats,
+            short_name=short_name,
+            specification_formats=specification_formats,
+            support_channels=support_channels,
+            type=type,
+            version_identifier=version_identifier,
+            version_innovation=version_innovation,
+        )
+
+    def _get_inherited_property(self, property_name, client, release_status="released"):
+        value = getattr(self, property_name)
+        if value:
+            return value
+        else:
+            parent = self.is_version_of.resolve(client, release_status=release_status)
+            return getattr(parent, property_name)
+
+    def get_full_name(self, client, release_status="released"):
+        return self._get_inherited_property("full_name", client, release_status)
+
+    def get_short_name(self, client, release_status="released"):
+        return self._get_inherited_property("short_name", client, release_status)
+
+    def get_description(self, client, release_status="released"):
+        return self._get_inherited_property("description", client, release_status)
+
+    def get_developers(self, client, release_status="released"):
+        return self._get_inherited_property("developers", client, release_status)

fairgraph/openminds/core/products/model.py

@@ -0,0 +1,103 @@
+"""
+Structured information on a computational model (concept level).
+"""
+
+# this file was auto-generated
+
+from openminds.properties import Property
+from openminds.v4.core import Model as OMModel
+from fairgraph import KGObject
+
+
+from openminds import IRI
+
+
+class Model(KGObject, OMModel):
+    """
+    Structured information on a computational model (concept level).
+    """
+
+    type_ = "https://openminds.om-i.org/types/Model"
+    default_space = "model"
+    # forward properties are defined in the parent class (in openMINDS-Python)
+    reverse_properties = [
+        Property(
+            "comments",
+            "openminds.v4.core.Comment",
+            "about",
+            reverse="about",
+            multiple=True,
+            description="reverse of 'about'",
+        ),
+        Property(
+            "is_part_of",
+            ["openminds.v4.core.Project", "openminds.v4.core.ResearchProductGroup"],
+            "hasPart",
+            reverse="has_parts",
+            multiple=True,
+            description="reverse of 'has_parts'",
+        ),
+        Property(
+            "learning_resources",
+            "openminds.v4.publications.LearningResource",
+            "about",
+            reverse="about",
+            multiple=True,
+            description="reverse of 'about'",
+        ),
+    ]
+    aliases = {"name": "full_name", "versions": "has_versions", "model_scope": "scope", "alias": "short_name"}
+    existence_query_properties = ("full_name",)
+
+    def __init__(
+        self,
+        name=None,
+        alias=None,
+        abstraction_level=None,
+        comments=None,
+        custodians=None,
+        description=None,
+        developers=None,
+        digital_identifier=None,
+        full_name=None,
+        has_versions=None,
+        homepage=None,
+        how_to_cite=None,
+        is_part_of=None,
+        learning_resources=None,
+        model_scope=None,
+        scope=None,
+        short_name=None,
+        study_targets=None,
+        versions=None,
+        id=None,
+        data=None,
+        space=None,
+        release_status=None,
+    ):
+        return KGObject.__init__(
+            self,
+            id=id,
+            space=space,
+            release_status=release_status,
+            data=data,
+            name=name,
+            alias=alias,
+            abstraction_level=abstraction_level,
+            comments=comments,
+            custodians=custodians,
+            description=description,
+            developers=developers,
+            digital_identifier=digital_identifier,
+            full_name=full_name,
+            has_versions=has_versions,
+            homepage=homepage,
+            how_to_cite=how_to_cite,
+            is_part_of=is_part_of,
+            learning_resources=learning_resources,
+            model_scope=model_scope,
+            scope=scope,
+            short_name=short_name,
+            study_targets=study_targets,
+            versions=versions,
+        )