fairgraph 0.13.0__py3-none-any.whl

fairgraph/openminds/core/products/model_version.py

@@ -0,0 +1,235 @@
+"""
+Structured information on a computational model (version level).
+"""
+
+# this file was auto-generated
+
+from openminds.properties import Property
+from openminds.v4.core import ModelVersion as OMModelVersion
+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 ModelVersion(KGObject, OMModelVersion):
+    """
+    Structured information on a computational model (version level).
+    """
+
+    type_ = "https://openminds.om-i.org/types/ModelVersion"
+    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_input_to",
+            [
+                "openminds.v4.computation.DataCopy",
+                "openminds.v4.computation.ModelValidation",
+                "openminds.v4.computation.Simulation",
+            ],
+            "input",
+            reverse="inputs",
+            multiple=True,
+            description="reverse of 'inputs'",
+        ),
+        Property(
+            "is_location_of",
+            "openminds.v4.core.ServiceLink",
+            "dataLocation",
+            reverse="data_location",
+            multiple=True,
+            description="reverse of 'data_location'",
+        ),
+        Property(
+            "is_old_version_of",
+            "openminds.v4.core.ModelVersion",
+            "isNewVersionOf",
+            reverse="is_new_version_of",
+            multiple=True,
+            description="reverse of 'is_new_version_of'",
+        ),
+        Property(
+            "is_output_of",
+            "openminds.v4.computation.Optimization",
+            "output",
+            reverse="outputs",
+            multiple=True,
+            description="reverse of 'outputs'",
+        ),
+        Property(
+            "is_part_of",
+            [
+                "openminds.v4.core.Project",
+                "openminds.v4.core.ResearchProductGroup",
+                "openminds.v4.core.SoftwareVersion",
+            ],
+            "hasPart",
+            reverse="has_parts",
+            multiple=True,
+            description="reverse of 'has_parts'",
+        ),
+        Property(
+            "is_version_of",
+            "openminds.v4.core.Model",
+            "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 = ("full_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,
+        formats=None,
+        full_documentation=None,
+        full_name=None,
+        funding=None,
+        homepage=None,
+        how_to_cite=None,
+        input_data=None,
+        is_alternative_version_of=None,
+        is_input_to=None,
+        is_location_of=None,
+        is_new_version_of=None,
+        is_old_version_of=None,
+        is_output_of=None,
+        is_part_of=None,
+        is_version_of=None,
+        keywords=None,
+        learning_resources=None,
+        licenses=None,
+        other_contributions=None,
+        output_data=None,
+        publication=None,
+        related_publications=None,
+        release_date=None,
+        repository=None,
+        short_name=None,
+        support_channels=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,
+            formats=formats,
+            full_documentation=full_documentation,
+            full_name=full_name,
+            funding=funding,
+            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_location_of=is_location_of,
+            is_new_version_of=is_new_version_of,
+            is_old_version_of=is_old_version_of,
+            is_output_of=is_output_of,
+            is_part_of=is_part_of,
+            is_version_of=is_version_of,
+            keywords=keywords,
+            learning_resources=learning_resources,
+            licenses=licenses,
+            other_contributions=other_contributions,
+            output_data=output_data,
+            publication=publication,
+            related_publications=related_publications,
+            release_date=release_date,
+            repository=repository,
+            short_name=short_name,
+            support_channels=support_channels,
+            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_developers(self, client, release_status="released"):
+        return self._get_inherited_property("developers", client, release_status)

fairgraph/openminds/core/products/project.py

@@ -0,0 +1,56 @@
+"""
+Structured information on a research project.
+"""
+
+# this file was auto-generated
+
+from openminds.properties import Property
+from openminds.v4.core import Project as OMProject
+from fairgraph import KGObject
+
+
+from openminds import IRI
+
+
+class Project(KGObject, OMProject):
+    """
+    Structured information on a research project.
+    """
+
+    type_ = "https://openminds.om-i.org/types/Project"
+    default_space = "common"
+    # forward properties are defined in the parent class (in openMINDS-Python)
+    reverse_properties = []
+    aliases = {"name": "full_name", "alias": "short_name"}
+    existence_query_properties = ("short_name",)
+
+    def __init__(
+        self,
+        name=None,
+        alias=None,
+        coordinators=None,
+        description=None,
+        full_name=None,
+        has_parts=None,
+        homepage=None,
+        short_name=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,
+            coordinators=coordinators,
+            description=description,
+            full_name=full_name,
+            has_parts=has_parts,
+            homepage=homepage,
+            short_name=short_name,
+        )

fairgraph/openminds/core/products/setup.py

@@ -0,0 +1,69 @@
+"""
+<description not available>
+"""
+
+# this file was auto-generated
+
+from openminds.properties import Property
+from openminds.v4.core import Setup as OMSetup
+from fairgraph import KGObject
+
+
+class Setup(KGObject, OMSetup):
+    """
+    <description not available>
+    """
+
+    type_ = "https://openminds.om-i.org/types/Setup"
+    default_space = "dataset"
+    # forward properties are defined in the parent class (in openMINDS-Python)
+    reverse_properties = [
+        Property(
+            "is_part_of",
+            "openminds.v4.core.Setup",
+            "hasPart",
+            reverse="has_parts",
+            multiple=True,
+            description="reverse of 'has_parts'",
+        ),
+        Property(
+            "used_in",
+            "openminds.v4.stimulation.StimulationActivity",
+            "setup",
+            reverse="setup",
+            multiple=True,
+            description="reverse of 'setup'",
+        ),
+    ]
+    existence_query_properties = ("description", "has_parts", "name")
+
+    def __init__(
+        self,
+        name=None,
+        description=None,
+        has_parts=None,
+        is_part_of=None,
+        location=None,
+        manufacturers=None,
+        types=None,
+        used_in=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,
+            description=description,
+            has_parts=has_parts,
+            is_part_of=is_part_of,
+            location=location,
+            manufacturers=manufacturers,
+            types=types,
+            used_in=used_in,
+        )

fairgraph/openminds/core/products/software.py

@@ -0,0 +1,95 @@
+"""
+Structured information on a software tool (concept level).
+"""
+
+# this file was auto-generated
+
+from openminds.properties import Property
+from openminds.v4.core import Software as OMSoftware
+from fairgraph import KGObject
+
+
+from openminds import IRI
+
+
+class Software(KGObject, OMSoftware):
+    """
+    Structured information on a software tool (concept level).
+    """
+
+    type_ = "https://openminds.om-i.org/types/Software"
+    default_space = "software"
+    # 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/software_version.py

@@ -0,0 +1,226 @@
+"""
+<description not available>
+"""
+
+# this file was auto-generated
+
+from openminds.properties import Property
+from openminds.v4.core import SoftwareVersion as OMSoftwareVersion
+from fairgraph import KGObject
+
+
+from datetime import date
+from openminds import IRI
+
+
+class SoftwareVersion(KGObject, OMSoftwareVersion):
+    """
+    <description not available>
+    """
+
+    type_ = "https://openminds.om-i.org/types/SoftwareVersion"
+    default_space = "software"
+    # 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_input_to",
+            [
+                "openminds.v4.computation.DataAnalysis",
+                "openminds.v4.computation.DataCopy",
+                "openminds.v4.computation.GenericComputation",
+                "openminds.v4.computation.ModelValidation",
+                "openminds.v4.computation.Optimization",
+                "openminds.v4.computation.Simulation",
+                "openminds.v4.computation.Visualization",
+            ],
+            "input",
+            reverse="inputs",
+            multiple=True,
+            description="reverse of 'inputs'",
+        ),
+        Property(
+            "is_old_version_of",
+            "openminds.v4.core.SoftwareVersion",
+            "isNewVersionOf",
+            reverse="is_new_version_of",
+            multiple=True,
+            description="reverse of 'is_new_version_of'",
+        ),
+        Property(
+            "is_part_of",
+            [
+                "openminds.v4.computation.WorkflowRecipeVersion",
+                "openminds.v4.core.Project",
+                "openminds.v4.core.ResearchProductGroup",
+                "openminds.v4.core.Setup",
+                "openminds.v4.core.WebServiceVersion",
+            ],
+            "hasPart",
+            reverse="has_parts",
+            multiple=True,
+            description="reverse of 'has_parts'",
+        ),
+        Property(
+            "is_version_of",
+            "openminds.v4.core.Software",
+            "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'",
+        ),
+        Property(
+            "used_in",
+            ["openminds.v4.computation.Environment", "openminds.v4.computation.SoftwareAgent"],
+            "software",
+            reverse="software",
+            multiple=True,
+            description="reverse of 'software'",
+        ),
+    ]
+    aliases = {"name": "full_name", "alias": "short_name"}
+    existence_query_properties = ("short_name", "version_identifier")
+
+    def __init__(
+        self,
+        name=None,
+        alias=None,
+        accessibility=None,
+        application_categories=None,
+        comments=None,
+        copyright=None,
+        custodians=None,
+        description=None,
+        developers=None,
+        devices=None,
+        digital_identifier=None,
+        features=None,
+        full_documentation=None,
+        full_name=None,
+        funding=None,
+        has_parts=None,
+        homepage=None,
+        how_to_cite=None,
+        input_formats=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,
+        languages=None,
+        learning_resources=None,
+        licenses=None,
+        operating_systems=None,
+        other_contributions=None,
+        output_formats=None,
+        programming_languages=None,
+        publication=None,
+        related_publications=None,
+        release_date=None,
+        repository=None,
+        requirements=None,
+        short_name=None,
+        support_channels=None,
+        used_in=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,
+            application_categories=application_categories,
+            comments=comments,
+            copyright=copyright,
+            custodians=custodians,
+            description=description,
+            developers=developers,
+            devices=devices,
+            digital_identifier=digital_identifier,
+            features=features,
+            full_documentation=full_documentation,
+            full_name=full_name,
+            funding=funding,
+            has_parts=has_parts,
+            homepage=homepage,
+            how_to_cite=how_to_cite,
+            input_formats=input_formats,
+            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,
+            languages=languages,
+            learning_resources=learning_resources,
+            licenses=licenses,
+            operating_systems=operating_systems,
+            other_contributions=other_contributions,
+            output_formats=output_formats,
+            programming_languages=programming_languages,
+            publication=publication,
+            related_publications=related_publications,
+            release_date=release_date,
+            repository=repository,
+            requirements=requirements,
+            short_name=short_name,
+            support_channels=support_channels,
+            used_in=used_in,
+            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)