Skip to content
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.

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

Start of executable docs #777

Open
wants to merge 38 commits into
base: main
Choose a base branch
from
Open
Changes from 1 commit
Commits
Show all changes
38 commits
Select commit Hold shift + click to select a range
5d65b26
doc: initial executeable docs
ianhi Feb 24, 2025
4a2fbe9
doc: add permalink anchors
ianhi Feb 24, 2025
079c5f2
doc: executable quickstart
ianhi Feb 24, 2025
3c0c0bd
remove old docs stuff
ianhi Feb 24, 2025
7e95499
doc: strict docs build
ianhi Feb 24, 2025
146801d
doc: add markdown-exec dependency
ianhi Feb 24, 2025
01e2a3e
doc: readthedocs build rust
ianhi Feb 24, 2025
d567379
doc: rtd build
ianhi Feb 24, 2025
8d346fe
doc: rtd build
ianhi Feb 24, 2025
5fb8ed1
doc: rtd build
ianhi Feb 24, 2025
ddd6283
doc: rtd build
ianhi Feb 24, 2025
d7f8cc8
doc: rtd build
ianhi Feb 24, 2025
66c4522
doc: rtd build
ianhi Feb 24, 2025
0a4dc89
doc: rtd build
ianhi Feb 24, 2025
bb650a3
doc: rtd build
ianhi Feb 24, 2025
64e74e7
docs: end of file
ianhi Feb 24, 2025
e2d1bf1
docs: back to snapshot_id
ianhi Feb 24, 2025
170559b
docs: add parallel to executed docs
ianhi Feb 24, 2025
7fa4d1a
docs: add xarray to doc req
ianhi Feb 24, 2025
9b50cf4
doc: build add pooch
ianhi Feb 25, 2025
b9e5c54
doc: build add scipy
ianhi Feb 25, 2025
45820c9
doc: add exec dask
ianhi Feb 28, 2025
4f70655
doc: formatting
ianhi Feb 28, 2025
ce755a9
doc: exec xarray
ianhi Feb 28, 2025
52c6c16
doc: exec version ctrl
ianhi Mar 1, 2025
3d8b943
doc: dataset rendering
ianhi Mar 1, 2025
bbe0780
doc: formatting output
ianhi Mar 1, 2025
86201c9
doc: remove parts of parallel from execution
ianhi Mar 1, 2025
4c6966a
doc: add more doc dependencies
ianhi Mar 1, 2025
ca5914f
doc: bld add dask distributed
ianhi Mar 1, 2025
8a7f081
doc: spelling
ianhi Mar 1, 2025
da754d9
doc: linting
ianhi Mar 1, 2025
723e7b0
doc: execute final dask block
ianhi Mar 1, 2025
ec2753d
doc: fix errors
ianhi Mar 1, 2025
9c83871
Update docs/docs/icechunk-python/quickstart.md
ianhi Mar 1, 2025
e775d27
doc: remove old file
ianhi Mar 1, 2025
b35caf0
doc: formatting
ianhi Mar 1, 2025
082ad54
doc: don't run parallel
ianhi Mar 1, 2025
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
6 changes: 3 additions & 3 deletions docs/docs/icechunk-python/parallel.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ import tempfile
from icechunk import Repository, local_filesystem_storage

ds = xr.tutorial.open_dataset("rasm").isel(time=slice(24))
repo = Repository.create(local_filesystem_storage(tempfile.mkdtemp()))
repo = Repository.create(local_filesystem_storage(tempfile.TemporaryDirectory().name))
session = repo.writable_session("main")
```

Expand Down Expand Up @@ -59,9 +59,9 @@ def write_timestamp(*, itime: int, session: Session) -> None:

Now execute the writes.

```python exec="on" session="parallel" source="material-block" result="code"
<!-- ```python exec="on" session="parallel" source="material-block" result="code" -->
```python
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this example runs fine for me locally, but ends up not writing anything to store when running on readthedocs.

from concurrent.futures import ThreadPoolExecutor, wait
from icechunk.distributed import merge_sessions

session = repo.writable_session("main")
with ThreadPoolExecutor() as executor:
Expand Down