Improve introductionary documentation

[matschreiner]

What maintenance does this project need?

I think it would be nice with a quick how-to tutorial on anemoi-transform - how would an example configuration file look, which CI-commands should be called. Maybe its supposed to work in conjunction with other packages, but I couldn't find it in the documentation if it's described somewhere.

Organisation

No response

[aaron-hopkinson]

Hi @matschreiner,

In response to your immediate questions, you're right that anemoi-transform is generally used in conjunction with the other packages (primarily anemoi-datasets and anemoi-inference), and so the command line isn't seen as the default entry point as it is in some of the other packages (e.g. datasets) – although there are a few CLI commands for specific operations.

At the moment the main feature that anemoi-transform provides are the data transformation "filters" – these are used by adding blocks to the relevant config (yaml) file for dataset creation, see e.g. the docs page for the rename filter.

I agree that there's definitely still some room for improvement in the documentation, and unfortunately all of the filters have not yet been fully documented (although they should all follow the same format as the rename filter, so hopefully that provides a good starting point) – this is something we hope to improve over time.