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

Migration guide for old users of xarray-contrib/datatree #8807

Closed
flamingbear opened this issue Mar 4, 2024 · 5 comments · Fixed by #9598
Closed

Migration guide for old users of xarray-contrib/datatree #8807

flamingbear opened this issue Mar 4, 2024 · 5 comments · Fixed by #9598
Labels
topic-DataTree Related to the implementation of a DataTree class topic-documentation

Comments

@flamingbear
Copy link
Member

flamingbear commented Mar 4, 2024

What is your issue?

This is an Issue to keep track of changes that have been made to DataTree from the initial migration of the code in xarray-contrib/datatree

@flamingbear flamingbear added the needs triage Issue that has not been reviewed by xarray team member label Mar 4, 2024
Copy link

welcome bot commented Mar 4, 2024

Thanks for opening your first issue here at xarray! Be sure to follow the issue template!
If you have an idea for a solution, we would really welcome a Pull Request with proposed changes.
See the Contributing Guide for more.
It may take us a while to respond here, but we really value your contribution. Contributors like you help make xarray better.
Thank you!

@flamingbear
Copy link
Member Author

Wasn't positive if I wanted to have a block in the actual top level issue or let people just add comments for the breaking changes.

@flamingbear
Copy link
Member Author

- ``Datatree``'s ``as_array`` renamed ``to_dataarray`` to align with ``Dataset``. (:pull:`8789`)
  By `Owen Littlejohns <https://github.com/owenlittlejohns>`_ and `Matt Savoie
  <https://github.com/flamingbear>`_

@TomNicholas TomNicholas added topic-DataTree Related to the implementation of a DataTree class and removed needs triage Issue that has not been reviewed by xarray team member labels Mar 4, 2024
@TomNicholas
Copy link
Member

Everything in #9297

@TomNicholas TomNicholas changed the title Collection of breaking changes in Datatree occurring during the migration from xarray-contrib/datatree into pydata/xarray proper Migration guide for old users of xarray-contrib/datatree Sep 9, 2024
@TomNicholas
Copy link
Member

We should take this list and use it to write a short migration guide for all the intrepid users of the original xarray-contrib/datatree package.

I'm not sure where the guide should live - it's not relevant for general xarray users who will use the version in main as their first experience of DataTree, and at some point hopefully it will become irrelevant as every user of xarray-contrib/datatree will have migrated. So it perhaps shouldn't live in the main xarray docs?

It also will become out of date as soon as we make any more backwards-incompatible changes to the new version of datatree. I don't think we need to go back and update the document - it describes differences at a specific point in time, and we have a whats-new for any further changes.

So perhaps we should just stick it on the old repository?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic-DataTree Related to the implementation of a DataTree class topic-documentation
Projects
Development

Successfully merging a pull request may close this issue.

2 participants