adding a comment on kind_tags in the doc

aiidateam · Feb 8, 2024 · 5cece37 · 5cece37
1 parent 0bca290
commit 5cece37
Showing 1 changed file with 26 additions and 3 deletions.
diff --git a/docs/source/user_guide/structuredata/API_start.ipynb b/docs/source/user_guide/structuredata/API_start.ipynb
@@ -428,7 +428,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 30,
+   "execution_count": 31,
    "metadata": {},
    "outputs": [
     {
@@ -437,7 +437,7 @@
        "0.001"
       ]
      },
-     "execution_count": 30,
+     "execution_count": 31,
      "metadata": {},
      "output_type": "execute_result"
     }
@@ -460,7 +460,30 @@
   {
    "cell_type": "markdown",
    "metadata": {},
-   "source": []
+   "source": [
+    "#### User defined kinds\n",
+    "\n",
+    "it is possible to define kinds by hands, when the StructureData instance is generated.\n",
+    "\n",
+    "```python\n",
+    "properties = {\n",
+    "    ...\n",
+    "    \"positions\":{\n",
+    "        \"value\":[...],\n",
+    "        \"kind_tags\":[\"Li0\",\"Li0\"],\n",
+    "    }\n",
+    "    ...\n",
+    "}\n",
+    "```\n",
+    "So that a given plugin will use the given tags, if checks that `structure.properties.positions.kind_tags`exists."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "\""
+   ]
   }
  ],
  "metadata": {