Update brainstem_api_tutorial.ipynb

Author: MingzeDou

brainstem_api_tutorial.ipynb

@@ -265,87 +265,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# 6. Including Related Models\n",
-    "\n",
-    "Brainstem's data models have relationships between them (projects contain sessions, sessions involve subjects, etc.). The include parameter lets you fetch related models in a single request, reducing the number of API calls needed. For example, you can retrieve a project along with all its sessions and subjects in one operation"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "# Find the Allen Institute: Visual Coding – Neuropixels project\n",
-    "allen_projects = client.load_model(\n",
-    "    \"project\", \n",
-    "    portal=\"public\", \n",
-    "    filters={'name.iexact': 'Allen Institute: Visual Coding – Neuropixels'}\n",
-    ").json()\n",
-    "\n",
-    "# Get project ID\n",
-    "project_id = allen_projects['projects'][0]['id']\n",
-    "\n",
-    "# Get detailed project information with sessions and subjects included\n",
-    "project_with_data = client.load_model(\n",
-    "    \"project\",\n",
-    "    portal=\"public\",\n",
-    "    id=project_id,\n",
-    "    include=[\"sessions\", \"subjects\"]  # Include both sessions and subjects\n",
-    ").json()\n",
-    "\n",
-    "# Access project information\n",
-    "project = project_with_data['project']\n",
-    "print(f\"Project name: {project['name']}\")\n",
-    "print(f\"Description: {project['description'][:100]}...\")\n",
-    "print(f\"Public: {project['is_public']}\")\n",
-    "\n",
-    "# Print session and subject counts. We have this data from a single API call\n",
-    "print(f\"\\nThis project has {len(project['sessions'])} sessions\")\n",
-    "print(f\"This project has {len(project['subjects'])} subjects\")\n",
-    "\n",
-    "# List first 3 subjects directly from the include\n",
-    "print(\"\\nFirst 3 subjects in the project:\")\n",
-    "for i, subject_id in enumerate(project['subjects'][:3]):\n",
-    "    print(f\"{i+1}. Subject ID: {subject_id}\")\n",
-    "\n",
-    "# List first 3 sessions directly from the include\n",
-    "print(\"\\nFirst 3 sessions in the project:\")\n",
-    "for i, session_id in enumerate(project['sessions'][:3]):\n",
-    "    print(f\"{i+1}. Session ID: {session_id}\")\n",
-    "\n",
-    "# Get details for a specific session with included dataacquisition\n",
-    "first_session_id = project['sessions'][0]\n",
-    "session_with_data = client.load_model(\n",
-    "    \"session\",\n",
-    "    portal=\"public\",\n",
-    "    id=first_session_id,\n",
-    "    include=[\"dataacquisition\"]  # Include data acquisition methods\n",
-    ").json()\n",
-    "\n",
-    "# Access the session data\n",
-    "session = session_with_data['session']\n",
-    "print(f\"\\nSession details:\")\n",
-    "print(f\"Name: {session['name']}\")\n",
-    "print(f\"Description: {session['description']}\")\n",
-    "\n",
-    "# Now actually use the included dataacquisition data\n",
-    "if 'dataacquisition' in session:\n",
-    "    data_acq_ids = session['dataacquisition']\n",
-    "    print(f\"\\nThis session has {len(data_acq_ids)} data acquisition method(s) (included in response)\")\n",
-    "    \n",
-    "    # Demonstrate using the included dataacquisition IDs\n",
-    "    if data_acq_ids:\n",
-    "        print(\"\\nData acquisition IDs from session include:\")\n",
-    "        for i, acq_id in enumerate(data_acq_ids):\n",
-    "            print(f\"{i+1}. {acq_id}\")"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "# 7. Sorting\n",
+    "# 6. Sorting\n",
     "\n",
     "You can control the order of returned results using the sort parameter. Sort by any field in ascending order (e.g., alphabetically by name) or use a minus sign prefix for descending order."
    ]
@@ -383,7 +303,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# 8. Updating data\n",
+    "# 7. Updating data\n",
     "The API supports creating new records and updating existing ones. When creating a record, provide the required fields for that model type. For updates, fetch the existing record, modify its attributes, and save it back. Both operations require appropriate permissions."
    ]
   },
@@ -447,7 +367,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# 9. Deleting data\n",
+    "# 8. Deleting data\n",
     "You can remove records from the database using their IDs. Deletion is permanent, so use this operation with caution. The API will return a success status code (204) when deletion is successful. Like other write operations, deletion requires appropriate permissions."
    ]
   },