docs/examples/dlite.ipynb

{
 "cells": [
  {
   "attachments": {},
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "# Use DLite strategies from OTEAPI-OPTIMADE\n",
    "\n",
    "This example shows how to use the DLite strategies from the OTEAPI-OPTIMADE plugin.\n",
    "\n",
    "[DLite](https://github.com/SINTEF/dlite) is a Python library for working with data models and semantics.\n",
    "It is considered to be the default semantic data model backend for use with OTEAPI.\n",
    "\n",
    "To see more fundamental examples of how to use OTEAPI-OPTIMADE, see the example [_Use OTEAPI-OPTIMADE with OTElib_](/oteapi-optimade/examples/otelib/).\n",
    "OTElib will also be used as a client in the current example.\n",
    "Furthermore, only the HTTP requests-based backend will be used in this example.\n",
    "\n",
    "## Setup\n",
    "\n",
    "Please see the [setup instructions in _Use OTEAPI-OPTIMADE with OTElib_](/oteapi-optimade/examples/otelib/#setup) for how to ensure you have a proper environment to run the example in.\n",
    "\n",
    "## Example\n",
    "\n",
    "In this example, we will use the DLite strategies to query the [Materials Project](https://www.materialsproject.org/) OPTIMADE API.\n",
    "We are interested in finding all structures that include the elements `Si` and `O`, and that have a maximum of 4 elements in total.\n",
    "\n",
    "### Create a client\n",
    "\n",
    "Let's start by initializing a client:"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 37,
   "metadata": {},
   "outputs": [],
   "source": [
    "from otelib import OTEClient\n",
    "\n",
    "client = OTEClient(\"python\")"
   ]
  },
  {
   "attachments": {},
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "### Data Resource strategy\n",
    "\n",
    "The general pipeline is the same as it was for [_Use OTEAPI-OPTIMADE with OTElib_](otelib##search-through-materials-project-for-all-structures-with-the-formula-al2o3):\n",
    "\n",
    "<!-- The mkdocs-jupyter plugin creates a folder 'dlite' wherein it puts the generated HTML\n",
    "Therefore, we need to go up one more folder level to reference the image.\n",
    "One could use an \"absolute\" link, however, in production, mike will append the version to the path,\n",
    "which this link could not dynamically include. -->\n",
    "![Pipeline example 1](../../img/chem_formula_pipeline.png)\n",
    "\n",
    "However, in order to use DLite we need to _either_ reference a specific `accessService` **or** set a flag in the configuration of the data resource strategy.\n",
    "\n",
    "Note, it is _only_ for the data resource strategy we need to specify the usage of DLite, as the filter strategy is generic and merely a helper for more explicitly setting the query parameters to be used for the underlying OPTIMADE query."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 38,
   "metadata": {},
   "outputs": [],
   "source": [
    "data_resource_strategy = client.create_dataresource(\n",
    "    accessService=\"OPTIMADE+DLite\",\n",
    "    accessUrl=\"https://optimade.materialsproject.org\",\n",
    ")\n",
    "\n",
    "# This is equivalent to:\n",
    "# data_resource_strategy = client.create_dataresource(\n",
    "#     accessService=\"OPTIMADE\",\n",
    "#     accessUrl=\"https://optimade.materialsproject.org\",\n",
    "#     configuration={\"use_dlite\": True},\n",
    "# )"
   ]
  },
  {
   "attachments": {},
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "### Filter strategy\n",
    "\n",
    "The OPTIMADE filter query to fulfill [the interests outlined above](#example) should look like this:\n",
    "\n",
    "```\n",
    "elements HAS ALL \"Si\",\"O\" AND nelements<=4\n",
    "```"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 39,
   "metadata": {},
   "outputs": [],
   "source": [
    "filter_strategy = client.create_filter(\n",
    "    filterType=\"OPTIMADE\",\n",
    "    query='elements HAS ALL \"Si\",\"O\" AND nelements<=4',\n",
    ")"
   ]
  },
  {
   "attachments": {},
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "#### Setup, execute and inspect the pipeline"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 40,
   "metadata": {},
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "Setting filter from query.\n",
      "Setting filter from query.\n",
      "Setting filter from query.\n",
      "resource_config: OPTIMADEResourceConfig(user=None, password=None, token=None, client_id=None, client_secret=None, configuration=OPTIMADEConfig(version='v1', endpoint='structures', query_parameters=OPTIMADEQueryParameters(filter='elements HAS ALL \"Si\",\"O\" AND nelements<=4', response_format='json', email_address='', response_fields='', sort='', page_limit=20, page_offset=0, page_number=None, page_cursor=0, page_above=None, page_below=None, include='references', api_hint=''), datacache_config=DataCacheConfig(cacheDir=PosixPath('oteapi'), accessKey=None, hashType='md5', expireTime=86400, tag='optimade'), return_object=False, use_dlite=False), description='Resource Strategy Data Configuration.\\n\\n    Important:\\n        Either of the pairs of attributes `downloadUrl`/`mediaType` or\\n        `accessUrl`/`accessService` MUST be specified.\\n\\n    ', downloadUrl=None, mediaType=None, accessUrl=OPTIMADEUrl('https://optimade.materialsproject.org', base_url='https://optimade.materialsproject.org', scheme='https', tld='org', host_type='domain'), accessService='OPTIMADE+DLite', license=None, accessRights=None, publisher=None)\n",
      "resource_config: OPTIMADEResourceConfig(user=None, password=None, token=None, client_id=None, client_secret=None, configuration=OPTIMADEConfig(version='v1', endpoint='structures', query_parameters=OPTIMADEQueryParameters(filter='elements HAS ALL \"Si\",\"O\" AND nelements<=4', response_format='json', email_address='', response_fields='', sort='', page_limit=20, page_offset=0, page_number=None, page_cursor=0, page_above=None, page_below=None, include='references', api_hint=''), datacache_config=DataCacheConfig(cacheDir=PosixPath('oteapi'), accessKey=None, hashType='md5', expireTime=86400, tag='optimade'), return_object=False, use_dlite=False), description='Resource Strategy Data Configuration.\\n\\n    Important:\\n        Either of the pairs of attributes `downloadUrl`/`mediaType` or\\n        `accessUrl`/`accessService` MUST be specified.\\n\\n    ', downloadUrl=None, mediaType=None, accessUrl=OPTIMADEUrl('https://optimade.materialsproject.org', base_url='https://optimade.materialsproject.org', scheme='https', tld='org', host_type='domain'), accessService='OPTIMADE+DLite', license=None, accessRights=None, publisher=None)\n",
      "resource_config: OPTIMADEResourceConfig(user=None, password=None, token=None, client_id=None, client_secret=None, configuration=OPTIMADEConfig(version='v1', endpoint='structures', query_parameters=OPTIMADEQueryParameters(filter='elements HAS ALL \"Si\",\"O\" AND nelements<=4', response_format='json', email_address='', response_fields='', sort='', page_limit=20, page_offset=0, page_number=None, page_cursor=0, page_above=None, page_below=None, include='references', api_hint=''), datacache_config=DataCacheConfig(cacheDir=PosixPath('oteapi'), accessKey=None, hashType='md5', expireTime=86400, tag='optimade'), return_object=False, use_dlite=False), description='Resource Strategy Data Configuration.\\n\\n    Important:\\n        Either of the pairs of attributes `downloadUrl`/`mediaType` or\\n        `accessUrl`/`accessService` MUST be specified.\\n\\n    ', downloadUrl=None, mediaType=None, accessUrl=OPTIMADEUrl('https://optimade.materialsproject.org', base_url='https://optimade.materialsproject.org', scheme='https', tld='org', host_type='domain'), accessService='OPTIMADE+DLite', license=None, accessRights=None, publisher=None)\n",
      "optimade_query after update: OPTIMADEQueryParameters(filter='elements HAS ALL \"Si\",\"O\" AND nelements<=4', response_format='json', email_address='', response_fields='', sort='', page_limit=20, page_offset=0, page_number=None, page_cursor=0, page_above=None, page_below=None, include='references', api_hint='')\n",
      "optimade_query after update: OPTIMADEQueryParameters(filter='elements HAS ALL \"Si\",\"O\" AND nelements<=4', response_format='json', email_address='', response_fields='', sort='', page_limit=20, page_offset=0, page_number=None, page_cursor=0, page_above=None, page_below=None, include='references', api_hint='')\n",
      "optimade_query after update: OPTIMADEQueryParameters(filter='elements HAS ALL \"Si\",\"O\" AND nelements<=4', response_format='json', email_address='', response_fields='', sort='', page_limit=20, page_offset=0, page_number=None, page_cursor=0, page_above=None, page_below=None, include='references', api_hint='')\n",
      "OPTIMADE URL to be requested: https://optimade.materialsproject.org/v1/structures?filter=elements%20HAS%20ALL%20%22Si%22%2C%22O%22%20AND%20nelements%3C%3D4&response_format=json&page_limit=20&include=references\n",
      "OPTIMADE URL to be requested: https://optimade.materialsproject.org/v1/structures?filter=elements%20HAS%20ALL%20%22Si%22%2C%22O%22%20AND%20nelements%3C%3D4&response_format=json&page_limit=20&include=references\n",
      "OPTIMADE URL to be requested: https://optimade.materialsproject.org/v1/structures?filter=elements%20HAS%20ALL%20%22Si%22%2C%22O%22%20AND%20nelements%3C%3D4&response_format=json&page_limit=20&include=references\n"
     ]
    },
    {
     "data": {
      "text/plain": [
       "dict_keys(['optimade_config', 'optimade_resources', 'optimade_resource_model', 'collection_id'])"
      ]
     },
     "execution_count": 40,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "import json\n",
    "\n",
    "pipeline = filter_strategy >> data_resource_strategy\n",
    "session = pipeline.get()\n",
    "parsed_session = json.loads(session)\n",
    "parsed_session.keys()"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 41,
   "metadata": {},
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "The query resulted in 20 structures found (on page 1) of the returned data.\n",
      "Their Materials Project IDs are: ['mp-1033911', 'mp-757887', 'mp-1219366', 'mp-733539', 'mp-542090', 'mp-758465', 'mp-560675', 'mp-774171', 'mp-1304778', 'mp-1016821', 'mp-1363556', 'mp-757013', 'mp-683953', 'mp-1020609', 'mp-17612', 'mp-558129', 'mp-1210628', 'mp-1197149', 'mp-21791', 'mp-752892']\n"
     ]
    }
   ],
   "source": [
    "from importlib import import_module\n",
    "\n",
    "import_path, class_name = parsed_session[\"optimade_resource_model\"].split(\":\", maxsplit=1)\n",
    "ResourceClass = getattr(import_module(import_path), class_name)\n",
    "\n",
    "parsed_structures = [ResourceClass(structure) for structure in parsed_session[\"optimade_resources\"]]\n",
    "print(f\"The query resulted in {len(parsed_structures)} structures found (on page 1) of the returned data.\")\n",
    "print(f\"Their Materials Project IDs are: {[structure.id for structure in parsed_structures]}\")"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 42,
   "metadata": {},
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "{\n",
      "  \"bfd78bf8-31fe-4487-a4c3-8cc5351ca87d\":  {\n",
      "    \"meta\": \"http://onto-ns.com/meta/0.1/Collection\",\n",
      "    \"dimensions\": {\n",
      "      \"nrelations\": 60\n",
      "    },\n",
      "    \"properties\": {\n",
      "      \"relations\": [[\"mp-1033911\", \"_is-a\", \"Instance\"], [\"mp-1033911\", \"_has-uuid\", \"f0676948-f620-4057-9291-b1851f519d66\"], [\"mp-1033911\", \"_has-meta\", \"http://onto-ns.com/meta/1.0/OPTIMADEStructure\"], [\"mp-757887\", \"_is-a\", \"Instance\"], [\"mp-757887\", \"_has-uuid\", \"76add43f-bb1e-4bdb-984e-dc6c16b9205d\"], [\"mp-757887\", \"_has-meta\", \"http://onto-ns.com/meta/1.0/OPTIMADEStructure\"], [\"mp-1219366\", \"_is-a\", \"Instance\"], [\"mp-1219366\", \"_has-uuid\", \"d0e7c4f7-1dd7-4206-aa53-2a67b755259d\"], [\"mp-1219366\", \"_has-meta\", \"http://onto-ns.com/meta/1.0/OPTIMADEStructure\"], [\"mp-733539\", \"_is-a\", \"Instance\"], [\"mp-733539\", \"_has-uuid\", \"e460fb2d-1639-4b65-9e61-f4c2869ef412\"], [\"mp-733539\", \"_has-meta\", \"http://onto-ns.com/meta/1.0/OPTIMADEStructure\"], [\"mp-542090\", \"_is-a\", \"Instance\"], [\"mp-542090\", \"_has-uuid\", \"4625be3d-cad7-42a2-afdd-3c01715c0905\"], [\"mp-542090\", \"_has-meta\", \"http://onto-ns.com/meta/1.0/OPTIMADEStructure\"], [\"mp-758465\", \"_is-a\", \"Instance\"], [\"mp-758465\", \"_has-uuid\", \"d041f6c2-4770-41ec-870c-66d07f9aafff\"], [\"mp-758465\", \"_has-meta\", \"http://onto-ns.com/meta/1.0/OPTIMADEStructure\"], [\"mp-560675\", \"_is-a\", \"Instance\"], [\"mp-560675\", \"_has-uuid\", \"d6dfd477-cea9-46c1-b56f-487a77fb615e\"], [\"mp-560675\", \"_has-meta\", \"http://onto-ns.com/meta/1.0/OPTIMADEStructure\"], [\"mp-774171\", \"_is-a\", \"Instance\"], [\"mp-774171\", \"_has-uuid\", \"ac42160c-9661-4180-812b-4c2b2e44145e\"], [\"mp-774171\", \"_has-meta\", \"http://onto-ns.com/meta/1.0/OPTIMADEStructure\"], [\"mp-1304778\", \"_is-a\", \"Instance\"], [\"mp-1304778\", \"_has-uuid\", \"d840939b-9b95-48b9-9be7-4f0d8bdf480d\"], [\"mp-1304778\", \"_has-meta\", \"http://onto-ns.com/meta/1.0/OPTIMADEStructure\"], [\"mp-1016821\", \"_is-a\", \"Instance\"], [\"mp-1016821\", \"_has-uuid\", \"d023ba43-f725-4a8d-b38c-ff5021729f9d\"], [\"mp-1016821\", \"_has-meta\", \"http://onto-ns.com/meta/1.0/OPTIMADEStructure\"], [\"mp-1363556\", \"_is-a\", \"Instance\"], [\"mp-1363556\", \"_has-uuid\", \"8d011cb4-fa24-44ac-960d-b027588924d3\"], [\"mp-1363556\", \"_has-meta\", \"http://onto-ns.com/meta/1.0/OPTIMADEStructure\"], [\"mp-757013\", \"_is-a\", \"Instance\"], [\"mp-757013\", \"_has-uuid\", \"9d7928e0-1209-4251-ab67-92f5cc1cb1a4\"], [\"mp-757013\", \"_has-meta\", \"http://onto-ns.com/meta/1.0/OPTIMADEStructure\"], [\"mp-683953\", \"_is-a\", \"Instance\"], [\"mp-683953\", \"_has-uuid\", \"05eae7e9-2e01-4e21-bc86-0e4004221f76\"], [\"mp-683953\", \"_has-meta\", \"http://onto-ns.com/meta/1.0/OPTIMADEStructure\"], [\"mp-1020609\", \"_is-a\", \"Instance\"], [\"mp-1020609\", \"_has-uuid\", \"99468a6c-3875-436c-8025-0af9d4b53be5\"], [\"mp-1020609\", \"_has-meta\", \"http://onto-ns.com/meta/1.0/OPTIMADEStructure\"], [\"mp-17612\", \"_is-a\", \"Instance\"], [\"mp-17612\", \"_has-uuid\", \"7b266e95-b56a-4fc3-921c-407daa7d1369\"], [\"mp-17612\", \"_has-meta\", \"http://onto-ns.com/meta/1.0/OPTIMADEStructure\"], [\"mp-558129\", \"_is-a\", \"Instance\"], [\"mp-558129\", \"_has-uuid\", \"5c4d6757-866a-482b-83ba-cb8aa035b180\"], [\"mp-558129\", \"_has-meta\", \"http://onto-ns.com/meta/1.0/OPTIMADEStructure\"], [\"mp-1210628\", \"_is-a\", \"Instance\"], [\"mp-1210628\", \"_has-uuid\", \"a32c7f8c-a4b8-40f8-96e5-92a642c0e644\"], [\"mp-1210628\", \"_has-meta\", \"http://onto-ns.com/meta/1.0/OPTIMADEStructure\"], [\"mp-1197149\", \"_is-a\", \"Instance\"], [\"mp-1197149\", \"_has-uuid\", \"68ec190e-7ff5-497d-a6e5-de1bb568205c\"], [\"mp-1197149\", \"_has-meta\", \"http://onto-ns.com/meta/1.0/OPTIMADEStructure\"], [\"mp-21791\", \"_is-a\", \"Instance\"], [\"mp-21791\", \"_has-uuid\", \"b9805c87-808a-48b8-be04-58b18ebafb4e\"], [\"mp-21791\", \"_has-meta\", \"http://onto-ns.com/meta/1.0/OPTIMADEStructure\"], [\"mp-752892\", \"_is-a\", \"Instance\"], [\"mp-752892\", \"_has-uuid\", \"e2674e42-465f-4991-b7f5-15a65fb07f6d\"], [\"mp-752892\", \"_has-meta\", \"http://onto-ns.com/meta/1.0/OPTIMADEStructure\"]]\n",
      "    }\n",
      "  }\n",
      "}\n"
     ]
    }
   ],
   "source": [
    "from oteapi_dlite.utils import get_collection\n",
    "\n",
    "collection = get_collection(session=parsed_session)\n",
    "print(collection)"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 43,
   "metadata": {},
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "{\n",
      "  \"f0676948-f620-4057-9291-b1851f519d66\":  {\n",
      "    \"meta\": \"http://onto-ns.com/meta/1.0/OPTIMADEStructure\",\n",
      "    \"dimensions\": {\n",
      "    },\n",
      "    \"properties\": {\n",
      "      \"type\": \"structures\",\n",
      "      \"attributes\": \"46900658-13b0-4072-8fc1-7e20de603765\",\n",
      "      \"id\": \"mp-1033911\"\n",
      "    }\n",
      "  }\n",
      "}\n",
      "{\n",
      "  \"76add43f-bb1e-4bdb-984e-dc6c16b9205d\":  {\n",
      "    \"meta\": \"http://onto-ns.com/meta/1.0/OPTIMADEStructure\",\n",
      "    \"dimensions\": {\n",
      "    },\n",
      "    \"properties\": {\n",
      "      \"type\": \"structures\",\n",
      "      \"attributes\": \"62d27df4-ac40-4784-a5fd-ce48cbf12a3a\",\n",
      "      \"id\": \"mp-757887\"\n",
      "    }\n",
      "  }\n",
      "}\n",
      "{\n",
      "  \"d0e7c4f7-1dd7-4206-aa53-2a67b755259d\":  {\n",
      "    \"meta\": \"http://onto-ns.com/meta/1.0/OPTIMADEStructure\",\n",
      "    \"dimensions\": {\n",
      "    },\n",
      "    \"properties\": {\n",
      "      \"type\": \"structures\",\n",
      "      \"attributes\": \"c890c277-74b5-42a9-8bed-d0687b34bbd6\",\n",
      "      \"id\": \"mp-1219366\"\n",
      "    }\n",
      "  }\n",
      "}\n",
      "{\n",
      "  \"e460fb2d-1639-4b65-9e61-f4c2869ef412\":  {\n",
      "    \"meta\": \"http://onto-ns.com/meta/1.0/OPTIMADEStructure\",\n",
      "    \"dimensions\": {\n",
      "    },\n",
      "    \"properties\": {\n",
      "      \"type\": \"structures\",\n",
      "      \"attributes\": \"4d2dc20a-671f-4c26-90a2-d9f6bc6bbe0c\",\n",
      "      \"id\": \"mp-733539\"\n",
      "    }\n",
      "  }\n",
      "}\n",
      "{\n",
      "  \"4625be3d-cad7-42a2-afdd-3c01715c0905\":  {\n",
      "    \"meta\": \"http://onto-ns.com/meta/1.0/OPTIMADEStructure\",\n",
      "    \"dimensions\": {\n",
      "    },\n",
      "    \"properties\": {\n",
      "      \"type\": \"structures\",\n",
      "      \"attributes\": \"c1e0bc0e-bc18-4ebe-b0df-c8ab4cba83ae\",\n",
      "      \"id\": \"mp-542090\"\n",
      "    }\n",
      "  }\n",
      "}\n",
      "{\n",
      "  \"d041f6c2-4770-41ec-870c-66d07f9aafff\":  {\n",
      "    \"meta\": \"http://onto-ns.com/meta/1.0/OPTIMADEStructure\",\n",
      "    \"dimensions\": {\n",
      "    },\n",
      "    \"properties\": {\n",
      "      \"type\": \"structures\",\n",
      "      \"attributes\": \"0592aaad-c896-464a-b368-82f62bbe42f9\",\n",
      "      \"id\": \"mp-758465\"\n",
      "    }\n",
      "  }\n",
      "}\n",
      "{\n",
      "  \"d6dfd477-cea9-46c1-b56f-487a77fb615e\":  {\n",
      "    \"meta\": \"http://onto-ns.com/meta/1.0/OPTIMADEStructure\",\n",
      "    \"dimensions\": {\n",
      "    },\n",
      "    \"properties\": {\n",
      "      \"type\": \"structures\",\n",
      "      \"attributes\": \"1baa18c6-fec5-4720-8554-5593ca656f06\",\n",
      "      \"id\": \"mp-560675\"\n",
      "    }\n",
      "  }\n",
      "}\n",
      "{\n",
      "  \"ac42160c-9661-4180-812b-4c2b2e44145e\":  {\n",
      "    \"meta\": \"http://onto-ns.com/meta/1.0/OPTIMADEStructure\",\n",
      "    \"dimensions\": {\n",
      "    },\n",
      "    \"properties\": {\n",
      "      \"type\": \"structures\",\n",
      "      \"attributes\": \"d9d59dc2-3f83-4f96-ae5c-6d3ad5a241c6\",\n",
      "      \"id\": \"mp-774171\"\n",
      "    }\n",
      "  }\n",
      "}\n",
      "{\n",
      "  \"d840939b-9b95-48b9-9be7-4f0d8bdf480d\":  {\n",
      "    \"meta\": \"http://onto-ns.com/meta/1.0/OPTIMADEStructure\",\n",
      "    \"dimensions\": {\n",
      "    },\n",
      "    \"properties\": {\n",
      "      \"type\": \"structures\",\n",
      "      \"attributes\": \"cdbfd5ec-9a84-4a09-94b8-8ec989f09019\",\n",
      "      \"id\": \"mp-1304778\"\n",
      "    }\n",
      "  }\n",
      "}\n",
      "{\n",
      "  \"d023ba43-f725-4a8d-b38c-ff5021729f9d\":  {\n",
      "    \"meta\": \"http://onto-ns.com/meta/1.0/OPTIMADEStructure\",\n",
      "    \"dimensions\": {\n",
      "    },\n",
      "    \"properties\": {\n",
      "      \"type\": \"structures\",\n",
      "      \"attributes\": \"0d46f58f-2744-4c4f-882b-57da2e1c9cdf\",\n",
      "      \"id\": \"mp-1016821\"\n",
      "    }\n",
      "  }\n",
      "}\n",
      "{\n",
      "  \"8d011cb4-fa24-44ac-960d-b027588924d3\":  {\n",
      "    \"meta\": \"http://onto-ns.com/meta/1.0/OPTIMADEStructure\",\n",
      "    \"dimensions\": {\n",
      "    },\n",
      "    \"properties\": {\n",
      "      \"type\": \"structures\",\n",
      "      \"attributes\": \"c951ff9b-688e-40f3-b15d-b0acfede5e0a\",\n",
      "      \"id\": \"mp-1363556\"\n",
      "    }\n",
      "  }\n",
      "}\n",
      "{\n",
      "  \"9d7928e0-1209-4251-ab67-92f5cc1cb1a4\":  {\n",
      "    \"meta\": \"http://onto-ns.com/meta/1.0/OPTIMADEStructure\",\n",
      "    \"dimensions\": {\n",
      "    },\n",
      "    \"properties\": {\n",
      "      \"type\": \"structures\",\n",
      "      \"attributes\": \"5053a07b-f15b-437a-9bde-ce646a669abe\",\n",
      "      \"id\": \"mp-757013\"\n",
      "    }\n",
      "  }\n",
      "}\n",
      "{\n",
      "  \"05eae7e9-2e01-4e21-bc86-0e4004221f76\":  {\n",
      "    \"meta\": \"http://onto-ns.com/meta/1.0/OPTIMADEStructure\",\n",
      "    \"dimensions\": {\n",
      "    },\n",
      "    \"properties\": {\n",
      "      \"type\": \"structures\",\n",
      "      \"attributes\": \"c2f151ff-6c3c-45ed-a7b0-3ee5117f0035\",\n",
      "      \"id\": \"mp-683953\"\n",
      "    }\n",
      "  }\n",
      "}\n",
      "{\n",
      "  \"99468a6c-3875-436c-8025-0af9d4b53be5\":  {\n",
      "    \"meta\": \"http://onto-ns.com/meta/1.0/OPTIMADEStructure\",\n",
      "    \"dimensions\": {\n",
      "    },\n",
      "    \"properties\": {\n",
      "      \"type\": \"structures\",\n",
      "      \"attributes\": \"22cd1e19-e45f-47b5-a62d-4027f61f9667\",\n",
      "      \"id\": \"mp-1020609\"\n",
      "    }\n",
      "  }\n",
      "}\n",
      "{\n",
      "  \"7b266e95-b56a-4fc3-921c-407daa7d1369\":  {\n",
      "    \"meta\": \"http://onto-ns.com/meta/1.0/OPTIMADEStructure\",\n",
      "    \"dimensions\": {\n",
      "    },\n",
      "    \"properties\": {\n",
      "      \"type\": \"structures\",\n",
      "      \"attributes\": \"0aeef165-da7e-4681-8052-e95b484d637f\",\n",
      "      \"id\": \"mp-17612\"\n",
      "    }\n",
      "  }\n",
      "}\n",
      "{\n",
      "  \"5c4d6757-866a-482b-83ba-cb8aa035b180\":  {\n",
      "    \"meta\": \"http://onto-ns.com/meta/1.0/OPTIMADEStructure\",\n",
      "    \"dimensions\": {\n",
      "    },\n",
      "    \"properties\": {\n",
      "      \"type\": \"structures\",\n",
      "      \"attributes\": \"ddb31fe8-6885-4c80-bf2e-044dad60f8c3\",\n",
      "      \"id\": \"mp-558129\"\n",
      "    }\n",
      "  }\n",
      "}\n",
      "{\n",
      "  \"a32c7f8c-a4b8-40f8-96e5-92a642c0e644\":  {\n",
      "    \"meta\": \"http://onto-ns.com/meta/1.0/OPTIMADEStructure\",\n",
      "    \"dimensions\": {\n",
      "    },\n",
      "    \"properties\": {\n",
      "      \"type\": \"structures\",\n",
      "      \"attributes\": \"62840cd5-2f20-481f-8967-43476ecec964\",\n",
      "      \"id\": \"mp-1210628\"\n",
      "    }\n",
      "  }\n",
      "}\n",
      "{\n",
      "  \"68ec190e-7ff5-497d-a6e5-de1bb568205c\":  {\n",
      "    \"meta\": \"http://onto-ns.com/meta/1.0/OPTIMADEStructure\",\n",
      "    \"dimensions\": {\n",
      "    },\n",
      "    \"properties\": {\n",
      "      \"type\": \"structures\",\n",
      "      \"attributes\": \"c0674560-bbde-4e93-aa8a-bf9260ef6975\",\n",
      "      \"id\": \"mp-1197149\"\n",
      "    }\n",
      "  }\n",
      "}\n",
      "{\n",
      "  \"b9805c87-808a-48b8-be04-58b18ebafb4e\":  {\n",
      "    \"meta\": \"http://onto-ns.com/meta/1.0/OPTIMADEStructure\",\n",
      "    \"dimensions\": {\n",
      "    },\n",
      "    \"properties\": {\n",
      "      \"type\": \"structures\",\n",
      "      \"attributes\": \"aec646fb-b54f-4526-ba97-5cae2d3a528a\",\n",
      "      \"id\": \"mp-21791\"\n",
      "    }\n",
      "  }\n",
      "}\n",
      "{\n",
      "  \"e2674e42-465f-4991-b7f5-15a65fb07f6d\":  {\n",
      "    \"meta\": \"http://onto-ns.com/meta/1.0/OPTIMADEStructure\",\n",
      "    \"dimensions\": {\n",
      "    },\n",
      "    \"properties\": {\n",
      "      \"type\": \"structures\",\n",
      "      \"attributes\": \"606e5ca8-0fb1-45a4-941a-45461d19eceb\",\n",
      "      \"id\": \"mp-752892\"\n",
      "    }\n",
      "  }\n",
      "}\n"
     ]
    }
   ],
   "source": [
    "for inst in collection.get_instances():\n",
    "    print(inst)"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 44,
   "metadata": {},
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "{\n",
      "  \"46900658-13b0-4072-8fc1-7e20de603765\":  {\n",
      "    \"meta\": \"http://onto-ns.com/meta/1.0/OPTIMADEStructureAttributes\",\n",
      "    \"dimensions\": {\n",
      "      \"nelements\": 4,\n",
      "      \"dimensionality\": 3,\n",
      "      \"nsites\": 32,\n",
      "      \"nspecies\": 4,\n",
      "      \"nstructure_features\": 0\n",
      "    },\n",
      "    \"properties\": {\n",
      "      \"elements\": [\"K\", \"Mg\", \"O\", \"Si\"],\n",
      "      \"nelements\": 4,\n",
      "      \"elements_ratios\": [0.03125, 0.4375, 0.03125, 0.5],\n",
      "      \"chemical_formula_descriptive\": \"KMg14O16Si\",\n",
      "      \"chemical_formula_reduced\": \"KMg14O16Si\",\n",
      "      \"chemical_formula_hill\": \"KMg14O16Si\",\n",
      "      \"chemical_formula_anonymous\": \"A16B14CD\",\n",
      "      \"dimension_types\": [1, 1, 1],\n",
      "      \"nperiodic_dimensions\": 3,\n",
      "      \"lattice_vectors\": [[8.59318, 0, 0], [0, 8.59318, 0], [0, 0, 4.41201]],\n",
      "      \"cartesian_site_positions\": [[0, 0, 0], [0, 4.29659, 0], [4.29659, 0, 0], [0, 2.1438, 2.20601], [0, 6.44938, 2.20601], [4.29659, 2.13079, 2.20601], [4.29659, 6.46238, 2.20601], [2.1438, 0, 2.20601], [2.13079, 4.29659, 2.20601], [6.44938, 0, 2.20601], [6.46238, 4.29659, 2.20601], [2.12673, 2.12673, 0], [2.12673, 6.46645, 0], [6.46645, 2.12673, 0], [6.46645, 6.46645, 0], [4.29659, 4.29659, 0], [2.37689, 0, 0], [2.32997, 4.29659, 0], [6.21628, 0, 0], [6.2632, 4.29659, 0], [2.16162, 2.16162, 2.20601], [2.16162, 6.43155, 2.20601], [6.43155, 2.16162, 2.20601], [6.43155, 6.43155, 2.20601], [0, 0, 2.20601], [0, 4.29659, 2.20601], [4.29659, 0, 2.20601], [4.29659, 4.29659, 2.20601], [0, 2.37689, 0], [0, 6.21628, 0], [4.29659, 2.32997, 0], [4.29659, 6.2632, 0]],\n",
      "      \"nsites\": 32,\n",
      "      \"species\": [\"b60b7266-2807-4d89-bdd7-776fc7bd84d0\", \"faa90667-ab90-484d-b0f5-17685b3c9d5b\", \"880e1de2-1608-4432-986c-8b199cff5018\", \"9ab25660-3d30-4034-a9f5-ba0e7a7a8adc\"],\n",
      "      \"species_at_sites\": [\"K\", \"Mg\", \"Mg\", \"Mg\", \"Mg\", \"Mg\", \"Mg\", \"Mg\", \"Mg\", \"Mg\", \"Mg\", \"Mg\", \"Mg\", \"Mg\", \"Mg\", \"Si\", \"O\", \"O\", \"O\", \"O\", \"O\", \"O\", \"O\", \"O\", \"O\", \"O\", \"O\", \"O\", \"O\", \"O\", \"O\", \"O\"],\n",
      "      \"assemblies\": null,\n",
      "      \"structure_features\": [],\n",
      "      \"immutable_id\": \"645d2b74bcd30f748b4746a3\",\n",
      "      \"last_modified\": \"2019-10-23 12:27:13+00:00\"\n",
      "    }\n",
      "  }\n",
      "}\n"
     ]
    }
   ],
   "source": [
    "import dlite\n",
    "\n",
    "structure_instances: list[dlite.Instance] = list(collection.get_instances())\n",
    "\n",
    "structure_attributes_instance: dlite.Instance = dlite.get_instance(structure_instances[0].attributes)\n",
    "\n",
    "print(structure_attributes_instance)"
   ]
  }
 ],
 "metadata": {
  "kernelspec": {
   "display_name": "oteapi-optimade",
   "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.9.19"
  },
  "orig_nbformat": 4
 },
 "nbformat": 4,
 "nbformat_minor": 2
}