Skip to content

Commit 6284db8

Browse files
EliEli
authored andcommitted
Edit and rebuild.
1 parent 7328141 commit 6284db8

1 file changed

Lines changed: 14 additions & 28 deletions

File tree

docsrc/notebooks/neighbor_fill.ipynb

Lines changed: 14 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,7 @@
66
"metadata": {},
77
"source": [
88
"\n",
9-
"# Filling Non-tidal Quantities Based on a Neighbor\n",
10-
"\n",
11-
"**neighbor_fill.ipynb — user guide** \n",
12-
"*Generated 2025-11-02 05:52 UTC*\n",
13-
"\n",
14-
"This notebook is a practical, self-contained guide for filling gaps in a target time series using a neighboring series\n",
15-
"(e.g., **San Joaquin at Vernalis** (VNS) flow filled from **Mossdale Bridge** (MSD) subtidal flow), the example we use here.\n",
16-
"\n",
17-
"---\n"
9+
"# Filling Non-tidal Quantities Based on a Neighbor\n"
1810
]
1911
},
2012
{
@@ -55,18 +47,14 @@
5547
"\n",
5648
"## 2. Setup\n",
5749
"\n",
58-
"The code assumes your standard environment with `vtools`, `dms_datastore`, and `statsmodels`. \n",
59-
"If you're browsing the notebook without your environment, you can still read the narrative and formulas.\n",
60-
"\n",
61-
"> **Modules** \n",
62-
"> - Data & utilities: `vtools`, `vtools.data.gap` \n",
63-
"> - Gap filling: `vtools.functions.neighbor_fill.fill_from_neighbor` \n",
64-
"> - Optional data provider: `dms_datastore.read_multi.read_ts_repo`\n"
50+
"The code assumes your standard environment with `vtools`, `dms_datastore`, and by extension `statsmodels`. The first steps have to \n",
51+
"do with imports, acquisition etc.\n",
52+
"\n"
6553
]
6654
},
6755
{
6856
"cell_type": "code",
69-
"execution_count": 1,
57+
"execution_count": null,
7058
"id": "b8546bcb",
7159
"metadata": {},
7260
"outputs": [],
@@ -107,13 +95,14 @@
10795
},
10896
{
10997
"cell_type": "code",
110-
"execution_count": 2,
98+
"execution_count": null,
11199
"id": "26bf5859",
112100
"metadata": {},
113101
"outputs": [],
114102
"source": [
115103
"\n",
116-
"# You may replace this with a project-specific provider using dms_datastore.\n",
104+
"# These series are provided in the examples. You could replace this \n",
105+
"# with a project-specific provider using dms_datastore.\n",
117106
"# The function must return (target: Series, neighbor: Series|DataFrame, regime: Series|None),\n",
118107
"# aligned (or alignable) by time.\n",
119108
"def provide_example_data(start='2017-02-01', end='2022-12-01'):\n",
@@ -140,9 +129,6 @@
140129
"y, x, regime = provide_example_data()\n",
141130
"\n",
142131
"\n",
143-
"\n",
144-
"\n",
145-
"\n",
146132
"# --- Stable, colorblind-safe colors and a label->color lookup ----------------\n",
147133
"# Okabe–Ito palette (colorblind friendly)\n",
148134
"OKABE_ITO = [\n",
@@ -156,7 +142,7 @@
156142
" \"#F0E442\", # 3 yellow \n",
157143
"]\n",
158144
"\n",
159-
"# Fixed order for algorithms you commonly plot (extend as needed)\n",
145+
"# Fixed order for algorithms in the notebook and plots\n",
160146
"ALGO_ORDER = [\n",
161147
" \"ols\",\n",
162148
" \"huber\",\n",
@@ -366,7 +352,7 @@
366352
},
367353
{
368354
"cell_type": "code",
369-
"execution_count": 3,
355+
"execution_count": null,
370356
"id": "e7eb4b9c",
371357
"metadata": {},
372358
"outputs": [
@@ -445,7 +431,7 @@
445431
},
446432
{
447433
"cell_type": "code",
448-
"execution_count": 4,
434+
"execution_count": null,
449435
"id": "616da888",
450436
"metadata": {},
451437
"outputs": [
@@ -516,7 +502,7 @@
516502
},
517503
{
518504
"cell_type": "code",
519-
"execution_count": 5,
505+
"execution_count": null,
520506
"id": "85929d59",
521507
"metadata": {},
522508
"outputs": [
@@ -616,7 +602,7 @@
616602
},
617603
{
618604
"cell_type": "code",
619-
"execution_count": 6,
605+
"execution_count": null,
620606
"id": "06ee9218",
621607
"metadata": {},
622608
"outputs": [
@@ -823,7 +809,7 @@
823809
},
824810
{
825811
"cell_type": "code",
826-
"execution_count": 7,
812+
"execution_count": null,
827813
"id": "5e46f183",
828814
"metadata": {},
829815
"outputs": [

0 commit comments

Comments
 (0)