update: swap mp to our bank 3

Author: VsevolodX

examples/job/run-simulations-and-extract-properties.ipynb

@@ -32,7 +32,7 @@
     "\n",
     "We follow the below steps:\n",
     "\n",
-    "- Import materials from [materials project](https://materialsproject.org/)\n",
+    "- Import materials from [Materials Bank](https://docs.mat3ra.com/materials/bank/)\n",
     "\n",
     "- Group imported materials inside a [materials set](https://docs.mat3ra.com/entities-general/sets/)\n",
     "\n",
@@ -49,7 +49,7 @@
     "The explanation below assumes that the reader is familiar with the concepts used in Mat3ra platform and RESTful API. We outline these below and direct the reader to the original sources of information:\n",
     "\n",
     "- [Generating RESTful API authentication parameters](../system/get_authentication_params.ipynb)\n",
-    "- [Importing materials from materials project](../material/import_materials_from_materialsproject.ipynb)\n",
+    "- [Importing materials from Materials Bank](../material/get_materials_by_formula.ipynb)\n",
     "- [Creating and submitting jobs](../job/create_and_submit_job.ipynb)"
    ]
   },
@@ -68,8 +68,6 @@
     "\n",
     "ACCOUNT_ID and AUTH_TOKEN - Authentication parameters needed for when making requests to [Mat3ra.com's API Endpoints](https://docs.mat3ra.com/rest-api/endpoints/).\n",
     "\n",
-    "MATERIALS_PROJECT_API_KEY - Authentication parameter needed for when making requests to [Material Project's API](https://materialsproject.org/open)\n",
-    "\n",
     "ORGANIZATION_ID - Authentication parameter needed for when working with collaborative accounts https://docs.mat3ra.com/collaboration/organizations/overview/\n",
     "\n",
     "> <span style=\"color: orange\">**NOTE**</span>: If you are running this notebook from Jupyter, the variables ACCOUNT_ID, AUTH_TOKEN, MATERIALS_PROJECT_API_KEY, and ORGANIZATION_ID should be set in the file [settings.json](../../utils/settings.json) if you need to use these variables. To obtain API token parameters, please see the following link to the documentation explaining how to get them: https://docs.mat3ra.com/accounts/ui/preferences/api/"
@@ -91,7 +89,6 @@
     "# @title Authorization Form\n",
     "ACCOUNT_ID = \"ACCOUNT_ID\"  # @param {type:\"string\"}\n",
     "AUTH_TOKEN = \"AUTH_TOKEN\"  # @param {type:\"string\"}\n",
-    "MATERIALS_PROJECT_API_KEY = \"MATERIALS_PROJECT_API_KEY\"  # @param {type:\"string\"}\n",
     "ORGANIZATION_ID = \"ORGANIZATION_ID\"  # @param {type:\"string\"}\n",
     "\n",
     "import os\n",
@@ -102,7 +99,6 @@
     "        dict(\n",
     "            ACCOUNT_ID=ACCOUNT_ID,\n",
     "            AUTH_TOKEN=AUTH_TOKEN,\n",
-    "            MATERIALS_PROJECT_API_KEY=MATERIALS_PROJECT_API_KEY,\n",
     "            ORGANIZATION_ID=ORGANIZATION_ID,\n",
     "        )\n",
     "    )\n",
@@ -116,7 +112,6 @@
     "        dict(\n",
     "            ACCOUNT_ID=apiConfig.get(\"accountId\"),\n",
     "            AUTH_TOKEN=apiConfig.get(\"authToken\"),\n",
-    "            MATERIALS_PROJECT_API_KEY=MATERIALS_PROJECT_API_KEY,\n",
     "            ORGANIZATION_ID=apiConfig.get(\"organizationId\") or \"\",\n",
     "        )\n",
     "    )\n",
@@ -152,7 +147,7 @@
     "from IPython.display import IFrame\n",
     "\n",
     "# Import settings file and utils file\n",
-    "from utils.settings import ENDPOINT_ARGS, ACCOUNT_ID, MATERIALS_PROJECT_API_KEY\n",
+    "from utils.settings import ENDPOINT_ARGS, ACCOUNT_ID\n",
     "from utils.generic import wait_for_jobs_to_finish, get_property_by_subworkflow_and_unit_indicies, dataframe_to_html\n",
     "\n",
     "import pandas as pd\n",
@@ -163,6 +158,7 @@
     "from exabyte_api_client.endpoints.projects import ProjectEndpoints\n",
     "from exabyte_api_client.endpoints.materials import MaterialEndpoints\n",
     "from exabyte_api_client.endpoints.bank_workflows import BankWorkflowEndpoints\n",
+    "from exabyte_api_client.endpoints.bank_materials import BankMaterialEndpoints\n",
     "from exabyte_api_client.endpoints.properties import PropertiesEndpoints"
    ]
   },
@@ -175,7 +171,8 @@
    "source": [
     "#### Materials\n",
     "\n",
-    "- **MATERIALS_PROJECT_IDS**: a list of material IDs to be imported from materials project\n",
+    "- **MATERIALS_SI_QUERY**: query to find Silicon materials in Materials Bank\n",
+    "- **MATERIALS_GE_QUERY**: query to find Germanium materials in Materials Bank\n",
     "- **TAGS**: a list of [tags](https://docs.mat3ra.com/entities-general/data/#tags) to assign to imported materials\n",
     "- **MATERIALS_SET_NAME**: the name of the materials set\n"
    ]
@@ -188,7 +185,9 @@
    },
    "outputs": [],
    "source": [
-    "MATERIALS_PROJECT_IDS = [\"mp-149\", \"mp-32\"]  # Si and Ge\n",
+    "# Materials Bank queries for Si and Ge\n",
+    "MATERIAL_SI_QUERY = {\"formula\": \"Si\"}\n",
+    "MATERIAL_GE_QUERY = {\"formula\": \"Ge\"}\n",
     "MATERIALS_SET_NAME = \"materials-set\"\n",
     "TAGS = [\"tag1\", \"tag2\"]"
    ]
@@ -326,7 +325,8 @@
     "project_endpoints = ProjectEndpoints(*ENDPOINT_ARGS)\n",
     "material_endpoints = MaterialEndpoints(*ENDPOINT_ARGS)\n",
     "property_endpoints = PropertiesEndpoints(*ENDPOINT_ARGS)\n",
-    "bank_workflow_endpoints = BankWorkflowEndpoints(*ENDPOINT_ARGS)"
+    "bank_workflow_endpoints = BankWorkflowEndpoints(*ENDPOINT_ARGS)\n",
+    "bank_material_endpoints = BankMaterialEndpoints(*ENDPOINT_ARGS)"
    ]
   },
   {
@@ -384,7 +384,7 @@
    "source": [
     "### Import materials\n",
     "\n",
-    "Import materials from materials project with the above tags."
+    "Get materials from Materials Bank and copy to account's materials collection."
    ]
   },
   {
@@ -395,9 +395,9 @@
    },
    "outputs": [],
    "source": [
-    "materials = material_endpoints.import_from_materialsproject(\n",
-    "    MATERIALS_PROJECT_API_KEY, MATERIALS_PROJECT_IDS, owner_id, TAGS\n",
-    ")"
+    "bank_si_material = bank_material_endpoints.list(MATERIAL_SI_QUERY)[0]\n",
+    "bank_ge_material = bank_material_endpoints.list(MATERIAL_GE_QUERY)[0]\n",
+    "materials = [bank_si_material, bank_ge_material]"
    ]
   },
   {