Skip to content

Conversation

@b8raoult
Copy link
Collaborator

@b8raoult b8raoult commented Sep 21, 2025

Description

Update documentation to follow a better user journey.

What problem does this change solve?

What issue or task does this change relate to?

Additional notes

As a contributor to the Anemoi framework, please ensure that your changes include unit tests, updates to any affected dependencies and documentation, and have been tested in a parallel setting (i.e., with multiple GPUs). As a reviewer, you are also responsible for verifying these aspects and requesting changes if they are not adequately addressed. For guidelines about those please refer to https://anemoi.readthedocs.io/en/latest/

By opening this pull request, I affirm that all authors agree to the Contributor License Agreement.


📚 Documentation preview 📚: https://anemoi-datasets--419.org.readthedocs.build/en/419/

@github-project-automation github-project-automation bot moved this to To be triaged in Anemoi-dev Sep 21, 2025
@github-actions github-actions bot added documentation Improvements or additions to documentation CI/CD labels Sep 21, 2025
@b8raoult b8raoult changed the title Docs/update docs docs: documentation updates Sep 21, 2025
@b8raoult b8raoult marked this pull request as ready for review October 7, 2025 13:57
@b8raoult b8raoult requested a review from a team as a code owner October 7, 2025 13:57
Copy link
Contributor

@aaron-hopkinson aaron-hopkinson left a comment

Choose a reason for hiding this comment

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

Looks good. Two minor suggestions – one to add a link to the new list of filters docs you added in anemoi-transform; another to remove a redundant yaml file.

@github-project-automation github-project-automation bot moved this from To be triaged to Under Review in Anemoi-dev Oct 7, 2025
@aaron-hopkinson aaron-hopkinson merged commit 4588175 into main Oct 21, 2025
69 of 72 checks passed
@aaron-hopkinson aaron-hopkinson deleted the docs/update-docs branch October 21, 2025 10:59
@github-project-automation github-project-automation bot moved this from Under Review to Done in Anemoi-dev Oct 21, 2025
b8raoult pushed a commit that referenced this pull request Oct 30, 2025
🤖 Automated Release PR

This PR was created by `release-please` to prepare the next release.
Once merged:

1. A new version tag will be created
2. A GitHub release will be published
3. The changelog will be updated

Changes to be included in the next release:
---


##
[0.5.28](0.5.27...0.5.28)
(2025-10-30)


### Features

* Added rolling average on read
([#448](#448))
([5cef720](5cef720))
* Fix repeat dates
([#458](#458))
([16b5c83](16b5c83))
* Refactor dataset create
([#379](#379))
([c5408da](c5408da))


### Bug Fixes

* Allow grib source to be used for constant data
([#428](#428))
([c1d7ff1](c1d7ff1))
* Broken source imports
([#450](#450))
([#454](#454))
([d6ed174](d6ed174))
* Ensure missing value indicator in not a valid value in accumulat…
([#316](#316))
([3541a1f](3541a1f))
* S3 access [#453](#453)
([#459](#459))
([2d810e3](2d810e3))
* Xarray-zarr filters
([#457](#457))
([5f2973f](5f2973f))


### Documentation

* Documentation updates
([#419](#419))
([4588175](4588175))

---
> [!IMPORTANT]
> Please do not change the PR title, manifest file, or any other
automatically generated content in this PR unless you understand the
implications. Changes here can break the release process.
> ⚠️ Merging this PR will:
> - Create a new release
> - Trigger deployment pipelines
> - Update package versions

 **Before merging:**
 - Ensure all tests pass
 - Review the changelog carefully
 - Get required approvals

[Release-please
documentation](https://github.com/googleapis/release-please)
CatdBD pushed a commit to CatdBD/anemoi-datasets that referenced this pull request Nov 14, 2025
🤖 Automated Release PR

This PR was created by `release-please` to prepare the next release.
Once merged:

1. A new version tag will be created
2. A GitHub release will be published
3. The changelog will be updated

Changes to be included in the next release:
---


##
[0.5.28](ecmwf/anemoi-datasets@0.5.27...0.5.28)
(2025-10-30)


### Features

* Added rolling average on read
([ecmwf#448](ecmwf#448))
([5cef720](ecmwf@5cef720))
* Fix repeat dates
([ecmwf#458](ecmwf#458))
([16b5c83](ecmwf@16b5c83))
* Refactor dataset create
([ecmwf#379](ecmwf#379))
([c5408da](ecmwf@c5408da))


### Bug Fixes

* Allow grib source to be used for constant data
([ecmwf#428](ecmwf#428))
([c1d7ff1](ecmwf@c1d7ff1))
* Broken source imports
([ecmwf#450](ecmwf#450))
([ecmwf#454](ecmwf#454))
([d6ed174](ecmwf@d6ed174))
* Ensure missing value indicator in not a valid value in accumulat…
([ecmwf#316](ecmwf#316))
([3541a1f](ecmwf@3541a1f))
* S3 access [ecmwf#453](ecmwf#453)
([ecmwf#459](ecmwf#459))
([2d810e3](ecmwf@2d810e3))
* Xarray-zarr filters
([ecmwf#457](ecmwf#457))
([5f2973f](ecmwf@5f2973f))


### Documentation

* Documentation updates
([ecmwf#419](ecmwf#419))
([4588175](ecmwf@4588175))

---
> [!IMPORTANT]
> Please do not change the PR title, manifest file, or any other
automatically generated content in this PR unless you understand the
implications. Changes here can break the release process.
> ⚠️ Merging this PR will:
> - Create a new release
> - Trigger deployment pipelines
> - Update package versions

 **Before merging:**
 - Ensure all tests pass
 - Review the changelog carefully
 - Get required approvals

[Release-please
documentation](https://github.com/googleapis/release-please)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ATS Approval not needed CI/CD documentation Improvements or additions to documentation

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

4 participants