Skip to content

Commit 8182ff9

Browse files
hdrakehdrake
authored
Merge pull request MOM6-community#43 from hdrake/add-docs
Fixed header levels to satisfy sphinx
2 parents d553813 + f9bf0d8 commit 8182ff9

5 files changed

Lines changed: 126 additions & 134 deletions

‎examples/1_creating_an_OSNAP_section.ipynb‎

Lines changed: 40 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,33 @@
11
{
22
"cells": [
33
{
4-
"cell_type": "code",
5-
"execution_count": 1,
4+
"cell_type": "markdown",
5+
"metadata": {},
6+
"source": [
7+
"# Computing velocity-grid following sections with `sectionate`\n",
8+
"\n",
9+
"In this example, we use the `sectionate.grid_section` function to find the indices for the series of grid cell faces (corresponding to velocity points on an Arakawa \"C-grid\" model such as MOM6) that best approximate a hydrographic section input by the user. In this case, we consider both the West and East sections of the *Overturning of the Subpolar North Atlantic (OSNAP)* observational program.\n",
10+
"\n",
11+
"We consider both cases of MOM6's horizontal grid configurations: non-symmetric (excluding the cell faces at the western and southern edges of the domain; also used in MOM5 and the MITgcm C-grids) and symmetric (including all tracer cell faces)."
12+
]
13+
},
14+
{
15+
"cell_type": "markdown",
616
"metadata": {},
7-
"outputs": [],
817
"source": [
9-
"%load_ext autoreload\n",
10-
"%autoreload 2"
18+
"## Import packages"
1119
]
1220
},
1321
{
1422
"cell_type": "code",
15-
"execution_count": 2,
23+
"execution_count": 1,
1624
"metadata": {},
1725
"outputs": [
1826
{
1927
"name": "stdout",
2028
"output_type": "stream",
2129
"text": [
22-
"Sectionate version: 0.5.0\n"
30+
"Sectionate version: 0.3.3\n"
2331
]
2432
}
2533
],
@@ -33,17 +41,6 @@
3341
"print(f\"Sectionate version: {sectionate.__version__}\")"
3442
]
3543
},
36-
{
37-
"cell_type": "markdown",
38-
"metadata": {},
39-
"source": [
40-
"# Computing velocity-grid following sections with `sectionate`\n",
41-
"\n",
42-
"In this example, we use the `sectionate.grid_section` function to find the indices for the series of grid cell faces (corresponding to velocity points on an Arakawa \"C-grid\" model such as MOM6) that best approximate a hydrographic section input by the user. In this case, we consider both the West and East sections of the *Overturning of the Subpolar North Atlantic (OSNAP)* observational program.\n",
43-
"\n",
44-
"We consider both cases of MOM6's horizontal grid configurations: non-symmetric (excluding the cell faces at the western and southern edges of the domain; also used in MOM5 and the MITgcm C-grids) and symmetric (including all tracer cell faces)."
45-
]
46-
},
4744
{
4845
"cell_type": "markdown",
4946
"metadata": {},
@@ -67,7 +64,7 @@
6764
},
6865
{
6966
"cell_type": "code",
70-
"execution_count": 3,
67+
"execution_count": 2,
7168
"metadata": {},
7269
"outputs": [
7370
{
@@ -108,7 +105,7 @@
108105
},
109106
{
110107
"cell_type": "code",
111-
"execution_count": 4,
108+
"execution_count": 3,
112109
"metadata": {},
113110
"outputs": [],
114111
"source": [
@@ -126,7 +123,7 @@
126123
},
127124
{
128125
"cell_type": "code",
129-
"execution_count": 5,
126+
"execution_count": 4,
130127
"metadata": {},
131128
"outputs": [],
132129
"source": [
@@ -140,7 +137,7 @@
140137
},
141138
{
142139
"cell_type": "code",
143-
"execution_count": 6,
140+
"execution_count": 5,
144141
"metadata": {},
145142
"outputs": [
146143
{
@@ -184,7 +181,7 @@
184181
},
185182
{
186183
"cell_type": "code",
187-
"execution_count": 7,
184+
"execution_count": 6,
188185
"metadata": {},
189186
"outputs": [],
190187
"source": [
@@ -206,7 +203,7 @@
206203
},
207204
{
208205
"cell_type": "code",
209-
"execution_count": 8,
206+
"execution_count": 7,
210207
"metadata": {},
211208
"outputs": [
212209
{
@@ -245,7 +242,7 @@
245242
"tags": []
246243
},
247244
"source": [
248-
"### 2. Symmetric grid example (MOM6)"
245+
"### B) Symmetric grid example (MOM6)"
249246
]
250247
},
251248
{
@@ -257,7 +254,7 @@
257254
},
258255
{
259256
"cell_type": "code",
260-
"execution_count": 9,
257+
"execution_count": 8,
261258
"metadata": {},
262259
"outputs": [],
263260
"source": [
@@ -277,7 +274,7 @@
277274
},
278275
{
279276
"cell_type": "code",
280-
"execution_count": 10,
277+
"execution_count": 9,
281278
"metadata": {},
282279
"outputs": [],
283280
"source": [
@@ -297,7 +294,7 @@
297294
},
298295
{
299296
"cell_type": "code",
300-
"execution_count": 11,
297+
"execution_count": 10,
301298
"metadata": {},
302299
"outputs": [],
303300
"source": [
@@ -311,7 +308,7 @@
311308
},
312309
{
313310
"cell_type": "code",
314-
"execution_count": 12,
311+
"execution_count": 11,
315312
"metadata": {},
316313
"outputs": [
317314
{
@@ -347,7 +344,7 @@
347344
},
348345
{
349346
"cell_type": "code",
350-
"execution_count": 13,
347+
"execution_count": 12,
351348
"metadata": {},
352349
"outputs": [],
353350
"source": [
@@ -360,7 +357,7 @@
360357
},
361358
{
362359
"cell_type": "code",
363-
"execution_count": 14,
360+
"execution_count": 13,
364361
"metadata": {},
365362
"outputs": [
366363
{
@@ -369,7 +366,7 @@
369366
"(np.float64(-50.0), np.float64(0.0), np.float64(51.0), np.float64(67.0))"
370367
]
371368
},
372-
"execution_count": 14,
369+
"execution_count": 13,
373370
"metadata": {},
374371
"output_type": "execute_result"
375372
},
@@ -429,7 +426,7 @@
429426
},
430427
{
431428
"cell_type": "code",
432-
"execution_count": 15,
429+
"execution_count": 14,
433430
"metadata": {},
434431
"outputs": [
435432
{
@@ -486,7 +483,7 @@
486483
},
487484
{
488485
"cell_type": "code",
489-
"execution_count": 16,
486+
"execution_count": 15,
490487
"metadata": {},
491488
"outputs": [
492489
{
@@ -512,7 +509,7 @@
512509
" 'Western Europe']"
513510
]
514511
},
515-
"execution_count": 16,
512+
"execution_count": 15,
516513
"metadata": {},
517514
"output_type": "execute_result"
518515
}
@@ -530,7 +527,7 @@
530527
},
531528
{
532529
"cell_type": "code",
533-
"execution_count": 17,
530+
"execution_count": 16,
534531
"metadata": {},
535532
"outputs": [
536533
{
@@ -581,7 +578,7 @@
581578
},
582579
{
583580
"cell_type": "code",
584-
"execution_count": 18,
581+
"execution_count": 17,
585582
"metadata": {},
586583
"outputs": [
587584
{
@@ -617,7 +614,7 @@
617614
},
618615
{
619616
"cell_type": "code",
620-
"execution_count": 19,
617+
"execution_count": 18,
621618
"metadata": {},
622619
"outputs": [],
623620
"source": [
@@ -631,7 +628,7 @@
631628
},
632629
{
633630
"cell_type": "code",
634-
"execution_count": 20,
631+
"execution_count": 19,
635632
"metadata": {},
636633
"outputs": [
637634
{
@@ -676,7 +673,7 @@
676673
},
677674
{
678675
"cell_type": "code",
679-
"execution_count": 21,
676+
"execution_count": 20,
680677
"metadata": {},
681678
"outputs": [
682679
{
@@ -697,7 +694,7 @@
697694
" - Section(OSNAP East, [(-44.0, 64.0), (-42.0, 60.5), (-31.0, 59.0), (-28.0, 58.25), (-15.0, 58.0), (-12.5, 57.5), (-9.5, 57.25), (-5.0, 56.75)])"
698695
]
699696
},
700-
"execution_count": 21,
697+
"execution_count": 20,
701698
"metadata": {},
702699
"output_type": "execute_result"
703700
}
@@ -719,7 +716,7 @@
719716
},
720717
{
721718
"cell_type": "code",
722-
"execution_count": 22,
719+
"execution_count": 21,
723720
"metadata": {},
724721
"outputs": [],
725722
"source": [
@@ -739,7 +736,7 @@
739736
},
740737
{
741738
"cell_type": "code",
742-
"execution_count": 23,
739+
"execution_count": 22,
743740
"metadata": {},
744741
"outputs": [
745742
{

0 commit comments

Comments
 (0)