Skip to content

Commit

Permalink
update binder links in tutorials, add a small note in dynamic simulation
Browse files Browse the repository at this point in the history
  • Loading branch information
@yalinli2
yalinli2 committed Oct 22, 2023
1 parent d988ea3 commit 9af67d5
Show file tree
Hide file tree
Showing 13 changed files with 57 additions and 26 deletions.
33 changes: 31 additions & 2 deletions docs/source/tutorials/0_Quick_Overview.ipynb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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)."
]
},
{
Expand Down Expand Up @@ -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,
Expand Down
2 changes: 1 addition & 1 deletion docs/source/tutorials/10_Process.ipynb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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!)."
]
Expand Down
28 changes: 15 additions & 13 deletions docs/source/tutorials/11_Dynamic_Simulation.ipynb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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!)."
]
Expand Down Expand Up @@ -255,31 +255,31 @@
"</g>\n",
"</g>\n",
"<!-- C1\n",
"Flat bottom circular clarifier&#45;&gt;77295603618 -->\n",
"Flat bottom circular clarifier&#45;&gt;121356496865 -->\n",
"<g id=\"edge6\" class=\"edge\">\n",
"<title>C1\n",
"Flat bottom circular clarifier:c-&gt;77295603618:w</title>\n",
"Flat bottom circular clarifier:c-&gt;121356496865:w</title>\n",
"<path fill=\"none\" stroke=\"#90918e\" stroke-dasharray=\"5,2\" d=\"M820.76,-56.51C843.43,-60.27 867.73,-63 890.5,-63\"/>\n",
"<g id=\"a_edge6-label\"><a xlink:title=\"(empty)\">\n",
"<text text-anchor=\"middle\" x=\"855\" y=\"-66.8\" font-family=\"Arial\" font-size=\"14.00\" fill=\"#90918e\"> effluent</text>\n",
"</a>\n",
"</g>\n",
"</g>\n",
"<!-- C1\n",
"Flat bottom circular clarifier&#45;&gt;77295603938 -->\n",
"Flat bottom circular clarifier&#45;&gt;121356496705 -->\n",
"<g id=\"edge10\" class=\"edge\">\n",
"<title>C1\n",
"Flat bottom circular clarifier:c-&gt;77295603938:w</title>\n",
"Flat bottom circular clarifier:c-&gt;121356496705:w</title>\n",
"<path fill=\"none\" stroke=\"#90918e\" stroke-dasharray=\"5,2\" d=\"M820.76,-13.49C843.43,-9.73 867.73,-7 890.5,-7\"/>\n",
"<g id=\"a_edge10-label\"><a xlink:title=\"(empty)\">\n",
"<text text-anchor=\"middle\" x=\"855\" y=\"-15.8\" font-family=\"Arial\" font-size=\"14.00\" fill=\"#90918e\"> WAS</text>\n",
"</a>\n",
"</g>\n",
"</g>\n",
"<!-- 77280229462&#45;&gt;A1\n",
"<!-- 121356497265&#45;&gt;A1\n",
"CSTR -->\n",
"<g id=\"edge1\" class=\"edge\">\n",
"<title>77280229462:e-&gt;A1\n",
"<title>121356497265:e-&gt;A1\n",
"CSTR:c</title>\n",
"<path fill=\"none\" stroke=\"#90918e\" d=\"M11,-96C42.14,-96 77.9,-96 101.82,-96\"/>\n",
"<g id=\"a_edge1-label\"><a xlink:title=\"Temperature: 293.15 K\n",
Expand Down Expand Up @@ -361,19 +361,19 @@
"</a>\n",
"</g>\n",
"</g>\n",
"<!-- 77280229462 -->\n",
"<!-- 121356497265 -->\n",
"<g id=\"node7\" class=\"node\">\n",
"<title>77280229462</title>\n",
"<title>121356497265</title>\n",
"<polygon fill=\"#f98f60\" stroke=\"#90918e\" points=\"5.5,-101.5 0,-96 5.5,-90.5 11,-96 5.5,-101.5\"/>\n",
"</g>\n",
"<!-- 77295603618 -->\n",
"<!-- 121356496865 -->\n",
"<g id=\"node8\" class=\"node\">\n",
"<title>77295603618</title>\n",
"<title>121356496865</title>\n",
"<polygon fill=\"#f98f60\" stroke=\"#90918e\" points=\"900,-63 891.75,-70 891.75,-56 900,-63\"/>\n",
"</g>\n",
"<!-- 77295603938 -->\n",
"<!-- 121356496705 -->\n",
"<g id=\"node9\" class=\"node\">\n",
"<title>77295603938</title>\n",
"<title>121356496705</title>\n",
"<polygon fill=\"#f98f60\" stroke=\"#90918e\" points=\"900,-7 891.75,-14 891.75,0 900,-7\"/>\n",
"</g>\n",
"</g>\n",
Expand Down Expand Up @@ -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()"
Expand Down Expand Up @@ -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)])"
]
Expand Down
2 changes: 1 addition & 1 deletion docs/source/tutorials/12_Anaerobic_Digestion_Model_No_1.ipynb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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)."
]
},
{
Expand Down
2 changes: 1 addition & 1 deletion docs/source/tutorials/1_Helpful_Basics.ipynb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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!)."
]
Expand Down
2 changes: 1 addition & 1 deletion docs/source/tutorials/2_Component.ipynb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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!)."
]
Expand Down
2 changes: 1 addition & 1 deletion docs/source/tutorials/3_WasteStream.ipynb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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!)."
]
Expand Down
2 changes: 1 addition & 1 deletion docs/source/tutorials/4_SanUnit_basic.ipynb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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!)."
]
Expand Down
2 changes: 1 addition & 1 deletion docs/source/tutorials/5_SanUnit_advanced.ipynb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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!)."
]
Expand Down
2 changes: 1 addition & 1 deletion docs/source/tutorials/6_System.ipynb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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!)."
]
Expand Down
2 changes: 1 addition & 1 deletion docs/source/tutorials/7_TEA.ipynb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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!)."
]
Expand Down
2 changes: 1 addition & 1 deletion docs/source/tutorials/8_LCA.ipynb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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!)."
]
Expand Down
2 changes: 1 addition & 1 deletion docs/source/tutorials/9_Uncertainty_and_Sensitivity_Analyses.ipynb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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!)."
]
Expand Down

0 comments on commit 9af67d5

Please sign in to comment.