modified to activate models from nb (#5)

Author: starry-phoenix

docs/build/doctrees/api/spyice.postprocess.doctree

@@ -4,14 +4,14 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# Quick start guide to model building and running with SPyice"
+    "# Model building and running with SPyice for heat-salt transport system"
    ]
   },
   {
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "Demonstrates a simple example for a freezing sea ice model for a simple heat diffusion setup with default settings of initial conditions of 265K at the top boundary and Salinity of 34ppt choosing constant fixed Dirichlet boundary conditions. For the one phase distinct interface system where sea water is at melt temperature of 271.25K. "
+    "Demonstrates a simple example for a freezing sea ice model heat-salt transport setup with default settings of initial conditions of 265K at the top boundary and Salinity of 34ppt choosing constant fixed Dirichlet boundary conditions. For the one phase distinct interface system where sea water is at melt temperature of 271.25K.\n"
    ]
   },
   {
@@ -30,6 +30,7 @@
     "import os\n",
     "from pathlib import Path\n",
     "import matplotlib.pyplot as plt\n",
+    "from datetime import datetime\n",
     "\n",
     "%matplotlib inline\n",
     "from omegaconf import OmegaConf\n",
@@ -55,6 +56,7 @@
    "outputs": [],
    "source": [
     "# creates a OmegaConf object from a dictionary for fast testing only for parameters: constants, dt, S_IC, iter_max, dz\n",
+    "# make sure to change userinput_data data class values if any parameters in constants_dict is changed!\n",
     "constants_dict = {\n",
     "    \"constants\": {\"constants\": \"real\"},\n",
     "    \"dt\": {\"dt\": 47},\n",
@@ -68,6 +70,9 @@
     "# choose your output directory\n",
     "base_dir = Path.cwd()\n",
     "output_base_dir = Path(base_dir, \"output\")\n",
+    "# Current date-time string\n",
+    "timestamp = datetime.now().strftime(\"%Y%m%d_%H%M%S\")\n",
+    "output_base_dir = create_output_directory(output_base_dir, timestamp)\n",
     "wo_hydra_dir = Path(output_base_dir, \"without_hydra\")\n",
     "out_dir_final = create_output_directory(wo_hydra_dir, config.initial_salinity.S_IC, \"2\", \"0.01\", \"47\", \"1500\", \"example\")"
    ]
@@ -119,7 +124,17 @@
    "outputs": [],
    "source": [
     "# choose the diffusion only equation for heat diffusion without the influence of salinity and physical properties\n",
-    "userinput_data.is_diffusiononly_equation = True"
+    "userinput_data.is_diffusiononly_equation = True\n",
+    "userinput_data.is_salinity_equation = True"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "preprocess_data = PreProcess.update_preprocess_dataclass(preprocess_data, userinput_data)"
    ]
   },
   {

docs/build/doctrees/api/spyice.postprocess.visualise_model.doctree

@@ -11,7 +11,9 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "The SPyIce package is a software tool that enables 1D finite difference simulation for vertical transport equations. It specifically focuses on thermal diffusion with the influence of salinity and physical properties. The package utilizes the Thomas tridiagonal solver as the solver algorithm. With SPyIce, users can model and analyze the behavior of temperature, salinity, and other relevant variables in a vertical system. It provides a comprehensive framework for studying the thermal diffusion process and its interaction with salinity in various scenarios. Hydra is used to automate the simulation runs of the Sea-Ice Model. It is used to manage and run sea ice simulations, making it easier for users to explore different scenarios and optimize their models."
+    "The SPyIce package is a software tool that enables 1D finite difference simulation for vertical transport equations. It specifically focuses on thermal diffusion with the influence of salinity and physical properties. The package utilizes the Thomas tridiagonal solver as the solver algorithm. With SPyIce, users can model and analyze the behavior of temperature, salinity, and other relevant variables in a vertical system. It provides a comprehensive framework for studying the thermal diffusion process and its interaction with salinity in various scenarios. Hydra is used to automate the simulation runs of the Sea-Ice Model. It is used to manage and run sea ice simulations, making it easier for users to explore different scenarios and optimize their models.\n",
+    "\n",
+    "<img src=\"../../images/seaice_withboundary.png\" width=\"250\">"
    ]
   },
   {