Update documentation with SMSConfig

SPSUnipi · Feb 12, 2025 · 518077e · 518077e
1 parent 68fceef
commit 518077e
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 3 deletions.
diff --git a/docs/getting-started/quick-start.rst b/docs/getting-started/quick-start.rst
@@ -56,7 +56,7 @@ Finally, the network is optimized with the following code:
 
 .. code:: python
     
-    configfile = "../../test/test_data/configs/UCBlockSolver/uc_solverconfig.txt"  # path to the solver configuration file
+    configfile = SMSConfig(template="uc_solverconfig")  # path to the template solver config file "uc_solverconfig"
     temporary_smspp_file = "./smspp_temp_file.nc"  # path to the temporary SMS++ file used as intermediate file to launch SMS++
     output_file = "./smspp_output.txt"  # path to the output file (optional)
 

diff --git a/examples/notebooks/ucblock_thermal_1bus.ipynb b/examples/notebooks/ucblock_thermal_1bus.ipynb
@@ -30,7 +30,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from pysmspp import SMSNetwork, Variable, Block, SMSFileType\n",
+    "from pysmspp import SMSConfig, SMSNetwork, Variable, Block, SMSFileType\n",
     "import numpy as np\n",
     "\n",
     "# Create an empty SMSNetwork with block file type\n",
@@ -128,7 +128,9 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "configfile = \"../../test/test_data/configs/UCBlockSolver/uc_solverconfig.txt\"  # path to solver config file\n",
+    "configfile = SMSConfig(\n",
+    "    template=\"uc_solverconfig\"\n",
+    ")  # path to the template solver config file \"uc_solverconfig\"\n",
     "temporary_smspp_file = \"./smspp_temp_file.nc\"  # path to temporary SMS++ file\n",
     "output_file = \"./smspp_output.txt\"  # path to the output file (optional)\n",
     "\n",