Skip to content

Commit 4e1a79c

Browse files
ChitYanToeChitYanToe
committed
Fixing SWASH tutorial
1. Fixed the SWASH data files download in remote.py 2. Changed the source path of the SWASH files in the tutorial
1 parent 0364fd7 commit 4e1a79c

2 files changed

Lines changed: 46 additions & 30 deletions

File tree

‎docs/user_guide/examples/tutorial_swash.ipynb‎

Lines changed: 22 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -58,12 +58,12 @@
5858
"data": {
5959
"application/vnd.holoviews_exec.v0+json": "",
6060
"text/html": [
61-
"<div id='48eaae67-aca7-4ad9-8591-d742d6cc18b2'>\n",
62-
" <div id=\"dc520f81-7763-459a-881d-7270d655dec8\" data-root-id=\"48eaae67-aca7-4ad9-8591-d742d6cc18b2\" style=\"display: contents;\"></div>\n",
61+
"<div id='f0dc6f77-9e34-4bee-aeaa-a69cb9197888'>\n",
62+
" <div id=\"f6676d58-63b2-407c-b2de-94b50925e248\" data-root-id=\"f0dc6f77-9e34-4bee-aeaa-a69cb9197888\" style=\"display: contents;\"></div>\n",
6363
"</div>\n",
6464
"<script type=\"application/javascript\">(function(root) {\n",
65-
" var docs_json = {\"dec8478e-adf3-47cb-a496-cb89b38f809e\":{\"version\":\"3.9.1\",\"title\":\"Bokeh Application\",\"config\":{\"type\":\"object\",\"name\":\"DocumentConfig\",\"id\":\"d4d2972a-01e0-4bed-91d8-072285877450\",\"attributes\":{\"notifications\":{\"type\":\"object\",\"name\":\"Notifications\",\"id\":\"39a8e2d5-1540-42fb-8dc4-368844b6c07f\"}}},\"roots\":[{\"type\":\"object\",\"name\":\"panel.models.browser.BrowserInfo\",\"id\":\"48eaae67-aca7-4ad9-8591-d742d6cc18b2\"},{\"type\":\"object\",\"name\":\"panel.models.comm_manager.CommManager\",\"id\":\"11fe8a9c-d3b6-4a48-936d-02f6f17119b5\",\"attributes\":{\"plot_id\":\"48eaae67-aca7-4ad9-8591-d742d6cc18b2\",\"comm_id\":\"e8a589c1822f40dd969946c3c08ee9c2\",\"client_comm_id\":\"fd22d8ab9e5d40e18a36bbcecc41447d\"}}],\"defs\":[{\"type\":\"model\",\"name\":\"ReactiveHTML1\"},{\"type\":\"model\",\"name\":\"FlexBox1\",\"properties\":[{\"name\":\"align_content\",\"kind\":\"Any\",\"default\":\"flex-start\"},{\"name\":\"align_items\",\"kind\":\"Any\",\"default\":\"flex-start\"},{\"name\":\"flex_direction\",\"kind\":\"Any\",\"default\":\"row\"},{\"name\":\"flex_wrap\",\"kind\":\"Any\",\"default\":\"wrap\"},{\"name\":\"gap\",\"kind\":\"Any\",\"default\":\"\"},{\"name\":\"justify_content\",\"kind\":\"Any\",\"default\":\"flex-start\"}]},{\"type\":\"model\",\"name\":\"FloatPanel1\",\"properties\":[{\"name\":\"config\",\"kind\":\"Any\",\"default\":{\"type\":\"map\"}},{\"name\":\"contained\",\"kind\":\"Any\",\"default\":true},{\"name\":\"position\",\"kind\":\"Any\",\"default\":\"right-top\"},{\"name\":\"offsetx\",\"kind\":\"Any\",\"default\":null},{\"name\":\"offsety\",\"kind\":\"Any\",\"default\":null},{\"name\":\"theme\",\"kind\":\"Any\",\"default\":\"primary\"},{\"name\":\"status\",\"kind\":\"Any\",\"default\":\"normalized\"}]},{\"type\":\"model\",\"name\":\"GridStack1\",\"properties\":[{\"name\":\"ncols\",\"kind\":\"Any\",\"default\":null},{\"name\":\"nrows\",\"kind\":\"Any\",\"default\":null},{\"name\":\"allow_resize\",\"kind\":\"Any\",\"default\":true},{\"name\":\"allow_drag\",\"kind\":\"Any\",\"default\":true},{\"name\":\"state\",\"kind\":\"Any\",\"default\":[]}]},{\"type\":\"model\",\"name\":\"drag1\",\"properties\":[{\"name\":\"slider_width\",\"kind\":\"Any\",\"default\":5},{\"name\":\"slider_color\",\"kind\":\"Any\",\"default\":\"black\"},{\"name\":\"start\",\"kind\":\"Any\",\"default\":0},{\"name\":\"end\",\"kind\":\"Any\",\"default\":100},{\"name\":\"value\",\"kind\":\"Any\",\"default\":50}]},{\"type\":\"model\",\"name\":\"click1\",\"properties\":[{\"name\":\"terminal_output\",\"kind\":\"Any\",\"default\":\"\"},{\"name\":\"debug_name\",\"kind\":\"Any\",\"default\":\"\"},{\"name\":\"clears\",\"kind\":\"Any\",\"default\":0}]},{\"type\":\"model\",\"name\":\"ReactiveESM1\",\"properties\":[{\"name\":\"esm_constants\",\"kind\":\"Any\",\"default\":{\"type\":\"map\"}}]},{\"type\":\"model\",\"name\":\"JSComponent1\",\"properties\":[{\"name\":\"esm_constants\",\"kind\":\"Any\",\"default\":{\"type\":\"map\"}}]},{\"type\":\"model\",\"name\":\"ReactComponent1\",\"properties\":[{\"name\":\"use_shadow_dom\",\"kind\":\"Any\",\"default\":true},{\"name\":\"esm_constants\",\"kind\":\"Any\",\"default\":{\"type\":\"map\"}}]},{\"type\":\"model\",\"name\":\"AnyWidgetComponent1\",\"properties\":[{\"name\":\"use_shadow_dom\",\"kind\":\"Any\",\"default\":true},{\"name\":\"esm_constants\",\"kind\":\"Any\",\"default\":{\"type\":\"map\"}}]},{\"type\":\"model\",\"name\":\"FastWrapper1\",\"properties\":[{\"name\":\"object\",\"kind\":\"Any\",\"default\":null},{\"name\":\"style\",\"kind\":\"Any\",\"default\":null}]},{\"type\":\"model\",\"name\":\"NotificationArea1\",\"properties\":[{\"name\":\"js_events\",\"kind\":\"Any\",\"default\":{\"type\":\"map\"}},{\"name\":\"max_notifications\",\"kind\":\"Any\",\"default\":5},{\"name\":\"notifications\",\"kind\":\"Any\",\"default\":[]},{\"name\":\"position\",\"kind\":\"Any\",\"default\":\"bottom-right\"},{\"name\":\"_clear\",\"kind\":\"Any\",\"default\":0},{\"name\":\"types\",\"kind\":\"Any\",\"default\":[{\"type\":\"map\",\"entries\":[[\"type\",\"warning\"],[\"background\",\"#ffc107\"],[\"icon\",{\"type\":\"map\",\"entries\":[[\"className\",\"fas fa-exclamation-triangle\"],[\"tagName\",\"i\"],[\"color\",\"white\"]]}]]},{\"type\":\"map\",\"entries\":[[\"type\",\"info\"],[\"background\",\"#007bff\"],[\"icon\",{\"type\":\"map\",\"entries\":[[\"className\",\"fas fa-info-circle\"],[\"tagName\",\"i\"],[\"color\",\"white\"]]}]]}]}]},{\"type\":\"model\",\"name\":\"Notification\",\"properties\":[{\"name\":\"background\",\"kind\":\"Any\",\"default\":null},{\"name\":\"duration\",\"kind\":\"Any\",\"default\":3000},{\"name\":\"icon\",\"kind\":\"Any\",\"default\":null},{\"name\":\"message\",\"kind\":\"Any\",\"default\":\"\"},{\"name\":\"notification_type\",\"kind\":\"Any\",\"default\":null},{\"name\":\"_rendered\",\"kind\":\"Any\",\"default\":false},{\"name\":\"_destroyed\",\"kind\":\"Any\",\"default\":false}]},{\"type\":\"model\",\"name\":\"TemplateActions1\",\"properties\":[{\"name\":\"open_modal\",\"kind\":\"Any\",\"default\":0},{\"name\":\"close_modal\",\"kind\":\"Any\",\"default\":0}]},{\"type\":\"model\",\"name\":\"BootstrapTemplateActions1\",\"properties\":[{\"name\":\"open_modal\",\"kind\":\"Any\",\"default\":0},{\"name\":\"close_modal\",\"kind\":\"Any\",\"default\":0}]},{\"type\":\"model\",\"name\":\"TemplateEditor1\",\"properties\":[{\"name\":\"layout\",\"kind\":\"Any\",\"default\":[]}]},{\"type\":\"model\",\"name\":\"MaterialTemplateActions1\",\"properties\":[{\"name\":\"open_modal\",\"kind\":\"Any\",\"default\":0},{\"name\":\"close_modal\",\"kind\":\"Any\",\"default\":0}]},{\"type\":\"model\",\"name\":\"request_value1\",\"properties\":[{\"name\":\"fill\",\"kind\":\"Any\",\"default\":\"none\"},{\"name\":\"_synced\",\"kind\":\"Any\",\"default\":null},{\"name\":\"_request_sync\",\"kind\":\"Any\",\"default\":0}]},{\"type\":\"model\",\"name\":\"holoviews.plotting.bokeh.raster.HoverModel\",\"properties\":[{\"name\":\"xy\",\"kind\":\"Any\",\"default\":null},{\"name\":\"data\",\"kind\":\"Any\",\"default\":null}]}]}};\n",
66-
" var render_items = [{\"docid\":\"dec8478e-adf3-47cb-a496-cb89b38f809e\",\"roots\":{\"48eaae67-aca7-4ad9-8591-d742d6cc18b2\":\"dc520f81-7763-459a-881d-7270d655dec8\"},\"root_ids\":[\"48eaae67-aca7-4ad9-8591-d742d6cc18b2\"]}];\n",
65+
" var docs_json = {\"9ce97755-6797-40f4-86a7-112f2609f6f5\":{\"version\":\"3.9.1\",\"title\":\"Bokeh Application\",\"config\":{\"type\":\"object\",\"name\":\"DocumentConfig\",\"id\":\"26006365-f5b0-4303-ba36-c088f5526031\",\"attributes\":{\"notifications\":{\"type\":\"object\",\"name\":\"Notifications\",\"id\":\"f1d8dfc2-5608-44d2-b707-cfbfe43ed285\"}}},\"roots\":[{\"type\":\"object\",\"name\":\"panel.models.browser.BrowserInfo\",\"id\":\"f0dc6f77-9e34-4bee-aeaa-a69cb9197888\"},{\"type\":\"object\",\"name\":\"panel.models.comm_manager.CommManager\",\"id\":\"e1dd11cc-39b6-458a-bde2-a63c90fa6f9e\",\"attributes\":{\"plot_id\":\"f0dc6f77-9e34-4bee-aeaa-a69cb9197888\",\"comm_id\":\"e697199c749d40e4a0c2e9bc7070bd3c\",\"client_comm_id\":\"a67cac75a81c4d9a8648d94d22dc0821\"}}],\"defs\":[{\"type\":\"model\",\"name\":\"ReactiveHTML1\"},{\"type\":\"model\",\"name\":\"FlexBox1\",\"properties\":[{\"name\":\"align_content\",\"kind\":\"Any\",\"default\":\"flex-start\"},{\"name\":\"align_items\",\"kind\":\"Any\",\"default\":\"flex-start\"},{\"name\":\"flex_direction\",\"kind\":\"Any\",\"default\":\"row\"},{\"name\":\"flex_wrap\",\"kind\":\"Any\",\"default\":\"wrap\"},{\"name\":\"gap\",\"kind\":\"Any\",\"default\":\"\"},{\"name\":\"justify_content\",\"kind\":\"Any\",\"default\":\"flex-start\"}]},{\"type\":\"model\",\"name\":\"FloatPanel1\",\"properties\":[{\"name\":\"config\",\"kind\":\"Any\",\"default\":{\"type\":\"map\"}},{\"name\":\"contained\",\"kind\":\"Any\",\"default\":true},{\"name\":\"position\",\"kind\":\"Any\",\"default\":\"right-top\"},{\"name\":\"offsetx\",\"kind\":\"Any\",\"default\":null},{\"name\":\"offsety\",\"kind\":\"Any\",\"default\":null},{\"name\":\"theme\",\"kind\":\"Any\",\"default\":\"primary\"},{\"name\":\"status\",\"kind\":\"Any\",\"default\":\"normalized\"}]},{\"type\":\"model\",\"name\":\"GridStack1\",\"properties\":[{\"name\":\"ncols\",\"kind\":\"Any\",\"default\":null},{\"name\":\"nrows\",\"kind\":\"Any\",\"default\":null},{\"name\":\"allow_resize\",\"kind\":\"Any\",\"default\":true},{\"name\":\"allow_drag\",\"kind\":\"Any\",\"default\":true},{\"name\":\"state\",\"kind\":\"Any\",\"default\":[]}]},{\"type\":\"model\",\"name\":\"drag1\",\"properties\":[{\"name\":\"slider_width\",\"kind\":\"Any\",\"default\":5},{\"name\":\"slider_color\",\"kind\":\"Any\",\"default\":\"black\"},{\"name\":\"start\",\"kind\":\"Any\",\"default\":0},{\"name\":\"end\",\"kind\":\"Any\",\"default\":100},{\"name\":\"value\",\"kind\":\"Any\",\"default\":50}]},{\"type\":\"model\",\"name\":\"click1\",\"properties\":[{\"name\":\"terminal_output\",\"kind\":\"Any\",\"default\":\"\"},{\"name\":\"debug_name\",\"kind\":\"Any\",\"default\":\"\"},{\"name\":\"clears\",\"kind\":\"Any\",\"default\":0}]},{\"type\":\"model\",\"name\":\"ReactiveESM1\",\"properties\":[{\"name\":\"esm_constants\",\"kind\":\"Any\",\"default\":{\"type\":\"map\"}}]},{\"type\":\"model\",\"name\":\"JSComponent1\",\"properties\":[{\"name\":\"esm_constants\",\"kind\":\"Any\",\"default\":{\"type\":\"map\"}}]},{\"type\":\"model\",\"name\":\"ReactComponent1\",\"properties\":[{\"name\":\"use_shadow_dom\",\"kind\":\"Any\",\"default\":true},{\"name\":\"esm_constants\",\"kind\":\"Any\",\"default\":{\"type\":\"map\"}}]},{\"type\":\"model\",\"name\":\"AnyWidgetComponent1\",\"properties\":[{\"name\":\"use_shadow_dom\",\"kind\":\"Any\",\"default\":true},{\"name\":\"esm_constants\",\"kind\":\"Any\",\"default\":{\"type\":\"map\"}}]},{\"type\":\"model\",\"name\":\"FastWrapper1\",\"properties\":[{\"name\":\"object\",\"kind\":\"Any\",\"default\":null},{\"name\":\"style\",\"kind\":\"Any\",\"default\":null}]},{\"type\":\"model\",\"name\":\"NotificationArea1\",\"properties\":[{\"name\":\"js_events\",\"kind\":\"Any\",\"default\":{\"type\":\"map\"}},{\"name\":\"max_notifications\",\"kind\":\"Any\",\"default\":5},{\"name\":\"notifications\",\"kind\":\"Any\",\"default\":[]},{\"name\":\"position\",\"kind\":\"Any\",\"default\":\"bottom-right\"},{\"name\":\"_clear\",\"kind\":\"Any\",\"default\":0},{\"name\":\"types\",\"kind\":\"Any\",\"default\":[{\"type\":\"map\",\"entries\":[[\"type\",\"warning\"],[\"background\",\"#ffc107\"],[\"icon\",{\"type\":\"map\",\"entries\":[[\"className\",\"fas fa-exclamation-triangle\"],[\"tagName\",\"i\"],[\"color\",\"white\"]]}]]},{\"type\":\"map\",\"entries\":[[\"type\",\"info\"],[\"background\",\"#007bff\"],[\"icon\",{\"type\":\"map\",\"entries\":[[\"className\",\"fas fa-info-circle\"],[\"tagName\",\"i\"],[\"color\",\"white\"]]}]]}]}]},{\"type\":\"model\",\"name\":\"Notification\",\"properties\":[{\"name\":\"background\",\"kind\":\"Any\",\"default\":null},{\"name\":\"duration\",\"kind\":\"Any\",\"default\":3000},{\"name\":\"icon\",\"kind\":\"Any\",\"default\":null},{\"name\":\"message\",\"kind\":\"Any\",\"default\":\"\"},{\"name\":\"notification_type\",\"kind\":\"Any\",\"default\":null},{\"name\":\"_rendered\",\"kind\":\"Any\",\"default\":false},{\"name\":\"_destroyed\",\"kind\":\"Any\",\"default\":false}]},{\"type\":\"model\",\"name\":\"TemplateActions1\",\"properties\":[{\"name\":\"open_modal\",\"kind\":\"Any\",\"default\":0},{\"name\":\"close_modal\",\"kind\":\"Any\",\"default\":0}]},{\"type\":\"model\",\"name\":\"BootstrapTemplateActions1\",\"properties\":[{\"name\":\"open_modal\",\"kind\":\"Any\",\"default\":0},{\"name\":\"close_modal\",\"kind\":\"Any\",\"default\":0}]},{\"type\":\"model\",\"name\":\"TemplateEditor1\",\"properties\":[{\"name\":\"layout\",\"kind\":\"Any\",\"default\":[]}]},{\"type\":\"model\",\"name\":\"MaterialTemplateActions1\",\"properties\":[{\"name\":\"open_modal\",\"kind\":\"Any\",\"default\":0},{\"name\":\"close_modal\",\"kind\":\"Any\",\"default\":0}]},{\"type\":\"model\",\"name\":\"request_value1\",\"properties\":[{\"name\":\"fill\",\"kind\":\"Any\",\"default\":\"none\"},{\"name\":\"_synced\",\"kind\":\"Any\",\"default\":null},{\"name\":\"_request_sync\",\"kind\":\"Any\",\"default\":0}]},{\"type\":\"model\",\"name\":\"holoviews.plotting.bokeh.raster.HoverModel\",\"properties\":[{\"name\":\"xy\",\"kind\":\"Any\",\"default\":null},{\"name\":\"data\",\"kind\":\"Any\",\"default\":null}]}]}};\n",
66+
" var render_items = [{\"docid\":\"9ce97755-6797-40f4-86a7-112f2609f6f5\",\"roots\":{\"f0dc6f77-9e34-4bee-aeaa-a69cb9197888\":\"f6676d58-63b2-407c-b2de-94b50925e248\"},\"root_ids\":[\"f0dc6f77-9e34-4bee-aeaa-a69cb9197888\"]}];\n",
6767
" var docs = Object.values(docs_json)\n",
6868
" if (!docs) {\n",
6969
" return\n",
@@ -132,7 +132,7 @@
132132
},
133133
"metadata": {
134134
"application/vnd.holoviews_exec.v0+json": {
135-
"id": "48eaae67-aca7-4ad9-8591-d742d6cc18b2"
135+
"id": "f0dc6f77-9e34-4bee-aeaa-a69cb9197888"
136136
}
137137
},
138138
"output_type": "display_data"
@@ -181,7 +181,7 @@
181181
"name": "stderr",
182182
"output_type": "stream",
183183
"text": [
184-
"/var/folders/2v/5l455kn13xq41s2x_zl1chlr0000gn/T/ipykernel_82001/1470123736.py:7: UserWarning: This is an alpha version of Parcels v4. The API is not stable and may change without deprecation warnings.\n",
184+
"/var/folders/2v/5l455kn13xq41s2x_zl1chlr0000gn/T/ipykernel_87891/208841806.py:7: UserWarning: This is an alpha version of Parcels v4. The API is not stable and may change without deprecation warnings.\n",
185185
" import parcels\n"
186186
]
187187
}
@@ -194,7 +194,8 @@
194194
"import xarray as xr\n",
195195
"\n",
196196
"import parcels\n",
197-
"import parcels.tutorial\n"
197+
"import parcels.tutorial\n",
198+
"import glob\n"
198199
]
199200
},
200201
{
@@ -207,33 +208,35 @@
207208
"name": "stdout",
208209
"output_type": "stream",
209210
"text": [
210-
"/Users/YanTo001/Library/Caches/parcels/data-matlab/F1GRD.mat\n"
211+
"['/Users/YanTo001/Library/Caches/parcels/data-matlab/F1ALL.mat', '/Users/YanTo001/Library/Caches/parcels/data-matlab/F1GRD.mat']\n"
211212
]
212213
}
213214
],
214215
"source": [
215-
"mat_files = parcels.tutorial.open_dataset(\n",
216+
"grid_file = parcels.tutorial.open_dataset(\n",
216217
" \"SWASH_data/data\", download_only=True\n",
217218
")\n",
218-
"print(mat_files)"
219+
"print(grid_file)\n"
219220
]
220221
},
221222
{
222223
"cell_type": "code",
223-
"execution_count": 9,
224+
"execution_count": 3,
224225
"id": "81c491ae",
225226
"metadata": {},
226227
"outputs": [],
227228
"source": [
228-
"grid_file = \"/Users/YanTo001/Documents/GitHub/parcels-data/data-matlab/F1GRD.mat\"#\"/Users/YanTo001/Library/Caches/parcels/data-matlab/F1GRD.mat\"\n",
229-
"result_file = \"/Users/YanTo001/Documents/GitHub/parcels-data/data-matlab/F1ALL.mat\"#\"/Users/YanTo001/Library/Caches/parcels/data-matlab/F1ALL.mat\"\n",
230-
"ds = parcels.convert.swash_to_sgrid(grid_file, result_file, total_depth=8.0)\n",
229+
"# grid_file = \"/Users/YanTo001/Documents/GitHub/parcels-data/data-matlab/F1GRD.mat\"#\"/Users/YanTo001/Library/Caches/parcels/data-matlab/F1GRD.mat\"\n",
230+
"# result_file = \"/Users/YanTo001/Documents/GitHub/parcels-data/data-matlab/F1ALL.mat\"#\"/Users/YanTo001/Library/Caches/parcels/data-matlab/F1ALL.mat\"\n",
231+
"# ds = parcels.convert.swash_to_sgrid(grid_file, result_file, total_depth=8.0)\n",
232+
"ds = parcels.convert.swash_to_sgrid(grid_file[1], grid_file[0], total_depth=8.0)\n",
233+
"\n",
231234
"fieldset = parcels.FieldSet.from_sgrid_conventions(ds)\n"
232235
]
233236
},
234237
{
235238
"cell_type": "code",
236-
"execution_count": 22,
239+
"execution_count": 5,
237240
"id": "7fd5d3d1",
238241
"metadata": {},
239242
"outputs": [
@@ -242,13 +245,7 @@
242245
"output_type": "stream",
243246
"text": [
244247
"INFO: Output files are stored in output-quickstart.parquet\n",
245-
"\n",
246-
"\u001b[A\n",
247-
"\u001b[A\n",
248-
"\u001b[A\n",
249-
"\u001b[A\n",
250-
"\u001b[A\n",
251-
"Integration time: 2026-06-01T00:00:15 100%|██████████| [00:00<00:00, 1151.08it/s]\n"
248+
"Integration time: 2026-06-01T00:00:15 100%|██████████| [00:00<00:00, 909.13it/s]\n"
252249
]
253250
}
254251
],
@@ -274,17 +271,17 @@
274271
},
275272
{
276273
"cell_type": "code",
277-
"execution_count": 23,
274+
"execution_count": 6,
278275
"id": "7933d20b",
279276
"metadata": {},
280277
"outputs": [
281278
{
282279
"data": {
283280
"text/plain": [
284-
"<matplotlib.collections.PathCollection at 0x339156e90>"
281+
"<matplotlib.collections.PathCollection at 0x337210a50>"
285282
]
286283
},
287-
"execution_count": 23,
284+
"execution_count": 6,
288285
"metadata": {},
289286
"output_type": "execute_result"
290287
},

0 commit comments

Comments
 (0)