Skip to content

Fix backend tutorial build #111

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dcherian merged 3 commits into from
Jun 28, 2022
Merged

Fix backend tutorial build #111

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
bc87e63
Fix backend tutorial warning
dcherian Jun 27, 2022
a586109
Fix build
dcherian Jun 28, 2022
65cd179
lint
dcherian Jun 28, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 20 additions & 22 deletions advanced/backends/1.Backend_without_Lazy_Loading.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,20 +17,20 @@
"## BackendEntrypoint\n",
"Implement a subclass of `BackendEntrypoint` that expose a method `open_dataset`:\n",
"\n",
" ```python\n",
" from xarray.backends import BackendEntrypoint\n",
"```python\n",
"from xarray.backends import BackendEntrypoint\n",
"\n",
"class MyBackendEntrypoint(BackendEntrypoint):\n",
" def open_dataset(\n",
" self,\n",
" filename_or_obj,\n",
" *,\n",
" drop_variables=None,\n",
" ):\n",
"\n",
" class MyBackendEntrypoint(BackendEntrypoint):\n",
" def open_dataset(\n",
" self,\n",
" filename_or_obj,\n",
" *,\n",
" drop_variables=None,\n",
" ):\n",
" \n",
" return my_open_dataset(filename_or_obj, drop_variables=drop_variables)\n",
" return my_open_dataset(filename_or_obj, drop_variables=drop_variables)\n",
"\n",
" ```"
"```"
]
},
{
Expand All @@ -41,20 +41,18 @@
"Declare this class as an external plugin in your `setup.py`:\n",
"\n",
"```python\n",
" setuptools.setup(\n",
" ...\n",
" entry_points={\n",
" 'xarray.backends': ['engine_name=package.module:my_backendentrypoint'],\n",
" },\n",
" )\n",
"\n",
"setuptools.setup(\n",
" ...\n",
" entry_points={\n",
" 'xarray.backends': ['engine_name=package.module:my_backendentrypoint'],\n",
" },\n",
")\n",
"```\n",
"or pass it in `xr.open_dataset`:\n",
"\n",
"```python\n",
" xr.open_dataset(..., engine=MyBackendEntrypoint)\n",
"```\n",
"<br/>"
"xr.open_dataset(..., engine=MyBackendEntrypoint)\n",
"```"
]
},
{
Expand Down
42 changes: 35 additions & 7 deletions advanced/backends/2.Backend_with_Lazy_Loading.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,41 @@
"<br/>"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"## Create sample files"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {},
"outputs": [],
"source": [
"import os\n",
"\n",
"import dask\n",
"import numpy as np\n",
"import xarray as xr"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {},
"outputs": [],
"source": [
"arr = np.arange(30000000, dtype=np.int64)\n",
"with open(\"foo.bin\", \"w\") as f:\n",
" arr.tofile(f)\n",
"\n",
"arr = np.arange(30000000, dtype=np.float64)\n",
"with open(\"foo_float.bin\", \"w\") as f:\n",
" arr.tofile(f)"
]
},
{
"cell_type": "markdown",
"metadata": {},
Expand Down Expand Up @@ -54,13 +89,6 @@
"metadata": {},
"outputs": [],
"source": [
"import os\n",
"\n",
"import dask\n",
"import numpy as np\n",
"import xarray as xr\n",
"\n",
"\n",
"class BinaryBackendArray(xr.backends.BackendArray):\n",
" def __init__(\n",
" self,\n",
Expand Down