Skip to content
Snippets Groups Projects
Normal view Permalink
pybis_example.ipynb 23 KiB
Newer Older
  • Learn to ignore specific revisions
    • Henry Luetcke's avatar
    connection to openBIS and Masterdata functionality
    Henry Luetcke committed
    1 2 3 4 
    {
 "cells": [
  {
   "cell_type": "code",
    Henry Luetcke's avatar
    add experiment deletion  
    Henry Luetcke committed
    5 
       "execution_count": 12,
    Henry Luetcke's avatar
    connection to openBIS and Masterdata functionality
    Henry Luetcke committed
    6 7 8 9 
       "metadata": {},
   "outputs": [],
   "source": [
    "from pybis import Openbis\n",
    Henry Luetcke's avatar
    fix bug in new_experiment function  
    Henry Luetcke committed
    10 
        "import getpass"
    Henry Luetcke's avatar
    connection to openBIS and Masterdata functionality
    Henry Luetcke committed
    11 12 13 14 15 16 17 18 19 20 21 
       ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "### Connecting to openBIS"
   ]
  },
  {
   "cell_type": "code",
    Henry Luetcke's avatar
    add experiment deletion  
    Henry Luetcke committed
    22 
       "execution_count": 13,
    Henry Luetcke's avatar
    connection to openBIS and Masterdata functionality
    Henry Luetcke committed
    23 24 25 
       "metadata": {},
   "outputs": [],
   "source": [
    Henry Luetcke's avatar
    fix bug in new_experiment function  
    Henry Luetcke committed
    26 
        "o = Openbis('https://127.0.0.1/openbis:8443', verify_certificates=False)"
    Henry Luetcke's avatar
    connection to openBIS and Masterdata functionality
    Henry Luetcke committed
    27 28 29 30 
       ]
  },
  {
   "cell_type": "code",
    Henry Luetcke's avatar
    add experiment deletion  
    Henry Luetcke committed
    31 32 33 34 35 36 37 38 39 40 41 
       "execution_count": 14,
   "metadata": {},
   "outputs": [
    {
     "name": "stdin",
     "output_type": "stream",
     "text": [
      " ·············\n"
     ]
    }
   ],
    Henry Luetcke's avatar
    connection to openBIS and Masterdata functionality
    Henry Luetcke committed
    42 
       "source": [
    Henry Luetcke's avatar
    fix bug in new_experiment function  
    Henry Luetcke committed
    43 
        "username = 'hluetcke'\n",
    Henry Luetcke's avatar
    connection to openBIS and Masterdata functionality
    Henry Luetcke committed
    44 45 46 47 48 
        "pw = getpass.getpass()"
   ]
  },
  {
   "cell_type": "code",
    Henry Luetcke's avatar
    add experiment deletion  
    Henry Luetcke committed
    49 
       "execution_count": 15,
    Henry Luetcke's avatar
    connection to openBIS and Masterdata functionality
    Henry Luetcke committed
    50 51 52 53 54 55 56 57 58 
       "metadata": {},
   "outputs": [],
   "source": [
    "o.login(username, pw, save_token=True)   # saves the session token in ~/.pybis/example.com.token\n",
    "del pw"
   ]
  },
  {
   "cell_type": "code",
    Henry Luetcke's avatar
    add experiment deletion  
    Henry Luetcke committed
    59 60 61 62 63 64 65 66 67 68 69 70 71 72 
       "execution_count": 16,
   "metadata": {},
   "outputs": [
    {
     "data": {
      "text/plain": [
       "'hluetcke-210707114707411xDBE993550910BD60EE612EF16B373511'"
      ]
     },
     "execution_count": 16,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
    Henry Luetcke's avatar
    connection to openBIS and Masterdata functionality
    Henry Luetcke committed
    73 74 75 76 77 78 
       "source": [
    "o.token"
   ]
  },
  {
   "cell_type": "code",
    Henry Luetcke's avatar
    add experiment deletion  
    Henry Luetcke committed
    79 80 81 82 83 84 85 86 87 88 89 90 91 92 
       "execution_count": 17,
   "metadata": {},
   "outputs": [
    {
     "data": {
      "text/plain": [
       "True"
      ]
     },
     "execution_count": 17,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
    Henry Luetcke's avatar
    connection to openBIS and Masterdata functionality
    Henry Luetcke committed
    93 94 95 96 97 98 
       "source": [
    "o.is_session_active()"
   ]
  },
  {
   "cell_type": "code",
    Henry Luetcke's avatar
    add experiment deletion  
    Henry Luetcke committed
    99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 
       "execution_count": 18,
   "metadata": {},
   "outputs": [
    {
     "data": {
      "text/html": [
       "<div>\n",
       "<style scoped>\n",
       "    .dataframe tbody tr th:only-of-type {\n",
       "        vertical-align: middle;\n",
       "    }\n",
       "\n",
       "    .dataframe tbody tr th {\n",
       "        vertical-align: top;\n",
       "    }\n",
       "\n",
       "    .dataframe thead th {\n",
       "        text-align: right;\n",
       "    }\n",
       "</style>\n",
       "<table border=\"1\" class=\"dataframe\">\n",
       "  <thead>\n",
       "    <tr style=\"text-align: right;\">\n",
       "      <th></th>\n",
       "      <th>code</th>\n",
       "      <th>downloadUrl</th>\n",
       "      <th>remoteUrl</th>\n",
       "    </tr>\n",
       "  </thead>\n",
       "  <tbody>\n",
       "    <tr>\n",
       "      <th>0</th>\n",
       "      <td>DSS1</td>\n",
       "      <td>https://127.0.0.1:443</td>\n",
       "      <td>http://127.0.0.1:8081</td>\n",
       "    </tr>\n",
       "  </tbody>\n",
       "</table>\n",
       "</div>"
      ],
      "text/plain": [
       "   code            downloadUrl              remoteUrl\n",
       "0  DSS1  https://127.0.0.1:443  http://127.0.0.1:8081"
      ]
     },
     "execution_count": 18,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
    Henry Luetcke's avatar
    connection to openBIS and Masterdata functionality
    Henry Luetcke committed
    149 150 151 152 153 154 155 156 157 158 159 160 161 
       "source": [
    "o.get_datastores()"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "### Masterdata"
   ]
  },
  {
   "cell_type": "code",
    Henry Luetcke's avatar
    implement dataset methods  
    Henry Luetcke committed
    162 163 164 
       "execution_count": null,
   "metadata": {},
   "outputs": [],
    Henry Luetcke's avatar
    connection to openBIS and Masterdata functionality
    Henry Luetcke committed
    165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 
       "source": [
    "o.get_experiment_types()"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "o.get_sample_types()"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "o.get_sample_type('PLATE')"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "o.get_material_types()"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "o.get_dataset_types()"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "o.get_terms()"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    Henry Luetcke's avatar
    implement dataset methods  
    Henry Luetcke committed
    218 
        "### Samples / objects"
    Henry Luetcke's avatar
    connection to openBIS and Masterdata functionality
    Henry Luetcke committed
    219 220 221 222 223 224 225 226 
       ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    Henry Luetcke's avatar
    implement dataset methods  
    Henry Luetcke committed
    227 
        "o.get_sample_types()"
    Henry Luetcke's avatar
    connection to openBIS and Masterdata functionality
    Henry Luetcke committed
    228 229 230 231 232 233 234 235 
       ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    Henry Luetcke's avatar
    implement dataset methods  
    Henry Luetcke committed
    236 
        "obj = o.new_object(type='UNKNOWN', space='MATLAB_TEST', code='12345')"
    Henry Luetcke's avatar
    connection to openBIS and Masterdata functionality
    Henry Luetcke committed
    237 238 239 240 241 242 243 244 
       ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    Henry Luetcke's avatar
    implement dataset methods  
    Henry Luetcke committed
    245 
        "obj.save()"
    Henry Luetcke's avatar
    connection to openBIS and Masterdata functionality
    Henry Luetcke committed
    246 247 248 249 
       ]
  },
  {
   "cell_type": "code",
    Henry Luetcke's avatar
    start experiment methods  
    Henry Luetcke committed
    250 
       "execution_count": null,
    Henry Luetcke's avatar
    connection to openBIS and Masterdata functionality
    Henry Luetcke committed
    251 252 
       "metadata": {},
   "outputs": [],
    Henry Luetcke's avatar
    work on object methods  
    Henry Luetcke committed
    253 254 255 256 257 258 
       "source": [
    "sample = o.get_sample('/MATLAB_TEST/911922')"
   ]
  },
  {
   "cell_type": "code",
    Henry Luetcke's avatar
    start experiment methods  
    Henry Luetcke committed
    259 
       "execution_count": null,
    Henry Luetcke's avatar
    work on object methods  
    Henry Luetcke committed
    260 
       "metadata": {},
    Henry Luetcke's avatar
    start experiment methods  
    Henry Luetcke committed
    261 
       "outputs": [],
    Henry Luetcke's avatar
    work on object methods  
    Henry Luetcke committed
    262 263 264 
       "source": [
    "sample.delete('just a test')"
   ]
    Henry Luetcke's avatar
    implement dataset methods  
    Henry Luetcke committed
    265 266 267 268 
      },
  {
   "cell_type": "markdown",
   "metadata": {},
    Henry Luetcke's avatar
    connection to openBIS and Masterdata functionality
    Henry Luetcke committed
    269 
       "source": [
    Henry Luetcke's avatar
    implement dataset methods  
    Henry Luetcke committed
    270 
        "### List and get datasets"
    Henry Luetcke's avatar
    connection to openBIS and Masterdata functionality
    Henry Luetcke committed
    271 272 
       ]
  },
    Henry Luetcke's avatar
    manage spaces  
    Henry Luetcke committed
    273 274 
      {
   "cell_type": "code",
    Henry Luetcke's avatar
    implement dataset methods  
    Henry Luetcke committed
    275 
       "execution_count": null,
    Henry Luetcke's avatar
    manage spaces  
    Henry Luetcke committed
    276 277 278 
       "metadata": {},
   "outputs": [],
   "source": [
    Henry Luetcke's avatar
    implement dataset methods  
    Henry Luetcke committed
    279 
        "datasets = o.get_datasets(type='HISTOLOGY')"
    Henry Luetcke's avatar
    manage spaces  
    Henry Luetcke committed
    280 281 282 283 
       ]
  },
  {
   "cell_type": "code",
    Henry Luetcke's avatar
    implement dataset methods  
    Henry Luetcke committed
    284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 
       "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "counter = 0\n",
    "for ds in datasets:\n",
    "    print(ds)\n",
    "    counter += 1\n",
    "    if counter > 10:\n",
    "        break"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "ds = o.get_dataset('20101105142049776-6512')"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "ds.get_files(start_folder='original')"
    Henry Luetcke's avatar
    manage spaces  
    Henry Luetcke committed
    312 313 
       ]
  },
    Henry Luetcke's avatar
    connection to openBIS and Masterdata functionality
    Henry Luetcke committed
    314 315 316 317 
      {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    Henry Luetcke's avatar
    continue with experiment methods  
    Henry Luetcke committed
    318 319 320 321 322 
        "### Experiments / collections"
   ]
  },
  {
   "cell_type": "code",
    Henry Luetcke's avatar
    work on dataset upload  
    Henry Luetcke committed
    323 324 325 
       "execution_count": null,
   "metadata": {},
   "outputs": [],
    Henry Luetcke's avatar
    continue with experiment methods  
    Henry Luetcke committed
    326 327 328 329 330 331 332 333 334 
       "source": [
    "o.get_experiments(\n",
    "    project='TEST_PROJECT',\n",
    "    space='MATLAB_TEST'\n",
    ")"
   ]
  },
  {
   "cell_type": "code",
    Henry Luetcke's avatar
    work on dataset upload  
    Henry Luetcke committed
    335 336 337 
       "execution_count": null,
   "metadata": {},
   "outputs": [],
    Henry Luetcke's avatar
    continue with experiment methods  
    Henry Luetcke committed
    338 339 340 341 342 343 344 
       "source": [
    "experiment = o.get_experiment('/MATLAB_TEST/TEST_PROJECT/E1300')\n",
    "experiment"
   ]
  },
  {
   "cell_type": "code",
    Henry Luetcke's avatar
    work on dataset upload  
    Henry Luetcke committed
    345 
       "execution_count": null,
    Henry Luetcke's avatar
    continue with experiment methods  
    Henry Luetcke committed
    346 
       "metadata": {},
    Henry Luetcke's avatar
    work on dataset upload  
    Henry Luetcke committed
    347 
       "outputs": [],
    Henry Luetcke's avatar
    continue with experiment methods  
    Henry Luetcke committed
    348 349 350 351 352 353 
       "source": [
    "experiment.props"
   ]
  },
  {
   "cell_type": "code",
    Henry Luetcke's avatar
    add experiment deletion  
    Henry Luetcke committed
    354 
       "execution_count": 19,
    Henry Luetcke's avatar
    continue with experiment methods  
    Henry Luetcke committed
    355 356 357 
       "metadata": {},
   "outputs": [],
   "source": [
    Henry Luetcke's avatar
    fix bug in new_experiment function  
    Henry Luetcke committed
    358 
        "experiment = o.new_experiment(type='UNKNOWN', code='EXP123456789', project='/HLUETCKE/PLAYGROUND')"
    Henry Luetcke's avatar
    continue with experiment methods  
    Henry Luetcke committed
    359 360 361 362 
       ]
  },
  {
   "cell_type": "code",
    Henry Luetcke's avatar
    add experiment deletion  
    Henry Luetcke committed
    363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 
       "execution_count": 20,
   "metadata": {},
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "experiment successfully created.\n"
     ]
    },
    {
     "data": {
      "text/html": [
       "\n",
       "            <table border=\"1\" class=\"dataframe\">\n",
       "            <thead>\n",
       "                <tr style=\"text-align: right;\">\n",
       "                <th>attribute</th>\n",
       "                <th>value</th>\n",
       "                </tr>\n",
       "            </thead>\n",
       "            <tbody>\n",
       "        <tr> <td>code</td> <td>EXP123456789</td> </tr><tr> <td>permId</td> <td>20210707114742976-102</td> </tr><tr> <td>identifier</td> <td>/HLUETCKE/PLAYGROUND/EXP123456789</td> </tr><tr> <td>type</td> <td>UNKNOWN</td> </tr><tr> <td>project</td> <td>/HLUETCKE/PLAYGROUND</td> </tr><tr> <td>tags</td> <td>[]</td> </tr><tr> <td>registrator</td> <td>hluetcke</td> </tr><tr> <td>registrationDate</td> <td>2021-07-07 13:47:43</td> </tr><tr> <td>modifier</td> <td>hluetcke</td> </tr><tr> <td>modificationDate</td> <td>2021-07-07 13:47:43</td> </tr><tr> <td>frozen</td> <td>False</td> </tr><tr> <td>frozenForDataSets</td> <td>False</td> </tr><tr> <td>frozenForSamples</td> <td>False</td> </tr><tr><td>attachments</td><td></td></tr>\n",
       "            </tbody>\n",
       "            </table>\n",
       "        "
      ],
      "text/plain": [
       "attribute          value\n",
       "-----------------  ---------------------------------\n",
       "code               EXP123456789\n",
       "permId             20210707114742976-102\n",
       "identifier         /HLUETCKE/PLAYGROUND/EXP123456789\n",
       "type               UNKNOWN\n",
       "project            /HLUETCKE/PLAYGROUND\n",
       "tags               []\n",
       "registrator        hluetcke\n",
       "registrationDate   2021-07-07 13:47:43\n",
       "modifier           hluetcke\n",
       "modificationDate   2021-07-07 13:47:43\n",
       "frozen             False\n",
       "frozenForDataSets  False\n",
       "frozenForSamples   False"
      ]
     },
     "execution_count": 20,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
    Henry Luetcke's avatar
    continue with experiment methods  
    Henry Luetcke committed
    413 
       "source": [
    Henry Luetcke's avatar
    fix issue with new sample  
    Henry Luetcke committed
    414 
        "experiment.save()"
    Henry Luetcke's avatar
    connection to openBIS and Masterdata functionality
    Henry Luetcke committed
    415 416 417 418 
       ]
  },
  {
   "cell_type": "code",
    Henry Luetcke's avatar
    add experiment deletion  
    Henry Luetcke committed
    419 
       "execution_count": 21,
    Henry Luetcke's avatar
    connection to openBIS and Masterdata functionality
    Henry Luetcke committed
    420 
       "metadata": {},
    Henry Luetcke's avatar
    add experiment deletion  
    Henry Luetcke committed
    421 422 423 424 425 426 427 428 429 
       "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "experiment 20210707114742976-102 successfully deleted.\n"
     ]
    }
   ],
    Henry Luetcke's avatar
    bug fixes and documentation  
    Henry Luetcke committed
    430 
       "source": [
    Henry Luetcke's avatar
    add experiment deletion  
    Henry Luetcke committed
    431 
        "experiment.delete('bla')"
    Henry Luetcke's avatar
    bug fixes and documentation  
    Henry Luetcke committed
    432 
       ]
    Henry Luetcke's avatar
    continue with experiment methods  
    Henry Luetcke committed
    433 434 435 
      },
  {
   "cell_type": "code",
    Henry Luetcke's avatar
    add experiment deletion  
    Henry Luetcke committed
    436 
       "execution_count": 22,
    Henry Luetcke's avatar
    continue with experiment methods  
    Henry Luetcke committed
    437 438 
       "metadata": {},
   "outputs": [],
    Henry Luetcke's avatar
    add experiment deletion  
    Henry Luetcke committed
    439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 
       "source": [
    "project = o.new_project('HLUETCKE', 'test_project', 'boring project')"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 23,
   "metadata": {
    "tags": []
   },
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "project successfully created.\n"
     ]
    },
    {
     "data": {
      "text/html": [
       "\n",
       "            <table border=\"1\" class=\"dataframe\">\n",
       "            <thead>\n",
       "                <tr style=\"text-align: right;\">\n",
       "                <th>attribute</th>\n",
       "                <th>value</th>\n",
       "                </tr>\n",
       "            </thead>\n",
       "            <tbody>\n",
       "        <tr> <td>code</td> <td>TEST_PROJECT</td> </tr><tr> <td>description</td> <td>boring project</td> </tr><tr> <td>permId</td> <td>20210707120832998-103</td> </tr><tr> <td>identifier</td> <td>/HLUETCKE/TEST_PROJECT</td> </tr><tr> <td>space</td> <td>HLUETCKE</td> </tr><tr> <td>leader</td> <td></td> </tr><tr> <td>registrator</td> <td>hluetcke</td> </tr><tr> <td>registrationDate</td> <td>2021-07-07 14:08:33</td> </tr><tr> <td>modifier</td> <td>12</td> </tr><tr> <td>modificationDate</td> <td>2021-07-07 14:08:33</td> </tr><tr> <td>frozen</td> <td>False</td> </tr><tr> <td>frozenForExperiments</td> <td>False</td> </tr><tr> <td>frozenForSamples</td> <td>False</td> </tr><tr><td>attachments</td><td></td></tr>\n",
       "            </tbody>\n",
       "            </table>\n",
       "        "
      ],
      "text/plain": [
       "attribute             value\n",
       "--------------------  ----------------------\n",
       "code                  TEST_PROJECT\n",
       "description           boring project\n",
       "permId                20210707120832998-103\n",
       "identifier            /HLUETCKE/TEST_PROJECT\n",
       "space                 HLUETCKE\n",
       "leader\n",
       "registrator           hluetcke\n",
       "registrationDate      2021-07-07 14:08:33\n",
       "modifier              12\n",
       "modificationDate      2021-07-07 14:08:33\n",
       "frozen                False\n",
       "frozenForExperiments  False\n",
       "frozenForSamples      False"
      ]
     },
     "execution_count": 23,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
    Henry Luetcke's avatar
    bug fixes and documentation  
    Henry Luetcke committed
    497 498 499 500 
       "source": [
    "project.save()"
   ]
  },
    Henry Luetcke's avatar
    add experiment deletion  
    Henry Luetcke committed
    501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 
      {
   "cell_type": "code",
   "execution_count": 24,
   "metadata": {},
   "outputs": [],
   "source": [
    "experiment = o.new_experiment(type='UNKNOWN', code='EXP333', project='/HLUETCKE/TEST_PROJECT')"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 25,
   "metadata": {},
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "experiment successfully created.\n"
     ]
    },
    {
     "data": {
      "text/html": [
       "\n",
       "            <table border=\"1\" class=\"dataframe\">\n",
       "            <thead>\n",
       "                <tr style=\"text-align: right;\">\n",
       "                <th>attribute</th>\n",
       "                <th>value</th>\n",
       "                </tr>\n",
       "            </thead>\n",
       "            <tbody>\n",
       "        <tr> <td>code</td> <td>EXP333</td> </tr><tr> <td>permId</td> <td>20210707121043770-104</td> </tr><tr> <td>identifier</td> <td>/HLUETCKE/TEST_PROJECT/EXP333</td> </tr><tr> <td>type</td> <td>UNKNOWN</td> </tr><tr> <td>project</td> <td>/HLUETCKE/TEST_PROJECT</td> </tr><tr> <td>tags</td> <td>[]</td> </tr><tr> <td>registrator</td> <td>hluetcke</td> </tr><tr> <td>registrationDate</td> <td>2021-07-07 14:10:44</td> </tr><tr> <td>modifier</td> <td>hluetcke</td> </tr><tr> <td>modificationDate</td> <td>2021-07-07 14:10:44</td> </tr><tr> <td>frozen</td> <td>False</td> </tr><tr> <td>frozenForDataSets</td> <td>False</td> </tr><tr> <td>frozenForSamples</td> <td>False</td> </tr><tr><td>attachments</td><td></td></tr>\n",
       "            </tbody>\n",
       "            </table>\n",
       "        "
      ],
      "text/plain": [
       "attribute          value\n",
       "-----------------  -----------------------------\n",
       "code               EXP333\n",
       "permId             20210707121043770-104\n",
       "identifier         /HLUETCKE/TEST_PROJECT/EXP333\n",
       "type               UNKNOWN\n",
       "project            /HLUETCKE/TEST_PROJECT\n",
       "tags               []\n",
       "registrator        hluetcke\n",
       "registrationDate   2021-07-07 14:10:44\n",
       "modifier           hluetcke\n",
       "modificationDate   2021-07-07 14:10:44\n",
       "frozen             False\n",
       "frozenForDataSets  False\n",
       "frozenForSamples   False"
      ]
     },
     "execution_count": 25,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "experiment.save()"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 26,
   "metadata": {},
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "experiment 20210707121043770-104 successfully deleted.\n"
     ]
    }
   ],
   "source": [
    "experiment.delete('bla')"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 27,
   "metadata": {},
   "outputs": [
    {
     "ename": "ValueError",
     "evalue": "Project 'TEST_PROJECT' can not be deleted because the following experiments are in the trash can: [EXP333] (Context: [])",
     "output_type": "error",
     "traceback": [
      "\u001b[0;31m---------------------------------------------------------------------------\u001b[0m",
      "\u001b[0;31mValueError\u001b[0m                                Traceback (most recent call last)",
      "\u001b[0;32m<ipython-input-27-9412c08c33df>\u001b[0m in \u001b[0;36m<module>\u001b[0;34m\u001b[0m\n\u001b[0;32m----> 1\u001b[0;31m \u001b[0mproject\u001b[0m\u001b[0;34m.\u001b[0m\u001b[0mdelete\u001b[0m\u001b[0;34m(\u001b[0m\u001b[0;34m'bla'\u001b[0m\u001b[0;34m)\u001b[0m\u001b[0;34m\u001b[0m\u001b[0;34m\u001b[0m\u001b[0m\n\u001b[0m",
      "\u001b[0;32m~/miniconda3/lib/python3.9/site-packages/pybis/openbis_object.py\u001b[0m in \u001b[0;36mdelete\u001b[0;34m(self, reason)\u001b[0m\n\u001b[1;32m    149\u001b[0m             \u001b[0;32mreturn\u001b[0m\u001b[0;34m\u001b[0m\u001b[0;34m\u001b[0m\u001b[0m\n\u001b[1;32m    150\u001b[0m \u001b[0;34m\u001b[0m\u001b[0m\n\u001b[0;32m--> 151\u001b[0;31m         self.openbis.delete_openbis_entity(\n\u001b[0m\u001b[1;32m    152\u001b[0m             \u001b[0mentity\u001b[0m\u001b[0;34m=\u001b[0m\u001b[0mself\u001b[0m\u001b[0;34m.\u001b[0m\u001b[0m_entity\u001b[0m\u001b[0;34m,\u001b[0m\u001b[0;34m\u001b[0m\u001b[0;34m\u001b[0m\u001b[0m\n\u001b[1;32m    153\u001b[0m             \u001b[0mobjectId\u001b[0m\u001b[0;34m=\u001b[0m\u001b[0mself\u001b[0m\u001b[0;34m.\u001b[0m\u001b[0mdata\u001b[0m\u001b[0;34m[\u001b[0m\u001b[0;34m'permId'\u001b[0m\u001b[0;34m]\u001b[0m\u001b[0;34m,\u001b[0m\u001b[0;34m\u001b[0m\u001b[0;34m\u001b[0m\u001b[0m\n",
      "\u001b[0;32m~/miniconda3/lib/python3.9/site-packages/pybis/pybis.py\u001b[0m in \u001b[0;36mdelete_openbis_entity\u001b[0;34m(self, entity, objectId, reason)\u001b[0m\n\u001b[1;32m   2559\u001b[0m             ]\n\u001b[1;32m   2560\u001b[0m         }\n\u001b[0;32m-> 2561\u001b[0;31m         \u001b[0mself\u001b[0m\u001b[0;34m.\u001b[0m\u001b[0m_post_request\u001b[0m\u001b[0;34m(\u001b[0m\u001b[0mself\u001b[0m\u001b[0;34m.\u001b[0m\u001b[0mas_v3\u001b[0m\u001b[0;34m,\u001b[0m \u001b[0mrequest\u001b[0m\u001b[0;34m)\u001b[0m\u001b[0;34m\u001b[0m\u001b[0;34m\u001b[0m\u001b[0m\n\u001b[0m\u001b[1;32m   2562\u001b[0m         \u001b[0;32mreturn\u001b[0m\u001b[0;34m\u001b[0m\u001b[0;34m\u001b[0m\u001b[0m\n\u001b[1;32m   2563\u001b[0m \u001b[0;34m\u001b[0m\u001b[0m\n",
      "\u001b[0;32m~/miniconda3/lib/python3.9/site-packages/pybis/pybis.py\u001b[0m in \u001b[0;36m_post_request\u001b[0;34m(self, resource, request)\u001b[0m\n\u001b[1;32m   1064\u001b[0m         \u001b[0mdata\u001b[0m\u001b[0;34m\u001b[0m\u001b[0;34m\u001b[0m\u001b[0m\n\u001b[1;32m   1065\u001b[0m         \"\"\"\n\u001b[0;32m-> 1066\u001b[0;31m         \u001b[0;32mreturn\u001b[0m \u001b[0mself\u001b[0m\u001b[0;34m.\u001b[0m\u001b[0m_post_request_full_url\u001b[0m\u001b[0;34m(\u001b[0m\u001b[0murljoin\u001b[0m\u001b[0;34m(\u001b[0m\u001b[0mself\u001b[0m\u001b[0;34m.\u001b[0m\u001b[0murl\u001b[0m\u001b[0;34m,\u001b[0m\u001b[0mresource\u001b[0m\u001b[0;34m)\u001b[0m\u001b[0;34m,\u001b[0m \u001b[0mrequest\u001b[0m\u001b[0;34m)\u001b[0m\u001b[0;34m\u001b[0m\u001b[0;34m\u001b[0m\u001b[0m\n\u001b[0m\u001b[1;32m   1067\u001b[0m \u001b[0;34m\u001b[0m\u001b[0m\n\u001b[1;32m   1068\u001b[0m     \u001b[0;32mdef\u001b[0m \u001b[0m_post_request_full_url\u001b[0m\u001b[0;34m(\u001b[0m\u001b[0mself\u001b[0m\u001b[0;34m,\u001b[0m \u001b[0mfull_url\u001b[0m\u001b[0;34m,\u001b[0m \u001b[0mrequest\u001b[0m\u001b[0;34m)\u001b[0m\u001b[0;34m:\u001b[0m\u001b[0;34m\u001b[0m\u001b[0;34m\u001b[0m\u001b[0m\n",
      "\u001b[0;32m~/miniconda3/lib/python3.9/site-packages/pybis/pybis.py\u001b[0m in \u001b[0;36m_post_request_full_url\u001b[0;34m(self, full_url, request)\u001b[0m\n\u001b[1;32m   1090\u001b[0m                 \u001b[0;31m#print(full_url)\u001b[0m\u001b[0;34m\u001b[0m\u001b[0;34m\u001b[0m\u001b[0;34m\u001b[0m\u001b[0m\n\u001b[1;32m   1091\u001b[0m                 \u001b[0;31m#print(json.dumps(request))\u001b[0m\u001b[0;34m\u001b[0m\u001b[0;34m\u001b[0m\u001b[0;34m\u001b[0m\u001b[0m\n\u001b[0;32m-> 1092\u001b[0;31m                 \u001b[0;32mraise\u001b[0m \u001b[0mValueError\u001b[0m\u001b[0;34m(\u001b[0m\u001b[0mresp\u001b[0m\u001b[0;34m[\u001b[0m\u001b[0;34m'error'\u001b[0m\u001b[0;34m]\u001b[0m\u001b[0;34m[\u001b[0m\u001b[0;34m'message'\u001b[0m\u001b[0;34m]\u001b[0m\u001b[0;34m)\u001b[0m\u001b[0;34m\u001b[0m\u001b[0;34m\u001b[0m\u001b[0m\n\u001b[0m\u001b[1;32m   1093\u001b[0m             \u001b[0;32melif\u001b[0m \u001b[0;34m'result'\u001b[0m \u001b[0;32min\u001b[0m \u001b[0mresp\u001b[0m\u001b[0;34m:\u001b[0m\u001b[0;34m\u001b[0m\u001b[0;34m\u001b[0m\u001b[0m\n\u001b[1;32m   1094\u001b[0m                 \u001b[0;32mreturn\u001b[0m \u001b[0mresp\u001b[0m\u001b[0;34m[\u001b[0m\u001b[0;34m'result'\u001b[0m\u001b[0;34m]\u001b[0m\u001b[0;34m\u001b[0m\u001b[0;34m\u001b[0m\u001b[0m\n",
      "\u001b[0;31mValueError\u001b[0m: Project 'TEST_PROJECT' can not be deleted because the following experiments are in the trash can: [EXP333] (Context: [])"
     ]
    }
   ],
   "source": [
    "project.delete('bla')"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": []
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": []
  },
    Henry Luetcke's avatar
    bug fixes and documentation  
    Henry Luetcke committed
    622 623 624 625 626 627 628 629 
      {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "o.get_objects('SIS_HLUETCKE/')"
   ]
    Henry Luetcke's avatar
    continue with experiment methods  
    Henry Luetcke committed
    630 631 632 633 
      },
  {
   "cell_type": "markdown",
   "metadata": {},
    Henry Luetcke's avatar
    connection to openBIS and Masterdata functionality
    Henry Luetcke committed
    634 
       "source": [
    Henry Luetcke's avatar
    continue with experiment methods  
    Henry Luetcke committed
    635 
        "### Download and import files"
    Henry Luetcke's avatar
    connection to openBIS and Masterdata functionality
    Henry Luetcke committed
    636 637 638 639 640 641 642 643 
       ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    Henry Luetcke's avatar
    continue with experiment methods  
    Henry Luetcke committed
    644 
        "ds.download(files='', destination='data', wait_until_finished=True)"
    Henry Luetcke's avatar
    connection to openBIS and Masterdata functionality
    Henry Luetcke committed
    645 646 647 648 649 650 651 652 
       ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    Henry Luetcke's avatar
    continue with experiment methods  
    Henry Luetcke committed
    653 
        "plt.imshow(plt.imread('data/20101105142920015-6525/original/441_x40001.tif'))"
    Henry Luetcke's avatar
    connection to openBIS and Masterdata functionality
    Henry Luetcke committed
    654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 
       ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "o.get_experiment_types()"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "o.get_dataset_types()"
   ]
    Henry Luetcke's avatar
    test object-oriented approach  
    Henry Luetcke committed
    673 674 675 
      },
  {
   "cell_type": "code",
    Henry Luetcke's avatar
    implement dataset methods  
    Henry Luetcke committed
    676 677 678 
       "execution_count": null,
   "metadata": {},
   "outputs": [],
    Henry Luetcke's avatar
    test object-oriented approach  
    Henry Luetcke committed
    679 680 681 682 683 684 
       "source": [
    "o.get_projects(space='MATLAB_TEST', code=None)"
   ]
  },
  {
   "cell_type": "code",
    Henry Luetcke's avatar
    implement dataset methods  
    Henry Luetcke committed
    685 
       "execution_count": null,
    Henry Luetcke's avatar
    test object-oriented approach  
    Henry Luetcke committed
    686 687 688 689 690 691 692 693 
       "metadata": {},
   "outputs": [],
   "source": [
    "project = o.new_project(space='MATLAB_TEST', code='ANOTHER_TEST', description='TGIF')"
   ]
  },
  {
   "cell_type": "code",
    Henry Luetcke's avatar
    implement dataset methods  
    Henry Luetcke committed
    694 695 696 
       "execution_count": null,
   "metadata": {},
   "outputs": [],
    Henry Luetcke's avatar
    test object-oriented approach  
    Henry Luetcke committed
    697 698 699 700 701 702 
       "source": [
    "project.save()"
   ]
  },
  {
   "cell_type": "code",
    Henry Luetcke's avatar
    implement dataset methods  
    Henry Luetcke committed
    703 704 705 
       "execution_count": null,
   "metadata": {},
   "outputs": [],
    Henry Luetcke's avatar
    test object-oriented approach  
    Henry Luetcke committed
    706 707 708 709 
       "source": [
    "project.delete('just a test')"
   ]
  },
    Henry Luetcke's avatar
    continue with experiment methods  
    Henry Luetcke committed
    710 711 712 713 
      {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    Henry Luetcke's avatar
    Check session activity  
    Henry Luetcke committed
    714 
        "### Create a new dataset"
    Henry Luetcke's avatar
    continue with experiment methods  
    Henry Luetcke committed
    715 716 717 718 
       ]
  },
  {
   "cell_type": "code",
    Henry Luetcke's avatar
    work on dataset upload  
    Henry Luetcke committed
    719 
       "execution_count": null,
    Henry Luetcke's avatar
    continue with experiment methods  
    Henry Luetcke committed
    720 
       "metadata": {},
    Henry Luetcke's avatar
    work on dataset upload  
    Henry Luetcke committed
    721 
       "outputs": [],
    Henry Luetcke's avatar
    Check session activity  
    Henry Luetcke committed
    722 723 724 725 726 727 728 729 730 731 732 
       "source": [
    "file_list = [\n",
    "    '/Users/Henry/Data/temp/file1.dat',\n",
    "    '/Users/Henry/Data/temp/file2.dat',\n",
    "    '/Users/Henry/Data/temp/file3.dat'\n",
    "]\n",
    "file_list"
   ]
  },
  {
   "cell_type": "code",
    Henry Luetcke's avatar
    work on dataset upload  
    Henry Luetcke committed
    733 
       "execution_count": null,
    Henry Luetcke's avatar
    Check session activity  
    Henry Luetcke committed
    734 
       "metadata": {},
    Henry Luetcke's avatar
    work on dataset upload  
    Henry Luetcke committed
    735 736 737 738 739 740 741 742 743 744 745 
       "outputs": [],
   "source": [
    "ds_new = o.new_dataset(type='ANALYZED_DATA', experiment='/HLUETCKE/DEMO/DEMO_EXP_1', sample='/HLUETCKE/DEMO/S43', files=file_list)"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    Henry Luetcke's avatar
    Check session activity  
    Henry Luetcke committed
    746 747 748 749 750 751 752 753 754 755 756 757 
        "ds_new.save()"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "### Logout"
   ]
  },
  {
   "cell_type": "code",
    Henry Luetcke's avatar
    bug fixes and documentation  
    Henry Luetcke committed
    758 
       "execution_count": null,
    Henry Luetcke's avatar
    Check session activity  
    Henry Luetcke committed
    759 
       "metadata": {},
    Henry Luetcke's avatar
    continue with experiment methods  
    Henry Luetcke committed
    760 761 762 763 764 
       "outputs": [],
   "source": [
    "o.logout()"
   ]
  },
    Henry Luetcke's avatar
    test object-oriented approach  
    Henry Luetcke committed
    765 766 767 768 769 770 
      {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": []
    Henry Luetcke's avatar
    connection to openBIS and Masterdata functionality
    Henry Luetcke committed
    771 772 773 774 
      }
 ],
 "metadata": {
  "kernelspec": {
    Henry Luetcke's avatar
    fix bug in new_experiment function  
    Henry Luetcke committed
    775 
       "display_name": "Python 3",
    Henry Luetcke's avatar
    connection to openBIS and Masterdata functionality
    Henry Luetcke committed
    776 777 778 779 780 781 782 783 784 785 786 787 788 
       "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",
    Henry Luetcke's avatar
    fix bug in new_experiment function  
    Henry Luetcke committed
    789 
       "version": "3.9.1"
    Henry Luetcke's avatar
    connection to openBIS and Masterdata functionality
    Henry Luetcke committed
    790 791 792 
      }
 },
 "nbformat": 4,
    Henry Luetcke's avatar
    fix bug in new_experiment function  
    Henry Luetcke committed
    793 
     "nbformat_minor": 4
    Henry Luetcke's avatar
    connection to openBIS and Masterdata functionality
    Henry Luetcke committed
    794 
    }