Skip to content

Commit 293d846

Browse files
committed
add developers.md and data description
1 parent 259a3ec commit 293d846

File tree

3 files changed

+51
-4
lines changed

3 files changed

+51
-4
lines changed

developers.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# NSDF Tutorial Codespaces Errors
2+
3+
This Google Docs document describes the possible error with the NSDF tutorial using Codespaces.
4+
5+
---
6+
7+
## Max Number of Codespaces Error
8+
9+
**Error:**
10+
> You have reached the maximum number of running codespaces.
11+
12+
**Solution:**
13+
Go to [https://github.com/codespaces](https://github.com/codespaces)
14+
Delete old codespaces and wait for a few minutes.
15+
16+
---
17+
18+
## Dev Configuration Error
19+
20+
**Error:**
21+
> codespace was not built properly; run ‘build’ or docker error
22+
23+
### Solution 1: Relaunch Codespace
24+
1. Exit the codespace
25+
2. Set the region to **‘US EAST’**
26+
3. Rerun the codespace
27+
28+
### Solution 2: Trigger Action
29+
If the first solution doesn’t work, try pushing dummy commits to trigger the action workflow. This will build a new Docker container and push it. It should take approximately 6 minutes.
30+
31+
> ⚠️ Note: If you rerun the submitted action/jobs, it may or may not work (50-50 in my experience). So, it's better to submit a new one.
32+
> Close the codespaces and start a new one.
33+
34+
---
35+
36+
## Sharing Access Without GitHub or Slides
37+
38+
If users don't have access to the PDF slide or GitHub link:
39+
40+
- Use [TinyURL](https://tinyurl.com/) to shorten the URL
41+
- Share the shortened link using the projector on the big screen

hands-on/session II/1.Tutorial.ipynb

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -972,7 +972,7 @@
972972
"metadata": {},
973973
"outputs": [],
974974
"source": [
975-
"%%capture\n",
975+
"%%capture # donot remove. This prevents the debugging information that openvisuspy prints by default.\n",
976976
"## Stop this cell before running another visualization dashboard\n",
977977
"!python -m panel serve Materials/openvisuspy/src/openvisuspy/dashboards --log-file \"Materials/files/log.log\" --dev --allow-websocket-origin='*' --address=\"{ADDRESS}\" --port \"{PORT}\" --args \"{URL}\" "
978978
]
@@ -1021,7 +1021,7 @@
10211021
"metadata": {},
10221022
"outputs": [],
10231023
"source": [
1024-
"%%capture\n",
1024+
"%%capture # donot remove. This prevents the debugging information that openvisuspy prints by default.\n",
10251025
"## Stop this cell before running another visualization dashboard\n",
10261026
"!python -m panel serve Materials/openvisuspy/src/openvisuspy/dashboards --log-file \"Materials/files/log.log\" --dev --allow-websocket-origin='*' --address=\"{ADDRESS}\" --port \"{PORT}\" --args \"{URL}\""
10271027
]
@@ -1063,7 +1063,7 @@
10631063
"metadata": {},
10641064
"outputs": [],
10651065
"source": [
1066-
"%%capture\n",
1066+
"%%capture # donot remove. This prevents the debugging information that openvisuspy prints by default.\n",
10671067
"## Stop this cell before running another visualization dashboard\n",
10681068
"!python -m panel serve Materials/openvisuspy/src/openvisuspy/dashboards --log-file \"Materials/files/log.log\" --dev --allow-websocket-origin='*' --address=\"{ADDRESS}\" --port \"{PORT}\" --args \"{URL}\""
10691069
]

hands-on/session III/3.Tutorial_PetascaleAnalysis.ipynb

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,13 @@
106106
"source": [
107107
"# Set your variable of interest\n",
108108
"\n",
109-
"variable='salt' # options are: u,v,w,salt,theta"
109+
"variable='salt' # options are: u,v,w,salt,theta\n",
110+
"\n",
111+
"#u: East-West Ocean Velocity\n",
112+
"#v: North-South Ocean Velocity\n",
113+
"#w: Vertical Ocean Velocity\n",
114+
"#theta: Ocean Temperature\n",
115+
"#salt: Ocean Salinity"
110116
]
111117
},
112118
{

0 commit comments

Comments
 (0)