fairgraph 0.13.0__py3-none-any.whl

fairgraph/openminds/core/products/web_service.py

@@ -0,0 +1,103 @@
+"""
+<description not available>
+"""
+
+# this file was auto-generated
+
+from openminds.properties import Property
+from openminds.v4.core import WebService as OMWebService
+from fairgraph import KGObject
+
+
+from openminds import IRI
+
+
+class WebService(KGObject, OMWebService):
+    """
+    <description not available>
+    """
+
+    type_ = "https://openminds.om-i.org/types/WebService"
+    default_space = "webservice"
+    # 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_accounts",
+            "openminds.v4.core.AccountInformation",
+            "service",
+            reverse="service",
+            multiple=True,
+            description="reverse of 'service'",
+        ),
+        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,
+        full_name=None,
+        has_accounts=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,
+            full_name=full_name,
+            has_accounts=has_accounts,
+            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/web_service_version.py

@@ -0,0 +1,182 @@
+"""
+<description not available>
+"""
+
+# this file was auto-generated
+
+from openminds.properties import Property
+from openminds.v4.core import WebServiceVersion as OMWebServiceVersion
+from fairgraph import KGObject
+
+
+from datetime import date
+from openminds import IRI
+
+
+class WebServiceVersion(KGObject, OMWebServiceVersion):
+    """
+    <description not available>
+    """
+
+    type_ = "https://openminds.om-i.org/types/WebServiceVersion"
+    default_space = "webservice"
+    # 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.WebServiceVersion",
+            "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.WebService",
+            "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(
+            "used_for",
+            [
+                "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",
+            ],
+            "environment",
+            reverse="environment",
+            multiple=True,
+            description="reverse of 'environment'",
+        ),
+    ]
+    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,
+        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_new_version_of=None,
+        is_old_version_of=None,
+        is_part_of=None,
+        is_version_of=None,
+        keywords=None,
+        learning_resources=None,
+        other_contributions=None,
+        output_formats=None,
+        related_publications=None,
+        release_date=None,
+        repository=None,
+        short_name=None,
+        support_channels=None,
+        used_for=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,
+            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_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,
+            other_contributions=other_contributions,
+            output_formats=output_formats,
+            related_publications=related_publications,
+            release_date=release_date,
+            repository=repository,
+            short_name=short_name,
+            support_channels=support_channels,
+            used_for=used_for,
+            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/research/__init__.py

@@ -0,0 +1,17 @@
+from .behavioral_protocol import BehavioralProtocol
+from .configuration import Configuration
+from .custom_property_set import CustomPropertySet
+from .numerical_property import NumericalProperty
+from .property_value_list import PropertyValueList
+from .protocol import Protocol
+from .protocol_execution import ProtocolExecution
+from .strain import Strain
+from .string_property import StringProperty
+from .subject import Subject
+from .subject_group import SubjectGroup
+from .subject_group_state import SubjectGroupState
+from .subject_state import SubjectState
+from .tissue_sample import TissueSample
+from .tissue_sample_collection import TissueSampleCollection
+from .tissue_sample_collection_state import TissueSampleCollectionState
+from .tissue_sample_state import TissueSampleState

fairgraph/openminds/core/research/behavioral_protocol.py

@@ -0,0 +1,69 @@
+"""
+Structured information about a protocol used in an experiment studying human or animal behavior.
+"""
+
+# this file was auto-generated
+
+from openminds.properties import Property
+from openminds.v4.core import BehavioralProtocol as OMBehavioralProtocol
+from fairgraph import KGObject
+
+
+class BehavioralProtocol(KGObject, OMBehavioralProtocol):
+    """
+    Structured information about a protocol used in an experiment studying human or animal behavior.
+    """
+
+    type_ = "https://openminds.om-i.org/types/BehavioralProtocol"
+    default_space = "dataset"
+    # forward properties are defined in the parent class (in openMINDS-Python)
+    reverse_properties = [
+        Property(
+            "is_used_to_group",
+            "openminds.v4.core.FileBundle",
+            "groupedBy",
+            reverse="grouped_by",
+            multiple=True,
+            description="reverse of 'grouped_by'",
+        ),
+        Property(
+            "used_in",
+            ["openminds.v4.core.DatasetVersion", "openminds.v4.core.ProtocolExecution"],
+            "behavioralProtocol",
+            reverse="behavioral_protocols",
+            multiple=True,
+            description="reverse of 'behavioral_protocols'",
+        ),
+    ]
+    existence_query_properties = ("description", "name")
+
+    def __init__(
+        self,
+        name=None,
+        described_in=None,
+        description=None,
+        internal_identifier=None,
+        is_used_to_group=None,
+        stimulations=None,
+        stimulus_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,
+            described_in=described_in,
+            description=description,
+            internal_identifier=internal_identifier,
+            is_used_to_group=is_used_to_group,
+            stimulations=stimulations,
+            stimulus_types=stimulus_types,
+            used_in=used_in,
+        )

fairgraph/openminds/core/research/configuration.py

@@ -0,0 +1,67 @@
+"""
+Structured information about the properties or parameters of an entity or process.
+"""
+
+# this file was auto-generated
+
+from openminds.properties import Property
+from openminds.v4.core import Configuration as OMConfiguration
+from fairgraph import KGObject
+
+
+class Configuration(KGObject, OMConfiguration):
+    """
+    Structured information about the properties or parameters of an entity or process.
+    """
+
+    type_ = "https://openminds.om-i.org/types/Configuration"
+    default_space = "common"
+    # forward properties are defined in the parent class (in openMINDS-Python)
+    reverse_properties = [
+        Property(
+            "is_configuration_of",
+            [
+                "openminds.v4.computation.Environment",
+                "openminds.v4.computation.ValidationTestVersion",
+                "openminds.v4.computation.WorkflowExecution",
+            ],
+            "configuration",
+            reverse="configuration",
+            multiple=True,
+            description="reverse of 'configuration'",
+        ),
+        Property(
+            "specifies",
+            "openminds.v4.stimulation.EphysStimulus",
+            "specification",
+            reverse="specifications",
+            multiple=True,
+            description="reverse of 'specifications'",
+        ),
+    ]
+    existence_query_properties = ("configuration",)
+
+    def __init__(
+        self,
+        lookup_label=None,
+        configuration=None,
+        format=None,
+        is_configuration_of=None,
+        specifies=None,
+        id=None,
+        data=None,
+        space=None,
+        release_status=None,
+    ):
+        return KGObject.__init__(
+            self,
+            id=id,
+            space=space,
+            release_status=release_status,
+            data=data,
+            lookup_label=lookup_label,
+            configuration=configuration,
+            format=format,
+            is_configuration_of=is_configuration_of,
+            specifies=specifies,
+        )

fairgraph/openminds/core/research/custom_property_set.py

@@ -0,0 +1,27 @@
+"""
+Structured information about properties of an entity that are not represented in an openMINDS schema.
+"""
+
+# this file was auto-generated
+
+from openminds.properties import Property
+from openminds.v4.core import CustomPropertySet as OMCustomPropertySet
+from fairgraph import EmbeddedMetadata
+
+
+class CustomPropertySet(EmbeddedMetadata, OMCustomPropertySet):
+    """
+    Structured information about properties of an entity that are not represented in an openMINDS schema.
+    """
+
+    type_ = "https://openminds.om-i.org/types/CustomPropertySet"
+    # forward properties are defined in the parent class (in openMINDS-Python)
+    reverse_properties = []
+    existence_query_properties = ("context", "data_location", "relevant_for")
+
+    def __init__(
+        self, context=None, data_location=None, relevant_for=None, id=None, data=None, space=None, release_status=None
+    ):
+        return EmbeddedMetadata.__init__(
+            self, data=data, context=context, data_location=data_location, relevant_for=relevant_for
+        )

fairgraph/openminds/core/research/numerical_property.py

@@ -0,0 +1,23 @@
+"""
+Structured information about a property of some entity or process whose value is a number.
+"""
+
+# this file was auto-generated
+
+from openminds.properties import Property
+from openminds.v4.core import NumericalProperty as OMNumericalProperty
+from fairgraph import EmbeddedMetadata
+
+
+class NumericalProperty(EmbeddedMetadata, OMNumericalProperty):
+    """
+    Structured information about a property of some entity or process whose value is a number.
+    """
+
+    type_ = "https://openminds.om-i.org/types/NumericalProperty"
+    # forward properties are defined in the parent class (in openMINDS-Python)
+    reverse_properties = []
+    existence_query_properties = ("name", "values")
+
+    def __init__(self, name=None, values=None, id=None, data=None, space=None, release_status=None):
+        return EmbeddedMetadata.__init__(self, data=data, name=name, values=values)

fairgraph/openminds/core/research/property_value_list.py

@@ -0,0 +1,71 @@
+"""
+An identifiable list of property-value pairs.
+"""
+
+# this file was auto-generated
+
+from openminds.properties import Property
+from openminds.v4.core import PropertyValueList as OMPropertyValueList
+from fairgraph import KGObject
+
+
+class PropertyValueList(KGObject, OMPropertyValueList):
+    """
+    An identifiable list of property-value pairs.
+    """
+
+    type_ = "https://openminds.om-i.org/types/PropertyValueList"
+    default_space = "dataset"
+    # forward properties are defined in the parent class (in openMINDS-Python)
+    reverse_properties = [
+        Property(
+            "defines_environment_of",
+            "openminds.v4.computation.LaunchConfiguration",
+            "environmentVariable",
+            reverse="environment_variable",
+            multiple=True,
+            description="reverse of 'environment_variable'",
+        ),
+        Property(
+            "is_configuration_of",
+            "openminds.v4.computation.ValidationTestVersion",
+            "configuration",
+            reverse="configuration",
+            multiple=True,
+            description="reverse of 'configuration'",
+        ),
+        Property(
+            "specifies",
+            ["openminds.v4.sands.CustomAnnotation", "openminds.v4.stimulation.EphysStimulus"],
+            "specification",
+            reverse="specification",
+            multiple=True,
+            description="reverse of 'specification'",
+        ),
+    ]
+    existence_query_properties = ("lookup_label",)
+
+    def __init__(
+        self,
+        lookup_label=None,
+        defines_environment_of=None,
+        is_configuration_of=None,
+        property_value_pairs=None,
+        specifies=None,
+        id=None,
+        data=None,
+        space=None,
+        release_status=None,
+    ):
+        return KGObject.__init__(
+            self,
+            id=id,
+            space=space,
+            release_status=release_status,
+            data=data,
+            lookup_label=lookup_label,
+            defines_environment_of=defines_environment_of,
+            is_configuration_of=is_configuration_of,
+            property_value_pairs=property_value_pairs,
+            specifies=specifies,
+        )

fairgraph/openminds/core/research/protocol.py

@@ -0,0 +1,67 @@
+"""
+Structured information on a research project.
+"""
+
+# this file was auto-generated
+
+from openminds.properties import Property
+from openminds.v4.core import Protocol as OMProtocol
+from fairgraph import KGObject
+
+
+class Protocol(KGObject, OMProtocol):
+    """
+    Structured information on a research project.
+    """
+
+    type_ = "https://openminds.om-i.org/types/Protocol"
+    default_space = "dataset"
+    # forward properties are defined in the parent class (in openMINDS-Python)
+    reverse_properties = [
+        Property(
+            "used_in",
+            [
+                "openminds.v4.core.DatasetVersion",
+                "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",
+            ],
+            "protocol",
+            reverse="protocols",
+            multiple=True,
+            description="reverse of 'protocols'",
+        ),
+    ]
+    existence_query_properties = ("name",)
+
+    def __init__(
+        self,
+        name=None,
+        described_in=None,
+        description=None,
+        stimulus_types=None,
+        techniques=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,
+            described_in=described_in,
+            description=description,
+            stimulus_types=stimulus_types,
+            techniques=techniques,
+            used_in=used_in,
+        )