docs/dsms_sdk/tutorials/1_introduction.ipynb

{
 "cells": [
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "# 1. Connecting with the SDK to DSMS\n",
    "\n",
    "In this tutorial we see the overview on how to setup and basic use DSMS-SDK\n"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "### 1.1. Setting up\n",
    "Before you run this tutorial: make sure to have access to a DSMS-instance of your interest, alongwith with installation of this package and have establised access to the DSMS through DSMS-SDK (refer to [Connecting to DSMS](../dsms_sdk.md#connecting-to-dsms))\n",
    "\n",
    "Now let us import the needed classes and functions for this tutorial."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 1,
   "metadata": {},
   "outputs": [],
   "source": [
    "from dsms import DSMS"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "Now source the environmental variables from an `.env` file and start the DSMS-session."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 2,
   "metadata": {},
   "outputs": [],
   "source": [
    "dsms = DSMS(env=\".env\")"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "### 1.2. Introduction to KItems"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "We can see which kitems we own as a user (in the beginning, we own none):"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 5,
   "metadata": {},
   "outputs": [
    {
     "data": {
      "text/plain": [
       "kitems: []\n",
       "total_count: 0"
      ]
     },
     "execution_count": 5,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "dsms.get_kitems(limit=100)"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "We can investigate what a KItem needs in order to be created. KItems are entirely based on Pydantic-Models (v2), hence the properties (in Pydantic called Fields) are automatically validated once we set them.\n",
    "\n",
    "The schema of the KItem itself is a JSON schema which is machine-readable and can be directly incorporated into Swagger-supported APIs like e.g. FastAPI.\n",
    "\n",
    "We can investigate the KTypes defined in the remote instance:"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 6,
   "metadata": {},
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "ktype:\n",
      "  id: organization\n",
      "  name: null\n",
      "  context: false\n",
      "  context_schema: []\n",
      "  webform: null\n",
      "  json_schema: null\n",
      "  created_at: '2024-12-09T15:48:24.918527'\n",
      "  updated_at: '2024-12-09T15:48:24.918527'\n",
      "\n",
      "ktype:\n",
      "  id: expert\n",
      "  name: null\n",
      "  context: false\n",
      "  context_schema: []\n",
      "  webform: null\n",
      "  json_schema: null\n",
      "  created_at: '2024-12-09T15:48:24.918527'\n",
      "  updated_at: '2024-12-09T15:48:24.918527'\n",
      "\n",
      "ktype:\n",
      "  id: app\n",
      "  name: null\n",
      "  context: false\n",
      "  context_schema: []\n",
      "  webform: null\n",
      "  json_schema: null\n",
      "  created_at: '2024-12-09T15:48:24.918527'\n",
      "  updated_at: '2024-12-09T15:48:24.918527'\n",
      "\n",
      "ktype:\n",
      "  id: dataset\n",
      "  name: dataset\n",
      "  context: false\n",
      "  context_schema: []\n",
      "  webform: null\n",
      "  json_schema: null\n",
      "  created_at: '2024-12-09T15:48:24.918527'\n",
      "  updated_at: '2024-12-09T15:48:24.918527'\n",
      "\n",
      "ktype:\n",
      "  id: dataset-catalog\n",
      "  name: dataset catalog\n",
      "  context: false\n",
      "  context_schema: []\n",
      "  webform: null\n",
      "  json_schema: null\n",
      "  created_at: '2024-12-09T15:48:24.918527'\n",
      "  updated_at: '2024-12-09T15:48:24.918527'\n",
      "\n",
      "ktype:\n",
      "  id: material\n",
      "  name: Material\n",
      "  context: false\n",
      "  context_schema: []\n",
      "  webform:\n",
      "    semantics_enabled: true\n",
      "    sections_enabled: true\n",
      "    class_mapping:\n",
      "    - https://w3id.org/emmo#EMMO_4207e895_8b83_4318_996a_72cfb32acd94\n",
      "    sections:\n",
      "    - id: id37bef167f3118\n",
      "      name: Material spec\n",
      "      inputs:\n",
      "      - id: idd4eca7fb62c54\n",
      "        label: Material type\n",
      "        widget: Select\n",
      "        required: false\n",
      "        value: null\n",
      "        hint: null\n",
      "        hidden: false\n",
      "        ignore: false\n",
      "        select_options:\n",
      "        - key: option1\n",
      "          label: Crystal\n",
      "          disabled: false\n",
      "        - key: option2\n",
      "          label: Liquid\n",
      "          disabled: false\n",
      "        - key: option3\n",
      "          label: Gas\n",
      "          disabled: false\n",
      "        measurement_unit: null\n",
      "        relation_mapping:\n",
      "          iri: https://w3id.org/steel/ProcessOntology/hasMaterialClass_Object\n",
      "          type: object_property\n",
      "          class_iri: https://w3id.org/emmo#EMMO_39348191_08fd_4bb6_9b1e_012d5b2f1ff6\n",
      "        relation_mapping_extra: null\n",
      "        multiple_selection: false\n",
      "        knowledge_type: null\n",
      "        range_options: null\n",
      "        placeholder: null\n",
      "      - id: id0ff68b6b11bf4\n",
      "        label: Supplier\n",
      "        widget: Multi-select\n",
      "        required: false\n",
      "        value: null\n",
      "        hint: null\n",
      "        hidden: false\n",
      "        ignore: false\n",
      "        select_options:\n",
      "        - key: option1\n",
      "          label: Company 1\n",
      "          disabled: false\n",
      "        - key: option2\n",
      "          label: Company 2\n",
      "          disabled: false\n",
      "        measurement_unit: null\n",
      "        relation_mapping:\n",
      "          iri: https://w3id.org/steel/ProcessOntology/hasSupplier_Object\n",
      "          type: object_property\n",
      "          class_iri: https://w3id.org/steel/ProcessOntology/Supplier\n",
      "        relation_mapping_extra: null\n",
      "        multiple_selection: false\n",
      "        knowledge_type: null\n",
      "        range_options: null\n",
      "        placeholder: null\n",
      "      - id: id8cc24aecb9282\n",
      "        label: Product form\n",
      "        widget: Radio\n",
      "        required: false\n",
      "        value: Sheet\n",
      "        hint: null\n",
      "        hidden: false\n",
      "        ignore: false\n",
      "        select_options:\n",
      "        - key: option1\n",
      "          label: Sheet\n",
      "          disabled: false\n",
      "        - key: option2\n",
      "          label: Block\n",
      "          disabled: false\n",
      "        measurement_unit: null\n",
      "        relation_mapping:\n",
      "          iri: https://w3id.org/emmo#EMMO_17e27c22_37e1_468c_9dd7_95e137f73e7f\n",
      "          type: object_property\n",
      "          class_iri: https://w3id.org/emmo#EMMO_dd4b7d81_28a9_4801_8831_4cbab217e362\n",
      "        relation_mapping_extra: null\n",
      "        multiple_selection: false\n",
      "        knowledge_type: null\n",
      "        range_options: null\n",
      "        placeholder: null\n",
      "      hidden: false\n",
      "  json_schema:\n",
      "    iri:\n",
      "    - https://w3id.org/emmo#EMMO_4207e895_8b83_4318_996a_72cfb32acd94\n",
      "    suffix: slug\n",
      "    source: material[*]\n",
      "    suffix_from_location: true\n",
      "    custom_relations:\n",
      "    - object_location: material-type\n",
      "      relation: https://w3id.org/steel/ProcessOntology/hasMaterialClass_Object\n",
      "      relation_type: object_property\n",
      "      object_type:\n",
      "        iri: https://w3id.org/emmo#EMMO_39348191_08fd_4bb6_9b1e_012d5b2f1ff6\n",
      "    - object_location: supplier\n",
      "      relation: https://w3id.org/steel/ProcessOntology/hasSupplier_Object\n",
      "      relation_type: object_property\n",
      "      object_type:\n",
      "        iri: https://w3id.org/steel/ProcessOntology/Supplier\n",
      "    - object_location: product-form\n",
      "      relation: https://w3id.org/emmo#EMMO_17e27c22_37e1_468c_9dd7_95e137f73e7f\n",
      "      relation_type: object_property\n",
      "      object_type:\n",
      "        iri: https://w3id.org/emmo#EMMO_dd4b7d81_28a9_4801_8831_4cbab217e362\n",
      "    - object_location: Name\n",
      "      relation: http://www.w3.org/2000/01/rdf-schema#label\n",
      "      relation_type: annotation_property\n",
      "      object_data_type: string\n",
      "  created_at: '2024-12-09T23:14:18.843010'\n",
      "  updated_at: '2025-01-17T09:57:57.584798'\n",
      "\n",
      "ktype:\n",
      "  id: testingmachine\n",
      "  name: Testing machine\n",
      "  context: false\n",
      "  context_schema: []\n",
      "  webform:\n",
      "    semantics_enabled: true\n",
      "    sections_enabled: false\n",
      "    class_mapping:\n",
      "    - https://w3id.org/pmd/co/Specimen\n",
      "    sections:\n",
      "    - id: id18d888a9c9fa48\n",
      "      name: Untitled Section\n",
      "      inputs:\n",
      "      - id: ida450e96a27a6e8\n",
      "        label: Machine\n",
      "        widget: Knowledge item\n",
      "        required: false\n",
      "        value: null\n",
      "        hint: null\n",
      "        hidden: false\n",
      "        ignore: false\n",
      "        select_options: []\n",
      "        measurement_unit: null\n",
      "        relation_mapping:\n",
      "          iri: https://w3id.org/steel/ProcessOntology/hasMachine_Object\n",
      "          type: object_property\n",
      "          class_iri: https://w3id.org/steel/ProcessOntology/Machine\n",
      "        relation_mapping_extra: null\n",
      "        multiple_selection: false\n",
      "        knowledge_type: testingmachine\n",
      "        range_options: null\n",
      "        placeholder: null\n",
      "      - id: idba8e853b2fdbe\n",
      "        label: Specimen\n",
      "        widget: Knowledge item\n",
      "        required: false\n",
      "        value: null\n",
      "        hint: null\n",
      "        hidden: false\n",
      "        ignore: false\n",
      "        select_options: []\n",
      "        measurement_unit: null\n",
      "        relation_mapping:\n",
      "          iri: https://w3id.org/steel/ProcessOntology/hasTestPiece_Object\n",
      "          type: object_property\n",
      "          class_iri: https://w3id.org/pmd/co/Specimen\n",
      "        relation_mapping_extra: null\n",
      "        multiple_selection: true\n",
      "        knowledge_type: specimen\n",
      "        range_options: null\n",
      "        placeholder: null\n",
      "      hidden: false\n",
      "  json_schema:\n",
      "    iri:\n",
      "    - https://w3id.org/pmd/co/Specimen\n",
      "    suffix: slug\n",
      "    source: testingmachine[*]\n",
      "    suffix_from_location: true\n",
      "    custom_relations:\n",
      "    - object_location: machine\n",
      "      relation: https://w3id.org/steel/ProcessOntology/hasMachine_Object\n",
      "      relation_type: object_property\n",
      "      object_type: anyURI\n",
      "    - object_location: specimen\n",
      "      relation: https://w3id.org/steel/ProcessOntology/hasTestPiece_Object\n",
      "      relation_type: object_property\n",
      "      object_type: anyURI\n",
      "    - object_location: Name\n",
      "      relation: http://www.w3.org/2000/01/rdf-schema#label\n",
      "      relation_type: annotation_property\n",
      "      object_data_type: string\n",
      "  created_at: '2024-12-12T17:56:45.095403'\n",
      "  updated_at: '2025-01-16T15:19:06.989779'\n",
      "\n",
      "ktype:\n",
      "  id: specimen\n",
      "  name: Specimen\n",
      "  context: false\n",
      "  context_schema: []\n",
      "  webform:\n",
      "    semantics_enabled: true\n",
      "    sections_enabled: false\n",
      "    class_mapping:\n",
      "    - https://w3id.org/pmd/co/Specimen\n",
      "    sections:\n",
      "    - id: ida3c5c42685526\n",
      "      name: Untitled Section\n",
      "      inputs:\n",
      "      - id: id175f885f8dda58\n",
      "        label: Width\n",
      "        widget: Slider\n",
      "        required: false\n",
      "        value: null\n",
      "        hint: null\n",
      "        hidden: false\n",
      "        ignore: false\n",
      "        select_options: []\n",
      "        measurement_unit:\n",
      "          label: Millimetre\n",
      "          iri: http://qudt.org/vocab/unit/MilliM\n",
      "          symbol: null\n",
      "          namespace: http://qudt.org/vocab/unit\n",
      "        relation_mapping:\n",
      "          iri: https://w3id.org/steel/ProcessOntology/hasWidth_Object\n",
      "          type: object_property\n",
      "          class_iri: https://w3id.org/emmo#EMMO_e4de48b1_dabb_4490_ac2b_040f926c64f0\n",
      "        relation_mapping_extra: null\n",
      "        multiple_selection: false\n",
      "        knowledge_type: null\n",
      "        range_options:\n",
      "          min: 0\n",
      "          max: 1\n",
      "          step: 0.1\n",
      "          range: false\n",
      "        placeholder: null\n",
      "      - id: idef5a37328789f\n",
      "        label: Length\n",
      "        widget: Slider\n",
      "        required: false\n",
      "        value: null\n",
      "        hint: null\n",
      "        hidden: false\n",
      "        ignore: false\n",
      "        select_options: []\n",
      "        measurement_unit:\n",
      "          label: Millimetre\n",
      "          iri: http://qudt.org/vocab/unit/MilliM\n",
      "          symbol: null\n",
      "          namespace: http://qudt.org/vocab/unit\n",
      "        relation_mapping:\n",
      "          iri: https://w3id.org/steel/ProcessOntology/hasTotalLength_Object\n",
      "          type: object_property\n",
      "          class_iri: https://w3id.org/steel/ProcessOntology/TotalLength\n",
      "        relation_mapping_extra:\n",
      "          iri: https://w3id.org/steel/ProcessOntology/hasTotalLength_Object\n",
      "          type: object_property\n",
      "          class_iri: https://w3id.org/steel/ProcessOntology/TotalLength\n",
      "        multiple_selection: false\n",
      "        knowledge_type: null\n",
      "        range_options:\n",
      "          min: 0\n",
      "          max: 1\n",
      "          step: 0.1\n",
      "          range: true\n",
      "        placeholder: null\n",
      "      - id: id54decb9641f9a\n",
      "        label: Radius\n",
      "        widget: Number\n",
      "        required: false\n",
      "        value: null\n",
      "        hint: null\n",
      "        hidden: false\n",
      "        ignore: false\n",
      "        select_options: []\n",
      "        measurement_unit:\n",
      "          label: Millimetre\n",
      "          iri: http://qudt.org/vocab/unit/MilliM\n",
      "          symbol: null\n",
      "          namespace: http://qudt.org/vocab/unit\n",
      "        relation_mapping:\n",
      "          iri: https://w3id.org/steel/ProcessOntology/hasRadius_Object\n",
      "          type: object_property\n",
      "          class_iri: https://w3id.org/emmo#EMMO_32dcd601_47c7_4028_b7fa_5e972ae57f12\n",
      "        relation_mapping_extra: null\n",
      "        multiple_selection: false\n",
      "        knowledge_type: null\n",
      "        range_options:\n",
      "          min: 0\n",
      "          max: 1\n",
      "          step: 0.1\n",
      "          range: false\n",
      "        placeholder: null\n",
      "      hidden: false\n",
      "  json_schema:\n",
      "    iri:\n",
      "    - https://w3id.org/pmd/co/Specimen\n",
      "    suffix: slug\n",
      "    source: specimen[*]\n",
      "    suffix_from_location: true\n",
      "    custom_relations:\n",
      "    - object_location: width\n",
      "      relation: https://w3id.org/steel/ProcessOntology/hasWidth_Object\n",
      "      relation_type: object_property\n",
      "      object_type:\n",
      "        iri: https://w3id.org/emmo#EMMO_e4de48b1_dabb_4490_ac2b_040f926c64f0\n",
      "        unit: http://qudt.org/vocab/unit/MilliM\n",
      "    - object_location: length[0]\n",
      "      relation: https://w3id.org/steel/ProcessOntology/hasTotalLength_Object\n",
      "      relation_type: object_property\n",
      "      object_type:\n",
      "        iri: https://w3id.org/steel/ProcessOntology/TotalLength\n",
      "        unit: http://qudt.org/vocab/unit/MilliM\n",
      "        suffix: min\n",
      "    - object_location: length[1]\n",
      "      relation: https://w3id.org/steel/ProcessOntology/hasTotalLength_Object\n",
      "      relation_type: object_property\n",
      "      object_type:\n",
      "        suffix: max\n",
      "        iri: https://w3id.org/steel/ProcessOntology/TotalLength\n",
      "        unit: http://qudt.org/vocab/unit/MilliM\n",
      "    - object_location: radius\n",
      "      relation: https://w3id.org/steel/ProcessOntology/hasRadius_Object\n",
      "      relation_type: object_property\n",
      "      object_type:\n",
      "        iri: https://w3id.org/emmo#EMMO_32dcd601_47c7_4028_b7fa_5e972ae57f12\n",
      "        unit: http://qudt.org/vocab/unit/MilliM\n",
      "    - object_location: Name\n",
      "      relation: http://www.w3.org/2000/01/rdf-schema#label\n",
      "      relation_type: annotation_property\n",
      "      object_data_type: string\n",
      "  created_at: '2024-12-17T11:00:34.924035'\n",
      "  updated_at: '2025-01-16T18:25:33.054442'\n",
      "\n"
     ]
    }
   ],
   "source": [
    "for ktype in dsms.ktypes:\n",
    "    print(ktype)"
   ]
  }
 ],
 "metadata": {
  "kernelspec": {
   "display_name": "Python 3",
   "language": "python",
   "name": "python3"
  },
  "language_info": {
   "codemirror_mode": {
    "name": "ipython",
    "version": 3
   },
   "file_extension": ".py",
   "mimetype": "text/x-python",
   "name": "python",
   "nbconvert_exporter": "python",
   "pygments_lexer": "ipython3",
   "version": "3.10.15"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 2
}