Skip to content

Commit 8eccb5d

Browse files
committed
remove non-existant link, add sphinx-mermaid
1 parent 8bbc512 commit 8eccb5d

File tree

5 files changed

+83
-24
lines changed

5 files changed

+83
-24
lines changed

_config.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,7 @@ sphinx:
6969
# https://github.com/wpilibsuite/sphinxext-rediraffe
7070
- sphinxext.rediraffe
7171
- sphinx_codeautolink
72+
- sphinxcontrib.mermaid
7273

7374
config:
7475
language: en # accessibility

conda/conda-lock.yml

Lines changed: 76 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,10 @@
1313
version: 1
1414
metadata:
1515
content_hash:
16-
osx-64: 1791e916d80ac885466e643ee654367d8fb91d5a74d34ec6743c8b39aa52399e
17-
linux-64: b96579b41e892b6d1a453495bcefb85681e0d807fe3e93866465367858319bcd
18-
win-64: 9aba715d7beceef1f07fd4120597cdc813c0c3f6dd61e8562ad73da4136ad0b6
19-
osx-arm64: fb501e34465ed4fac70f9444ad2d1f9a85d629db962c2e3cd5f58b68fb9fa538
16+
osx-64: 49571e2dd9e6d47ce6aa3d5bbdc919081985983797be17081f68f976779c036e
17+
linux-64: 4daa19bce4836dfdde9cc57bf64660e6a0a4f9cd3aec6d3431e4bed60e747064
18+
win-64: 6748589622af59ba72a8bf19ac474488b96e495deb23fbd7fe5599db2c6fbf0b
19+
osx-arm64: c99d388694ed3922bfb2c9f3f7467188f2730fb6a376021cd10f2c3468b709c5
2020
channels:
2121
- url: conda-forge
2222
used_env_vars: []
@@ -8583,55 +8583,55 @@ package:
85838583
category: main
85848584
optional: false
85858585
- name: identify
8586-
version: 2.5.36
8586+
version: 2.6.0
85878587
manager: conda
85888588
platform: linux-64
85898589
dependencies:
85908590
python: '>=3.6'
85918591
ukkonen: ''
8592-
url: https://conda.anaconda.org/conda-forge/noarch/identify-2.5.36-pyhd8ed1ab_0.conda
8592+
url: https://conda.anaconda.org/conda-forge/noarch/identify-2.6.0-pyhd8ed1ab_0.conda
85938593
hash:
8594-
md5: ba68cb5105760379432cebc82b45af40
8595-
sha256: dc98ab2233d3ed3692499e2a06b027489ee317658cef9277ec23cab00236f31c
8594+
md5: f80cc5989f445f23b1622d6c455896d9
8595+
sha256: 4a2889027df94d51be283536ac235feba77eaa42a0d051f65cd07ba824b324a6
85968596
category: main
85978597
optional: false
85988598
- name: identify
8599-
version: 2.5.36
8599+
version: 2.6.0
86008600
manager: conda
86018601
platform: osx-64
86028602
dependencies:
86038603
ukkonen: ''
86048604
python: '>=3.6'
8605-
url: https://conda.anaconda.org/conda-forge/noarch/identify-2.5.36-pyhd8ed1ab_0.conda
8605+
url: https://conda.anaconda.org/conda-forge/noarch/identify-2.6.0-pyhd8ed1ab_0.conda
86068606
hash:
8607-
md5: ba68cb5105760379432cebc82b45af40
8608-
sha256: dc98ab2233d3ed3692499e2a06b027489ee317658cef9277ec23cab00236f31c
8607+
md5: f80cc5989f445f23b1622d6c455896d9
8608+
sha256: 4a2889027df94d51be283536ac235feba77eaa42a0d051f65cd07ba824b324a6
86098609
category: main
86108610
optional: false
86118611
- name: identify
8612-
version: 2.5.36
8612+
version: 2.6.0
86138613
manager: conda
86148614
platform: osx-arm64
86158615
dependencies:
86168616
ukkonen: ''
86178617
python: '>=3.6'
8618-
url: https://conda.anaconda.org/conda-forge/noarch/identify-2.5.36-pyhd8ed1ab_0.conda
8618+
url: https://conda.anaconda.org/conda-forge/noarch/identify-2.6.0-pyhd8ed1ab_0.conda
86198619
hash:
8620-
md5: ba68cb5105760379432cebc82b45af40
8621-
sha256: dc98ab2233d3ed3692499e2a06b027489ee317658cef9277ec23cab00236f31c
8620+
md5: f80cc5989f445f23b1622d6c455896d9
8621+
sha256: 4a2889027df94d51be283536ac235feba77eaa42a0d051f65cd07ba824b324a6
86228622
category: main
86238623
optional: false
86248624
- name: identify
8625-
version: 2.5.36
8625+
version: 2.6.0
86268626
manager: conda
86278627
platform: win-64
86288628
dependencies:
86298629
ukkonen: ''
86308630
python: '>=3.6'
8631-
url: https://conda.anaconda.org/conda-forge/noarch/identify-2.5.36-pyhd8ed1ab_0.conda
8631+
url: https://conda.anaconda.org/conda-forge/noarch/identify-2.6.0-pyhd8ed1ab_0.conda
86328632
hash:
8633-
md5: ba68cb5105760379432cebc82b45af40
8634-
sha256: dc98ab2233d3ed3692499e2a06b027489ee317658cef9277ec23cab00236f31c
8633+
md5: f80cc5989f445f23b1622d6c455896d9
8634+
sha256: 4a2889027df94d51be283536ac235feba77eaa42a0d051f65cd07ba824b324a6
86358635
category: main
86368636
optional: false
86378637
- name: idna
@@ -23683,6 +23683,62 @@ package:
2368323683
sha256: d4337d83b8edba688547766fc80f1ac86d6ec86ceeeda93f376acc04079c5ce2
2368423684
category: main
2368523685
optional: false
23686+
- name: sphinxcontrib-mermaid
23687+
version: 0.9.2
23688+
manager: conda
23689+
platform: linux-64
23690+
dependencies:
23691+
docutils: ''
23692+
python: '>=3.7'
23693+
sphinx: ''
23694+
url: https://conda.anaconda.org/conda-forge/noarch/sphinxcontrib-mermaid-0.9.2-pyhd8ed1ab_0.conda
23695+
hash:
23696+
md5: 54a6a75e5b3989f1d925d8e5674bbbcb
23697+
sha256: bb02467bb3569406d978112f299e8d8b0832cc495b8bbd5d591858ddbe3a291d
23698+
category: main
23699+
optional: false
23700+
- name: sphinxcontrib-mermaid
23701+
version: 0.9.2
23702+
manager: conda
23703+
platform: osx-64
23704+
dependencies:
23705+
sphinx: ''
23706+
docutils: ''
23707+
python: '>=3.7'
23708+
url: https://conda.anaconda.org/conda-forge/noarch/sphinxcontrib-mermaid-0.9.2-pyhd8ed1ab_0.conda
23709+
hash:
23710+
md5: 54a6a75e5b3989f1d925d8e5674bbbcb
23711+
sha256: bb02467bb3569406d978112f299e8d8b0832cc495b8bbd5d591858ddbe3a291d
23712+
category: main
23713+
optional: false
23714+
- name: sphinxcontrib-mermaid
23715+
version: 0.9.2
23716+
manager: conda
23717+
platform: osx-arm64
23718+
dependencies:
23719+
sphinx: ''
23720+
docutils: ''
23721+
python: '>=3.7'
23722+
url: https://conda.anaconda.org/conda-forge/noarch/sphinxcontrib-mermaid-0.9.2-pyhd8ed1ab_0.conda
23723+
hash:
23724+
md5: 54a6a75e5b3989f1d925d8e5674bbbcb
23725+
sha256: bb02467bb3569406d978112f299e8d8b0832cc495b8bbd5d591858ddbe3a291d
23726+
category: main
23727+
optional: false
23728+
- name: sphinxcontrib-mermaid
23729+
version: 0.9.2
23730+
manager: conda
23731+
platform: win-64
23732+
dependencies:
23733+
sphinx: ''
23734+
docutils: ''
23735+
python: '>=3.7'
23736+
url: https://conda.anaconda.org/conda-forge/noarch/sphinxcontrib-mermaid-0.9.2-pyhd8ed1ab_0.conda
23737+
hash:
23738+
md5: 54a6a75e5b3989f1d925d8e5674bbbcb
23739+
sha256: bb02467bb3569406d978112f299e8d8b0832cc495b8bbd5d591858ddbe3a291d
23740+
category: main
23741+
optional: false
2368623742
- name: sphinxcontrib-qthelp
2368723743
version: 1.0.7
2368823744
manager: conda

conda/environment-unpinned.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ dependencies:
3535
- rioxarray
3636
- scipy
3737
- sphinx-codeautolink
38+
- sphinxcontrib-mermaid
3839
- sphinx-notfound-page
3940
- sphinxext-rediraffe
4041
- s3fs

conda/environment.yml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Generated by conda-lock.
22
# platform: linux-64
3-
# input_hash: b96579b41e892b6d1a453495bcefb85681e0d807fe3e93866465367858319bcd
3+
# input_hash: 4daa19bce4836dfdde9cc57bf64660e6a0a4f9cd3aec6d3431e4bed60e747064
44

55
channels:
66
- conda-forge
@@ -151,7 +151,7 @@ dependencies:
151151
- hvplot=0.10.0=pyhd8ed1ab_0
152152
- hyperframe=6.0.1=pyhd8ed1ab_0
153153
- icu=73.2=h59595ed_0
154-
- identify=2.5.36=pyhd8ed1ab_0
154+
- identify=2.6.0=pyhd8ed1ab_0
155155
- idna=3.7=pyhd8ed1ab_0
156156
- imagesize=1.4.1=pyhd8ed1ab_0
157157
- importlib-metadata=8.0.0=pyha770c72_0
@@ -401,6 +401,7 @@ dependencies:
401401
- sphinxcontrib-devhelp=1.0.6=pyhd8ed1ab_0
402402
- sphinxcontrib-htmlhelp=2.0.5=pyhd8ed1ab_0
403403
- sphinxcontrib-jsmath=1.0.1=pyhd8ed1ab_0
404+
- sphinxcontrib-mermaid=0.9.2=pyhd8ed1ab_0
404405
- sphinxcontrib-qthelp=1.0.7=pyhd8ed1ab_0
405406
- sphinxcontrib-serializinghtml=1.1.10=pyhd8ed1ab_0
406407
- sphinxext-rediraffe=0.2.7=pyhd8ed1ab_1

intermediate/remote_data/remote-data.ipynb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -208,7 +208,7 @@
208208
"\n",
209209
"**Handles Own I/O**: Some libraries have self contained code that can handle I/O, compression, codecs and data access. Some engines task their I/O to lower level libraries. This is the case with rasterio that uses GDAL to access raster files. If a Library is in control of its own I/O operations can be easily adapted to read from buffers.\n",
210210
"\n",
211-
"```mermaid\n",
211+
"```{mermaid}\n",
212212
"graph TD\n",
213213
" A[\"netCDF-4 (.nc, .nc4) and most HDF5 files\"] -->|netcdf4| B[\"Remote Access: No\"]\n",
214214
" A -->|h5netcdf| C[\"Remote Access: Yes\"]\n",
@@ -230,7 +230,7 @@
230230
"\n",
231231
"When we use fsspec to abstract a remote file we are in essence translating byte requests to HTTP range requests over the internet. An HTTP request is a costly I/O operation compared to accessing a local file. Because of this, it's common that libraries that handle over the network data transfers implement a cache to avoid requesting the same data over and over. In the case of fsspec there are different ways to ask the library to handle this **caching and this is one of the most relevant performance considerations** when we work with xarray and remote data.\n",
232232
"\n",
233-
"fsspec default cache is called `read-ahead` and as its name suggests it will read ahead of our request a fixed amount of bytes, this is good when we are working with text or tabular data but it's really an anti pattern when we work with scientific data formats. [Benchmarks show]() that any of the caching schemas will perform better than using the default `read-ahead`.\n",
233+
"fsspec default cache is called `read-ahead` and as its name suggests it will read ahead of our request a fixed amount of bytes, this is good when we are working with text or tabular data but it's really an anti pattern when we work with scientific data formats. Benchmarks show that any of the caching schemas will perform better than using the default `read-ahead`.\n",
234234
"\n",
235235
"### fsspec caching implementations.\n",
236236
"\n",

0 commit comments

Comments
 (0)