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

Update usage.md with append method for icechunk #409

Merged
merged 2 commits into from
Jan 30, 2025

Conversation

abarciauskas-bgse
Copy link
Collaborator

@@ -431,14 +431,27 @@ We can also write these references out as an [IcechunkStore](https://icechunk.io
```python
# create an icechunk repository, session and write the virtual dataset to the session
from icechunk import Repository, Storage, VirtualChunkContainer, local_filesystem_storage
storage = local_filesystem_storage(str('combined'))
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I wasn't really sure why the argument was str('combined') but happy to revert this change if there is a reason

Copy link
Member

Choose a reason for hiding this comment

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

I mean this can't possibly be necessary, because str(<str obj>) == <str obj>, even down to having the same hash. So you should be able to get rid of the enclosing str() call.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

oh yes, I did already get rid of the enclosing str call (see change below), but I also changed the string, which I think more clearly indicates a local path

Copy link
Member

@TomNicholas TomNicholas left a comment

Choose a reason for hiding this comment

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

Thanks @abarciauskas-bgse - these two minor suggestions and then please merge!

docs/usage.md Outdated

#### Append to an existing Icechunk Store

You can append a virtual dataset to an existing Icechunk store using the `append_dim` argument. This is especially useful for ongoing datasets. Note that Zarr does not currently support concatenating datasets with different codecs or chunk shapes.
Copy link
Member

Choose a reason for hiding this comment

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

I would change "ongoing" to "datasets that expand over time" or something like that.

@abarciauskas-bgse abarciauskas-bgse merged commit 9c3d0f9 into main Jan 30, 2025
5 checks passed
@TomNicholas TomNicholas deleted the ab/icechunk-append-usage-doc branch January 31, 2025 19:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants