From 9af67d54ecafcbb16220089357f96366bf4fc8ff Mon Sep 17 00:00:00 2001 From: Yalin Date: Sun, 22 Oct 2023 10:43:57 -0400 Subject: [PATCH] update binder links in tutorials, add a small note in dynamic simulation --- docs/source/tutorials/0_Quick_Overview.ipynb | 33 +++++++++++++++++-- docs/source/tutorials/10_Process.ipynb | 2 +- .../tutorials/11_Dynamic_Simulation.ipynb | 28 ++++++++-------- .../12_Anaerobic_Digestion_Model_No_1.ipynb | 2 +- docs/source/tutorials/1_Helpful_Basics.ipynb | 2 +- docs/source/tutorials/2_Component.ipynb | 2 +- docs/source/tutorials/3_WasteStream.ipynb | 2 +- docs/source/tutorials/4_SanUnit_basic.ipynb | 2 +- .../source/tutorials/5_SanUnit_advanced.ipynb | 2 +- docs/source/tutorials/6_System.ipynb | 2 +- docs/source/tutorials/7_TEA.ipynb | 2 +- docs/source/tutorials/8_LCA.ipynb | 2 +- ...Uncertainty_and_Sensitivity_Analyses.ipynb | 2 +- 13 files changed, 57 insertions(+), 26 deletions(-) diff --git a/docs/source/tutorials/0_Quick_Overview.ipynb b/docs/source/tutorials/0_Quick_Overview.ipynb index e8191de7..5f4341ec 100644 --- a/docs/source/tutorials/0_Quick_Overview.ipynb +++ b/docs/source/tutorials/0_Quick_Overview.ipynb @@ -11,7 +11,7 @@ " \n", " - [Yalin Li](https://qsdsan.readthedocs.io/en/latest/CONTRIBUTING.html)\n", " \n", - "To run tutorials in your browser, go to this [Binder page](https://mybinder.org/v2/gh/QSD-Group/QSDsan/main?filepath=%2Fdocs%2Fsource%2Ftutorials)." + "To run tutorials in your browser, go to this [Binder page](https://mybinder.org/v2/gh/QSD-Group/QSDsan-env/main?urlpath=git-pull%3Frepo%3Dhttps%253A%252F%252Fgithub.com%252FQSD-group%252FQSDsan%26urlpath%3Dtree%252FQSDsan%252Fdocs%252Fsource%252Ftutorials%26branch%3Dmain)." ] }, { @@ -605,7 +605,36 @@ "name": "python", "nbconvert_exporter": "python", "pygments_lexer": "ipython3", - "version": "3.8.12" + "version": "3.9.13" + }, + "varInspector": { + "cols": { + "lenName": 16, + "lenType": 16, + "lenVar": 40 + }, + "kernels_config": { + "python": { + "delete_cmd_postfix": "", + "delete_cmd_prefix": "del ", + "library": "var_list.py", + "varRefreshCmd": "print(var_dic_list())" + }, + "r": { + "delete_cmd_postfix": ") ", + "delete_cmd_prefix": "rm(", + "library": "var_list.r", + "varRefreshCmd": "cat(var_dic_list()) " + } + }, + "types_to_exclude": [ + "module", + "function", + "builtin_function_or_method", + "instance", + "_Feature" + ], + "window_display": false } }, "nbformat": 4, diff --git a/docs/source/tutorials/10_Process.ipynb b/docs/source/tutorials/10_Process.ipynb index 945c66f0..5d1069ff 100644 --- a/docs/source/tutorials/10_Process.ipynb +++ b/docs/source/tutorials/10_Process.ipynb @@ -22,7 +22,7 @@ "\n", " - [Joy Zhang](https://qsdsan.readthedocs.io/en/latest/CONTRIBUTING.html)\n", " \n", - "To run tutorials in your browser, go to this [Binder page](https://mybinder.org/v2/gh/QSD-Group/QSDsan/main?filepath=%2Fdocs%2Fsource%2Ftutorials).\n", + "To run tutorials in your browser, go to this [Binder page](https://mybinder.org/v2/gh/QSD-Group/QSDsan-env/main?urlpath=git-pull%3Frepo%3Dhttps%253A%252F%252Fgithub.com%252FQSD-group%252FQSDsan%26urlpath%3Dtree%252FQSDsan%252Fdocs%252Fsource%252Ftutorials%26branch%3Dmain).\n", " \n", "You can also watch a video demo on YouTube ([part 1](https://youtu.be/r9HrfTH9_Tg), [part 2](https://youtu.be/noVSJboqSuc)) (subscriptions & likes appreciated!)." ] diff --git a/docs/source/tutorials/11_Dynamic_Simulation.ipynb b/docs/source/tutorials/11_Dynamic_Simulation.ipynb index 4f990179..57072991 100644 --- a/docs/source/tutorials/11_Dynamic_Simulation.ipynb +++ b/docs/source/tutorials/11_Dynamic_Simulation.ipynb @@ -25,7 +25,7 @@ "\n", " - [Yalin Li](https://qsdsan.readthedocs.io/en/latest/CONTRIBUTING.html)\n", " \n", - "To run tutorials in your browser, go to this [Binder page](https://mybinder.org/v2/gh/QSD-Group/QSDsan/main?filepath=%2Fdocs%2Fsource%2Ftutorials).\n", + "To run tutorials in your browser, go to this [Binder page](https://mybinder.org/v2/gh/QSD-Group/QSDsan-env/main?urlpath=git-pull%3Frepo%3Dhttps%253A%252F%252Fgithub.com%252FQSD-group%252FQSDsan%26urlpath%3Dtree%252FQSDsan%252Fdocs%252Fsource%252Ftutorials%26branch%3Dmain).\n", " \n", "You can also watch a video demo on [YouTube](https://youtu.be/1Rr1QxUiE5k) (subscriptions & likes appreciated!)." ] @@ -255,10 +255,10 @@ "\n", "\n", "\n", + "Flat bottom circular clarifier->121356496865 -->\n", "\n", "C1\n", - "Flat bottom circular clarifier:c->77295603618:w\n", + "Flat bottom circular clarifier:c->121356496865:w\n", "\n", "\n", " effluent\n", @@ -266,20 +266,20 @@ "\n", "\n", "\n", + "Flat bottom circular clarifier->121356496705 -->\n", "\n", "C1\n", - "Flat bottom circular clarifier:c->77295603938:w\n", + "Flat bottom circular clarifier:c->121356496705:w\n", "\n", "\n", " WAS\n", "\n", "\n", "\n", - "\n", "\n", - "77280229462:e->A1\n", + "<title>121356497265:e->A1\n", "CSTR:c\n", "\n", "\n", "\n", "\n", - "\n", + "\n", "\n", - "77280229462\n", + "121356497265\n", "\n", "\n", - "\n", + "\n", "\n", - "77295603618\n", + "121356496865\n", "\n", "\n", - "\n", + "\n", "\n", - "77295603938\n", + "121356496705\n", "\n", "\n", "\n", @@ -571,6 +571,7 @@ ], "source": [ "# Let's try simulating the BSM1 system from day 0 to day 50\n", + "# user shorter time or try changing method to 'RK23' (explicit solver) if it takes a long time\n", "sys.isdynamic = True\n", "sys.simulate(t_span=(0, 50), method='BDF', state_reset_hook='reset_cache')\n", "sys.show()" @@ -875,6 +876,7 @@ ], "source": [ "# Need to rerun the simulation before retrieving results\n", + "# user shorter time or try changing method to 'RK23' (explicit solver) if it takes a long time\n", "sys.simulate(t_span=(0, 50), method='BDF', state_reset_hook='reset_cache')\n", "fig, ax = C1.scope.plot_time_series([f'TSS{i}' for i in range(1,11)])" ] diff --git a/docs/source/tutorials/12_Anaerobic_Digestion_Model_No_1.ipynb b/docs/source/tutorials/12_Anaerobic_Digestion_Model_No_1.ipynb index 34e0cc52..b986a473 100644 --- a/docs/source/tutorials/12_Anaerobic_Digestion_Model_No_1.ipynb +++ b/docs/source/tutorials/12_Anaerobic_Digestion_Model_No_1.ipynb @@ -17,7 +17,7 @@ " - [2. System Setup](#s2)\n", " - [3. System Simulation](#s3)\n", " \n", - "To run tutorials in your browser, go to this [Binder page](https://mybinder.org/v2/gh/QSD-Group/QSDsan/main?filepath=%2Fdocs%2Fsource%2Ftutorials)." + "To run tutorials in your browser, go to this [Binder page](https://mybinder.org/v2/gh/QSD-Group/QSDsan-env/main?urlpath=git-pull%3Frepo%3Dhttps%253A%252F%252Fgithub.com%252FQSD-group%252FQSDsan%26urlpath%3Dtree%252FQSDsan%252Fdocs%252Fsource%252Ftutorials%26branch%3Dmain)." ] }, { diff --git a/docs/source/tutorials/1_Helpful_Basics.ipynb b/docs/source/tutorials/1_Helpful_Basics.ipynb index 6f5abeb0..1f4b8afa 100644 --- a/docs/source/tutorials/1_Helpful_Basics.ipynb +++ b/docs/source/tutorials/1_Helpful_Basics.ipynb @@ -21,7 +21,7 @@ "\n", " - [Yalin Li](https://qsdsan.readthedocs.io/en/latest/CONTRIBUTING.html)\n", " \n", - "To run tutorials in your browser, go to this [Binder page](https://mybinder.org/v2/gh/QSD-Group/QSDsan/main?filepath=%2Fdocs%2Fsource%2Ftutorials).\n", + "To run tutorials in your browser, go to this [Binder page](https://mybinder.org/v2/gh/QSD-Group/QSDsan-env/main?urlpath=git-pull%3Frepo%3Dhttps%253A%252F%252Fgithub.com%252FQSD-group%252FQSDsan%26urlpath%3Dtree%252FQSDsan%252Fdocs%252Fsource%252Ftutorials%26branch%3Dmain).\n", " \n", "You can also watch a video demo on [YouTube](https://www.youtube.com/watch?v=g8mXWycdi4E) (subscriptions & likes appreciated!)." ] diff --git a/docs/source/tutorials/2_Component.ipynb b/docs/source/tutorials/2_Component.ipynb index 54c80ae2..078db8c2 100644 --- a/docs/source/tutorials/2_Component.ipynb +++ b/docs/source/tutorials/2_Component.ipynb @@ -22,7 +22,7 @@ "\n", " - [Tori Morgan](https://qsdsan.readthedocs.io/en/latest/authors/Tori_Morgan.html)\n", " \n", - "To run tutorials in your browser, go to this [Binder page](https://mybinder.org/v2/gh/QSD-Group/QSDsan/main?filepath=%2Fdocs%2Fsource%2Ftutorials).\n", + "To run tutorials in your browser, go to this [Binder page](https://mybinder.org/v2/gh/QSD-Group/QSDsan-env/main?urlpath=git-pull%3Frepo%3Dhttps%253A%252F%252Fgithub.com%252FQSD-group%252FQSDsan%26urlpath%3Dtree%252FQSDsan%252Fdocs%252Fsource%252Ftutorials%26branch%3Dmain).\n", "\n", "You can also watch a video demo on [YouTube](https://www.youtube.com/watch?v=1OlGsjbqUX8) (subscriptions & likes appreciated!)." ] diff --git a/docs/source/tutorials/3_WasteStream.ipynb b/docs/source/tutorials/3_WasteStream.ipynb index 6b37883e..8434a853 100644 --- a/docs/source/tutorials/3_WasteStream.ipynb +++ b/docs/source/tutorials/3_WasteStream.ipynb @@ -20,7 +20,7 @@ "\n", " - [Hannah Lohman](https://qsdsan.readthedocs.io/en/latest/authors/Hannah_Lohman.html)\n", " \n", - "To run tutorials in your browser, go to this [Binder page](https://mybinder.org/v2/gh/QSD-Group/QSDsan/main?filepath=%2Fdocs%2Fsource%2Ftutorials).\n", + "To run tutorials in your browser, go to this [Binder page](https://mybinder.org/v2/gh/QSD-Group/QSDsan-env/main?urlpath=git-pull%3Frepo%3Dhttps%253A%252F%252Fgithub.com%252FQSD-group%252FQSDsan%26urlpath%3Dtree%252FQSDsan%252Fdocs%252Fsource%252Ftutorials%26branch%3Dmain).\n", "\n", "You can also watch a video demo on [YouTube](https://youtu.be/yCOZ0F6E1Sw) (subscriptions & likes appreciated!)." ] diff --git a/docs/source/tutorials/4_SanUnit_basic.ipynb b/docs/source/tutorials/4_SanUnit_basic.ipynb index 54eb061e..7837358c 100644 --- a/docs/source/tutorials/4_SanUnit_basic.ipynb +++ b/docs/source/tutorials/4_SanUnit_basic.ipynb @@ -19,7 +19,7 @@ "\n", " - [Tori Morgan](https://qsdsan.readthedocs.io/en/latest/CONTRIBUTING.html)\n", " \n", - "To run tutorials in your browser, go to this [Binder page](https://mybinder.org/v2/gh/QSD-Group/QSDsan/main?filepath=%2Fdocs%2Fsource%2Ftutorials).\n", + "To run tutorials in your browser, go to this [Binder page](https://mybinder.org/v2/gh/QSD-Group/QSDsan-env/main?urlpath=git-pull%3Frepo%3Dhttps%253A%252F%252Fgithub.com%252FQSD-group%252FQSDsan%26urlpath%3Dtree%252FQSDsan%252Fdocs%252Fsource%252Ftutorials%26branch%3Dmain).\n", "\n", "You can also watch a video demo on [YouTube](https://youtu.be/s9zr0rCX3UY) (subscriptions & likes appreciated!)." ] diff --git a/docs/source/tutorials/5_SanUnit_advanced.ipynb b/docs/source/tutorials/5_SanUnit_advanced.ipynb index e97d0a3a..7c0a4179 100644 --- a/docs/source/tutorials/5_SanUnit_advanced.ipynb +++ b/docs/source/tutorials/5_SanUnit_advanced.ipynb @@ -21,7 +21,7 @@ "\n", " - [Hannah Lohman](https://qsdsan.readthedocs.io/en/latest/CONTRIBUTING.html)\n", " \n", - "To run tutorials in your browser, go to this [Binder page](https://mybinder.org/v2/gh/QSD-Group/QSDsan/main?filepath=%2Fdocs%2Fsource%2Ftutorials).\n", + "To run tutorials in your browser, go to this [Binder page](https://mybinder.org/v2/gh/QSD-Group/QSDsan-env/main?urlpath=git-pull%3Frepo%3Dhttps%253A%252F%252Fgithub.com%252FQSD-group%252FQSDsan%26urlpath%3Dtree%252FQSDsan%252Fdocs%252Fsource%252Ftutorials%26branch%3Dmain).\n", "\n", "You can also watch a video demo on [YouTube](https://youtu.be/G20J2U8g7Dg) (subscriptions & likes appreciated!)." ] diff --git a/docs/source/tutorials/6_System.ipynb b/docs/source/tutorials/6_System.ipynb index 1722504b..b95c555a 100644 --- a/docs/source/tutorials/6_System.ipynb +++ b/docs/source/tutorials/6_System.ipynb @@ -19,7 +19,7 @@ "\n", " - [Tori Morgan](https://qsdsan.readthedocs.io/en/latest/CONTRIBUTING.html)\n", "\n", - "To run tutorials in your browser, go to this [Binder page](https://mybinder.org/v2/gh/QSD-Group/QSDsan/main?filepath=%2Fdocs%2Fsource%2Ftutorials).\n", + "To run tutorials in your browser, go to this [Binder page](https://mybinder.org/v2/gh/QSD-Group/QSDsan-env/main?urlpath=git-pull%3Frepo%3Dhttps%253A%252F%252Fgithub.com%252FQSD-group%252FQSDsan%26urlpath%3Dtree%252FQSDsan%252Fdocs%252Fsource%252Ftutorials%26branch%3Dmain).\n", "\n", "You can also watch a video demo on [YouTube](https://youtu.be/iIx28JkNjQ8) (subscriptions & likes appreciated!)." ] diff --git a/docs/source/tutorials/7_TEA.ipynb b/docs/source/tutorials/7_TEA.ipynb index 184d10c5..cfcdb544 100755 --- a/docs/source/tutorials/7_TEA.ipynb +++ b/docs/source/tutorials/7_TEA.ipynb @@ -19,7 +19,7 @@ "\n", " - [Hannah Lohman](https://qsdsan.readthedocs.io/en/latest/CONTRIBUTING.html)\n", "\n", - "To run tutorials in your browser, go to this [Binder page](https://mybinder.org/v2/gh/QSD-Group/QSDsan/main?filepath=%2Fdocs%2Fsource%2Ftutorials).\n", + "To run tutorials in your browser, go to this [Binder page](https://mybinder.org/v2/gh/QSD-Group/QSDsan-env/main?urlpath=git-pull%3Frepo%3Dhttps%253A%252F%252Fgithub.com%252FQSD-group%252FQSDsan%26urlpath%3Dtree%252FQSDsan%252Fdocs%252Fsource%252Ftutorials%26branch%3Dmain).\n", "\n", "You can also watch a video demo on [YouTube](https://youtu.be/v3qNNZypTKY) (subscriptions & likes appreciated!)." ] diff --git a/docs/source/tutorials/8_LCA.ipynb b/docs/source/tutorials/8_LCA.ipynb index 2e67c6f0..998c86a0 100644 --- a/docs/source/tutorials/8_LCA.ipynb +++ b/docs/source/tutorials/8_LCA.ipynb @@ -21,7 +21,7 @@ "\n", " - [Tori Morgan](https://qsdsan.readthedocs.io/en/latest/CONTRIBUTING.html)\n", "\n", - "To run tutorials in your browser, go to this [Binder page](https://mybinder.org/v2/gh/QSD-Group/QSDsan/main?filepath=%2Fdocs%2Fsource%2Ftutorials).\n", + "To run tutorials in your browser, go to this [Binder page](https://mybinder.org/v2/gh/QSD-Group/QSDsan-env/main?urlpath=git-pull%3Frepo%3Dhttps%253A%252F%252Fgithub.com%252FQSD-group%252FQSDsan%26urlpath%3Dtree%252FQSDsan%252Fdocs%252Fsource%252Ftutorials%26branch%3Dmain).\n", "\n", "You can also watch a video demo on [YouTube](https://youtu.be/ULmFYO8nTrM) (subscriptions & likes appreciated!)." ] diff --git a/docs/source/tutorials/9_Uncertainty_and_Sensitivity_Analyses.ipynb b/docs/source/tutorials/9_Uncertainty_and_Sensitivity_Analyses.ipynb index df4a4e32..97c51a74 100644 --- a/docs/source/tutorials/9_Uncertainty_and_Sensitivity_Analyses.ipynb +++ b/docs/source/tutorials/9_Uncertainty_and_Sensitivity_Analyses.ipynb @@ -20,7 +20,7 @@ "\n", " - [Hannah Lohman](https://qsdsan.readthedocs.io/en/latest/CONTRIBUTING.html)\n", "\n", - "To run tutorials in your browser, go to this [Binder page](https://mybinder.org/v2/gh/QSD-Group/QSDsan/main?filepath=%2Fdocs%2Fsource%2Ftutorials).\n", + "To run tutorials in your browser, go to this [Binder page](https://mybinder.org/v2/gh/QSD-Group/QSDsan-env/main?urlpath=git-pull%3Frepo%3Dhttps%253A%252F%252Fgithub.com%252FQSD-group%252FQSDsan%26urlpath%3Dtree%252FQSDsan%252Fdocs%252Fsource%252Ftutorials%26branch%3Dmain).\n", "\n", "You can also watch a video demo on [YouTube](https://youtu.be/_pIfUEda2jc) (subscriptions & likes appreciated!)." ]