Update to notebooks/demo_data_integration.ipynb. Step description now includes information about set up with network_mount env variable

This commit is contained in:
2025-06-22 12:16:26 +02:00
parent cbcebd998a
commit 334335387e

View File

@ -40,10 +40,19 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"## Step 1: Specify data integration task through YAML configuration file\n",
"## Step 1: Configure Your Data Integration Task\n",
"\n",
"1. Based on one of the example `.yaml` files found in the `input_files/` folder, define the input and output directory paths inside the file.\n",
"\n",
"2. When working with network drives, create `.env` file in the root of the `dima/` project with the following line:\n",
"\n",
" ```dotenv\n",
" NETWORK_MOUNT=//your-server/your-share\n",
" ```\n",
"3. Excecute Cell.\n",
"\n",
"**Note:** Ensure `.env` is listed in `.gitignore` and `.dockerignore`.\n",
"\n",
"* Create your configuration file (i.e., *.yaml file) adhering to the example yaml file in the input folder.\n",
"* Set up input directory and output directory paths and Excecute Cell.\n",
"\n"
]
},
@ -53,7 +62,7 @@
"metadata": {},
"outputs": [],
"source": [
"number, initials = 1, 'LI' # Set as either 2, 'TBR' or 3, 'NG'\n",
"number, initials = 2, 'TBR' # Set as either 2, 'TBR' or 3, 'NG'\n",
"campaign_descriptor_path = f'../input_files/campaignDescriptor{number}_{initials}.yaml'\n",
"\n",
"print(campaign_descriptor_path)\n"
@ -65,7 +74,9 @@
"source": [
"## Step 2: Create an integrated HDF5 file of experimental campaign.\n",
"\n",
"* Excecute Cell. Here we run the function `integrate_data_sources` with input argument as the previously specified YAML config file."
"* Excecute Cell. Here we run the function `integrate_data_sources` with input argument as the previously specified YAML config file.\n",
"\n",
" "
]
},
{
@ -159,7 +170,7 @@
],
"metadata": {
"kernelspec": {
"display_name": "Python 3",
"display_name": "multiphase_chemistry_env",
"language": "python",
"name": "python3"
},
@ -173,7 +184,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.11.10"
"version": "3.11.9"
}
},
"nbformat": 4,